org.apache.myfaces.custom.tree2
Interface TreeState

All Superinterfaces:

Serializable

All Known Implementing Classes:

TreeStateBase

public interface TreeState
extends Serializable

Method Summary

void	collapsePath(String[] nodePath) Collapse the complete path specified.
void	expandPath(String[] nodePath) Expand the complete path specified.
boolean	isNodeExpanded(String nodeId) Indicates whether or not the specified TreeNode is expanded.
boolean	isSelected(String nodeId) Indicates whether or not the specified node is selected.
boolean	isTransient() Getter for transient property.
void	setSelected(String nodeId) Sets the id of the currently selected node
void	setTransient(boolean trans) Setter for transient property
void	toggleExpanded(String nodeId) Toggle the expanded state of the specified TreeNode.

Method Detail

isNodeExpanded

boolean isNodeExpanded(String nodeId)

Indicates whether or not the specified TreeNode is expanded.

Parameters:

nodeId - The id of the node in question.

Returns:

If the node is expanded.

toggleExpanded

void toggleExpanded(String nodeId)

Toggle the expanded state of the specified TreeNode.

Parameters:

nodeId - The id of the node whose expanded state should be toggled.

expandPath

void expandPath(String[] nodePath)

Expand the complete path specified. If any node in the path is already expanded, that node should be left as it is.

Parameters:

nodePath - The path to be expanded.

collapsePath

void collapsePath(String[] nodePath)

Collapse the complete path specified. If any node in the path is already collapsed, that node should be left as it is.

Parameters:

nodePath - The path to be collapsed.

isTransient

boolean isTransient()

Getter for transient property.

Returns:

boolean

setTransient

void setTransient(boolean trans)

Setter for transient property

Parameters:

trans - boolean

setSelected

void setSelected(String nodeId)

Sets the id of the currently selected node

Parameters:

nodeId - The id of the currently selected node

isSelected

boolean isSelected(String nodeId)

Indicates whether or not the specified node is selected.

Parameters:

nodeId - String

Returns:

boolean