Class ecm.widget.FavoritesTree
Extends
ecm.widget.Tree.
Provides a widget that contains a tree that is used to display the user’s favorites.
Defined in: <ecm\widget\FavoritesTree.js>.
Constructor Summary
Constructor Attributes | Constructor Name and Description |
---|---|
Field Summary
Field Attributes | Field Name and Description |
---|---|
The dnd controller to be used by dijit.Tree.
|
|
Enable drag and drop.
|
- Fields borrowed from class ecm.widget.Tree:
- showMissingFolderMessage, singular
Method Summary
Method Attributes | Method Name and Description |
---|---|
checkAcceptance(source, nodes)
Checks if the tree can accept nodes from this source.
|
|
checkItemAcceptance(target, source, position)
Checks if the tree can accept the item.
|
|
getActionsMenuType(item, loadBaseMenu)
Returns the action menu type for the specified item.
|
|
getIconClass(item, opened)
Returns the icon class for the specified item.
|
|
getNodesByItem(item)
Returns the nodes with the input item.
|
|
onContextMenuCreated(selectedItems, menu)
Event fired when the context menu is created.
|
|
onItemSelected(item, node)
Event fired indicating the item is selected.
|
|
onOpenItem(item, resultSet)
Event indicating item opened.
|
|
Event fired indicating paging complete.
|
|
Event fired indicating the paging start.
|
|
onRefresh(items)
Event fired when refresh.
|
|
- Methods borrowed from class ecm.widget.Tree:
- checkItemAcceptance2, destroy, isPathSelected, itemCreator, onExternalDragEnter, onExternalDragExit, onExternalDragOver, onExternalDrop, postMixInProperties
Field Detail
dndController
The dnd controller to be used by dijit.Tree.
enableDnd
Enable drag and drop.
Method Detail
{Boolean} checkAcceptance(source, nodes)
Checks if the tree can accept nodes from this source.
- Parameters:
- source
- {dijit.tree._dndSource} The source which provides items.
- nodes
- Array of DOM nodes corresponding to nodes being dropped, dijitTreeRow nodes if source is a dijit.Tree.
- Returns:
- {Boolean} true if the tree can accept nodes.
{Boolean} checkItemAcceptance(target, source, position)
Checks if the tree can accept the item.
- Parameters:
- target
- The target.
- source
- {dijit.tree._dndSource} The source which provides items.
- position
- Returns:
- {Boolean} true if the tree target can accept nodes.
getActionsMenuType(item, loadBaseMenu)
Returns the action menu type for the specified item.
- Parameters:
- item
- The item for which to get the action menu type.
- loadBaseMenu
- Boolean indicating whether to load just the base favorite actions. If false, item-specific context menus will be loaded.
- Returns:
- The context menu type string.
getIconClass(item, opened)
Returns the icon class for the specified item.
- Parameters:
- item
- The item in the tree.
- opened
- Boolean indicating if opened.
getNodesByItem(item)
Returns the nodes with the input item.
- Parameters:
- item
- The item.
- Returns:
- The array of tree nodes having the specified item.
onContextMenuCreated(selectedItems, menu)
Event fired when the context menu is created.
- Parameters:
- selectedItems
- The selected items.
- menu
- The menu.
onItemSelected(item, node)
Event fired indicating the item is selected.
- Parameters:
- item
- The item that is selected.
- node
- The node that is selected.
onOpenItem(item, resultSet)
Event indicating item opened.
- Parameters:
- item
- The item to open.
- resultSet
- A ecm.model.ResultSet object that contains the item's result set.
onPagingComplete()
Event fired indicating paging complete.
onPagingStart()
Event fired indicating the paging start.
onRefresh(items)
Event fired when refresh.
- Parameters:
- items
- The items.