Class ecm.widget.dialog.SelectUserGroupDialog

Extends ecm.widget.dialog.BaseDialog.
Provides a dialog box that is used to select users and groups.
Defined in: <ecm\widget\dialog\SelectUserGroupDialog.js>.

Constructor Summary

Constructor Attributes	Constructor Name and Description
	ecm.widget.dialog.SelectUserGroupDialog()

Field Summary

Field Attributes	Field Name and Description
	cancelButtonLabel Sets the cancel button label.
	defaultScope Sets to default query mode when using queryMode = all.
	filteredItems Array of object selected ecm.model.User or ecm.model.UserGroup to filter from the available list.
	hideCurrentUser Hide the logged in user for the repository
	queryMode Indicates the query mode of the Select User Group dialog.
	selectionMode Indicates the selection mode of the Select User Group dialog.

Fields borrowed from class ecm.widget.dialog.BaseDialog:: fitContentArea, lockFullscreen

Method Summary

Method Attributes	Method Name and Description
	constructor(args) Constructor
	onAdd() Event fired when the Add button is clicked.
	onCancel() Event fired when the Close button is clicked.
	onLoaded() Fired when the content group selector is loaded.
	postCreate()
	setCriteriaTextBox(value) Set the value in the criteria text box and run the search.
	show(repository) Shows the dialog.

Methods borrowed from class ecm.widget.dialog.BaseDialog:: addButton, appendSecondaryMessage, buildRendering, clearMessage, clearSecondaryMessage, destroy, hide, isMaximized, onDragOver, resize, setIntroText, setIntroTextRef, setMaximized, setMessage, setReferenceLink, setResizable, setSize, setSizeToViewportRatio, setTitle, setWidth, showActionBar

Constructor Detail

ecm.widget.dialog.SelectUserGroupDialog()

Field Detail

cancelButtonLabel

Sets the cancel button label. The default is Close.

defaultScope

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

Since:: 2.0.3

filteredItems

Array of object selected ecm.model.User or ecm.model.UserGroup to filter from the available list.

Since:: 2.0.3

hideCurrentUser

Hide the logged in user for the repository

Since:: 2.0.3.3

queryMode

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

selectionMode

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

Method Detail

constructor(args)

Constructor

Parameters:
args

onAdd()

Event fired when the Add button is clicked.

onCancel()

Event fired when the Close button is clicked.

onLoaded()

Fired when the content group selector is loaded.

Since:: 2.0.3.3

postCreate()

setCriteriaTextBox(value)

Set the value in the criteria text box and run the search.

Parameters:
value

Since:: 2.0.3.3

show(repository)

Shows the dialog.

Parameters:
repository: An instance of ecm.model.Repository.