Class ecm.model.TeamspaceTreeModel

Extends ecm.model._ModelObject.
Represents a tree that is used to display the hierarchy of all teamspaces for a repository. This class implements the Dojo dijit.tree.model class.
Defined in: <ecm\model\TeamspaceTreeModel.js>.

Constructor Summary

Constructor Attributes	Constructor Name and Description
	ecm.model.TeamspaceTreeModel()

Fields borrowed from class ecm.model._ModelObject:: categorization, id, isRecurring, name, nameFilter, pane, status, type, userId

Method Summary

Method Attributes	Method Name and Description
	constructor() Constructs the tree model.
	destroy() Destroys the model.
	fetchItemByIdentity(keywordArgs) This method is not implemented.
	getChildren(parentItem, onComplete) Invokes the onComplete callback function which provides an array of the children for an item.
	getIdentity(item) Returns the identifier for the given item.
	getLabel(item) Returns the name for an item.
	getRoot(onItem) Returns the root item of the model.
	isItem(something) Returns true if an object is an item that can be displayed in the tree.
	mayHaveChildren(item) Returns `true` if the item is permitted to have children.
	newItem(args, parent, insertIndex) This method is not implemented.
	onChange(item) Event method that is called when an item's properties have changed.
	onChildrenChange(parent, newChildrenList) Event method that is called when an item's children have changed (added, updated, deleted).
	onProcessingComplete(item) This event is triggered when the model completes processing an item.
	onProcessingStarted(item) This event is triggered when the model begins processing an item.
	pasteItem(childItem, oldParentItem, newParentItem, bCopy) This method is not implemented.
	setRepository(repository) Sets the repository used for this model.

Methods borrowed from class ecm.model._ModelObject:: own, refresh, toString

Constructor Detail

ecm.model.TeamspaceTreeModel()

Method Detail

constructor()

Constructs the tree model.

destroy()

Destroys the model. Note: This is required by dijit.tree.model although this tree model is doing nothing for destroy.

fetchItemByIdentity(keywordArgs)

This method is not implemented.

Parameters:
keywordArgs

getChildren(parentItem, onComplete)

Invokes the onComplete callback function which provides an array of the children for an item.

Parameters:
parentItem: The item used to determine the children.
onComplete: The callback function that is used to invoke with an array of the child items as the only argument.

getIdentity(item)

Returns the identifier for the given item.

Parameters:
item

getLabel(item)

Returns the name for an item. The name can be displayed in the user interface.

Parameters:
item

getRoot(onItem)

Returns the root item of the model.

Parameters:
onItem

isItem(something)

Returns true if an object is an item that can be displayed in the tree.

Parameters:
something: Any object.

mayHaveChildren(item)

Returns true if the item is permitted to have children.

Parameters:
item

newItem(args, parent, insertIndex)

This method is not implemented.

Parameters:
args
parent
insertIndex

onChange(item)

Event method that is called when an item's properties have changed.

Parameters:
item

onChildrenChange(parent, newChildrenList)

Event method that is called when an item's children have changed (added, updated, deleted).

Parameters:
parent
newChildrenList

onProcessingComplete(item)

This event is triggered when the model completes processing an item. It is intended to allow tree widgets to remove display of progress indicators.

Parameters:
item

onProcessingStarted(item)

This event is triggered when the model begins processing an item. It is intended to allow tree widgets to display a progress indicator next to the node for the item.

Parameters:
item

pasteItem(childItem, oldParentItem, newParentItem, bCopy)

This method is not implemented.

Parameters:
childItem
oldParentItem
newParentItem
bCopy

setRepository(repository)

Sets the repository used for this model. This is needed in cases where the tree widget using the model needs to show teamspaces for a different repository.

Parameters:
repository