Class ecm.widget.SelectObject
Extends
dijit._Widget.
Provides a widget that is used to select a repository object by entering a query.
Defined in: <ecm\widget\SelectObject.js>.
Constructor Summary
Constructor Attributes | Constructor Name and Description |
---|---|
Field Summary
Field Attributes | Field Name and Description |
---|---|
Set to
true to allow multiple selection of objects. |
|
An ecm.model.Repository object representing the current repository the select object widget will use.
|
|
Comma separated string containing the list of repository types.
|
|
A
_SELECTION_MODE value. |
|
Sets the option whether to display all repositories in the repository selector for the Search in
option.
|
|
Sets the option whether to allow the Existing search option to include cross repository
search templates.
|
|
Sets the option of whether to allow the Existing search option to include a repository
selector.
|
|
Sets the option of whether to allow the Search in option to include multiple repositories
or only the current repository.
|
|
If showVersionSelection is true, then this option allows the user to show or hide the select versions button.
|
|
Sets the option to allow selecting specific versions of a document.
|
Method Summary
Method Attributes | Method Name and Description |
---|---|
constructor(cArgs)
Constructs an ecm.widget.SelectObject object.
|
|
getSelectedItems(callback)
Returns the currently selected items in the results.
|
|
Determines if the results list is currently displaying a version list.
|
|
onSelectionChange(selectedItems, isValid)
Event function that is called when an item is selected in the search results.
|
|
setClassSelectorDisabled(disabled)
Sets the class selector as disabled.
|
|
setClassSelectorItemList(itemList)
The array of item class ids to display in the class selector.
|
|
setRepository(repository)
Sets the repository.
|
|
setRepositoryTypes(repositoryTypes)
Set comma separated list of the repository types that will be displayed in the repository selection control.
|
|
setSelectionMode(selectionMode)
Sets the selection mode to control what object types can be selected.
|
|
setShowAllRepositories(showAllRepositories)
Sets the option that determines if the Search in selector presents all repositories
assigned to the current desktop.
|
|
setShowMultiRepositorySelector(showMultiRepositorySelector)
Sets the option that determines if the Search in selector presents multiple repositories or
only the current repository.
|
|
setShowSelectVersionButton(showSelectVersionButton)
Sets the option to allow showing the select versions button that is displayed when showVersionSelection is
true.
|
|
setShowVersionSelection(showVersionSelection)
Sets the option to allow selecting specific versions of a document.
|
Field Detail
multiSelect
Set to
true
to allow multiple selection of objects.
repository
An ecm.model.Repository object representing the current repository the select object widget will use.
repositoryTypes
Comma separated string containing the list of repository types.
- Since:
- 2.0.3
selectionMode
A
_SELECTION_MODE
value. Specifies what object types can be selected.
showAllRepositories
Sets the option whether to display all repositories in the repository selector for the Search in
option. If set to
true
, then all repositories assigned to the desktop will be available to
search.
- 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. If false
, then only the current
repository will available to search.
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
constructor(cArgs)
Constructs an ecm.widget.SelectObject object.
- Parameters:
- cArgs
getSelectedItems(callback)
Returns the currently selected items in the results.
- Parameters:
- callback
- A callback function that is called with the selected items list.
- Returns:
- An array of objects with these properties:
id
: the id of the content itemname
: the name of the content itemmimetype
: the mimetype of the content itemcontentItem
: the content item objectvsId
: for FileNet P8 documents, the version series id (only if current or released version is specified)version
: a string representing whether the item is the current or released version id
{Boolean} isShowingVersions()
Determines if the results list is currently displaying a version list.
- Returns:
- {Boolean} A value of
true
if the results list is a versions list, otherwisefalse
.
onSelectionChange(selectedItems, isValid)
Event function that is called when an item is selected in the search results.
- Parameters:
- selectedItems
- An array of content items that are selected in the results list.
- isValid
- A boolean value indicating if the selection is valid, based on
selectionMode
.
postCreate()
postMixInProperties()
setClassSelectorDisabled(disabled)
Sets the class selector as disabled.
- Parameters:
- disabled
- Boolean indicating if the class selector should be disabled.
- Since:
- 2.0.3
setClassSelectorItemList(itemList)
The array of item class ids to display in the class selector.
- Parameters:
- itemList
- An array of class ids, if specified then only those classes are displayed in the class selector.
- Since:
- 2.0.3
setRepository(repository)
Sets the repository.
- Parameters:
- repository
- An ecm.model.Repository object.
- Since:
- 2.0.3 Added filtered repository behavior. If repository is not enabled to show in Search then use default repository instead
setRepositoryTypes(repositoryTypes)
Set comma separated list of the repository types that will be displayed in the repository selection control.
- Parameters:
- repositoryTypes
- String value holding comma separated list of repository types to display.
- Since:
- 2.0.3
setSelectionMode(selectionMode)
Sets the selection mode to control what object types can be selected. Valid values are
any
,
document
, or folder
.
- Parameters:
- selectionMode
- A
_SELECTION_MODE
value. Ifany
is specified, then any object type can be selected. Ifdocument
, only documents can be selected. Iffolder
, only folders can be selected.
setShowAllRepositories(showAllRepositories)
Sets the option that determines if the Search in selector presents all repositories
assigned to the current desktop. If set to
true
, then all repositories assigned to the
desktop will be available to search. *
- Parameters:
- showAllRepositories
- If
true
, then allow all repositories assigned to the desktop in thesearch in
setShowMultiRepositorySelector(showMultiRepositorySelector)
Sets the option that determines if the Search in selector presents 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. If false
, then only the current
repository will be available to search.
- Parameters:
- showMultiRepositorySelector
- If
true
, then allow multiple repositories in thesearch in
option. Iffalse
, then only the current repository will appear.
setShowSelectVersionButton(showSelectVersionButton)
Sets the option to allow showing the select versions button that is displayed when showVersionSelection is
true.
- Parameters:
- showSelectVersionButton
- If
true
and showVersionSelction istrue
, then the select version button is displayed. Iffalse
and showVersionSelction istrue
, then the select version button is not displayed.
- Since:
- 2.0.3
setShowVersionSelection(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.
- Parameters:
- showVersionSelection
- If
true
then the version selection button is displayed. Iffalse
then there is no option to display document versions.