Class ecm.widget.listView.ContentList

Extends dijit._Widget, dijit._TemplatedMixin, dijit._WidgetsInTemplateMixin, ecm.MessagesMixin.
Provides a widget that displays the results of a search, the contents of a folder, the work items in a work list, lists of teamspaces, and so on. This widget can be used to navigate folders and launch actions for the items that are displayed. The widget provides the ability to enable multiple content views.
Defined in: <ecm\widget\listView\ContentList.js>.

Constructor Summary

Constructor Attributes	Constructor Name and Description
	ecm.widget.listView.ContentList()

Field Summary

Field Attributes	Field Name and Description
	coreModules List of core modules.
	emptyMessage Message displayed in the grid if there are no results.
	escapeCellData A Boolean value indicating whether HTML characters are escaped in the cell.
	escapeStructureName A Boolean value indicating whether HTML characters are escaped in the structure name.
	grid Handle to the gridx.Gridx object for details and magazine views.
	headerHidden If true, the grid will not display the header row.
	multiSelect Indicates if the grid supports multiple or single selection.
	selectFirstRowOnSetResult If true, when the result set is displayed, automatically select the first row.

Method Summary

Method Attributes	Method Name and Description
	appendResultSet(model) Append to the result set.
	constructor()
<static>	ecm.widget.listView.ContentList.ContentList.callMethod(widgetId, method) This static method calls the specified method on the widget matching the specified widget identifier.
	getContentListModule(name) Returns the specified content list module.
	getContentListModules(modules) Returns the list of contentList modules
	getGridExtensionModules(modules) Returns the list of grid extension modules.
	getGridModule(name) Returns the specified grid module.
	getResultSet() Returns the result set associated with this content list.
	getSelectedItems() Returns array of selected items.
	onBeforeSetResultSet(model) Event fired before setting the resultSet.
	onContentListModulesLoaded() Event fired when all the content list grid modules are loaded.
	onGridResize(start, count) Event fired by grid.
	onModulesLoaded() Event fired when all the grid modules are loaded.
	onOpenItem(item, openItemData) Event fired indicating an item (i.e.
	onRender(start, count) Event fired by grid body.
	onRowClick(item, evt) Event fired when a row click occurs in the grid.
	onRowDblClick(item, evt) Event fired when double click a row in the grid.
	onRowSelectionChange(selectedItems) Event fired when row selection in the grid changes.
	onSelectedItemUpdateItem(selectedItems) Event fired when a selected row is updated.
	onSetResultSet(listParent) Event fired after the result set is set.
	onSetViews() Event fired after the views have been reset by the resultSet.
	onViewButtonClicked(buttonViewName, currentViewName) Event fired when a view button is clicked.
	openCompoundDocument(item) Navigate into a compound document.
	openItem(item) Opens the specified item.
	postCreate() Called after widget creation to connect ecm.model.Desktop events.
	reset() Destroys the grid and its modules.
	setContentListModules(modules) Set the list of contentList modules to load the first time the result set is set.
	setGridExtensionModules(modules) Set the list of grid extension modules to load when the grid is created.
	setResultSet(model, listParent) Sets the model for this content list.
	uninitialize() Cleans up the widget.

Constructor Detail

ecm.widget.listView.ContentList()

Field Detail

coreModules

List of core modules. Filled out in the constructor.

emptyMessage

Message displayed in the grid if there are no results.

escapeCellData

A Boolean value indicating whether HTML characters are escaped in the cell. Default is true. If you are using HTML tags in the cell data to display icons or formatted text, set this value to false so that the HTML tags are applied.

Since:: 2.0.3.2

escapeStructureName

A Boolean value indicating whether HTML characters are escaped in the structure name. Default is true. If you are using HTML tags in the structure name to display icons or formatted text, set this value to false so that the HTML tags are applied.

Since:: 2.0.3

grid

Handle to the gridx.Gridx object for details and magazine views.

Since:: 2.0.2

headerHidden

If true, the grid will not display the header row.

Since:: 2.0.3.5

multiSelect

Indicates if the grid supports multiple or single selection.

selectFirstRowOnSetResult

If true, when the result set is displayed, automatically select the first row.

Method Detail

appendResultSet(model)

Append to the result set.

Parameters:
model: An instance of ecm.model.ResultSet

constructor()

<static> ecm.widget.listView.ContentList.ContentList.callMethod(widgetId, method)

This static method calls the specified method on the widget matching the specified widget identifier.

Parameters:
widgetId: Identifier of the widget with the specified method
method: The widget method to call.

getContentListModule(name)

Returns the specified content list module.

Parameters:
name

Returns:: Instance of ecm.widget.listView.modules._Module.

getContentListModules(modules)

Returns the list of contentList modules

Parameters:
modules

Since:: 2.0.2

Returns:: modules List of modules added to this content list.

getGridExtensionModules(modules)

Returns the list of grid extension modules.

Parameters:
modules

Since:: 2.0.2

Returns:: modules List of modules added to this content list.

getGridModule(name)

Returns the specified grid module.

Parameters:
name

Returns:: Instance of gridx.core._Module.

getResultSet()

Returns the result set associated with this content list.

Returns:: Returns an instance of ecm.model.ResultSet

getSelectedItems()

Returns array of selected items.

Returns:: Array of ecm.model.Item or ecm.model.Favorite.

onBeforeSetResultSet(model)

Event fired before setting the resultSet. Allows the user to update the resultSet before setting it in the content list.

Parameters:
model: An instance of ecm.model.ResultSet

onContentListModulesLoaded()

Event fired when all the content list grid modules are loaded.

Since:: 2.0.3

onGridResize(start, count)

Event fired by grid.

Parameters:
start
count

onModulesLoaded()

Event fired when all the grid modules are loaded.

onOpenItem(item, openItemData)

Event fired indicating an item (i.e. folder, teamspace) is opened or should be opened.

Parameters:
item: The ecm.model.Item opened.
openItemData: Data associated with the action.

onRender(start, count)

Event fired by grid body.

Parameters:
start
count

onRowClick(item, evt)

Event fired when a row click occurs in the grid.

Parameters:
item: The ecm.model.Item or ecm.model.Favorite opened.
evt: The mouse click event

Since:: 2.0.2

onRowDblClick(item, evt)

Event fired when double click a row in the grid.

Parameters:
item: The ecm.model.Item or ecm.model.Favorite opened.
evt: The mouse click event

onRowSelectionChange(selectedItems)

Event fired when row selection in the grid changes.

Parameters:
selectedItems: Array of ecm.model.Item or ecm.model.Favorite.

onSelectedItemUpdateItem(selectedItems)

Event fired when a selected row is updated.

Parameters:
selectedItems: Array of ecm.model.Item or ecm.model.Favorite.

onSetResultSet(listParent)

Event fired after the result set is set. This allows content list modules to be notified when the result set is updated.

Parameters:
listParent: A parent folder or search of the parent content list

onSetViews()

Event fired after the views have been reset by the resultSet.

onViewButtonClicked(buttonViewName, currentViewName)

Event fired when a view button is clicked.

Parameters:
buttonViewName: Name of the view button clicked.
currentViewName: Name of the current view button.

openCompoundDocument(item)

Navigate into a compound document.

Parameters:
item: Handle to the ecm.model.Item to navigate into. If the item is not a recognized compound document, or the configured action handler does not contain actionViewChildDocuments, openItem is called, and the default action for the item will be invoked.

Since:: 2.0.3

openItem(item)

Opens the specified item.

Parameters:
item: Handle to the ecm.model.Item to open.

postCreate()

Called after widget creation to connect ecm.model.Desktop events.

reset()

Destroys the grid and its modules.

setContentListModules(modules)

Set the list of contentList modules to load the first time the result set is set.

Parameters:
modules: List of modules to extend the content list.

setGridExtensionModules(modules)

Set the list of grid extension modules to load when the grid is created.

Parameters:
modules: List of modules to extend the internal grid object.

setResultSet(model, listParent)

Sets the model for this content list.

Parameters:
model: An instance of ecm.model.ResultSet
listParent: A parent folder or search of the parent content list

uninitialize()

Cleans up the widget.