Class ecm.widget.Tree

A custom version of dijit.Tree that is used within the IBM Content Navigator widgets.
Defined in: <ecm\widget\Tree.js>.

Constructor Summary

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

Field Summary

Field Attributes	Field Name and Description
	showMissingFolderMessage Boolean indicating if `true`, show a dialog with the error message when the folder is missing from the tree.
	singular This tree only supports single selection.

Method Summary

Method Attributes	Method Name and Description
	checkItemAcceptance2(target, source, position) Stub function to be overridden if one wants to check for the ability to drop at the node/item level.
	destroy() Cleans up the widget.
	getIconClass(item, opened) Returns the icon class for the item.
	isPathSelected(path) Returns a boolean indicating if the path is selected.
	itemCreator(nodes, target, source) Returns objects passed to `Tree.model.newItem() based on drag-and-drop (DnD) nodes dropped onto the tree.`
	onExternalDragEnter(evt) Event that is fired when a user drags an external document into the widget (i.e.
	onExternalDragExit(evt) Event that is fired when a user drags an external document out of the widget (i.e.
	onExternalDragOver(evt) Event that is fired when a user drags an external document over the widget.
	onExternalDrop(evt) Event that is fired when a user drops an external document on the widget.
	postCreate()
	postMixInProperties()

Constructor Detail

ecm.widget.Tree()

Field Detail

showMissingFolderMessage

Boolean indicating if true, show a dialog with the error message when the folder is missing from the tree.

singular

This tree only supports single selection.

Method Detail

checkItemAcceptance2(target, source, position)

Stub function to be overridden if one wants to check for the ability to drop at the node/item level. In the base case, this is called to check if the target can become a child of source. When

betweenThreshold
is set, position="before" or "after"

means that we are asking if the source node can be dropped before/after the target node.

Parameters:
target: DOMNode The dijitTreeRoot DOM node inside of the TreeNode that we are dropping on to.
source: dijit.tree.dndSource The (set of) nodes we are dropping.
position: String containing value of "over", "before", or "after".

destroy()

Cleans up the widget.

getIconClass(item, opened)

Returns the icon class for the item.

Parameters:
item: The item.
opened

{Boolean} isPathSelected(path)

Returns a boolean indicating if the path is selected.

Parameters:
path: The path.

Returns:: {Boolean} Indicates if the path is selected.

itemCreator(nodes, target, source)

Returns objects passed to

Tree.model.newItem() based on drag-and-drop (DnD) nodes dropped onto the
tree. Developer must override this method to enable dropping from external sources onto this Tree, unless the
Tree.model's items happen to look like {id: 123, name: "Apple" } with no other attributes.
For each node in nodes[], which came from source, create a hash of name/value pairs to be passed to
Tree.model.newItem(). Returns an array of those hashes.


					
					
					
					
						
							Parameters:

							
								
									nodes
									
								
								Array of the DOMNodes dragged from the source container.
							
								
									target
									
								
								The target TreeNode.rowNode.
							
								
									source
									
								
								The source container the nodes were dragged from, perhaps another Tree or the ContentList.
							
						
					
					
					
					
					
						
							Returns:
							
								Array of name/value hashes for each new item to be added to the Tree.
							
						
					
					
					

					
				
					 
					
					
						
						onExternalDragEnter(evt)
					
					
						Event that is fired when a user drags an external document into the widget (i.e., the document is entering
the widget).
						
						
					
					
					
					
					
						
							Parameters:

							
								
									evt
									
								
								The event.
							
						
					
					
					
					
					
					
					

					
				
					 
					
					
						
						onExternalDragExit(evt)
					
					
						Event that is fired when a user drags an external document out of the widget (i.e., the document is exiting
the widget).
						
						
					
					
					
					
					
						
							Parameters:

							
								
									evt
									
								
								The event.
							
						
					
					
					
					
					
					
					

					
				
					 
					
					
						
						onExternalDragOver(evt)
					
					
						Event that is fired when a user drags an external document over the widget.
						
						
					
					
					
					
					
						
							Parameters:

							
								
									evt
									
								
								The event.
							
						
					
					
					
					
					
					
					

					
				
					 
					
					
						
						onExternalDrop(evt)
					
					
						Event that is fired when a user drops an external document on the widget.
						
						
					
					
					
					
					
						
							Parameters:

							
								
									evt
									
								
								The event.
							
						
					
					
					
					
					
					
					

					
				
					 
					
					
						
						postCreate()
					
					
						
						
						
					
					
					
					
					
					
					
					
					
					
					

					
				
					 
					
					
						
						postMixInProperties()