org.apache.myfaces.custom.tree2

Interface TreeModel

public interface TreeModel extends Serializable

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: 231342 $ $Date: 2005-08-11 00:33:20 +0200 (Thu, 11 Aug 2005) $

Author: Sean Schofield

Field Summary
static StringSEPARATOR
Separator char to be used in node path generation.
Method Summary
TreeNodegetNode()
Gets the current TreeNode or null if no node ID is selected.
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.
TreeStategetTreeState()
booleanisLastChild(String nodeId)
Indicates whether or not the specified TreeNode is the last child in the List of children.
voidsetNodeId(String nodeId)
Sets the current TreeNode to the specified node ID.
voidsetTreeState(TreeState state)

Field Detail

SEPARATOR

public static final String SEPARATOR
Separator char to be used in node path generation.

Method Detail

getNode

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

Returns: The current node

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.

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

Returns: String[]

getTreeState

public TreeState getTreeState()

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.

Parameters: nodeId The ID of the node to check

Returns: boolean

setNodeId

public void setNodeId(String nodeId)
Sets the current TreeNode to the specified node ID.

Parameters: nodeId The id of the node to set

setTreeState

public void setTreeState(TreeState state)