Decision Center API

ilog.rules.teamserver.web.tree
Interface IlrTreeStateProvider

All Known Implementing Classes:
IlrDefaultTreeStateProvider

public interface IlrTreeStateProvider

A tree state provider is a representation of the current state of the tree component.

This provider handles the expand/collapse state and the current selection.

See Also:
IlrTreeController.getTreeStateProvider()

Method Summary
 void collapseNode(String nodeId)
          Collapses the node with a given ID.
 void expandNode(String nodeId)
          Expands the node with a given ID.
 String getSelectedNodeId()
          Returns the ID of the currently selected node.
 boolean isExpanded(String nodeId)
          Indicates if a node with a given ID is expanded or collapsed.
 boolean isSelected(String nodeId)
          Indicates if the node with a given ID is selected.
 void reset()
          Resets the state of the tree component.
 void selectNode(String nodeId)
          Selects the node with a given ID.
 

Method Detail

isExpanded

boolean isExpanded(String nodeId)
Indicates if a node with a given ID is expanded or collapsed.

Parameters:
nodeId - The ID of the node.
Returns:
true if the node with a given ID is expanded, and false otherwise.

expandNode

void expandNode(String nodeId)
Expands the node with a given ID.

Parameters:
nodeId - The ID of the node.

collapseNode

void collapseNode(String nodeId)
Collapses the node with a given ID.

Parameters:
nodeId - The ID of the node.

getSelectedNodeId

String getSelectedNodeId()
Returns the ID of the currently selected node.

Returns:
The ID of the currently selected node, or null if no node is selected.
See Also:
selectNode(String)

selectNode

void selectNode(String nodeId)
Selects the node with a given ID.

Parameters:
nodeId - The ID of the node.
See Also:
getSelectedNodeId()

isSelected

boolean isSelected(String nodeId)
Indicates if the node with a given ID is selected.

Parameters:
nodeId - The ID of the node.
Returns:
true if the node with a given ID is selected, and false otherwise.
See Also:
selectNode(String)

reset

void reset()
Resets the state of the tree component.


Decision Center API

© Copyright IBM Corp. 1987, 2013