Class ecm.widget.SloshBucket

Extends dijit._Widget.
Provides a widget that is used to pick a subset of unique items from a larger set of items.

The widget contains two single column lists. One list contains the available items and the other list contains the selected items. The Add button and a Remove button that are used to move items from one list to the other appear between the columns. Optionally, the widget includes an Up button and a Down button that are used to order the selected items.

Defined in: <ecm\widget\SloshBucket.js>.

Constructor Summary

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

Field Summary

Field Attributes	Field Name and Description
	availableLabel The label above the available grid or 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 The label above the selected grid.
	tooltipClass This object implements the `getTooltipText` method which returns the tooltip text for a row.
	tooltipPosition The tooltip position.
	validateRemove If defined, this function will be called to perform validation before removing items from the slosh bucket.

Method Summary

Method Attributes	Method Name and Description
	addToSelected(newData) Used for user-entered values that need to be added to the selected grid and may not be in the available grid.
	destroy()
	filter(struct) Filters the available data using the passed in filter structure.
	getSelectedItems() Returns the selected items.
	getSelectedValuesGrid() Returns the selected values grid.
	onHide()
	postCreate()
	registerCustomAddFunc(customAdd) Registers a custom add function.
	registerCustomRemoveFunc(customRemove) Registers a custom remove function.
	resize(changeSize) Resizes the pane.
	setAvailableGridModel(store, layout) Sets the store and layout on the available (left) grid.
	setAvailableTreeModel(treeModel, showRoot) Sets the tree model for the available (left) tree.
	setEditable(editable) Boolean that sets the slosh bucket as editable or read only.
	setSelectedValuesGridModel(store, layout, selectedValues, fixedSelectedValues) Sets the store, layout, selected values, and fixed values for the selected (right) grid.

Constructor Detail

ecm.widget.SloshBucket()

Deprecated:: As of 2.0.3. This widget has been replaced by idx.widget.SloshBucket

Field Detail

availableLabel

The label above the available grid or 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

The label above the selected grid.

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 tooltip position.

validateRemove

If defined, this function will be called to perform validation before removing items from the slosh bucket. selection is passed as the first parameter to validateRemove. The function defined should return true if it is okay to proceed with the remove. Required for P8 markings use case.

Method Detail

addToSelected(newData)

Used for user-entered values that need to be added to the selected grid and may not be in the available grid. Currently only the available grid is supported.

Parameters:
newData: The item to add to the selected grid.

destroy()

filter(struct)

Filters the available data using the passed in filter structure.

Parameters:
struct: The filter structure for the DataGrid.

getSelectedItems()

Returns the selected items.

getSelectedValuesGrid()

Returns the selected values grid.

Returns:: The Dojo DataGrid.

onHide()

postCreate()

registerCustomAddFunc(customAdd)

Registers a custom add function.

Parameters:
customAdd: Custom add function.

registerCustomRemoveFunc(customRemove)

Registers a custom remove function.

Parameters:
customRemove: Custom remove function.

resize(changeSize)

Resizes the pane.

Parameters:
changeSize: The changed size.

setAvailableGridModel(store, layout)

Sets the store and layout on the available (left) grid. Use either setAvailableGridModel if the available list is a grid, or use setAvailableTreeModel if the available list is a tree.

Parameters:
store: The store for the available DataGrid.
layout: The structure for the available DataGrid.

setAvailableTreeModel(treeModel, showRoot)

Sets the tree model for the available (left) tree. Use either setAvailableGridModel if the available list is a grid, or use setAvailableTreeModel if the available list is a tree.

Parameters:
treeModel: The tree model for the available tree.
showRoot: Boolean indicating if the root should or should not be shown.

setEditable(editable)

Boolean that sets the slosh bucket as editable or read only.

Parameters:
editable: {Boolean} Set to true to make the slosh bucket editable and false to make it read only.

setSelectedValuesGridModel(store, layout, selectedValues, fixedSelectedValues)

Sets the store, layout, selected values, and fixed values for the selected (right) grid.

Parameters:
store: The selected values store.
layout: The selected values structure.
selectedValues: The keys on this structure are the default selected values to add to the selected values grid.
fixedSelectedValues: Array of values that cannot be removed from the selected values grid.