Tree (Smart GWT LGPL Edition API 5.1p (2022-05-28))

java.lang.Object
- com.smartgwt.client.core.BaseClass
- - com.smartgwt.client.data.RecordList
  - - com.smartgwt.client.widgets.tree.Tree

All Implemented Interfaces:

com.google.gwt.event.shared.HasHandlers, HasDataChangedHandlers

Direct Known Subclasses:

ResultTree
```
public class Tree
extends RecordList
implements HasDataChangedHandlers
```
A Tree is a data model representing a set of objects linked into a hierarchy.
A Tree has no visual presentation, it is displayed by a TreeGrid or ColumnTree when supplied as TreeGrid.data or ColumnTree.data.
A Tree can be constructed out of a List of objects interlinked by IDs or via explicitly specified Arrays of child objects. See modelType for an explanation of how to pass data to a Tree.
Typical usage is to call TreeGrid.fetchData() to cause automatic creation of a ResultTree, which is a type of Tree that automatically handles loading data on demand. For information on DataBinding Trees, see TreeDataBinding.

Nested Class Summary
- Nested classes/interfaces inherited from class com.smartgwt.client.data.RecordList
  RecordList.SortNormalizer

Field Summary
- Fields inherited from class com.smartgwt.client.data.RecordList
  jsObj
- Fields inherited from class com.smartgwt.client.core.BaseClass
  config, configOnly, factoryCreated, factoryProperties, id, scClassName

Constructor Summary

Constructors
Constructor and Description

Tree()

Tree(com.google.gwt.core.client.JavaScriptObject jsObj)

Constructors
Constructor and Description
`Tree()`
`Tree(com.google.gwt.core.client.JavaScriptObject jsObj)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`TreeNode`	`add(TreeNode node, java.lang.String parentPath)` Add a single node under the specified parent
`TreeNode`	`add(TreeNode node, java.lang.String parentPath, int position)`
`TreeNode`	`add(TreeNode node, TreeNode parent)` Add a single node under the specified parent
`TreeNode`	`add(TreeNode node, TreeNode parent, int position)` Add a single node under the specified parent
`com.google.gwt.event.shared.HandlerRegistration`	`addDataChangedHandler(DataChangedHandler handler)` Add a dataChanged handler.
`TreeNode[]`	`addList(TreeNode[] nodeList, java.lang.String parentPath)` Add a list of nodes to some parent.
`TreeNode[]`	`addList(TreeNode[] nodeList, java.lang.String parentPath, int position)` Add a list of nodes to some parent.
`TreeNode[]`	`addList(TreeNode[] nodeList, TreeNode parent)` Add a list of nodes to some parent.
`TreeNode[]`	`addList(TreeNode[] nodeList, TreeNode parent, int position)` Add a list of nodes to some parent.
`java.lang.Boolean`	`allChildrenLoaded(TreeNode node)` For a databound tree, do the children of this folder form a ResultSet with a full cache.
`void`	`closeAll()` Close all nodes under a particular node
`void`	`closeAll(TreeNode node)` Close all nodes under a particular node
`void`	`closeFolder(TreeNode node)` Closes a folder
`void`	`closeFolders(TreeNode[] nodeList)` Close a set of folders, specified by path or as pointers to nodes.
`com.google.gwt.core.client.JavaScriptObject`	`create()`
`TreeNode`	`find(java.lang.String fieldNameOrPath)` Find a node within this tree using a string path or by attribute value(s).
`TreeNode`	`find(java.lang.String propertyName, java.util.Date value)` Find a node within this tree using a string path or by attribute value(s).
`TreeNode`	`find(java.lang.String fieldNameOrPath, java.lang.Object value)` Find a node within this tree using a string path or by attribute value(s).
`TreeNode`	`findById(java.lang.String id)` Find the node with the specified ID.
`TreeNode[]`	`getAllNodes()` Get all the nodes that exist in the tree under a particular node, as a flat list, in depth-first traversal order.
`TreeNode[]`	`getAllNodes(TreeNode node)` Get all the nodes that exist in the tree under a particular node, as a flat list, in depth-first traversal order.
`java.lang.Boolean`	`getAutoOpenRoot()` If true, the root node is automatically opened when the tree is created or `setRoot()` is called.
`TreeNode[]`	`getChildren(TreeNode node)` Returns all children of a node.
`java.lang.String`	`getChildrenProperty()` For trees with the modelType "children", this property specifies the name of the property that contains the list of children for a node.
`ResultSet`	`getChildrenResultSet(TreeNode node)` Returns a ResultSet that provides access to any partially-loaded children of a node.
`ListGridRecord[]`	`getData()`
`DataSource`	`getDataSource()` Specifies what `DataSource` this tree is associated with.
`java.lang.String`	`getDataSourceAsString()` Specifies what `DataSource` this tree is associated with.
`java.lang.Boolean`	`getDefaultIsFolder()` Controls whether nodes are assumed to be folders or leaves by default.
`java.lang.String`	`getDefaultNodeTitle()` Title assigned to nodes without a `titleProperty` value or a `nameProperty` value.
`TreeNode[]`	`getDescendantFolders()` Ruturns the list of all descendants of a node that are folders.
`TreeNode[]`	`getDescendantFolders(TreeNode node)` Ruturns the list of all descendants of a node that are folders.
`TreeNode[]`	`getDescendantLeaves()` Returns the list of all descendants of a node that are leaves.
`TreeNode[]`	`getDescendantLeaves(TreeNode node)` Returns the list of all descendants of a node that are leaves.
`TreeNode[]`	`getDescendants()` Returns the list of all descendants of a node.
`TreeNode[]`	`getDescendants(TreeNode node)` Returns the list of all descendants of a node.
`java.lang.Boolean`	`getDiscardParentlessNodes()` If this tree has `modelType:"parent"`, should nodes in the data array for the tree be dropped if they have an explicitly specified value for the `parentIdField` which doesn't match any other nodes in the tree.
`Tree`	`getFilteredTree(Criteria criteria)` Filters this tree by the provided criteria, returning a new Tree containing just the nodes that match the criteria.
`Tree`	`getFilteredTree(Criteria criteria, TreeFilterMode filterMode, DataSource dataSource)` Filters this tree by the provided criteria, returning a new Tree containing just the nodes that match the criteria.
`TreeNode[]`	`getFolders(TreeNode node)` Returns all the first-level folders of a node.
`java.lang.String`	`getIdField()` Name of the property on a `TreeNode` that holds an id for the node which is unique across the entire Tree.
`java.lang.String`	`getIsFolderProperty()` Name of property that defines whether a node is a folder.
`TreeNode[]`	`getLeaves(TreeNode node)` Return all the first-level leaves of a node.
`int`	`getLength()` Returns the number of items in the current open list.
`int`	`getLevel(TreeNode node)` Return the number of levels deep this node is in the tree.
`LoadState`	`getLoadState(TreeNode node)` What is the loadState of a given folder?
`TreeModelType`	`getModelType()` Selects the model used to construct the tree representation.
`java.lang.String`	`getName(TreeNode node)` Get the 'name' of a node.
`java.lang.String`	`getNameProperty()` Name of the property on a `TreeNode` that holds a name for the node that is unique among its immediate siblings, thus allowing a unique path to be used to identify the node, similar to a file system.
`TreeNode[]`	`getOpenList(TreeNode node)` Return a flattened list of nodes that are open under some parent, including the parent itself.
`java.lang.String`	`getOpenProperty()` The property consulted by the default implementation of `isOpen()` to determine if the node is open or not.
`static Tree`	`getOrCreateRef(com.google.gwt.core.client.JavaScriptObject jsObj)`
`TreeNode`	`getParent(TreeNode node)` Returns the parent of this node.
`java.lang.String`	`getParentIdField()` For trees with modelType "parent", this property specifies the name of the property that contains the unique parent ID of a node.
`java.lang.String`	`getParentPath(TreeNode node)` Given a node, return the path to its parent.
`TreeNode[]`	`getParents(TreeNode node)` Given a node, return an array of the node's parents with the immediate parent first.
`java.lang.String`	`getPath(TreeNode node)` Returns the path of a node - a path has the following format: `([name][pathDelim]?)*` For example, in this tree:
`java.lang.String`	`getPathDelim()` Specifies the delimiter between node names.
`java.lang.Boolean`	`getReportCollisions()` If new nodes are added to a tree with modelType:"parent" which have the same `id field value` as existing nodes, the existing nodes are removed when the new nodes are added.
`TreeNode`	`getRoot()` If you're using the "parent" modelType, you can provide the root node configuration via this property.
`java.lang.String`	`getRootValue()`
`java.lang.Boolean`	`getSeparateFolders()` Should folders be sorted separately from leaves or should nodes be ordered according to their sort field value regardless of whether the node is a leaf or folder?
`java.lang.Boolean`	`getShowRoot()` Controls whether the implicit root node is returned as part of the visible tree, specifically, whether it is returned in `getOpenList()`, which is the API view components typically use to get the list of visible nodes.
`java.lang.Boolean`	`getSortFoldersBeforeLeaves()` If `separateFolders` is true, should folders be displayed above or below leaves? When set to `true` folders will appear above leaves when the `sortDirection` applied to the tree is `"ascending"`
`java.lang.String`	`getTitle(TreeNode node)` Return the title of a node -- the name as it should be presented to the user.
`java.lang.String`	`getTitleProperty()` Name of the property on a `TreeNode` that holds the title of the node as it should be shown to the user.
`java.lang.Boolean`	`hasChildren(TreeNode node)` Returns true if this node has any children.
`java.lang.Boolean`	`hasFolders(TreeNode node)` Return true if this this node has any children that are folders.
`java.lang.Boolean`	`hasLeaves(TreeNode node)` Return whether this node has any children that are leaves.
`java.lang.Boolean`	`isDescendantOf(TreeNode child, TreeNode parent)` Is one node a descendant of the other?
`java.lang.Boolean`	`isFolder(TreeNode node)` Determines whether a particular node is a folder.
`java.lang.Boolean`	`isLeaf(TreeNode node)` Returns true if the passed in node is a leaf.
`java.lang.Boolean`	`isLoaded(TreeNode node)` For a databound tree, has this folder either already loaded its children or is it in the process of loading them.
`java.lang.Boolean`	`isOpen(TreeNode node)` Whether a particular node is open or closed (works for leaves and folders).
`java.lang.Boolean`	`isRoot(TreeNode node)` Return true if the passed node is the root node.
`void`	`linkNodes(TreeNode[] nodes)` This method is provided as a mechanism to link new nodes into the tree of modelType "parent".
`void`	`loadChildren(TreeNode node)` Load the children of a given node.
`void`	`loadChildren(TreeNode node, DSCallback callback)` Load the children of a given node.
`void`	`move(TreeNode node, TreeNode newParent)` Moves the specified node to a new parent.
`void`	`move(TreeNode node, TreeNode newParent, java.lang.Integer position)` Moves the specified node to a new parent.
`static TreeNode`	`nodeForRecord(ListGridRecord record)` A TreeNode and ListGridRecord represent similar datastructures and it is possible that certain TreeGrid operations return a ListGridRecord since TreeGrid extends ListGrid.
`void`	`openAll()` Open all nodes under a particular node.
`void`	`openAll(TreeNode node)` Open all nodes under a particular node.
`void`	`openFolder(TreeNode node)` Open a particular node
`void`	`openFolders(TreeNode[] nodeList)` Open a set of folders, specified by path or as pointers to nodes.
`void`	`reloadChildren(TreeNode node)` Reload the children of a folder.
`java.lang.Boolean`	`remove(TreeNode node)` Removes a node, along with all its children.
`void`	`removeChildren(TreeNode node)` Removes all children of the node and sets it to a loaded state.
`java.lang.Boolean`	`removeList(TreeNode[] nodeList)` Remove a list of nodes (not necessarily from the same parent), and all children of those nodes.
`void`	`setAutoOpenRoot(java.lang.Boolean autoOpenRoot)` If true, the root node is automatically opened when the tree is created or `setRoot()` is called.
`void`	`setChildren(TreeNode parent, java.util.List newChildren)` Replaces the existing children of a parent node, leaving the node in the loaded state.
`void`	`setChildrenProperty(java.lang.String childrenProperty)` For trees with the modelType "children", this property specifies the name of the property that contains the list of children for a node.
`void`	`setData(TreeNode[] nodes)` Optional initial data for the tree.
`void`	`setDataSource(DataSource dataSource)` Specifies what `DataSource` this tree is associated with.
`void`	`setDataSource(java.lang.String dataSource)` Specifies what `DataSource` this tree is associated with.
`void`	`setDefaultIsFolder(java.lang.Boolean defaultIsFolder)` Controls whether nodes are assumed to be folders or leaves by default.
`void`	`setDefaultNodeTitle(java.lang.String defaultNodeTitle)` Title assigned to nodes without a `titleProperty` value or a `nameProperty` value.
`void`	`setDiscardParentlessNodes(java.lang.Boolean discardParentlessNodes)` If this tree has `modelType:"parent"`, should nodes in the data array for the tree be dropped if they have an explicitly specified value for the `parentIdField` which doesn't match any other nodes in the tree.
`void`	`setIdField(java.lang.String idField)` Name of the property on a `TreeNode` that holds an id for the node which is unique across the entire Tree.
`void`	`setIsFolderProperty(java.lang.String isFolderProperty)` Name of property that defines whether a node is a folder.
`void`	`setJavaScriptObject(com.google.gwt.core.client.JavaScriptObject jsObj)`
`void`	`setModelType(TreeModelType modelType)` Selects the model used to construct the tree representation.
`void`	`setNameProperty(java.lang.String nameProperty)` Name of the property on a `TreeNode` that holds a name for the node that is unique among its immediate siblings, thus allowing a unique path to be used to identify the node, similar to a file system.
`void`	`setOpenProperty(java.lang.String openProperty)` The property consulted by the default implementation of `isOpen()` to determine if the node is open or not.
`void`	`setParentIdField(java.lang.String parentIdField)` For trees with modelType "parent", this property specifies the name of the property that contains the unique parent ID of a node.
`void`	`setPathDelim(java.lang.String pathDelim)` Specifies the delimiter between node names.
`void`	`setProperty(java.lang.String property, boolean value)`
`void`	`setProperty(java.lang.String property, double value)`
`void`	`setProperty(java.lang.String property, com.google.gwt.core.client.JavaScriptObject value)`
`void`	`setProperty(java.lang.String property, java.lang.String value)`
`void`	`setReportCollisions(java.lang.Boolean reportCollisions)` If new nodes are added to a tree with modelType:"parent" which have the same `id field value` as existing nodes, the existing nodes are removed when the new nodes are added.
`void`	`setRoot(TreeNode root)` If you're using the "parent" modelType, you can provide the root node configuration via this property.
`void`	`setRootValue(int rootValue)` If you are using the "parent" modelType and did not specify a root node via `root` with an id (`idField`), then you can provide the root node's id via this property.
`void`	`setRootValue(java.lang.String rootValue)` If you are using the "parent" modelType and did not specify a root node via `root` with an id (`idField`), then you can provide the root node's id via this property.
`void`	`setSeparateFolders(java.lang.Boolean separateFolders)` Should folders be sorted separately from leaves or should nodes be ordered according to their sort field value regardless of whether the node is a leaf or folder? If this method is called after the component has been drawn/initialized: Setter for `separateFolders`.
`void`	`setShowRoot(java.lang.Boolean showRoot)` Controls whether the implicit root node is returned as part of the visible tree, specifically, whether it is returned in `getOpenList()`, which is the API view components typically use to get the list of visible nodes.
`void`	`setSortFoldersBeforeLeaves(java.lang.Boolean sortFoldersBeforeLeaves)` If `separateFolders` is true, should folders be displayed above or below leaves? When set to `true` folders will appear above leaves when the `sortDirection` applied to the tree is `"ascending"` If this method is called after the component has been drawn/initialized: Setter for `sortFoldersBeforeLeaves`.
`void`	`setTitleProperty(java.lang.String titleProperty)` Name of the property on a `TreeNode` that holds the title of the node as it should be shown to the user.
`void`	`unloadChildren(TreeNode node)` Deprecated. It's recommended that you instead use `reloadChildren()` to reload the children of a folder, or `removeChildren()` if you need to clear the cached children of a folder to add specific local data.

Methods inherited from class com.smartgwt.client.data.RecordList
add, addAt, addDataChangedHandler, addList, addList, addListAt, contains, contains, containsAll, duplicate, equals, find, find, find, findAll, findAll, findAll, findAll, findAll, findAll, findAll, findAll, findIndex, findIndex, findIndex, findIndex, findIndex, findIndex, findIndex, findIndex, findNextIndex, findNextIndex, findNextIndex, findNextIndex, findNextIndex, findNextIndex, findNextIndex, findNextIndex, findNextIndex, findNextIndex, first, get, getItems, getJsObj, getOrCreateJsObj, getProperty, getRange, getRangeList, getValueMap, indexOf, indexOf, intersect, isARecordList, isCreated, isEmpty, last, lastIndexOf, lastIndexOf, remove, removeAt, removeList, set, setLength, setSort, sort, sort, sortByProperty, sortByProperty, toArray

Methods inherited from class com.smartgwt.client.core.BaseClass
applyFactoryProperties, asSGWTComponent, createJsObj, destroy, doAddHandler, doInit, error, error, errorIfNotCreated, fireEvent, getAttribute, getAttributeAsBoolean, getAttributeAsDate, getAttributeAsDouble, getAttributeAsElement, getAttributeAsFloat, getAttributeAsInt, getAttributeAsJavaScriptObject, getAttributeAsMap, getAttributeAsString, getAttributeAsStringArray, getClassName, getConfig, getHandlerCount, getID, getRef, getScClassName, getTestInstance, hasAutoAssignedID, internalSetID, internalSetID, isConfigOnly, isFactoryCreated, onBind, onInit, registerID, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setConfig, setConfigOnly, setFactoryCreated, setID, setScClassName

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.google.gwt.event.shared.HasHandlers
fireEvent

- Constructor Detail
  - Tree
```
public Tree()
```
  - Tree
```
public Tree(com.google.gwt.core.client.JavaScriptObject jsObj)
```
- Method Detail
  - getOrCreateRef
```
public static Tree getOrCreateRef(com.google.gwt.core.client.JavaScriptObject jsObj)
```
  - setJavaScriptObject
```
public void setJavaScriptObject(com.google.gwt.core.client.JavaScriptObject jsObj)
```
    Overrides:
    
    setJavaScriptObject in class BaseClass
  - create
```
public com.google.gwt.core.client.JavaScriptObject create()
```
    Overrides:
    
    create in class RecordList
  - setAutoOpenRoot
```
public void setAutoOpenRoot(java.lang.Boolean autoOpenRoot)
```
    If true, the root node is automatically opened when the tree is created or setRoot() is called.
    
    Parameters:
    
    autoOpenRoot - Default value is true
  - getAutoOpenRoot
```
public java.lang.Boolean getAutoOpenRoot()
```
    If true, the root node is automatically opened when the tree is created or setRoot() is called.
    
    Returns:
    
    Boolean
  - setChildrenProperty
```
public void setChildrenProperty(java.lang.String childrenProperty)
```
    For trees with the modelType "children", this property specifies the name of the property that contains the list of children for a node.
    
    Parameters:
    
    childrenProperty - Default value is "children"
    
    See Also:
    
    setModelType(com.smartgwt.client.types.TreeModelType), Children Arrays Example
  - getChildrenProperty
```
public java.lang.String getChildrenProperty()
```
    For trees with the modelType "children", this property specifies the name of the property that contains the list of children for a node.
    
    Returns:
    
    String
    
    See Also:
    
    getModelType(), Children Arrays Example
  - setDataSource
```
public void setDataSource(DataSource dataSource)
                   throws java.lang.IllegalStateException
```
    Specifies what DataSource this tree is associated with.
    A DataSource is required when filtering a tree, even if it isn't a ResultTree, though it may be passed to getFilteredTree() rather than set on the tree itself. If a DataSource is specified it will also affect sorting, where relevant, such as if the tree is set as TreeGrid.data.
    
    Parameters:
    
    dataSource - Default value is null
    
    Throws:
    
    java.lang.IllegalStateException - this property cannot be changed after the underlying component has been created
  - getDataSource
```
public DataSource getDataSource()
```
    Specifies what DataSource this tree is associated with.
    A DataSource is required when filtering a tree, even if it isn't a ResultTree, though it may be passed to getFilteredTree() rather than set on the tree itself. If a DataSource is specified it will also affect sorting, where relevant, such as if the tree is set as TreeGrid.data.
    
    Returns:
    
    DataSource
  - setDataSource
```
public void setDataSource(java.lang.String dataSource)
                   throws java.lang.IllegalStateException
```
    Specifies what DataSource this tree is associated with.
    A DataSource is required when filtering a tree, even if it isn't a ResultTree, though it may be passed to getFilteredTree() rather than set on the tree itself. If a DataSource is specified it will also affect sorting, where relevant, such as if the tree is set as TreeGrid.data.
    
    Parameters:
    
    dataSource - Default value is null
    
    Throws:
    
    java.lang.IllegalStateException - this property cannot be changed after the underlying component has been created
  - getDataSourceAsString
```
public java.lang.String getDataSourceAsString()
```
    Specifies what DataSource this tree is associated with.
    A DataSource is required when filtering a tree, even if it isn't a ResultTree, though it may be passed to getFilteredTree() rather than set on the tree itself. If a DataSource is specified it will also affect sorting, where relevant, such as if the tree is set as TreeGrid.data.
    
    Returns:
    
    String
  - setDefaultIsFolder
```
public void setDefaultIsFolder(java.lang.Boolean defaultIsFolder)
                        throws java.lang.IllegalStateException
```
    Controls whether nodes are assumed to be folders or leaves by default.
    Nodes that have children or have the isFolderProperty set to true will be considered folders by default. Other nodes will be considered folders or leaves by default according to this setting.
    See also ResultTree.defaultIsFolder for more details on how defaultIsFolder interacts with loading data on demand.
    
    Parameters:
    
    defaultIsFolder - Default value is null
    
    Throws:
    
    java.lang.IllegalStateException - this property cannot be changed after the underlying component has been created
  - getDefaultIsFolder
```
public java.lang.Boolean getDefaultIsFolder()
```
    Controls whether nodes are assumed to be folders or leaves by default.
    Nodes that have children or have the isFolderProperty set to true will be considered folders by default. Other nodes will be considered folders or leaves by default according to this setting.
    See also ResultTree.defaultIsFolder for more details on how defaultIsFolder interacts with loading data on demand.
    
    Returns:
    
    Boolean
  - setDefaultNodeTitle
```
public void setDefaultNodeTitle(java.lang.String defaultNodeTitle)
```
    Title assigned to nodes without a titleProperty value or a nameProperty value.
    
    Parameters:
    
    defaultNodeTitle - Default value is "Untitled"
  - getDefaultNodeTitle
```
public java.lang.String getDefaultNodeTitle()
```
    Title assigned to nodes without a titleProperty value or a nameProperty value.
    
    Returns:
    
    String
  - setDiscardParentlessNodes
```
public void setDiscardParentlessNodes(java.lang.Boolean discardParentlessNodes)
                               throws java.lang.IllegalStateException
```
    If this tree has modelType:"parent", should nodes in the data array for the tree be dropped if they have an explicitly specified value for the parentIdField which doesn't match any other nodes in the tree. If set to false these nodes will be added as children of the root node.
    Note : This is an advanced setting
    
    Parameters:
    
    discardParentlessNodes - Default value is false
    
    Throws:
    
    java.lang.IllegalStateException - this property cannot be changed after the underlying component has been created
  - getDiscardParentlessNodes
```
public java.lang.Boolean getDiscardParentlessNodes()
```
    If this tree has modelType:"parent", should nodes in the data array for the tree be dropped if they have an explicitly specified value for the parentIdField which doesn't match any other nodes in the tree. If set to false these nodes will be added as children of the root node.
    
    Returns:
    
    Boolean
  - setIdField
```
public void setIdField(java.lang.String idField)
                throws java.lang.IllegalStateException
```
    Name of the property on a TreeNode that holds an id for the node which is unique across the entire Tree. Required for all nodes for trees with modelType "parent". Default value is "id". See TreeNode.id for usage.
    Note : This is an advanced setting
    
    Parameters:
    
    idField - Default value is "id"
    
    Throws:
    
    java.lang.IllegalStateException - this property cannot be changed after the underlying component has been created
    
    See Also:
    
    com.smartgwt.client.widgets.tree.TreeNode#setId, Node Titles Example
  - getIdField
```
public java.lang.String getIdField()
```
    Name of the property on a TreeNode that holds an id for the node which is unique across the entire Tree. Required for all nodes for trees with modelType "parent". Default value is "id". See TreeNode.id for usage.
    
    Returns:
    
    String
    
    See Also:
    
    com.smartgwt.client.widgets.tree.TreeNode#getId, Node Titles Example
  - setIsFolderProperty
```
public void setIsFolderProperty(java.lang.String isFolderProperty)
```
    Name of property that defines whether a node is a folder. By default this is set to TreeNode.isFolder.
    
    Parameters:
    
    isFolderProperty - Default value is "isFolder"
    
    See Also:
    
    TreeNode.setIsFolder(boolean)
  - getIsFolderProperty
```
public java.lang.String getIsFolderProperty()
```
    Name of property that defines whether a node is a folder. By default this is set to TreeNode.isFolder.
    
    Returns:
    
    String
    
    See Also:
    
    com.smartgwt.client.widgets.tree.TreeNode#getIsFolder
  - setModelType
```
public void setModelType(TreeModelType modelType)
```
    Selects the model used to construct the tree representation. See TreeModelType for the available options and their implications.
    If the "parent" modelType is used, you can provide the initial parent-linked data set to the tree via the data attribute. If the "children" modelType is used, you can provide the initial tree structure to the Tree via the root attribute.
    Note : This is an advanced setting
    
    Parameters:
    
    modelType - Default value is "children"
    
    See Also:
    
    setData(com.smartgwt.client.widgets.tree.TreeNode[]), setRoot(com.smartgwt.client.widgets.tree.TreeNode), Node Titles Example
  - getModelType
```
public TreeModelType getModelType()
```
    Selects the model used to construct the tree representation. See TreeModelType for the available options and their implications.
    If the "parent" modelType is used, you can provide the initial parent-linked data set to the tree via the data attribute. If the "children" modelType is used, you can provide the initial tree structure to the Tree via the root attribute.
    
    Returns:
    
    TreeModelType
    
    See Also:
    
    getData(), getRoot(), Node Titles Example
  - setNameProperty
```
public void setNameProperty(java.lang.String nameProperty)
```
    Name of the property on a TreeNode that holds a name for the node that is unique among its immediate siblings, thus allowing a unique path to be used to identify the node, similar to a file system. Default value is "name". See TreeNode.name for usage.
    
    Parameters:
    
    nameProperty - Default value is "name"
    
    See Also:
    
    TreeNode.setName(java.lang.String), Node Titles Example
  - getNameProperty
```
public java.lang.String getNameProperty()
```
    Name of the property on a TreeNode that holds a name for the node that is unique among its immediate siblings, thus allowing a unique path to be used to identify the node, similar to a file system. Default value is "name". See TreeNode.name for usage.
    
    Returns:
    
    String
    
    See Also:
    
    TreeNode.getName(), Node Titles Example
  - setOpenProperty
```
public void setOpenProperty(java.lang.String openProperty)
```
    The property consulted by the default implementation of isOpen() to determine if the node is open or not. By default, this property is auto-generated for you, but you can set it to a custom value if you want to declaratively specify this state, but be careful - if you display this Tree in multiple TreeGrids at the same time, the open state will not be tracked independently - see SharingNodes for more info on this.
    Note : This is an advanced setting
    
    Parameters:
    
    openProperty - Default value is null
    
    See Also:
    
    Initial Data & Load on Demand Example
  - getOpenProperty
```
public java.lang.String getOpenProperty()
```
    The property consulted by the default implementation of isOpen() to determine if the node is open or not. By default, this property is auto-generated for you, but you can set it to a custom value if you want to declaratively specify this state, but be careful - if you display this Tree in multiple TreeGrids at the same time, the open state will not be tracked independently - see SharingNodes for more info on this.
    
    Returns:
    
    String
    
    See Also:
    
    Initial Data & Load on Demand Example
  - setParentIdField
```
public void setParentIdField(java.lang.String parentIdField)
                      throws java.lang.IllegalStateException
```
    For trees with modelType "parent", this property specifies the name of the property that contains the unique parent ID of a node. Default value is "parentId". See TreeNode.parentId for usage.
    Note : This is an advanced setting
    
    Parameters:
    
    parentIdField - Default value is "parentId"
    
    Throws:
    
    java.lang.IllegalStateException - this property cannot be changed after the underlying component has been created
    
    See Also:
    
    com.smartgwt.client.widgets.tree.TreeNode#setParentId, Node Titles Example
  - getParentIdField
```
public java.lang.String getParentIdField()
```
    For trees with modelType "parent", this property specifies the name of the property that contains the unique parent ID of a node. Default value is "parentId". See TreeNode.parentId for usage.
    
    Returns:
    
    String
    
    See Also:
    
    com.smartgwt.client.widgets.tree.TreeNode#getParentId, Node Titles Example
  - setPathDelim
```
public void setPathDelim(java.lang.String pathDelim)
```
    Specifies the delimiter between node names. The pathDelim is used to construct a unique path to each node. A path can be obtained for any node by calling getPath() and can be used to find any node in the tree by calling find(). Note that you can also hand-construct a path - in other words you are not required to call getPath() in order to later use find() to retrieve it.
    
    The pathDelim can be any character or sequence of characters, but must be a unique string with respect to the text that can appear in the nameProperty that's used for naming the nodes. So for example, if you have the following tree:
```
  one
    two
      three/four
  
```
    Then you will be unable to find the three/four node using find() if your tree is using the default pathDelim of /. In such a case, you can use a different pathDelim for the tree. For example if you used | for the path delim, then you can find the three/four node in the tree above by calling tree.find("one|two|three/four").
    
    The pathDelim is used only by getPath() and find() and does not affect any aspect of the tree structure or other forms of tree navigation (such as via getChildren()).
    Note : This is an advanced setting
    Parameters:
    
    pathDelim - Default value is "/"
    
    See Also:
    
    setNameProperty(java.lang.String), find(java.lang.String)
  - getPathDelim
```
public java.lang.String getPathDelim()
```
    Specifies the delimiter between node names. The pathDelim is used to construct a unique path to each node. A path can be obtained for any node by calling getPath() and can be used to find any node in the tree by calling find(). Note that you can also hand-construct a path - in other words you are not required to call getPath() in order to later use find() to retrieve it.
    
    The pathDelim can be any character or sequence of characters, but must be a unique string with respect to the text that can appear in the nameProperty that's used for naming the nodes. So for example, if you have the following tree:
```
  one
    two
      three/four
  
```
    Then you will be unable to find the three/four node using find() if your tree is using the default pathDelim of /. In such a case, you can use a different pathDelim for the tree. For example if you used | for the path delim, then you can find the three/four node in the tree above by calling tree.find("one|two|three/four").
    
    The pathDelim is used only by getPath() and find() and does not affect any aspect of the tree structure or other forms of tree navigation (such as via getChildren()).
    Returns:
    
    String
    
    See Also:
    
    getNameProperty(), find(java.lang.String)
  - setReportCollisions
```
public void setReportCollisions(java.lang.Boolean reportCollisions)
                         throws java.lang.IllegalStateException
```
    If new nodes are added to a tree with modelType:"parent" which have the same id field value as existing nodes, the existing nodes are removed when the new nodes are added.
    If reportCollisions is true, the Tree will log a warning in the developer console about this.
    Note that if an id collision occurs between a new node and its ancestor, the ancestor will be removed and the new node will not be added to the tree.
    
    Parameters:
    
    reportCollisions - Default value is true
    
    Throws:
    
    java.lang.IllegalStateException - this property cannot be changed after the underlying component has been created
  - getReportCollisions
```
public java.lang.Boolean getReportCollisions()
```
    If new nodes are added to a tree with modelType:"parent" which have the same id field value as existing nodes, the existing nodes are removed when the new nodes are added.
    If reportCollisions is true, the Tree will log a warning in the developer console about this.
    Note that if an id collision occurs between a new node and its ancestor, the ancestor will be removed and the new node will not be added to the tree.
    
    Returns:
    
    Boolean
  - setRoot
```
public void setRoot(TreeNode root)
```
    If you're using the "parent" modelType, you can provide the root node configuration via this property. If you don't provide it, one will be auto-created for you with an empty name. Read on for a description of what omitting the name property on the root node means for path derivation.
    If you're using the "children" modelType, you can provide the initial tree data via this property. So, for example, to construct the following tree:
```
  foo
    bar
  zoo
  
```
    You would initialize the tree as follows:
```
  Tree tree = new Tree();
  tree.setRoot(
      new TreeNode("root",
          new TreeNode("foo",
              new TreeNode("bar")),
          new TreeNode("zoo")
      )
  );
  
```
    Note: if you initialize a Tree with no root value, a root node will be auto-created for you. You can then call add() to construct the tree.
    
    If this method is called after the component has been drawn/initialized: Set the root node of the tree.
    Parameters:
    
    root - new root node. Default value is null
    
    See Also:
    
    setModelType(com.smartgwt.client.types.TreeModelType), setRoot(com.smartgwt.client.widgets.tree.TreeNode), Children Arrays Example
  - getRoot
```
public TreeNode getRoot()
```
    If you're using the "parent" modelType, you can provide the root node configuration via this property. If you don't provide it, one will be auto-created for you with an empty name. Read on for a description of what omitting the name property on the root node means for path derivation.
    If you're using the "children" modelType, you can provide the initial tree data via this property. So, for example, to construct the following tree:
```
  foo
    bar
  zoo
  
```
    You would initialize the tree as follows:
```
  Tree tree = new Tree();
  tree.setRoot(
      new TreeNode("root",
          new TreeNode("foo",
              new TreeNode("bar")),
          new TreeNode("zoo")
      )
  );
  
```
    Note: if you initialize a Tree with no root value, a root node will be auto-created for you. You can then call add() to construct the tree.
    Returns:
    
    Returns the root node of the tree.
    
    See Also:
    
    getModelType(), setRoot(com.smartgwt.client.widgets.tree.TreeNode), Children Arrays Example
  - setSeparateFolders
```
public void setSeparateFolders(java.lang.Boolean separateFolders)
```
    Should folders be sorted separately from leaves or should nodes be ordered according to their sort field value regardless of whether the node is a leaf or folder?
    
    If this method is called after the component has been drawn/initialized: Setter for separateFolders.
    
    Parameters:
    
    separateFolders - new separateFolders value. Default value is false
    
    See Also:
    
    setSortFoldersBeforeLeaves(java.lang.Boolean)
  - getSeparateFolders
```
public java.lang.Boolean getSeparateFolders()
```
    Should folders be sorted separately from leaves or should nodes be ordered according to their sort field value regardless of whether the node is a leaf or folder?
    
    Returns:
    
    Boolean
    
    See Also:
    
    getSortFoldersBeforeLeaves()
  - setShowRoot
```
public void setShowRoot(java.lang.Boolean showRoot)
```
    Controls whether the implicit root node is returned as part of the visible tree, specifically, whether it is returned in getOpenList(), which is the API view components typically use to get the list of visible nodes.
    Default is to have the root node be implicit and not included in the open list, which means that the visible tree begins with the children of root. This allows multiple nodes to appear at the top level of the tree.
    You can set showRoot:true to show the single, logical root node as the only top-level node. This property is only meaningful for Trees where you supplied a value for root, otherwise, you will see an automatically generated root node that is meaningless to the user.
    
    If this method is called after the component has been drawn/initialized: Setter for showRoot.
    
    Parameters:
    
    showRoot - new showRoot value. Default value is false
  - getShowRoot
```
public java.lang.Boolean getShowRoot()
```
    Controls whether the implicit root node is returned as part of the visible tree, specifically, whether it is returned in getOpenList(), which is the API view components typically use to get the list of visible nodes.
    Default is to have the root node be implicit and not included in the open list, which means that the visible tree begins with the children of root. This allows multiple nodes to appear at the top level of the tree.
    You can set showRoot:true to show the single, logical root node as the only top-level node. This property is only meaningful for Trees where you supplied a value for root, otherwise, you will see an automatically generated root node that is meaningless to the user.
    
    Returns:
    
    Boolean
  - setSortFoldersBeforeLeaves
```
public void setSortFoldersBeforeLeaves(java.lang.Boolean sortFoldersBeforeLeaves)
```
    If separateFolders is true, should folders be displayed above or below leaves? When set to true folders will appear above leaves when the sortDirection applied to the tree is "ascending"
    
    If this method is called after the component has been drawn/initialized: Setter for sortFoldersBeforeLeaves.
    
    Parameters:
    
    sortFoldersBeforeLeaves - new sortFoldersBeforeLeaves value. Default value is true
  - getSortFoldersBeforeLeaves
```
public java.lang.Boolean getSortFoldersBeforeLeaves()
```
    If separateFolders is true, should folders be displayed above or below leaves? When set to true folders will appear above leaves when the sortDirection applied to the tree is "ascending"
    
    Returns:
    
    Boolean
  - setTitleProperty
```
public void setTitleProperty(java.lang.String titleProperty)
```
    Name of the property on a TreeNode that holds the title of the node as it should be shown to the user. Default value is "title". See TreeNode.title for usage.
    
    Parameters:
    
    titleProperty - Default value is "title"
  - getTitleProperty
```
public java.lang.String getTitleProperty()
```
    Name of the property on a TreeNode that holds the title of the node as it should be shown to the user. Default value is "title". See TreeNode.title for usage.
    
    Returns:
    
    String
  - allChildrenLoaded
```
public java.lang.Boolean allChildrenLoaded(TreeNode node)
```
    For a databound tree, do the children of this folder form a ResultSet with a full cache.
    Note that this method only applies to ResultTree.fetchMode "paged".
    
    Parameters:
    
    node - folder in question
    
    Returns:
    
    folder's children are a ResultSet with a full cache
    
    See Also:
    
    getChildrenResultSet(com.smartgwt.client.widgets.tree.TreeNode)
  - closeAll
```
public void closeAll()
```
    Close all nodes under a particular node
  - closeAll
```
public void closeAll(TreeNode node)
```
    Close all nodes under a particular node
    
    Parameters:
    
    node - node from which to close folders (if not specified, the root node is used)
  - closeFolder
```
public void closeFolder(TreeNode node)
```
    Closes a folder
    
    Parameters:
    
    node - folder to close
  - addDataChangedHandler
```
public com.google.gwt.event.shared.HandlerRegistration addDataChangedHandler(DataChangedHandler handler)
```
    Add a dataChanged handler.
    Called when the structure of this tree is changed in any way. Intended to be observed.
    
    Note that on a big change (many items being added or deleted) this may be called multiple times
    
    Parameters:
    
    handler - the dataChanged handler
    
    Returns:
    
    HandlerRegistration used to remove this handler
  - getChildrenResultSet
```
public ResultSet getChildrenResultSet(TreeNode node)
```
    Returns a ResultSet that provides access to any partially-loaded children of a node. If the node is a leaf, this method returns null.
    
    Parameters:
    
    node - The node whose children you want to fetch.
    
    Returns:
    
    List of children for the node, including an empty ResultSet if the node has no children. For a leaf, returns null.
    
    See Also:
    
    getChildren(com.smartgwt.client.widgets.tree.TreeNode), allChildrenLoaded(com.smartgwt.client.widgets.tree.TreeNode)
  - getLength
```
public int getLength()
```
    Returns the number of items in the current open list.
    
    Overrides:
    
    getLength in class RecordList
    
    Returns:
    
    number of items in open list
    
    See Also:
    
    getOpenList(com.smartgwt.client.widgets.tree.TreeNode)
  - getLevel
```
public int getLevel(TreeNode node)
```
    Return the number of levels deep this node is in the tree. For example, for this tree:
```
  root
    foo
      bar
  
```
    Calling tree.getLevel(bar) will return 2.
    Note showRoot defaults to false so that multiple nodes can be shown at top level. In this case, the top-level nodes still have root as a parent, so have level 1, even though they have no visible parents.
    Parameters:
    
    node - node in question
    
    Returns:
    
    number of parents the node has
  - getLoadState
```
public LoadState getLoadState(TreeNode node)
```
    What is the loadState of a given folder?
    
    Parameters:
    
    node - folder in question
    
    Returns:
    
    state of the node
  - getName
```
public java.lang.String getName(TreeNode node)
```
    Get the 'name' of a node. This is node[nameProperty]. If that value has not been set on the node, a unique value (within this parent) will be auto-generated and returned.
    
    Parameters:
    
    node - node in question
    
    Returns:
    
    name of the node
  - getParentPath
```
public java.lang.String getParentPath(TreeNode node)
```
    Given a node, return the path to its parent. This works just like getPath() except the node itself is not reported as part of the path.
    
    Parameters:
    
    node - node in question
    
    Returns:
    
    path to the node's parent
    
    See Also:
    
    getPath(com.smartgwt.client.widgets.tree.TreeNode)
  - getPath
```
public java.lang.String getPath(TreeNode node)
```
    Returns the path of a node - a path has the following format: ([name][pathDelim]?)*
    
    For example, in this tree:
```
  root
    foo
      bar
  
```
    Assuming that pathDelim is the default /, the bar node would have the path root/foo/bar and the path for the foo node would be root/foo.
    
    Once you have a path to a node, you can call find(path) to retrieve a reference to the node later.
    Parameters:
    
    node - node in question
    
    Returns:
    
    path to the node
    
    See Also:
    
    getParentPath(com.smartgwt.client.widgets.tree.TreeNode)
  - getTitle
```
public java.lang.String getTitle(TreeNode node)
```
    Return the title of a node -- the name as it should be presented to the user. This method works as follows:
    - If a titleProperty is set on the node, the value of that property is returned.
    - Otherwise, if the nameProperty is set on the node, that value is returned, minus any trailing pathDelim.
    - Finally, if none of the above yielded a title, the value of defaultNodeTitle is returned.
    You can override this method to return the title of your choice for a given node.
    
    To override the title for an auto-constructed tree (for example, in a databound TreeGrid), override TreeGrid.getNodeTitle() instead.
    Parameters:
    
    node - node for which the title is being requested
    
    Returns:
    
    title to display
    
    See Also:
    
    TreeGrid.getNodeTitle(com.smartgwt.client.data.Record, int, com.smartgwt.client.widgets.grid.ListGridField)
  - hasChildren
```
public java.lang.Boolean hasChildren(TreeNode node)
```
    Returns true if this node has any children.
    
    Parameters:
    
    node - node in question
    
    Returns:
    
    true if the node has children
  - hasFolders
```
public java.lang.Boolean hasFolders(TreeNode node)
```
    Return true if this this node has any children that are folders.
    
    Parameters:
    
    node - node in question
    
    Returns:
    
    true if the node has children that are folders
  - hasLeaves
```
public java.lang.Boolean hasLeaves(TreeNode node)
```
    Return whether this node has any children that are leaves.
    
    Parameters:
    
    node - node in question
    
    Returns:
    
    true if the node has children that are leaves
  - isDescendantOf
```
public java.lang.Boolean isDescendantOf(TreeNode child,
                                        TreeNode parent)
```
    Is one node a descendant of the other?
    
    Parameters:
    
    child - child node
    
    parent - parent node
    
    Returns:
    
    true == parent is an ancestor of child
  - isFolder
```
public java.lang.Boolean isFolder(TreeNode node)
```
    Determines whether a particular node is a folder. The logic works as follows:
    - If the TreeNode has a value for the isFolderProperty (TreeNode.isFolder by default) that value is returned.
    - Next, the existence of the childrenProperty (by default TreeNode.children) is checked on the TreeNode. If the node has the children property defined (regardless of whether it actually has any children), then isFolder() returns true for that node.
    Parameters:
    
    node - node in question
    
    Returns:
    
    true if the node is a folder
  - isLeaf
```
public java.lang.Boolean isLeaf(TreeNode node)
```
    Returns true if the passed in node is a leaf.
    
    Parameters:
    
    node - node in question
    
    Returns:
    
    true if the node is a leaf
    
    See Also:
    
    isFolder(com.smartgwt.client.widgets.tree.TreeNode)
  - isLoaded
```
public java.lang.Boolean isLoaded(TreeNode node)
```
    For a databound tree, has this folder either already loaded its children or is it in the process of loading them.
    
    Parameters:
    
    node - folder in question
    
    Returns:
    
    folder is loaded or is currently loading
  - isOpen
```
public java.lang.Boolean isOpen(TreeNode node)
```
    Whether a particular node is open or closed (works for leaves and folders).
    
    Parameters:
    
    node - node in question
    
    Returns:
    
    true if the node is open
  - isRoot
```
public java.lang.Boolean isRoot(TreeNode node)
```
    Return true if the passed node is the root node.
    
    Parameters:
    
    node - node to test
    
    Returns:
    
    true if the node is the root node
  - loadChildren
```
public void loadChildren(TreeNode node)
```
    Load the children of a given node.
    For a databound tree this will trigger a fetch against the Tree's DataSource.
    
    Parameters:
    
    node - node in question
  - loadChildren
```
public void loadChildren(TreeNode node,
                         DSCallback callback)
```
    Load the children of a given node.
    For a databound tree this will trigger a fetch against the Tree's DataSource.
    
    Parameters:
    
    node - node in question
    
    callback - Optional callback (stringMethod) to fire when loading completes. Has a single param node - the node whose children have been loaded, and is fired in the scope of the Tree.
  - move
```
public void move(TreeNode node,
                 TreeNode newParent)
```
    Moves the specified node to a new parent.
    
    Parameters:
    
    node - node to move
    
    newParent - new parent to move the node to
  - move
```
public void move(TreeNode node,
                 TreeNode newParent,
                 java.lang.Integer position)
```
    Moves the specified node to a new parent.
    
    Parameters:
    
    node - node to move
    
    newParent - new parent to move the node to
    
    position - Position of the new node in the children list. If not specified, the node will be added at the end of the list.
  - openAll
```
public void openAll()
```
    Open all nodes under a particular node.
    
    See Also:
    
    Parent Linking Example
  - openAll
```
public void openAll(TreeNode node)
```
    Open all nodes under a particular node.
    
    Parameters:
    
    node - node from which to open folders (if not specified, the root node is used)
    
    See Also:
    
    Parent Linking Example
  - reloadChildren
```
public void reloadChildren(TreeNode node)
```
    Reload the children of a folder.
    
    Parameters:
    
    node - node in question
    
    See Also:
    
    removeChildren(com.smartgwt.client.widgets.tree.TreeNode)
  - remove
```
public java.lang.Boolean remove(TreeNode node)
```
    Removes a node, along with all its children. See "Modifying ResultTrees" when working with a ResultTree for limitations.
    
    Parameters:
    
    node - node to remove
    
    Returns:
    
    true if the tree was changed as a result of this call
  - removeChildren
```
public void removeChildren(TreeNode node)
```
    Removes all children of the node and sets it to a loaded state. For non-ResultTrees, or non-paged ResultTrees, add() or addList() can then be used to provide new children. For paged ResultTrees, DataSource.updateCaches() must be used to insert nodes into the cache as local data, since such ResultTrees are considered read-only, and add() and addList() are not perrmitted.
    
    Parameters:
    
    node - folder in question
    
    See Also:
    
    getLoadState(com.smartgwt.client.widgets.tree.TreeNode), reloadChildren(com.smartgwt.client.widgets.tree.TreeNode)
  - setChildren
```
public void setChildren(TreeNode parent,
                        java.util.List newChildren)
```
    Replaces the existing children of a parent node, leaving the node in the loaded state. Only a flat list of children nodes is supported, as in addList().
    
    Parameters:
    
    parent - parent of children
    
    newChildren - children to be set
    
    See Also:
    
    removeChildren(com.smartgwt.client.widgets.tree.TreeNode), DataSource.updateCaches(com.smartgwt.client.data.DSResponse)
  - unloadChildren
```
public void unloadChildren(TreeNode node)
```
    Deprecated. It's recommended that you instead use reloadChildren() to reload the children of a folder, or removeChildren() if you need to clear the cached children of a folder to add specific local data.
    
    Unload the children of a folder, returning the folder to the "unloaded" state.
    
    Parameters:
    
    node - folder in question
  - setData
```
public void setData(TreeNode[] nodes)
```
    Optional initial data for the tree. How this data is interpreted depends on this tree's modelType.
    If modelType is "parent", the list that you provide will be passed to linkNodes(com.smartgwt.client.widgets.tree.TreeNode[]), integrating the nodes into the tree.
    In this case the root node must be supplied separately via root. So for example, to create this tree:
```
foo
    bar
        zoo 
```
    with modelType:"parent", you can do this:
```
        TreeNode root = new TreeNode("root");

        Tree tree = new Tree();
        tree.setRoot(root);
        tree.setModelType(TreeModelType.PARENT);

        TreeNode data[] = new TreeNode[3];
        data[0] = new TreeNode("foo");
        data[0].setID("foo");
        data[0].setParentID("root");
        data[1] = new TreeNode("bar");
        data[1].setID("bar");
        data[1].setParentID("foo");
        data[2] = new TreeNode("zoo");
        data[2].setID("zoo");
        data[2].setParentID("bar");
        tree.setData(data);
 
```
    Specifying the root node explicitly allows you to give it a name, changing the way path derivation works (see root for more on naming the root node).
    For modelType:"children" trees, the data passed in will be assumed to be an array of children of the tree's root node.
    Parameters:
    
    nodes - data
  - getData
```
public ListGridRecord[] getData()
```
  - setRootValue
```
public void setRootValue(java.lang.String rootValue)
```
    If you are using the "parent" modelType and did not specify a root node via root with an id (idField), then you can provide the root node's id via this property. See the example in data for more info.
    
    Parameters:
    
    rootValue - rootValue Default value is null
    
    Throws:
    
    java.lang.IllegalStateException - this property cannot be changed after the underlying component has been created
  - setRootValue
```
public void setRootValue(int rootValue)
```
    If you are using the "parent" modelType and did not specify a root node via root with an id (idField), then you can provide the root node's id via this property. See the example in data for more info.
    
    Parameters:
    
    rootValue - rootValue Default value is null
    
    Throws:
    
    java.lang.IllegalStateException - this property cannot be changed after the underlying component has been created
  - getRootValue
```
public java.lang.String getRootValue()
```
  - getParent
```
public TreeNode getParent(TreeNode node)
```
    Returns the parent of this node.
    
    Parameters:
    
    node - node in question
    
    Returns:
    
    parent of this node
  - getFilteredTree
```
public Tree getFilteredTree(Criteria criteria)
```
    Filters this tree by the provided criteria, returning a new Tree containing just the nodes that match the criteria.
    If filterMode is "keepParents", parents are retained if any of their children match the criteria even if those parents do not match the criteria.
    
    Parameters:
    
    criteria - criteria to filter by
    
    Returns:
    
    filtered tree
  - getFilteredTree
```
public Tree getFilteredTree(Criteria criteria,
                            TreeFilterMode filterMode,
                            DataSource dataSource)
```
    Filters this tree by the provided criteria, returning a new Tree containing just the nodes that match the criteria.
    If filterMode is "keepParents", parents are retained if any of their children match the criteria even if those parents do not match the criteria.
    
    Parameters:
    
    criteria - criteria to filter by
    
    filterMode - mode to use for filtering, defaults to "strict"
    
    dataSource - dataSource to use for filtering, if this Tree does not already have one
    
    Returns:
    
    filtered tree
  - linkNodes
```
public void linkNodes(TreeNode[] nodes)
```
    This method is provided as a mechanism to link new nodes into the tree of modelType "parent". This method takes a list of nodes that must contain at a minimum a unique ID (keyed by idField) and a parent ID (keyed by parentIdField). Based on this information, the list of nodes is integrated into the tree structure.
    
    Parameters:
    
    nodes - list of nodes to link into the tree.
  - getParents
```
public TreeNode[] getParents(TreeNode node)
```
    Given a node, return an array of the node's parents with the immediate parent first. The node itself is not included in the result. For example, for the following tree:
```
 root   foo     bar 
```
    Calling tree.getParents(bar) would return: [foo, root]. Note that the returned array will contain references to the nodes, not the names.
    Parameters:
    
    node - node in question
    
    Returns:
    
    array of node's parents
  - findById
```
public TreeNode findById(java.lang.String id)
```
    Find the node with the specified ID. Specifically, it returns the node whose idField matches the id passed to this method. If the tree is using the "parent" modelType, this lookup will be constant-time. For all other modelTypes, the tree will be searched recursively.
    
    Parameters:
    
    id - ID of the node to return.
    
    Returns:
    
    node with appropriate ID, or null if not found.
  - find
```
public TreeNode find(java.lang.String fieldNameOrPath)
```
    Find a node within this tree using a string path or by attribute value(s). This method can be called with 1 or 2 arguments. If a single String argument is supplied, the value of the argument is treated as the path to the node. if a single argument of type Object is provided, it is treated as a set of field name/value pairs to search for (see com.smartgwt.client..List#find).
    If 2 arguments are supplied, this method will treat the first argument as a fieldName, and return the first node encountered where node[fieldName]matches the second argument. So for example, given this tree:
```
 foo   zoo
   bar   moo     bar 
```
    Assuming your pathDelim is the default / and foo is the name of the root node, then tree.find("foo/moo/bar") would return the bar node under the moo node.
    
    tree.find("name", "bar") would return the first bar node because it is the first one in the list whose name (default value of nameProperty) property matches the value bar. The two argument usage is generally more interesting when your tree nodes have some custom unique property that you wish to search on. For example if your tree nodes had a unique field called "UID", their serialized form would look something like this:
```
 { name: "foo", children: [...], UID:"someUniqueId"} 
```
    You could then call tree.find("UID", "someUniqueId") to find that node. Note that the value doesn't have to be a string - it can be any valid JS value, but since this data generally comes from the server, the typical types are string, number, and boolean.
    
    The usage where you pass a single object is interesting when your tree nodes have a number of custom properties that you want to search for in combination. Say your tree nodes had properties for "color" and "shape"; tree.find({color: "green", shape: "circle"}) would return the first node in the tree where both properties matched.
    
    When searching by path, trailing path delimiters are ignored. So for example tree.find("foo/zoo/bar") is equivalent to tree.find("foo/zoo/bar/")
    Parameters:
    
    fieldNameOrPath - Either the path to the node to be found, or the name of a field which should match the value passed as a second parameter
    
    Returns:
    
    the node matching the supplied criteria or null if not found
  - find
```
public TreeNode find(java.lang.String fieldNameOrPath,
                     java.lang.Object value)
```
    Find a node within this tree using a string path or by attribute value(s).
    
    Overrides:
    
    find in class RecordList
    
    Parameters:
    
    fieldNameOrPath - Either the path to the node to be found, or the name of a field which should match the value passed as a second parameter
    
    value - If specified, this is the desired value for the appropriate field
    
    Returns:
    
    the node matching the supplied criteria or null if not found
    
    See Also:
    
    find(String)
  - find
```
public TreeNode find(java.lang.String propertyName,
                     java.util.Date value)
```
    Find a node within this tree using a string path or by attribute value(s).
    
    Overrides:
    
    find in class RecordList
    
    Parameters:
    
    fieldNameOrPath - Either the path to the node to be found, or the name of a field which should match the value passed as a second parameter
    
    value - If specified, this is the desired value for the appropriate field
    
    Returns:
    
    the node matching the supplied criteria or null if not found
    
    See Also:
    
    find(String)
  - getChildren
```
public TreeNode[] getChildren(TreeNode node)
```
    Returns all children of a node. If the node is a leaf, this method returns null.
    
    For load on demand trees (those that only have a partial representation client-side) or for databound tree where the underlying set of children is incomplete, this method will return only those nodes that have already been loaded from the server.
    
    Parameters:
    
    node - The node whose children you want to fetch.
    
    Returns:
    
    List of children for the node (empty List if node is a leaf or has no children)
  - getFolders
```
public TreeNode[] getFolders(TreeNode node)
```
    Returns all the first-level folders of a node.
    
    For load on demand trees (those that only have a partial representation client-side), this method will return only nodes that have already been loaded from the server.
    
    Parameters:
    
    node - node in question
    
    Returns:
    
    List of immediate children that are folders
  - getLeaves
```
public TreeNode[] getLeaves(TreeNode node)
```
    Return all the first-level leaves of a node.
    
    For load on demand trees (those that only have a partial representation client-side), this method will return only nodes that have already been loaded from the server.
    
    Parameters:
    
    node - node in question
    
    Returns:
    
    List of immediate children that are leaves.
  - getDescendants
```
public TreeNode[] getDescendants()
```
    Returns the list of all descendants of a node. Note: this method can be very slow, especially on large trees because it assembles a list of all descendants recursively. Generally, find(java.lang.String) in combination with getChildren(com.smartgwt.client.widgets.tree.TreeNode) will be much faster.
    
    For load on demand trees (those that only have a partial representation client-side), this method will return only nodes that have already been loaded from the server.
    
    Returns:
    
    List of descendants of the node.
  - getDescendants
```
public TreeNode[] getDescendants(TreeNode node)
```
    Returns the list of all descendants of a node. Note: this method can be very slow, especially on large trees because it assembles a list of all descendants recursively. Generally, find(java.lang.String) in combination with getChildren(com.smartgwt.client.widgets.tree.TreeNode) will be much faster.
    
    For load on demand trees (those that only have a partial representation client-side), this method will return only nodes that have already been loaded from the server.
    
    Parameters:
    
    node - node in question (the root node is asumed if none specified)
    
    Returns:
    
    List of descendants of the node.
  - getDescendantFolders
```
public TreeNode[] getDescendantFolders()
```
    Ruturns the list of all descendants of a node that are folders. This works just like getDescendants(), except leaf nodes are not part of the returned list. Like getDescendants(), this method can be very slow for large trees. Generally, find(java.lang.String) in combination with getFolders(com.smartgwt.client.widgets.tree.TreeNode) be much faster.
    
    For load on demand trees (those that only have a partial representation client-side), this method will return only nodes that have already been loaded from the server.
    
    Returns:
    
    List of descendants of the node that are folders.
  - getDescendantFolders
```
public TreeNode[] getDescendantFolders(TreeNode node)
```
    Ruturns the list of all descendants of a node that are folders. This works just like getDescendants(), except leaf nodes are not part of the returned list. Like getDescendants(), this method can be very slow for large trees. Generally, find(java.lang.String) in combination with getFolders(com.smartgwt.client.widgets.tree.TreeNode) be much faster.
    
    For load on demand trees (those that only have a partial representation client-side), this method will return only nodes that have already been loaded from the server.
    
    Parameters:
    
    node - node in question (the root node is assumed if none specified)
    
    Returns:
    
    List of descendants of the node that are folders.
  - getDescendantLeaves
```
public TreeNode[] getDescendantLeaves()
```
    Returns the list of all descendants of a node that are leaves. This works just like getDescendants(), except folders are not part of the returned list. Folders are still recursed into, just not returned. Like getDescendants(), this method can be very slow for large trees. Generally, find(java.lang.String) in combination with getLeaves(com.smartgwt.client.widgets.tree.TreeNode) be much faster.
    
    For load on demand trees (those that only have a partial representation client-side), this method will return only nodes that have already been loaded from the server.
    
    Returns:
    
    List of descendants of the node that are leaves.
  - getDescendantLeaves
```
public TreeNode[] getDescendantLeaves(TreeNode node)
```
    Returns the list of all descendants of a node that are leaves. This works just like getDescendants(), except folders are not part of the returned list. Folders are still recursed into, just not returned. Like getDescendants(), this method can be very slow for large trees. Generally, find(java.lang.String) in combination with getLeaves(com.smartgwt.client.widgets.tree.TreeNode) be much faster.
    
    For load on demand trees (those that only have a partial representation client-side), this method will return only nodes that have already been loaded from the server.
    
    Parameters:
    
    node - node in question (the root node is assumed if none specified)
    
    Returns:
    
    List of descendants of the node that are leaves.
  - add
```
public TreeNode add(TreeNode node,
                    TreeNode parent)
```
    Add a single node under the specified parent
    
    Parameters:
    
    node - node to add
    
    parent - Parent of the node being added. You can pass in either the TreeNode itself, or a path to the node (as a String), in which case a find(java.lang.String) is performed to find the node.
    
    Returns:
    
    The added node.
  - add
```
public TreeNode add(TreeNode node,
                    java.lang.String parentPath)
```
    Add a single node under the specified parent
    
    Parameters:
    
    node - node to add
    
    parentPath - Parent of the node being added. You can pass in either the TreeNode itself, or a path to the node (as a String), in which case a find(java.lang.String) is performed to find the node.
    
    Returns:
    
    The added node.
  - add
```
public TreeNode add(TreeNode node,
                    TreeNode parent,
                    int position)
```
    Add a single node under the specified parent
    
    Parameters:
    
    node - node to add
    
    parent - Parent of the node being added. You can pass in either the TreeNode itself, or a path to the node (as a String), in which case a find(java.lang.String) is performed to find the node.
    
    position - Position of the new node in the children list. If not specified, the node will be added at the end of the list.
    
    Returns:
    
    The added node.
  - add
```
public TreeNode add(TreeNode node,
                    java.lang.String parentPath,
                    int position)
```
  - addList
```
public TreeNode[] addList(TreeNode[] nodeList,
                          TreeNode parent)
```
    Add a list of nodes to some parent.
    
    Parameters:
    
    nodeList - The list of nodes to add
    
    parent - Parent of the node being added. You can pass in either the TreeNode itself, or a path to the node (as a String), in which case a find(java.lang.String) is performed to find the node.
    
    Returns:
    
    List of added nodes.
  - addList
```
public TreeNode[] addList(TreeNode[] nodeList,
                          java.lang.String parentPath)
```
    Add a list of nodes to some parent.
    
    Parameters:
    
    nodeList - The list of nodes to add
    
    parentPath - Parent of the node being added. You can pass in either the TreeNode itself, or a path to the node (as a String), in which case a find(java.lang.String) is performed to find the node.
    
    Returns:
    
    List of added nodes.
  - addList
```
public TreeNode[] addList(TreeNode[] nodeList,
                          TreeNode parent,
                          int position)
```
    Add a list of nodes to some parent.
    
    Parameters:
    
    nodeList - The list of nodes to add
    
    parent - Parent of the node being added. You can pass in either the TreeNode itself, or a path to the node (as a String), in which case a find(java.lang.String) is performed to find the node.
    
    position - Position of the new node in the children list. If not specified, the node will be added at the end of the list.
    
    Returns:
    
    List of added nodes.
  - addList
```
public TreeNode[] addList(TreeNode[] nodeList,
                          java.lang.String parentPath,
                          int position)
```
    Add a list of nodes to some parent.
    
    Parameters:
    
    nodeList - The list of nodes to add
    
    parentPath - Parent of the node being added. You can pass in either the TreeNode itself, or a path to the node (as a String), in which case a find(java.lang.String) is performed to find the node.
    
    position - Position of the new node in the children list. If not specified, the node will be added at the end of the list.
    
    Returns:
    
    List of added nodes.
  - removeList
```
public java.lang.Boolean removeList(TreeNode[] nodeList)
```
    Remove a list of nodes (not necessarily from the same parent), and all children of those nodes.
    
    Parameters:
    
    nodeList - list of nodes to remove
    
    Returns:
    
    true if the tree was changed as a result of this call
  - openFolders
```
public void openFolders(TreeNode[] nodeList)
```
    Open a set of folders, specified by path or as pointers to nodes.
    
    Parameters:
    
    nodeList - List of nodes or node paths.
  - closeFolders
```
public void closeFolders(TreeNode[] nodeList)
```
    Close a set of folders, specified by path or as pointers to nodes.
    
    Parameters:
    
    nodeList - List of nodes or node paths.
  - getOpenList
```
public TreeNode[] getOpenList(TreeNode node)
```
    Return a flattened list of nodes that are open under some parent, including the parent itself. If the passed in node is a leaf, this method returns null
    
    Parameters:
    
    node - node in question
    
    Returns:
    
    flattened list of open nodes
  - nodeForRecord
```
public static TreeNode nodeForRecord(ListGridRecord record)
```
    A TreeNode and ListGridRecord represent similar datastructures and it is possible that certain TreeGrid operations return a ListGridRecord since TreeGrid extends ListGrid. So in order to call several of the methods in this Tree class, you need to coerce a ListGridRecord to a TreeNode. This can be done by calling this method.
    
    Parameters:
    
    record - the record
    
    Returns:
    
    the TreeNode representation of the record
  - openFolder
```
public void openFolder(TreeNode node)
```
    Open a particular node
    
    Parameters:
    
    node - node to open
  - getAllNodes
```
public TreeNode[] getAllNodes()
```
    Get all the nodes that exist in the tree under a particular node, as a flat list, in depth-first traversal order.
    
    Returns:
    
    all the nodes that exist in the tree
  - getAllNodes
```
public TreeNode[] getAllNodes(TreeNode node)
```
    Get all the nodes that exist in the tree under a particular node, as a flat list, in depth-first traversal order.
    
    Parameters:
    
    node - optional node to start from. Default is root.
    
    Returns:
    
    all the nodes that exist in the tree
  - setProperty
```
public void setProperty(java.lang.String property,
                        java.lang.String value)
```
    Overrides:
    
    setProperty in class BaseClass
  - setProperty
```
public void setProperty(java.lang.String property,
                        boolean value)
```
    Overrides:
    
    setProperty in class BaseClass
  - setProperty
```
public void setProperty(java.lang.String property,
                        double value)
```
    Overrides:
    
    setProperty in class BaseClass
  - setProperty
```
public void setProperty(java.lang.String property,
                        com.google.gwt.core.client.JavaScriptObject value)
```
    Overrides:
    
    setProperty in class BaseClass

Class Tree

Nested Class Summary

Nested classes/interfaces inherited from class com.smartgwt.client.data.RecordList

Field Summary

Fields inherited from class com.smartgwt.client.data.RecordList

Fields inherited from class com.smartgwt.client.core.BaseClass

Constructor Summary

Method Summary

Methods inherited from class com.smartgwt.client.data.RecordList

Methods inherited from class com.smartgwt.client.core.BaseClass

Methods inherited from class java.lang.Object

Methods inherited from interface com.google.gwt.event.shared.HasHandlers

Constructor Detail

Tree

Tree

Method Detail

getOrCreateRef

setJavaScriptObject

create

setAutoOpenRoot

getAutoOpenRoot

setChildrenProperty

getChildrenProperty

setDataSource

getDataSource

setDataSource

getDataSourceAsString

setDefaultIsFolder

getDefaultIsFolder

setDefaultNodeTitle

getDefaultNodeTitle

setDiscardParentlessNodes

getDiscardParentlessNodes

setIdField

getIdField

setIsFolderProperty

getIsFolderProperty

setModelType

getModelType

setNameProperty

getNameProperty

setOpenProperty

getOpenProperty

setParentIdField

getParentIdField

setPathDelim

getPathDelim

setReportCollisions

getReportCollisions

setRoot

getRoot

setSeparateFolders

getSeparateFolders

setShowRoot

getShowRoot

setSortFoldersBeforeLeaves

getSortFoldersBeforeLeaves

setTitleProperty

getTitleProperty

allChildrenLoaded

closeAll

closeAll

closeFolder

addDataChangedHandler

getChildrenResultSet

getLength

getLevel

getLoadState

getName

getParentPath

getPath

getTitle

hasChildren

hasFolders

hasLeaves

isDescendantOf

isFolder

isLeaf

isLoaded

isOpen