Class ecm.widget.Toolbar

Extends dijit.Toolbar, ecm.MessagesMixin.
Provides a widget that creates a generic toolbar pane for an IBM Content Navigator application.
Defined in: <ecm\widget\Toolbar.js>.

Constructor Summary

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

Field Summary

Field Attributes	Field Name and Description
	repository Handle to the ecm.model.Repository object used to perform actions.
	showButtonLabels Flag indicating is button labels should be shown.
	toolbarButtons An array of dijit/form/Button and/or dijit/form/DropDownButton objects.
	toolbarName Name of the IBM Content Navigator toolbar definition to load.

Method Summary

Method Attributes	Method Name and Description
	canPerform(action, params) Returns true if the action can be performed.
	clearToolbar() Clears the toolbar.
	createToolbar(params) Creates the toolbar.
	onToolbarButtonsCreated(toolbarButtons) Event fired when toolbar buttons are created.
	postCreate()
	updateToolbarState() Update toolbar button state.

Constructor Detail

ecm.widget.Toolbar()

Since:: 2.0.3

Field Detail

repository

Handle to the ecm.model.Repository object used to perform actions.

showButtonLabels

Flag indicating is button labels should be shown.

toolbarButtons

An array of dijit/form/Button and/or dijit/form/DropDownButton objects.

toolbarName

Name of the IBM Content Navigator toolbar definition to load. Toolbars are defined in the IBM Content Navigator administration.

Method Detail

canPerform(action, params)

Returns true if the action can be performed.

Parameters:

action

The ecm.model.Action object representing the action to perform.

params

An object containing additional parameters used to validate if an action can be performed. The object can include:

resultSet - A ecm.model.ResultSet model object containing the results of a search.
items - An array of ecm.model.Item objects.
teamspace - A ecm.model.Teamspace model object, if the action is being performed within a teamspace.

clearToolbar()

Clears the toolbar.

createToolbar(params)

Creates the toolbar.

Parameters:

params

List of parameters to provide to ecm.model.Action classes associated with the buttons and drop down buttons in this toolbar. List of parameters include:

items - The selected items. This will be empty for global actions.
listType - Passed into isEnabled method of the action. A string value indicating the type of object in the items list.
callbackMap - Can be null.
repository - Instance of ecm.model.Repository.
teamspace - Instance of ecm.model.Teamspace.
resultSet - Instance of ecm.model.ResultSet.
contentList - Instance of ecm.model.listView.ContentList.
parameterMap - Passed into performAction method of the action. An array of extra parameters to be passed to the action (can be null).

onToolbarButtonsCreated(toolbarButtons)

Event fired when toolbar buttons are created.

Parameters:
toolbarButtons: The array of toolbar buttons.

postCreate()

updateToolbarState()

Update toolbar button state.