Class ecm.widget.TreeSloshBucket

Extends dijit._Widget.
Provides a widget that contains a slosh bucket that uses a tree to display available and selected items.
Defined in: <ecm\widget\TreeSloshBucket.js>.

Constructor Summary

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

Field Summary

Field Attributes	Field Name and Description
	availableLabel Label displayed above the available (left) tree.
	hasSorting If set to `false`, then the move up and move down buttons and container are not displayed.
	hideAvailableOnAdd If set to `true`, when an available item is added to the selected list it is hidden in the available list.
	selectedLabel Label displayed above the selected (right) tree.
	tooltipClass This object implements the `getTooltipText` method which returns the tooltip text for a row.
	tooltipPosition The desired tooltip positioning choices, ordered by preference.

Method Summary

Method Attributes	Method Name and Description
	addNewToSelected(item) Adds the new item to the selected (right) tree.
	destroy()
	getSelectedTree() Retrieves the selected (right) tree.
	getTreeIconClass(item, opened) Returns the icon class for the input item.
	onHide()
	postCreate()
	resize(changeSize) Resizes the pane.
	setAvailableTreeModel(showRoot, showRoot) Sets the available (left) tree model.
	setEditable(editable) Set if the tree is editable.
	setMultipleLevelsSupported(multiLevelSupported) Sets whether multiple levels are supported.
	setSelectedTreeModel(showRoot, selectedValues, selectedValues) Sets the selected (right) tree model.

Constructor Detail

ecm.widget.TreeSloshBucket()

Field Detail

availableLabel

Label displayed above the available (left) tree.

hasSorting

If set to false, then the move up and move down buttons and container are not displayed.

hideAvailableOnAdd

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

selectedLabel

Label displayed above the selected (right) tree.

tooltipClass

This object implements the getTooltipText method which returns the tooltip text for a row. Tooltip text is displayed when the user hovers the mouse over a row.

tooltipPosition

The desired tooltip positioning choices, ordered by preference.

Method Detail

addNewToSelected(item)

Adds the new item to the selected (right) tree.

Parameters:
item: New item to add to the selected tree.

Returns:: Returns null if there was an error adding the item.

destroy()

getSelectedTree()

Retrieves the selected (right) tree.

Returns:: A dijit.Tree.

getTreeIconClass(item, opened)

Returns the icon class for the input item.

Parameters:
item: The input item.
opened: A value of true if the item is opened.

Returns:: An icon class.

onHide()

postCreate()

resize(changeSize)

Resizes the pane.

Parameters:
changeSize: The changed size.

setAvailableTreeModel(showRoot, showRoot)

Sets the available (left) tree model.

Parameters:
showRoot: A boolean value. If true the root is displayed. Otherwise, the root is hidden.
showRoot

setEditable(editable)

Set if the tree is editable.

Parameters:
editable: A boolean value. True if the tree is editable, otherwise it is read only.

setMultipleLevelsSupported(multiLevelSupported)

Sets whether multiple levels are supported.

Parameters:
multiLevelSupported: A boolean value. Indicates if the selected tree supports one level (false) or two levels (true). If true, the right and left buttons are shown; otherwise, they are hidden.

setSelectedTreeModel(showRoot, selectedValues, selectedValues)

Sets the selected (right) tree model.

Parameters:
showRoot: A boolean value. If true the root is displayed. Otherwise, the root is hidden.
selectedValues: The array of selected values. If hideAvailableOnAdd is true, the selected values are hidden in the available tree.
selectedValues