Class ecm.widget.MultiColumnList

Extends dijit._Widget, dijit._TemplatedMixin, dijit._WidgetsInTemplateMixin, ecm.LoggerMixin, ecm.MessagesMixin.
Provides a simple multiple-column list that is used to select items.
Defined in: <ecm\widget\MultiColumnList.js>.

Constructor Summary

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

Field Summary

Field Attributes	Field Name and Description
	borderHeight A string indicating the height of the list.
	contextMenuHandler instance for the context menu to use for the list.
	label ************************************************************************************************************ A string indicating the name of the list.
	pageSize Sets the numbers of items per page.
	selectionLabel Selection label.
	selectionMode selection mode.

Method Summary

Method Attributes	Method Name and Description
	addToSelection(selection) Adds and item to the selection list.
	clearSelection() Resets the selection list.
	destroy() Destroys the widget.
	doheaderclick(onClick) Override grid's doheaderclick to support nosort for a column
	getSelectedItems() Get an Array of selected items from the dojox.grid.DataGrid.
	onSelection(selectedItems) Invoked when an item is selected in the grid.
	postCreate() Called after widget creation to connect ecm.model.Desktop events and create grid.
	postMixInProperties()
	resize() Invokes resize on the border container for the widget.
	setModel(structure, store) Used to build grid without a ecm.model.Resultset.
	setResultSet(resultSet) Sets the ecm.model.Resultset on the dojox.grid.DataGrid.
	setSelectionMode(selectionMode) Sets the single or multiple selection mode for the dojox.grid.DataGrid.
	setToolbar(toolbar) Sets the toolbar to be used for the list.

Constructor Detail

ecm.widget.MultiColumnList()

Field Detail

borderHeight

A string indicating the height of the list.

contextMenuHandler

instance for the context menu to use for the list.

label

************************************************************************************************************ A string indicating the name of the list.

pageSize

Sets the numbers of items per page.

selectionLabel

Selection label.

selectionMode

selection mode.

Method Detail

addToSelection(selection)

Adds and item to the selection list.

Parameters:
selection: The row number of the item to be selected.

clearSelection()

Resets the selection list.

destroy()

Destroys the widget.

doheaderclick(onClick)

Override grid's doheaderclick to support nosort for a column

Parameters:
onClick: event.

getSelectedItems()

Get an Array of selected items from the dojox.grid.DataGrid.

Returns:: An array of the selected rows.

onSelection(selectedItems)

Invoked when an item is selected in the grid.

Parameters:
selectedItems: An array of the selected items.

postCreate()

Called after widget creation to connect ecm.model.Desktop events and create grid.

postMixInProperties()

resize()

Invokes resize on the border container for the widget.

setModel(structure, store)

Used to build grid without a ecm.model.Resultset.

Parameters:
structure: The structure for the dojox.grid.DataGrid.
store: The store for the dojox.grid.DataGrid.

setResultSet(resultSet)

Sets the ecm.model.Resultset on the dojox.grid.DataGrid.

Parameters:
resultSet: An instance of ecm.model.Resultset.

setSelectionMode(selectionMode)

Sets the single or multiple selection mode for the dojox.grid.DataGrid.

Parameters:
selectionMode: The string value "single" or "multiple".

setToolbar(toolbar)

Sets the toolbar to be used for the list.

Parameters:
toolbar: A ecm.widget.teamspaceBuilder.SelectionToolbar object.