Class ecm.widget.UserGroupSelector

Extends dijit._Widget.
Provides a widget that is used to select a user or group. This widget can be configured to display both users and groups or only users. The widget can also be configured to support multiple selections or only single selections.
Defined in: <ecm\widget\UserGroupSelector.js>.

Constructor Summary

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

Field Summary

Field Attributes	Field Name and Description
	defaultScope Sets to default query mode when using queryMode = all.
	hideCurrentUser Hide the user that is currently logged into the repository.
	queryMode Indicates the query mode of the User Group Selector widget.
	repository An instance of ecm.model.Repository representing the repository from which users or groups will be selected.
	selectionMode Indicates the selection mode of the User Group Selector widget.
	showCreatorOwnerAccount Sets to true to enable pseudo user (#CREATOR-OWNER) selection for P8.
	showPseudoGroups Sets to true to enable pseudo groups (#Authenticated User) selection for P8.
	showPseudoUsers Sets to true to enable pseudo users (Me) selection.

Method Summary

Method Attributes	Method Name and Description
	clearSelectedItems() Clears the current selected users and groups from the Selected list.
	constructor(args) Constructor
	createRendering(repository) Renders the user group selector pane
	destroy() Cleans up the widget
	focus() Sets the initial to the criteria box.
	getSelectedItems() Returns the current selected users and groups
	onAdd(items) Event fired after new items are added to the available list.
	onChange() Event fired after double clicking a grid row when in a single selection mode or when the selected items have changed in the extended mode
	onLoaded() Fired when the selector is loaded.
	onRemove(items) Event fired after items are removed from the available list.
	onSelectionChanged(item) Event fired when the available grid row selection changed.
	onShow() Event fired when showing the pane.
	postCreate()
	resize() Resizes the widget
	setFilteredItems(filteredItems) Sets the filtered items list.
	setSelectedItems(selectedItems) Sets the selected items list.

Constructor Detail

ecm.widget.UserGroupSelector()

Field Detail

defaultScope

Sets to default query mode when using queryMode = all. The default is users.

hideCurrentUser

Hide the user that is currently logged into the repository.

Since:: 2.0.3.3

queryMode

Indicates the query mode of the User Group Selector widget. Sets to all for both user and group queries and users for users query only. The default is all.

repository

An instance of ecm.model.Repository representing the repository from which users or groups will be selected.

selectionMode

Indicates the selection mode of the User Group Selector widget. Sets the selection mode to extended for multi select operation and single for single select operation. The default is extended.

showCreatorOwnerAccount

Sets to true to enable pseudo user (#CREATOR-OWNER) selection for P8. The default is false.

Since:: 2.0.3.1

showPseudoGroups

Sets to true to enable pseudo groups (#Authenticated User) selection for P8. The default is false.

showPseudoUsers

Sets to true to enable pseudo users (Me) selection. The default is false.

Method Detail

clearSelectedItems()

Clears the current selected users and groups from the Selected list.

constructor(args)

Constructor

Parameters:
args

createRendering(repository)

Renders the user group selector pane

Parameters:
repository

destroy()

Cleans up the widget

focus()

Sets the initial to the criteria box.

getSelectedItems()

Returns the current selected users and groups

Returns:: An array of ecm.model.User and/or ecm.model.UserGroup object.

onAdd(items)

Event fired after new items are added to the available list.

Parameters:
items: An array of ecm.model.User and/or ecm.model.UserGroup object.

onChange()

Event fired after double clicking a grid row when in a single selection mode or when the selected items have changed in the extended mode

onLoaded()

Fired when the selector is loaded.

Since:: 2.0.3.3

onRemove(items)

Event fired after items are removed from the available list.

Parameters:
items: An array of ecm.model.User and/or ecm.model.UserGroup object.

onSelectionChanged(item)

Event fired when the available grid row selection changed.

Parameters:
item

Since:: 2.0.3

onShow()

Event fired when showing the pane. This is triggered by the UserGroupSelectorPane onShow event.

postCreate()

resize()

Resizes the widget

setFilteredItems(filteredItems)

Sets the filtered items list. The filtered items are filtered out from the available list.

Parameters:
filteredItems: An array of ecm.model.User or ecm.model.UserGroup

setSelectedItems(selectedItems)

Sets the selected items list. The selected items are displayed in the selected list.

Parameters:
selectedItems: An array of ecm.model.User or ecm.model.UserGroup