Class ecm.widget.search.SearchInDropDown

Extends dijit._WidgetBase.
Provides an interface to select the scope of a search.
Defined in: <ecm\widget\search\SearchInDropDown.js>.

Constructor Summary

Constructor Attributes	Constructor Name and Description
	ecm.widget.search.SearchInDropDown()

Field Summary

Field Attributes	Field Name and Description
	disabled Whether the control should be disabled.
	displayAllRepositories An optional flag that allows you to display all the repositories assigned to the current desktop including IBM FileNet P8 repositories that are in a different domain.
	displayFilteredRepositories An optional flag indicate this control is embedded in Add Document wizard if value is true.
	displayForSearch Whether the "Search In" title will be displayed.
	displayRepositoryDropDownList Whether the repository drop-down list will be displayed.
	displaySelectRepositoriesNode Whether the repositories choice will be displayed.
	displaySelectTeamspacesNode Whether the teamspaces choice will be displayed if the repository supports teamspaces.
	displayTeamspacesInitially Whether should display folders or teamspaces initially
	dropDownClass
	forceWidth Option of if set the width in force.
	isRequired Sets whether a folder selection by the user is required.
	label The label of the widget.
	preventSelectRoot Whether the root node should be made unselectable.
	preventSelectRootTooltip Displayed in tooltip when the user hovers over root node when it is not selectable.
	repository The ecm.model.Respository object.
	repositoryTeamspaceName Name of the repository teamspace.
	selectRootInitially Whether the root node of the control should be selected initially.
	showIncludeSubFolders Whether the include subfolders check box should be displayed.
	showRepositoryTeamspace This option causes the control to display the top level repository or teamspace in the label.
	unselectableFolderIds Array of folder IDs which will be non-selectable in the tree.
	validateRepository An optional function called with a repository belonging to the same domain as the primary repository.

Method Summary

Method Attributes	Method Name and Description
	createFolderSelector(params) Creates the folder selector control.
	destroy() Destroys the control.
	getAvailableRepositoriesForSelection() Returns all the repositories available for selection.
	getDisabled() Returns boolean indicating whether the control is disabled.
	getFilter() Get the filter widget.
	getFolderSelector() Returns the folder selector widget within this dropdown.
	getIsSelectableCallback() Returns the callback function to determine whether a folder is selectable.
	getSelected() Returns the currently selected item in the control.
	getTeamspace() Get the teamspace.
	isIncludeSubfolders(includeSubfolders) Returns a boolean indicating the Include subfolders check box checked state.
	isValid() Checks to see whether the user has selected a value when required to do so.
	onFolderSelected(selectedFolder)
	postCreate() Launches after the widget is created.
	rootSet() Event to notify caller that setting root object is complete.
<static>	ecm.widget.search.SearchInDropDown.SearchInDropDown.addExtension(extensionClass, params) This static method allows the `SearchInDropDown` to be extended with additional sections.
	setDisabled(disabled) Sets the control to be disabled.
	setFocus() Sets focus to the control
	setIncludeSubfolders(includeSubfolders) Sets whether the Include subfolders check box will be displayed.
	setIsSelectableCallback(callbackFunction, callbackObject) Sets the callback function to determine whether a folder is selectable.
	setLabel(label, displayInTooltip) Sets the text for the control.
	setRepositoryTypes(repositoryTypes) Set comma separated list of the repository types that will be displayed in the repository selection control.
	setRoot(rootObject) Sets the root repository, teamspace, or folder of the control.
	setSelected(folder, isTeamspaceFolder, pathName) Sets the folder selected in the control
	setShowIncludeSubFolders(showIncludeSubFolders) Sets the control to show/hide the Include subfolders check box.
	setTeamspace(teamspace) Sets the parent teamspace for the control.
	setUnselectableFolders(unselectableFolders)
	validate() Checks the control for validity.

Constructor Detail

ecm.widget.search.SearchInDropDown()

Field Detail

disabled

Whether the control should be disabled.

displayAllRepositories

An optional flag that allows you to display all the repositories assigned to the current desktop including IBM FileNet P8 repositories that are in a different domain.

Since:: 2.0.3

displayFilteredRepositories

An optional flag indicate this control is embedded in Add Document wizard if value is true. And in this case it will look for Browse feature in desktop and if it is enabled then it will use showInBrowseView attribute to remove any repository doesn't have it set ,otherwise it will use showinSearchView to filter repository. Default is to use showInSearchView attribute.

Since:: 2.0.3

displayForSearch

Whether the "Search In" title will be displayed.

displayRepositoryDropDownList

Whether the repository drop-down list will be displayed.

Since:: 2.0.2

displaySelectRepositoriesNode

Whether the repositories choice will be displayed.

displaySelectTeamspacesNode

Whether the teamspaces choice will be displayed if the repository supports teamspaces.

displayTeamspacesInitially

Whether should display folders or teamspaces initially

Since:: 2.0.3

dropDownClass

Since:: 2.0.2 Adds a class to the drop-down div.

forceWidth

Option of if set the width in force.

isRequired

Sets whether a folder selection by the user is required.

label

The label of the widget.

preventSelectRoot

Whether the root node should be made unselectable.

preventSelectRootTooltip

Displayed in tooltip when the user hovers over root node when it is not selectable.

repository

The ecm.model.Respository object.

repositoryTeamspaceName

Name of the repository teamspace.

selectRootInitially

Whether the root node of the control should be selected initially.

showIncludeSubFolders

Whether the include subfolders check box should be displayed.

showRepositoryTeamspace

This option causes the control to display the top level repository or teamspace in the label.

unselectableFolderIds

Array of folder IDs which will be non-selectable in the tree.

validateRepository

An optional function called with a repository belonging to the same domain as the primary repository. If defined, the repository will only be added to the repository selection list if the return value is true.

Since:: 2.0.2

Method Detail

createFolderSelector(params)

Creates the folder selector control.

Parameters:
params: The parameters used to create the folder selector

destroy()

Destroys the control.

getAvailableRepositoriesForSelection()

Returns all the repositories available for selection.

Returns:: an array of repositories

getDisabled()

Returns boolean indicating whether the control is disabled.

Returns:: Boolean indicating whether the control is disabled.

getFilter()

Get the filter widget.

Since:: 2.0.3.1

getFolderSelector()

Returns the folder selector widget within this dropdown.

Since:: 2.0.3

getIsSelectableCallback()

Returns the callback function to determine whether a folder is selectable.

Returns:: Callback function to determine whether a folder is selectable.

getSelected()

Returns the currently selected item in the control.

Returns:: The selected ecm.model.SelectedFolder object.

getTeamspace()

Get the teamspace.

Since:: 2.0.3.1

Returns:: teamspace A ecm.model.Teamspace object.

isIncludeSubfolders(includeSubfolders)

Returns a boolean indicating the Include subfolders check box checked state.

Parameters:
includeSubfolders: Boolean indicating whether the Include subfolders check box will be displayed.

isValid()

Checks to see whether the user has selected a value when required to do so.

Returns:: Boolean indicating whether the control is valid.

onFolderSelected(selectedFolder)

Parameters:
selectedFolder

postCreate()

Launches after the widget is created.

rootSet()

Event to notify caller that setting root object is complete.

<static> ecm.widget.search.SearchInDropDown.SearchInDropDown.addExtension(extensionClass, params)

This static method allows the SearchInDropDown to be extended with additional sections.

Parameters:
extensionClass: The constructor function for creating an instance of the extenstion.
params

Since:: 2.0.3.1

setDisabled(disabled)

Sets the control to be disabled.

Parameters:
disabled: Boolean indicating whether the control will be disabled.

setFocus()

Sets focus to the control

setIncludeSubfolders(includeSubfolders)

Sets whether the Include subfolders check box will be displayed.

Parameters:
includeSubfolders: Boolean indicating whether the Include subfolders checkbox will be displayed.

setIsSelectableCallback(callbackFunction, callbackObject)

Sets the callback function to determine whether a folder is selectable.

Parameters:
callbackFunction: The function used to determine whether a folder is selectable.
callbackObject: An instance of ecm/widget/FolderSelectorCallback. This callback will be used to call the callbackFunction

setLabel(label, displayInTooltip)

Sets the text for the control.

Parameters:
label: The text that will be displayed.
displayInTooltip: Boolean indicating whether the label should be displayed in a tooltip when the mouse is hovered.

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

setRoot(rootObject)

Sets the root repository, teamspace, or folder of the control.

Parameters:
rootObject: An ecm.model.Repository, ecm.model.Teamspace, or ecm.model.Item to be used as the root node of the control.

setSelected(folder, isTeamspaceFolder, pathName)

Sets the folder selected in the control

Parameters:
folder: ecm.model.Item corresponding to the selected folder.
isTeamspaceFolder
pathName

setShowIncludeSubFolders(showIncludeSubFolders)

Sets the control to show/hide the Include subfolders check box.

Parameters:
showIncludeSubFolders: Boolean indicating whether to show the Include subfolders checkbox.

setTeamspace(teamspace)

Sets the parent teamspace for the control.

Parameters:
teamspace: A ecm.model.Teamspace object.

setUnselectableFolders(unselectableFolders)

Parameters:
unselectableFolders

validate()

Checks the control for validity.

Returns:: Boolean indicating whether the control is valid.