org.apache.myfaces.custom.tree2
Class TreeModel

java.lang.Object
  |
  +--org.apache.myfaces.custom.tree2.TreeModel

public class TreeModel
extends java.lang.Object

Model class for the tree component. It provides random access to nodes in a tree made up of instances of the TreeNode class.

Version:
$Revision: 1.3 $ $Date: 2005/02/19 09:03:02 $
Author:
Sean Schofield, Hans Bergsten (Some code taken from an example in his O'Reilly JavaServer Faces book. Copied with permission)

Constructor Summary
TreeModel(TreeNode root)
          Constructor
 
Method Summary
 TreeNode getNode()
          Gets the current TreeNode or null if no node ID is selected.
 java.lang.String[] getPathInformation(java.lang.String nodeId)
          Gets an array of String containing the ID's of all of the TreeNodes in the path to the specified node.
 boolean isLastChild(java.lang.String nodeId)
          Indicates whether or not the specified TreeNode is the last child in the List of children.
 void setNodeId(java.lang.String nodeId)
          Sets the current TreeNode to the specified node ID, which is a colon-separated list of node indexes.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

TreeModel

public TreeModel(TreeNode root)
Constructor

Parameters:
root - The root TreeNode
Method Detail

getNode

public TreeNode getNode()
Gets the current TreeNode or null if no node ID is selected.

Returns:
The current node

setNodeId

public void setNodeId(java.lang.String nodeId)
Sets the current TreeNode to the specified node ID, which is a colon-separated list of node indexes. For instance, "0:0:1" means "the second child node of the first child node under the root node."

Parameters:
nodeId - The id of the node to set

getPathInformation

public java.lang.String[] getPathInformation(java.lang.String nodeId)
Gets an array of String containing the ID's of all of the TreeNodes in the path to the specified node. The path information will be an array of String objects representing node ID's. The array will starting with the ID of the root node and end with the ID of the specified node.

Parameters:
nodeId - The id of the node for whom the path information is needed.
Returns:
String[]

isLastChild

public boolean isLastChild(java.lang.String nodeId)
Indicates whether or not the specified TreeNode is the last child in the List of children. If the node id provided corresponds to the root node, this returns true.

Parameters:
nodeId - The ID of the node to check
Returns:
boolean