Packageorg.aswing.tree
Interfacepublic interface TreeModel
ImplementorsDefaultTreeModel

The interface that defines a suitable data model for a JTree. For further information on tree models, including an example of a custom implementation, see How to Use Trees in The Java Tutorial.

JTree and its related classes make extensive use of TreePaths for indentifying nodes in the TreeModel. If a TreeModel returns the same object, as compared by equals, at two different indices under the same parent than the resulting TreePath objects will be considered equal as well. Some implementations may assume that if two TreePaths are equal, they identify the same node. If this condition is not met, painting problems and other oddities may result. In other words, if getChild for a given parent returns the same Object (as determined by equals) problems may result, and it is recommended you avoid doing this.
(Fully quoted from java swing's tree doc)

See also

TreePath


Public Methods
 MethodDefined by
  
Adds a listener for the TreeModelEvent posted after the tree changes.
TreeModel
  
getChild(parent:Object, index:int):Object
Returns the child of parent at index index in the parent's child array.
TreeModel
  
getChildCount(parent:Object):int
Returns the number of children of parent.
TreeModel
  
getIndexOfChild(parent:Object, child:Object):int
Returns the index of child in parent.
TreeModel
  
getRoot():Object
Returns the root of the tree.
TreeModel
  
isLeaf(node:Object):Boolean
Returns true if node is a leaf.
TreeModel
  
Removes a listener previously added with addTreeModelListener.
TreeModel
  
valueForPathChanged(path:TreePath, newValue:Object):void
Messaged when the user has altered the value for the item identified by path to newValue.
TreeModel
Method detail
addTreeModelListener()method
public function addTreeModelListener(l:TreeModelListener):void

Adds a listener for the TreeModelEvent posted after the tree changes.

Parameters
l:TreeModelListener — l the listener to add

See also

getChild()method 
public function getChild(parent:Object, index:int):Object

Returns the child of parent at index index in the parent's child array. parent must be a node previously obtained from this data source. This should not return null if index is a valid index for parent (that is index >= 0 && index < getChildCount(parent)).

Parameters
parent:Object — parent a node in the tree, obtained from this data source
 
index:int

Returns
Object — the child of parent at index index
getChildCount()method 
public function getChildCount(parent:Object):int

Returns the number of children of parent. Returns 0 if the node is a leaf or if it has no children. parent must be a node previously obtained from this data source.

Parameters
parent:Object — parent a node in the tree, obtained from this data source

Returns
int — the number of children of the node parent
getIndexOfChild()method 
public function getIndexOfChild(parent:Object, child:Object):int

Returns the index of child in parent. If either parent or child is null, returns -1. If either parent or child don't belong to this tree model, returns -1.

Parameters
parent:Object — a note in the tree, obtained from this data source
 
child:Object — the node we are interested in

Returns
int — the index of the child in the parent, or -1 if either child or parent are null or don't belong to this tree model
getRoot()method 
public function getRoot():Object

Returns the root of the tree. Returns null only if the tree has no nodes.

Returns
Object — the root of the tree
isLeaf()method 
public function isLeaf(node:Object):Boolean

Returns true if node is a leaf. It is possible for this method to return false even if node has no children. A directory in a filesystem, for example, may contain no files; the node representing the directory is not a leaf, but it also has no children.

Parameters
node:Object — node a node in the tree, obtained from this data source

Returns
Boolean — true if node is a leaf
removeTreeModelListener()method 
public function removeTreeModelListener(l:TreeModelListener):void

Removes a listener previously added with addTreeModelListener.

Parameters
l:TreeModelListener — l the listener to remove

See also

valueForPathChanged()method 
public function valueForPathChanged(path:TreePath, newValue:Object):void

Messaged when the user has altered the value for the item identified by path to newValue. If newValue signifies a truly new value the model should post a treeNodesChanged event.

Parameters
path:TreePath — path to the node that the user has altered
 
newValue:Object — the new value from the TreeCellEditor