wicket.extensions.markup.html.tree
Interface ITreeState

All Known Implementing Classes:

DefaultTreeState

public interface ITreeState

Tree state holds information about a tree such as which nodes are expanded / collapsed and which nodes are selected, It can also fire callbacks on listener in case any of the information changed.

Author:

Matej Knopp

Method Summary

void	addTreeStateListener(ITreeStateListener l) Adds a tree state listener.
void	collapseAll() Collapses all nodes of the tree.
void	collapseNode(javax.swing.tree.TreeNode node) Collapses the given node.
void	expandAll() Expands all nodes of the tree.
void	expandNode(javax.swing.tree.TreeNode node) Expands the given node.
java.util.Collection	getSelectedNodes() Returns the collection of all selected nodes.
boolean	isAllowSelectMultiple() Returns whether multiple nodes can be selected.
boolean	isNodeExpanded(javax.swing.tree.TreeNode node) Returns true if the given node is expanded.
boolean	isNodeSelected(javax.swing.tree.TreeNode node) Returns true if the given node is selected, false otherwise.
void	removeTreeStateListener(ITreeStateListener l) Removes a tree state listener.
void	selectNode(javax.swing.tree.TreeNode node, boolean selected) Marks given node as selected (or unselected) according to the selected value.
void	setAllowSelectMultiple(boolean value) Sets whether multiple nodes can be selected.

Method Detail

addTreeStateListener

public void addTreeStateListener(ITreeStateListener l)

Adds a tree state listener. On state change events on the listener are fired.

Parameters:

l - Listener to add

collapseAll

public void collapseAll()

Collapses all nodes of the tree.

collapseNode

public void collapseNode(javax.swing.tree.TreeNode node)

Collapses the given node.

Parameters:

node - Node to collapse

expandAll

public void expandAll()

Expands all nodes of the tree.

expandNode

public void expandNode(javax.swing.tree.TreeNode node)

Expands the given node.

Parameters:

node - Node to expand

getSelectedNodes

public java.util.Collection getSelectedNodes()

Returns the collection of all selected nodes.

Returns:

The collection of selected nodes

isAllowSelectMultiple

public boolean isAllowSelectMultiple()

Returns whether multiple nodes can be selected.

Returns:

True if mutliple nodes can be selected

isNodeExpanded

public boolean isNodeExpanded(javax.swing.tree.TreeNode node)

Returns true if the given node is expanded.

Parameters:

node - The node to inspect

Returns:

True if the node is expanded

isNodeSelected

public boolean isNodeSelected(javax.swing.tree.TreeNode node)

Returns true if the given node is selected, false otherwise.

Parameters:

node - The node to inspect

Returns:

True if the node is selected

removeTreeStateListener

public void removeTreeStateListener(ITreeStateListener l)

Removes a tree state listener.

Parameters:

l - The listener to remove

selectNode

public void selectNode(javax.swing.tree.TreeNode node,
                       boolean selected)

Marks given node as selected (or unselected) according to the selected value.

If tree is in single selection mode and a new node is selected, old node is automatically unselected (and the event is fired on listeners).

Parameters:

node - The node to select or deselect

selected - If true, the node will be selected, otherwise, the node will be unselected

setAllowSelectMultiple

public void setAllowSelectMultiple(boolean value)

Sets whether multiple nodes can be selected.

Parameters:

value - If true, multiple nodes can be selected. If false, only one node at a time can be selected