Interface: treeNodeAdapter

// Add a node as a child of the parent node with the // given label (optional) and at the given index. // context is arbitrary additional information that can be used in creating the new node // In the callback function child is the node that was added. If child is false try again. // If child is null then add failed - node is removed. // Index is the position the node was actually inserted at.

Check if the node allows adding children to it. Returns true if the node allows children to be added to it. If the children parameter is passed in return true if each of those children (or ones just like them) can be added. Children is an array of nodes. operation is "add" when adding a new node (addNode will be called), "move" when the node comes from elsewhere in the tree and is being moved (moveNodes will be called), and "copy" when the node is a copy of a node from elsewhere in the tree (copyNodes will be called). additional operation values are possible if the adapter supports custom drag operations.

Return true if the given node can be deleted.

Return true if the given node can be dragged.

Return true if the given node can be renamed.

Return the i^th child of the given node.

Returns the number of children that the given node has or null if the answer is not yet known, which can happen for lazy loaded nodes.

copyNodes: function(parent, index, children, function(places)), // copies one or more nodes from elsewhere in the // tree to be children of parent starting at index among the existing children of parent. A copy of each node // and all its descendants is made. The copies are the same except for identity and parentage. // When the nodes have been copied the callback function is called with a places array of indexes where the // children nodes ended up. If the tree nodes are sorted then even though they were copied starting at the // given index they could end up at any position. If the tree nodes are not sorted then places will consist // of integers index ... index + n - 1 where n is the number of children. If the move fails return false // for places. If some of the nodes can't be moved return -1 for its index in places.

deleteNode: function(n, function(status), more), // Called in response to DEL key. Delete node n then call fn with true to delete // the tree node or false to cancel the delete. // If more is true another deleteNode call will be made right away. The more argument can be ignored or can // be used to batch up requests to the server. In either case each call back must be made.

Determine which operations are allowed while dragging the given array of nodes. Return an object with allowed drag operations. The properties are: "normal", "ctrl", "alt", "shift", "meta". The standard values are "move", "copy" or "add". Other values are allowed. The normal property is required. The default is: { normal: "move", ctrl: "copy" } or if nodes is null { normal: "add" }

Fetch child nodes for the given node from a server (or by any other asynchronous means). This method is optional. This is used for asynchronous/lazy tree construction. The root and first level of nodes should not be lazy loaded. May be called after child count returns null.

Returns one or more CSS classes to add to the node content container or null if none. Multiple classes are separated by a space. This is an optional method. If the method doesn't exist then no nodes will have classes added to the node content container.

Returns the icon of the node or null if none. The icon is a CSS class name. The icon is used by node content rendering. This is an optional method. If the method doesn't exist then no nodes will have icons.

Returns the label of the given node. The label is used by node content rendering (if renderNodeContent not implemented) and for editing during rename.

Returns the URL to navigate to when the node is activated. This is an optional method. It is only needed for navigation trees. If defined it is called during activation if treeView.navigation option is true.

Returns true if the node has children, false if it does not and null if not yet known.

Returns the disabled state of a node. A disabled node cannot be selected or activated but it can be focused. This is an optional method. If not defined no nodes are ever disabled.

moveNodes: function(parent, index, children, function(places)), // moves one or more nodes from elsewhere in the // tree to be children of parent starting at index among the existing children of parent. The move includes // all the descendants of the moved nodes. Only the parents and/or positions of the moved nodes should change. // When the nodes have been moved the callback function is called with a places array of indexes where the // children nodes ended up. If the tree nodes are sorted then even though they were moved starting at the // given index they could end up at any position. If the tree nodes are not sorted then places will consist // of integers index ... index + n - 1 where n is the number of children. If the move fails return false // for places. If some of the nodes can't be moved return -1 for its index in places. *

Rename a node. n is the node to rename with newLabel. // In the callback node is the renamed node (most likely the same) // If node is false try again. // If node is null then rename failed return to previous value. // Index is the new position the node is in after rename.

This is an optional function used to render the node content. It is used for advanced cases where more control over the node markup is needed.

The content must include an element with tabindex='-1' and that element must have a class that matches the treeView.labelClass option. The custom rendering is responsible for setting the aria-level, aria-disabled, aria-selected, and aria-expanded attributes for proper accessibility.

The options and state arguments provide additional information to determine how to render the node.

Returns the root node of the tree. All trees must have a single root node even if it is not shown/used.

This is the specific object structure for nodes used by the defaultNodeAdapter returned by treeView.makeDefaultNodeAdapter.

An object that represents a node in a tree data structure. There are no requirements for and no assumptions are made about the specific properties of the object as all access to the node is through the treeNodeAdapter interface.

xxx