org.apache.myfaces.custom.tree2
Class TreeModelBase

java.lang.Object
  org.apache.myfaces.custom.tree2.TreeModelBase

All Implemented Interfaces:

Serializable, TreeModel

public class TreeModelBase
extends Object
implements TreeModel

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: 168205 $ $Date: 2005-05-04 18:59:21 -0400 (Wed, 04 May 2005) $

Author:

Sean Schofield, Hans Bergsten (Some code taken from an example in his O'Reilly JavaServer Faces book. Copied with permission)

See Also:

Serialized Form

Field Summary

Fields inherited from interface org.apache.myfaces.custom.tree2.TreeModel

SEPARATOR

Constructor Summary

TreeModelBase(TreeNode root)
Constructor

Method Summary

TreeNode	getNodeById(String nodeId)
String[]	getPathInformation(String nodeId) Gets an array of String containing the ID's of all of the TreeNodes in the path to the specified node.
TreeState	getTreeState()
TreeWalker	getTreeWalker() Gets the TreeWalker associated with the model.
boolean	isLastChild(String nodeId) Indicates whether or not the specified TreeNode is the last child in the List of children.
void	setTreeState(TreeState treeState)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TreeModelBase

public TreeModelBase(TreeNode root)

Constructor

Parameters:

root - The root TreeNode

Method Detail

getTreeState

public TreeState getTreeState()

Specified by:

getTreeState in interface TreeModel

setTreeState

public void setTreeState(TreeState treeState)

Specified by:

setTreeState in interface TreeModel

getPathInformation

public String[] getPathInformation(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.

Specified by:

getPathInformation in interface TreeModel

Parameters:

nodeId - The id of the node for whom the path information is needed.

Returns:

String[]

isLastChild

public boolean isLastChild(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.

Specified by:

isLastChild in interface TreeModel

Parameters:

nodeId - The ID of the node to check

Returns:

boolean

getNodeById

public TreeNode getNodeById(String nodeId)

Specified by:

getNodeById in interface TreeModel

getTreeWalker

public TreeWalker getTreeWalker()

Description copied from interface: TreeModel

Gets the TreeWalker associated with the model. Allows the user to customize the manner in which nodes are walked by the renderer.

Specified by:

getTreeWalker in interface TreeModel

Returns:

TreeWalker