Package org.apache.myfaces.tobago.model

Class ExpandedState

java.lang.Object

org.apache.myfaces.tobago.model.ExpandedState

All Implemented Interfaces:

Serializable

public class ExpandedState
extends Object
implements Serializable

Manages the expanded state of an tree.

Since:

2.0.0

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
ExpandedState(int defaultExpandedLevels)	Creates a new state object to store which nodes of a tree are expanded and collapsed in a view.

Method Summary

Modifier and Type	Method	Description
void	collapse(int level)	Collapses all nodes that level are higher or equals the parameter level.
void	collapse(TreeNode node)	Collapses a single node.
void	collapse(TreePath path)	Collapses a single node.
void	collapseAll()	Collapses a nodes of the tree.
void	collapseAllButRoot()	Collapses a nodes of the tree.
void	expand(int level)	Expands all nodes that level are lower or equals the parameter level.
void	expand(TreeNode node)	Expands a single node.
void	expand(TreeNode node, boolean parents)	Expands a single node.
void	expand(TreePath path)	Expands a single node.
void	expand(TreePath path, boolean parents)	Expands a single node.
void	expandAll()	Expands a nodes of the tree.
Set<TreePath>	getCollapsedSet()
Set<TreePath>	getExpandedSet()
boolean	isExpanded(TreeNode node)	Checks if a node is expanded.
boolean	isExpanded(TreePath path)	Checks if a node is expanded.
void	reset()	Resets the state to the defaults.

Methods inherited from class java.lang.Object

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

Constructor Detail

ExpandedState

public ExpandedState(int defaultExpandedLevels)

Creates a new state object to store which nodes of a tree are expanded and collapsed in a view.

Parameters:

defaultExpandedLevels - All nodes up to this level are expanded by default.

Method Detail

isExpanded

public boolean isExpanded(TreeNode node)

Checks if a node is expanded.

Parameters:

node - The node to check.

Returns:

Is the node expanded?

isExpanded

public boolean isExpanded(TreePath path)

Checks if a node is expanded.

Parameters:

path - The path of the node to check.

Returns:

Is the node behind this path is expanded?

expand

public void expand(TreeNode node)

Expands a single node.

Parameters:

node - The node to expand. Also the parents will be expanded since Tobago 3.0.0.

expand

public void expand(TreeNode node,
                   boolean parents)

Expands a single node.

Parameters:

node - The node to expand.

parents - Should the parents also be expanded?

expand

public void expand(TreePath path)

Expands a single node.

Parameters:

path - The path of the node to expand. Also the parents will be expanded since Tobago 3.0.0.

expand

public void expand(TreePath path,
                   boolean parents)

Expands a single node.

Parameters:

path - The path of the node to expand.

parents - Should the parents also be expanded?

expand

public void expand(int level)

Expands all nodes that level are lower or equals the parameter level.

Parameters:

level - The level to expand.

expandAll

public void expandAll()

Expands a nodes of the tree.

collapse

public void collapse(TreeNode node)

Collapses a single node.

Parameters:

node - The node to collapse.

collapse

public void collapse(TreePath path)

Collapses a single node.

Parameters:

path - The path of the node to collapse.

collapse

public void collapse(int level)

Collapses all nodes that level are higher or equals the parameter level.

Parameters:

level - The level to expand.

collapseAll

public void collapseAll()

Collapses a nodes of the tree.

collapseAllButRoot

public void collapseAllButRoot()

Collapses a nodes of the tree. The root node will be expanded.

reset

public void reset()

Resets the state to the defaults. After this call, the nodes with level smaller than defaultExpandedLevels are expanded, the other ones are collapsed.

getExpandedSet

public Set<TreePath> getExpandedSet()

Returns:

A unmodifiable set of paths of the expanded nodes.

getCollapsedSet

public Set<TreePath> getCollapsedSet()

Returns:

A unmodifiable set of paths of the collapsed nodes.