Interface: treeNodeAdapter

Adds a new node as a child of the given parent node with the given label (optional) and at the given index.

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 (treeNodeAdapter#addNode will be called), "move" when the node comes from elsewhere in the tree and is being moved (treeNodeAdapter#moveNodes will be called), and "copy" when the node is a copy of a node from elsewhere in the tree (treeNodeAdapter#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.

Remove the view id mapping for node pNode. If the node is null then all previous view id mappings should be removed. See also treeNodeAdapter#setViewId.

Copies one or more nodes from elsewhere in the tree to be children of the given parent starting at the given index among the existing children of the 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.

Deletes the given node. When the node has been deleted the callback is called.

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 should be:
{ 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 treeNodeAdapter#childCount 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 an array of each of the expanded node's id. Can be used to persist the expansion state. See treeView#getExpandedNodeIds.

Returns map of node id to expansion state. See treeView#getExpandedState.

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 for node content rendering (if treeNodeAdapter#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 the window target to open the link in when the node is activated. This is an optional method. It is only needed for navigation trees and is only used when there is a link. If defined it is called during activation if treeView#navigation option is true.

Return the view id for the given pTreeId and pNode. This is used by the treeView to map from nodes to DOM elements. See also treeNodeAdapter#setViewId.

Returns true if the node has children, false if it does not and null if not yet known, which can happen for lazy loaded nodes.

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.

Return true if the given node is or should be expanded and false otherwise.

Returns the hidden state of a node. Returns true if the node should be hidden. This is an optional method. If not defined no nodes are ever hidden. The default adapter does not implement this method.

Moves one or more nodes from elsewhere in the tree to be children of the given parent starting at the given 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.

Rename the given node.

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.

Called when the expansion state of the tree node changes.

Set the view id for the given pTreeId and pNode. This is used by the treeView to map from nodes to DOM elements.

This is the specific object structure for nodes used by the default treeNodeAdapter returned by treeView.makeDefaultNodeAdapter. It is possible for nodes to have additional properties. For example the APEX Tree region adds a tooltip property

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.

The default treeNodeAdapter returned by treeView.makeDefaultNodeAdapter uses this type information to provide default settings and control over allowed edit operations for nodes based on their type.