org.apache.myfaces.custom.tree.model

Interface TreeModel

public interface TreeModel

Version: $Revision: 209487 $ $Date: 2005-07-06 19:49:15 +0200 (Wed, 06 Jul 2005) $

Author: Oliver Rossmueller

Method Summary
ObjectgetChild(Object parent, int index)
Return the child of parent at index index in the parent's child array.
intgetChildCount(Object parent)
Answer the number of children of parent.
intgetIndexOfChild(Object parent, Object child)
Return the index of child in parent.
ObjectgetRoot()
Return the root of the tree.
CollectiongetTreeModelListeners()
Answer the mutable collection of tree model listeners.
booleanisLeaf(Object node)
Answer true if node is a leaf.
voidvalueForPathChanged(TreePath path, Object newValue)
Called when the value for the item identified by path has changed to newValue.

Method Detail

getChild

public Object getChild(Object parent, int index)
Return the child of parent at index index in the parent's child array.

Parameters: parent a node in the tree

Returns: the child of parent at index index

getChildCount

public int getChildCount(Object parent)
Answer the number of children of parent.

Parameters: parent a node in the tree

Returns: the number of children of the node parent

getIndexOfChild

public int getIndexOfChild(Object parent, Object child)
Return the index of child in parent.

Parameters: parent a node in the tree child the node we are interested in

Returns: the index of the child in the parent, or -1 if either child or parent are null

getRoot

public Object getRoot()
Return the root of the tree.

Returns: the root of the tree or null, it this tree has no nodes

getTreeModelListeners

public Collection getTreeModelListeners()
Answer the mutable collection of tree model listeners.

Returns: Collection

isLeaf

public boolean isLeaf(Object node)
Answer true if node is a leaf.

Parameters: node a node in the tree

Returns: true if node is a leaf

valueForPathChanged

public void valueForPathChanged(TreePath path, Object newValue)
Called when the value for the item identified by path has changed to newValue. If newValue signifies a truly new value the model should post a treeNodesChanged event.

Parameters: path path to the node that has been altered newValue the new value from the TreeCellEditor