org.apache.wicket.extensions.markup.html.tree

Interface ITreeState

All Superinterfaces:

Serializable

All Known Implementing Classes:

DefaultTreeState

Deprecated.

@Deprecated
public interface ITreeState
extends Serializable

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

Methods

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

Method Detail

addTreeStateListener

void addTreeStateListener(ITreeStateListener l)

Deprecated.

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

Parameters:

l - Listener to add

collapseAll

void collapseAll()

Deprecated.

Collapses all nodes of the tree.

collapseNode

void collapseNode(Object node)

Deprecated.

Collapses the given node.

Parameters:

node - Node to collapse

expandAll

void expandAll()

Deprecated.

Expands all nodes of the tree.

expandNode

void expandNode(Object node)

Deprecated.

Expands the given node.

Parameters:

node - Node to expand

getSelectedNodes

Collection<Object> getSelectedNodes()

Deprecated.

Returns the collection of all selected nodes.

Returns:

The collection of selected nodes

isAllowSelectMultiple

boolean isAllowSelectMultiple()

Deprecated.

Returns whether multiple nodes can be selected.

Returns:

True if multiple nodes can be selected

isNodeExpanded

boolean isNodeExpanded(Object node)

Deprecated.

Returns true if the given node is expanded.

Parameters:

node - The node to inspect

Returns:

True if the node is expanded

isNodeSelected

boolean isNodeSelected(Object node)

Deprecated.

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

Parameters:

node - The node to inspect

Returns:

True if the node is selected

removeTreeStateListener

void removeTreeStateListener(ITreeStateListener l)

Deprecated.

Removes a tree state listener.

Parameters:

l - The listener to remove

selectNode

void selectNode(Object node,
              boolean selected)

Deprecated.

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

void setAllowSelectMultiple(boolean value)

Deprecated.

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