Class ecm.widget.listView.modules.Toolbar

Extends ecm.widget.listView.modules._Module.
This content list module provides toolbar capability.
Defined in: <ecm\widget\listView\modules\Toolbar.js>.

Constructor Summary

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

Method Summary

Method Attributes	Method Name and Description
	cleanUpToolButtons() Cleans up the toolbar buttons.
	constructor()
	createToolButtons() Creates the toolbar buttons.
	destroy()
	getAPIPath() See GridX API documentation for details.
	getButtonArea() Returns the button area dom node that the buttons are contained in.
	getSelectedItems() Return selected items.
	getToolbarButton(actionId) Retrieves a specific toolbar button if it exists.
	getToolbarButtons() 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()
	setToolbarButtonDisabled(actionId, disable) Allows users to disable a specific toolbar button.
	updateToolbarState() Update toolbar button state.

Constructor Detail

ecm.widget.listView.modules.Toolbar()

Deprecated:: Since 2.0.3. Use ecm.widget.listView.modules.Toolbar2 instead.

Method Detail

cleanUpToolButtons()

Cleans up the toolbar buttons.

constructor()

createToolButtons()

Creates the toolbar buttons. Gets the button actions from the resultset.

destroy()

getAPIPath()

See GridX API documentation for details.

getButtonArea()

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

getSelectedItems()

Return selected items.

Returns:: Array of ecm.model.Item or ecm.model.Favorite.

getToolbarButton(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.

getToolbarButtons()

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.

preload()

setToolbarButtonDisabled(actionId, disable)

Allows users to disable a specific toolbar button.

Parameters:
actionId: The id of the ecm.model.Action.
disable: Boolean indicating if the button should be disabled.

updateToolbarState()

Update toolbar button state.