Class ecm.widget.dialog.SelectObjectDialog

Extends ecm.widget.dialog.BaseDialog.
Provides a dialog box that is used to search for and select repository items.
Defined in: <ecm\widget\dialog\SelectObjectDialog.js>.

Constructor Summary

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

Field Summary

Field Attributes	Field Name and Description
	classSelectorDisabled Boolean indicating if the class selector should be disabled.
	classSelectorItemList An array of class ids, if specified then only those classes are displayed in the class selector.
	multiSelect Set to `true` to allow multiple selection of objects.
	repositoryTypes Comma separated string containing the list of repository types.
	selectionMode Specifies what object types can be selected.
	showAllRepositories Sets the option of whether to allow the Search in option to include all repositories assigned to the desktop.
	showCrossRepositorySearches Sets the option whether to allow the Existing search option to include cross repository search templates.
	showExistingSearchRepositorySelector Sets the option of whether to allow the Existing search option to include a repository selector.
	showMultiRepositorySelector Sets the option of whether to allow the Search in option to include multiple repositories or only the current repository.
	showSelectVersionButton If showVersionSelection is true, then this option allows the user to show or hide the select versions button.
	showVersionSelection Sets the option to allow selecting specific versions of a document.

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

Method Summary

Method Attributes	Method Name and Description
	postCreate()
	show(callback) 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.SelectObjectDialog()

Field Detail

classSelectorDisabled

Boolean indicating if the class selector should be disabled.

Since:: 2.0.3

classSelectorItemList

An array of class ids, if specified then only those classes are displayed in the class selector.

Since:: 2.0.3

multiSelect

Set to true to allow multiple selection of objects.

repositoryTypes

Comma separated string containing the list of repository types. Not required if only using dialog in P8 repository.

Since:: 2.0.3

selectionMode

Specifies what object types can be selected. Valid values are any, document, or folder.

showAllRepositories

Sets the option of whether to allow the Search in option to include all repositories assigned to the desktop. If set to true then all repositories assigned to the desktop will be available to search in. If false then the Search in option will display repositories based on the setting for showMultiRepositorySelector.

Since:: 2.0.3

showCrossRepositorySearches

Sets the option whether to allow the Existing search option to include cross repository search templates. If set to true then cross repository search templates (if any) will be included in the search selector. If set to false then cross repository search templates will be excluded from the search selector.

Since:: 2.0.3

showExistingSearchRepositorySelector

Sets the option of whether to allow the Existing search option to include a repository selector. If set to true then the user will have the option to select from multiple repositories to find documents to select. If false then only the current repository will be used.

Since:: 2.0.3

showMultiRepositorySelector

Sets the option of whether to allow the Search in option to include multiple repositories or only the current repository. If set to true then all FileNet P8 repositories in the same domain as the current repository will be available to search in. If false then only the current repository will appear.

showSelectVersionButton

If showVersionSelection is true, then this option allows the user to show or hide the select versions button.

Since:: 2.0.3

showVersionSelection

Sets the option to allow selecting specific versions of a document. If true is specified then a button is displayed that lists the versions of the selected document.

Method Detail

postCreate()

show(callback)

Shows the dialog.

Parameters:

callback

A function that is called when the dialog is closed. The list of selected items is passed as a parameter to the callback. Each item is an object with the following properties:

id: The id of the item
name: the name of the item
mimetype: the items mimetype
version: the version selected (current, released, if null then a static version was selected)
contentItem: the content item object
vsId: for FileNet P8 docs, the version series id (only if current or released version is specified)