Package org.apache.myfaces.tobago.model
Class ExpandedState
java.lang.Object
org.apache.myfaces.tobago.model.ExpandedState
- All Implemented Interfaces:
Serializable
Manages the expanded state of an tree.
- Since:
- 2.0.0
- See Also:
-
Constructor Summary
ConstructorsConstructorDescriptionExpandedState
(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 TypeMethodDescriptionvoid
collapse
(int level) Collapses all nodes that level are higher or equals the parameter level.void
Collapses a single node.void
Collapses a single node.void
Collapses a nodes of the tree.void
Collapses a nodes of the tree.void
expand
(int level) Expands all nodes that level are lower or equals the parameter level.void
Expands a single node.void
Expands a single node.void
Expands a single node.void
Expands a single node.void
Expands a nodes of the tree.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.
-
Constructor Details
-
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 Details
-
isExpanded
Checks if a node is expanded.- Parameters:
node
- The node to check.- Returns:
- Is the node expanded?
-
isExpanded
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
Expands a single node.- Parameters:
node
- The node to expand. Also the parents will be expanded since Tobago 3.0.0.
-
expand
Expands a single node.- Parameters:
node
- The node to expand.parents
- Should the parents also be expanded?
-
expand
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
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
Collapses a single node.- Parameters:
node
- The node to collapse.
-
collapse
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
- Returns:
- A unmodifiable set of paths of the expanded nodes.
-
getCollapsedSet
- Returns:
- A unmodifiable set of paths of the collapsed nodes.
-