Class ecm.widget.VerticalSloshBucket

Extends dijit._Widget, dijit._TemplatedMixin, dijit._WidgetsInTemplateMixin, ecm.LoggerMixin, ecm.widget._MoveUpDownMixin.
Provides a vertical slosh bucket that is used in teamspace builder to add classes or entry templates, searches, and existing roles to teamspace templates.
Defined in: <ecm\widget\VerticalSloshBucket.js>.

Constructor Summary

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

Field Summary

Field Attributes	Field Name and Description
	addButtonLabel The label used for the Add button.
	availableHeight Height of the available list.
	availableListLabel The label used for the available list.
	createButtonLabel The label used for the Create button.
	doubleClickAddAvailable Indicates double-click is enabled to open or view an item in the available list.
	doubleClickAddSelection Indicates that double-click is enabled to add a selection.
	hideAvailableItemOnAdd If set to `true`, when an available item is added to the selection list it is hidden in the available list.
	selectedHeight Height of the selection list.
	selectedListLabel The label used for the selection list.
	selectionLabel The label used for the selection list.
	showAddButton Indicates if the Add button should be visible.
	showCreateButton Indicates if the Create button should be visible.
	showEditButton Indicates if the Edit button should be visible.
	showMakeAvailableButton Indicates if the Make Available button should be visible.
	showMakeDefaultButton Indicates if the Make Default button should be visible.

Method Summary

Method Attributes	Method Name and Description
	addItemToAvailableList(obj) Adds an object to the available store.
	addItemToSelection(obj) Adds an object to the selection store.
	onAddNewItem() Invoked when the Add New button is clicked.
	onCreateNewItem() Invoked when the Create New button is clicked.
	onEdit(obj) Called when the Edit button is clicked and an item is selected in the selection list.
	onEditButtonClicked() Invoked when the Edit button is clicked.
	onMakeAvailable(obj) Called when the Make Available button is clicked and an item is selected in the selection list.
	onMakeAvailableButtonClicked() Invoked when the Make Available button is clicked.
	onMakeDefault() Invoked when the Make Default button is clicked.
	onMoveItemFromSelectedToAvailable() Moves the selected rows in the selection list to the bottom of the available list.
	onMoveOrderDown() Moves the selected rows in the selection list down.
	onMoveOrderUp() Moves the selected rows in the selection list up.
	onRemoveItems() Removes the selected rows from the selection list.
	onSelectionChange(selectedItems) Invoked when the selection list selections change.
	postCreate() Overrides dijit._Widget.postCreate to create the teamspaceBuilder.
	removeItemFromAvailableList(obj) Removes an object from the available list.
	resize() Invokes resize on the selected and available list.
	setModels(availableStore, selectionStore, availableListColumns, selectionListColumns) Sets the models to be used in the verticalSloshBucket.

Constructor Detail

ecm.widget.VerticalSloshBucket()

Field Detail

addButtonLabel

The label used for the Add button.

availableHeight

Height of the available list.

availableListLabel

The label used for the available list.

createButtonLabel

The label used for the Create button.

doubleClickAddAvailable

Indicates double-click is enabled to open or view an item in the available list.

doubleClickAddSelection

Indicates that double-click is enabled to add a selection.

hideAvailableItemOnAdd

If set to true, when an available item is added to the selection list it is hidden in the available list.

selectedHeight

Height of the selection list.

selectedListLabel

The label used for the selection list.

selectionLabel

The label used for the selection list.

showAddButton

Indicates if the Add button should be visible.

showCreateButton

Indicates if the Create button should be visible.

showEditButton

Indicates if the Edit button should be visible.

showMakeAvailableButton

Indicates if the Make Available button should be visible.

showMakeDefaultButton

Indicates if the Make Default button should be visible.

Method Detail

addItemToAvailableList(obj)

Adds an object to the available store.

Parameters:
obj: The object that will be added to the available store.

addItemToSelection(obj)

Adds an object to the selection store.

Parameters:
obj: The object that will be added to the selection store.

onAddNewItem()

Invoked when the Add New button is clicked.

onCreateNewItem()

Invoked when the Create New button is clicked.

onEdit(obj)

Called when the Edit button is clicked and an item is selected in the selection list.

Parameters:
obj: The selected object.

onEditButtonClicked()

Invoked when the Edit button is clicked. Gets the selected item from the selection list and calls onEdit with the selected item. If there is no selected item, onEdit is not called.

onMakeAvailable(obj)

Called when the Make Available button is clicked and an item is selected in the selection list.

Parameters:
obj: The selected object.

onMakeAvailableButtonClicked()

Invoked when the Make Available button is clicked. Gets the selected item from the selection list and calls onMakeAvailable with the selected item. If there is no selected item, onMakeAvailable is not called.

onMakeDefault()

Invoked when the Make Default button is clicked.

onMoveItemFromSelectedToAvailable()

Moves the selected rows in the selection list to the bottom of the available list.

onMoveOrderDown()

Moves the selected rows in the selection list down.

onMoveOrderUp()

Moves the selected rows in the selection list up.

onRemoveItems()

Removes the selected rows from the selection list.

onSelectionChange(selectedItems)

Invoked when the selection list selections change.

Parameters:
selectedItems: An array of selected items.

postCreate()

Overrides dijit._Widget.postCreate to create the teamspaceBuilder.

removeItemFromAvailableList(obj)

Removes an object from the available list.

Parameters:
obj: The object that will be removed from the available store.

resize()

Invokes resize on the selected and available list.

setModels(availableStore, selectionStore, availableListColumns, selectionListColumns)

Sets the models to be used in the verticalSloshBucket.

Parameters:
availableStore: A dojo.data.ItemFileWriteStore object that contains the available items.
selectionStore: A dojo.data.ItemFileWriteStore object that will store the selected items.
availableListColumns: An array of columns for the available list grid.
selectionListColumns: An array of columns for the selection list grid.