Class ecm.widget.MultiValueChoicePane

Extends dijit._Widget.
Provides a widget that is used to select multiple values from a choice list. This widget is used for IBM FileNet Content Manager repositories.
Defined in: <ecm\widget\MultiValueChoicePane.js>.

Constructor Summary

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

Field Summary

Field Attributes	Field Name and Description
	allowDuplicateValues Boolean indicating if duplicate values are allowed.
	availableData Choice list to be displayed as the available data.
	editable Boolean indicating if the data is editable.
	hasSorting Boolean indicating if the widget supports sorting.
	hideAvailableOnAdd If set to `true`, when an available item is added to the selected list, it is hidden in the available list.
	isTree Boolean indicating if the available list is a tree or grid.
	selectedValues Array of the selected values.

Method Summary

Method Attributes	Method Name and Description
	constructor()
	destroy()
	getGridTooltipText(grid, item) Callback from the sloshBucket.
	getLabel() Returns the label string for the selected values.
	getTreeTooltipText(treeModel, treeNode) Callback from the sloshBucket.
	getValue() Returns the value.
	onHide()
	onSave() Called when the user clicks the `Save` or `OK` button to save the changes.
	onShow() When the widget is shown, clears the filter and loads the ecm.widget.SloshBucket widget.
	postCreate()
	resize(changeSize) Resizes the sloshBucket.

Constructor Detail

ecm.widget.MultiValueChoicePane()

Field Detail

allowDuplicateValues

Boolean indicating if duplicate values are allowed. If set to false, then value will be the identifier.

availableData

Choice list to be displayed as the available data. This has a displayName and choices.

editable

Boolean indicating if the data is editable.

hasSorting

Boolean indicating if the widget supports sorting. If set to false, then the move up down buttons/container is non-displayed.

hideAvailableOnAdd

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

isTree

Boolean indicating if the available list is a tree or grid.

selectedValues

Array of the selected values.

Method Detail

constructor()

destroy()

getGridTooltipText(grid, item)

Callback from the sloshBucket. Loads the grid tooltip.

Parameters:
grid: The grid.
item: The item.

getLabel()

Returns the label string for the selected values.

Returns:: The full label string. When multiple values are selected, the label for each selected value is appended to the label string. The _separator character is used to separate multiple labels in the label string.

getTreeTooltipText(treeModel, treeNode)

Callback from the sloshBucket. Loads the tree node's tooltip.

Parameters:
treeModel: The treeModel.
treeNode: The tree node.

getValue()

Returns the value.

Returns:: An array of the selected values in the selected values sloshBucket.

onHide()

onSave()

Called when the user clicks the Save or OK button to save the changes. Gets the selected values from the sloshBucket.

onShow()

When the widget is shown, clears the filter and loads the ecm.widget.SloshBucket widget.

postCreate()

resize(changeSize)

Resizes the sloshBucket.

Parameters:
changeSize: The changed size. See the ecm.widget.SloshBucket method resize.