Class ecm.widget.listView.modules.Toolbar2

Extends ecm.widget.listView.modules._Module.
This content list module provides toolbar capability. This module uses the ecm.widget.Toolbar (which supports regular and dropdown buttons) to load the toolbar buttons. By default, this module also has an Actions drop down button which has the context menu actions for the selected items in the content list.
Defined in: <ecm\widget\listView\modules\Toolbar2.js>.

Constructor Summary

Constructor Attributes	Constructor Name and Description
	ecm.widget.listView.modules.Toolbar2()

Field Summary

Field Attributes	Field Name and Description
	showActionsButton Show the actions button.

Method Summary

Method Attributes	Method Name and Description
	clearToolbar() Clears the toolbar buttons.
	constructor()
	constructToolbarWidget() Construct the Toolbar widget used to display the action items
	createToolbar() Creates the toolbar.
	destroy() Destroy.
	getAPIPath() See GridX API documentation for details.
	getButton(actionId) Retrieves a specific toolbar button if it exists.
	getButtonArea() Returns the button area dom node that the buttons are contained in.
	getButtons() Retrieves the toolbar buttons.
	loadContextMenu(selectedItems, callback) Load the context menu by loading it from the resultSet.
	onContextMenuCreated(actionMenu, items) Event fired when the context menus have been constructed.
	onToolbarButtonsCreated(toolbarButtons) Event fired when toolbar buttons are created.
	preload()

Constructor Detail

ecm.widget.listView.modules.Toolbar2()

Since:: 2.0.3

Field Detail

showActionsButton

Show the actions button.

Method Detail

clearToolbar()

Clears the toolbar buttons.

constructor()

constructToolbarWidget()

Construct the Toolbar widget used to display the action items

createToolbar()

Creates the toolbar.

destroy()

Destroy.

getAPIPath()

See GridX API documentation for details.

getButton(actionId)

Retrieves a specific toolbar button if it exists.

Parameters:
actionId: The id of the ecm.model.Action.

Returns:: The button with the associated action id.

getButtonArea()

Returns the button area dom node that the buttons are contained in.

getButtons()

Retrieves the toolbar buttons.

Returns:: Array of buttons.

loadContextMenu(selectedItems, callback)

Load the context menu by loading it from the resultSet. Provides a way for sub-modules to override this functionality.

Parameters:
selectedItems: Array of ecm.model.Item or ecm.model.Favorite.
callback: The callback function.

onContextMenuCreated(actionMenu, items)

Event fired when the context menus have been constructed. This is used to alter the menu items if necessary.

Parameters:
actionMenu: The action menu.
items: The selected items.

onToolbarButtonsCreated(toolbarButtons)

Event fired when toolbar buttons are created.

Parameters:
toolbarButtons: The array of toolbar buttons.

Classes