org.apache.myfaces.custom.tree2
Interface TreeWalker

All Known Implementing Classes:

TreeWalkerBase

public interface TreeWalker

Method Summary

java.lang.String	getRootNodeId() Returns the id of the root node.
boolean	isCheckState() Getter for the check state property.
boolean	next() Walk the tree and set the current node to the next node.
void	reset() Reset the walker so the tree can be walked again starting from the root.
void	setCheckState(boolean checkState) Setter for the check state property.
void	setTree(Tree tree) This method allows the renderer to pass a reference to the tree object.

Method Detail

isCheckState

boolean isCheckState()

Getter for the check state property. Indicates whether or not the TreeWalker should navigate over nodes that are not currently expanded.

Returns:

boolean

setCheckState

void setCheckState(boolean checkState)

Setter for the check state property. Indicates whether or not the TreeWalker should navigate over nodes that are not currently expanded.

Parameters:

checkState - boolean

next

boolean next()

Walk the tree and set the current node to the next node.

Returns:

boolean whether or not there was another node to walk

getRootNodeId

java.lang.String getRootNodeId()

Returns the id of the root node.

Returns:

String

setTree

void setTree(Tree tree)

This method allows the renderer to pass a reference to the tree object. With this reference the TreeWalker can set the current node as its walking the tree.

Parameters:

tree - Tree

reset

void reset()

Reset the walker so the tree can be walked again starting from the root.