Class ecm.widget.FolderSelector

Extends dijit._Widget.
Provides a widget that is used to select folders in a repository, teamspace, or parent folder.
Defined in: <ecm\widget\FolderSelector.js>.

Constructor Summary

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

Field Summary

Field Attributes	Field Name and Description
	avoidInitialTreeCreation  Boolean indicating whether to avoid recreating the internal folder tree initially.
	preventSelectRoot  Whether the root node should be selectable.
	preventSelectRootTooltip  String displayed in tooltip when user hovers over root node when it is not selectable.
	repository  The ecm.model.Respository object.
	rootItemToFilter  An teamspace id of a node to filter from the list of teamspaces.
	selectRootInitially  Whether the root node should be selected initially.
	showIncludeSubfolders  Whether the include subfolders checkbox should be displayed.
	style  Either dropdown or inline.
	teamspacemode  Boolean indicating whether the control should be used to select a folder in a teamspace.
	teamspacename  The name of the teamspace.
	unselectableFolders  Array of ecm.widget.UnselectableFolder objects that represent folders that will be unselectable in the tree.

Method Summary

Method Attributes	Method Name and Description
	createFolderTree(params) Creates the folder tree
	getIsSelectableCallback() Returns the function used to determine whether folders in the tree are selectable.
	getSelected(inRepo) Returns an ecm.model.SelectedFolder object representing the selected folder.
	hideTooltip()
	onFolderDblClick()
	onFolderSelect(item) Event fired when a folder is selected by the user.
	onFolderTreeRendered() Event fired after the folder tree is rendered.
	onPagingComplete()
	onPagingStart()
	postCreate()
	resize(size) Resizes the control
	scrollSelectedIntoView() Scrolls the selected folder into view if it is not visible.
	selectRootNode() Selects the root node in the tree.
	setIsSelectableCallback(callbackFunction, callbackObject) Sets the callback function to determine whether a folder is selectable.
	setRoot(root, objectStore) Sets the root repository, teamspace or folder of the control.
	setSelected(folder) Sets the initially selected folder.
	setStyle(style) Sets the style of the control to be displayed inline in a widget, or in a dropdown control (see ecm.widget._FolderSelectorDropDown).
	setTeamspace(teamspace) Sets the teamspace.
	setUnselectableFolders(unselectableFolders) Sets folders that will be unselectable in the control.
	startup() Initializes control to display as inline

Field Detail

avoidInitialTreeCreation

Since:

2.0.3

---

preventSelectRoot

---

preventSelectRootTooltip

---

repository

---

rootItemToFilter

Since:

2.0.3

---

selectRootInitially

---

showIncludeSubfolders

---

style

---

teamspacemode

---

teamspacename

---

unselectableFolders

Method Detail

createFolderTree(params)

Parameters:

params

The parameters used to create the folder tree

---

getIsSelectableCallback()

Returns:

The callback function set in setIsSelectableCallback, used to determine whether a folder is seletable in the control.

---

getSelected(inRepo)

Parameters:

inRepo

A {Boolean} value indicating that the repository should be selected.

Returns:

A {@link ecm.model.Item) object that is the selected folder in the control.

---

hideTooltip()

Since:

2.0.3

---

onFolderDblClick()

---

onFolderSelect(item)

Parameters:

item

A ecm.model.Item object that is the seleted folder.

---

onFolderTreeRendered()

Since:

2.0.3

---

onPagingComplete()

---

onPagingStart()

---

postCreate()

---

resize(size)

Parameters:

size

An object that contains the new width and height of the control.

---

scrollSelectedIntoView()

---

selectRootNode()

---

setIsSelectableCallback(callbackFunction, callbackObject)

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

---

setRoot(root, objectStore)

Parameters:

root

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

objectStore

The object store for the root object. May be null.

---

setSelected(folder)

Parameters:

folder

{link ecm.model.item} object that is the initially selected folder.

---

setStyle(style)

Parameters:

style

A String, either "inline" or "dropdown".

---

setTeamspace(teamspace)

Parameters:

teamspace

A {link ecm.model.Teamspace} object. Used when the root of the control is a folder in a teamspace.

---

setUnselectableFolders(unselectableFolders)

Parameters:

unselectableFolders

Array of ecm.widget.UnselectableFolder objects where the corresponding folder nodes in the control will not be selectable.

---

startup()

---