Class ecm.model.SearchTemplateTreeModel
Extends
ecm.model._ModelObject.
Represents a tree that is used to display the hierarchy of search template folders and the search
templates in these folders. This class implements the dijit.tree.model contract.
Defined in: <ecm\model\SearchTemplateTreeModel.js>.
Constructor Summary
Constructor Attributes | Constructor Name and Description |
---|---|
Field Summary
Field Attributes | Field Name and Description |
---|---|
The number of search templates that are displayed per page.
|
|
Indicates whether this model has an all searches node.
|
|
Indicates whether to show cross repository search templates.
|
|
Indicates whether to show the list of opened search templates.
|
|
Indicates whether to show the list of recently used search templates.
|
- Fields borrowed from class ecm.model._ModelObject:
- categorization, id, isRecurring, name, nameFilter, pane, status, type, userId
Method Summary
Method Attributes | Method Name and Description |
---|---|
applyFilter(filter)
Applies the given filter to the tree model.
|
|
constructor(repository, teamspace)
Constructs a tree model.
|
|
destroy()
|
|
fetchItemByIdentity(keywordArgs)
Not implemented.
|
|
getChildren(parentItem, onComplete)
Calls onComplete with an array of child items of the given parent item.
|
|
getIdentity(something)
Returns the identity of an item.
|
|
getLabel(item)
Returns the label for an item.
|
|
getRoot(onItem)
Calls onItem with the root node of this model.
|
|
isItem(something)
Returns true if "something" is an item in or belonging to this model.
|
|
loadMore()
Loads the next page of items.
|
|
mayHaveChildren(item)
Returns true if the item has or may have children.
|
|
newItem(args, parent, insertIndex)
Not implemented.
|
|
onChange(item)
Called whenever an item has changed.
|
|
onChildrenChange(parent, newChildrenList)
Called whenever a parent item or its children have changed.
|
|
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.
|
|
onRecentSearchesLoad(recentSearches)
Called whenever recent searches are loaded.
|
|
pasteItem(childItem, oldParentItem, newParentItem, bCopy)
Not implemented.
|
|
reload()
Reloads this model.
|
|
reloadNode(item)
Reloads the specified node.
|
- Methods borrowed from class ecm.model._ModelObject:
- own, refresh, toString
Field Detail
itemsPerPage
The number of search templates that are displayed per page.
noAllSearches
Indicates whether this model has an all searches node.
showCrossRepositorySearches
Indicates whether to show cross repository search templates.
showOpenedSearches
Indicates whether to show the list of opened search templates.
showRecents
Indicates whether to show the list of recently used search templates.
Method Detail
applyFilter(filter)
Applies the given filter to the tree model.
- Parameters:
- filter
- Simple filter string to apply.
constructor(repository, teamspace)
Constructs a tree model.
- Parameters:
- repository
- A ecm.model.Repository object
- teamspace
- An optional ecm.model.Teamspace object
destroy()
fetchItemByIdentity(keywordArgs)
Not implemented.
- Parameters:
- keywordArgs
getChildren(parentItem, onComplete)
Calls onComplete with an array of child items of the given parent item.
- Parameters:
- parentItem
- The parent of the child items to be loaded
- onComplete
- A function called with an array of child items of the parent item
getIdentity(something)
Returns the identity of an item.
- Parameters:
- something
- The item for which to get the identity
getLabel(item)
Returns the label for an item.
- Parameters:
- item
- The item for which to get the label
getRoot(onItem)
Calls onItem with the root node of this model.
- Parameters:
- onItem
isItem(something)
Returns true if "something" is an item in or belonging to this model.
- Parameters:
- something
- The object to be evaluated
loadMore()
Loads the next page of items.
mayHaveChildren(item)
Returns true if the item has or may have children.
- Parameters:
- item
- The item to be evaluated
newItem(args, parent, insertIndex)
Not implemented.
- Parameters:
- args
- parent
- insertIndex
onChange(item)
Called whenever an item has changed.
- Parameters:
- item
- The item that has changed
onChildrenChange(parent, newChildrenList)
Called whenever a parent item or its children have changed.
- Parameters:
- parent
- The parent item that has changed
- newChildrenList
- An array of newly loaded child items of the given parent item
onProcessingComplete(item)
This event is triggered when the model completes processing an item. It is intended to allow tree dijits to
remove display of progress indicators.
- Parameters:
- item
- The item that was being processed.
onProcessingStarted(item)
This event is triggered when the model begins processing an item. It is intended to allow tree dijits to
display a progress indicator next to the node for the item.
- Parameters:
- item
- The item that is being processed.
onRecentSearchesLoad(recentSearches)
Called whenever recent searches are loaded.
- Parameters:
- recentSearches
- An array of recent searches loaded
- Since:
- 2.0.2
pasteItem(childItem, oldParentItem, newParentItem, bCopy)
Not implemented.
- Parameters:
- childItem
- oldParentItem
- newParentItem
- bCopy
reload()
Reloads this model.
reloadNode(item)
Reloads the specified node.
- Parameters:
- item