com.waveset.ui.util
Interface ITreeStateManager


public interface ITreeStateManager

Interface that allows interested clients to query the owner of a tree as to whether a specific node is selected or expanded.


Field Summary
static java.lang.String code_id
           
 
Method Summary
 boolean getAllowSorting(java.lang.String treeName)
           
 java.util.List getColumnNames(RequestState state, java.lang.String treeName)
           
 java.util.List getColumnNames(java.lang.String treeName)
           
 java.util.List getDisplayColumnNames(RequestState state, java.lang.String treeName)
           
 java.util.List getDisplayColumnNames(java.lang.String treeName)
           
 boolean getRenderTreeFlat(java.lang.String treeName)
          Causes the tree to be rendered flat
 java.lang.String[] getSelectedNodeNames(java.lang.String treeNames)
           
 java.lang.String getSortedColumn(java.lang.String treeName)
           
 java.lang.Object getTreeNodePartiallyDisplayedCookie(java.lang.String treeName, java.lang.String nodeName)
          Tells the client the cookie value for this node.
 int getTreeNodePartiallyDisplayedListSize(java.lang.String treeName, java.lang.String nodeName)
          Tells the client the total request size of this partially displayed paged display.
 int getTreeNodePartiallyDisplayedTargetOffset(java.lang.String treeName, java.lang.String nodeName)
          Tells the client the target offset for the current page to display.
 boolean isSortAscending(java.lang.String treeName)
           
 boolean isSortDescending(java.lang.String treeName)
           
 boolean isSortedOnColumn(java.lang.String treeName)
           
 boolean isSortedOnTree(java.lang.String treeName)
           
 boolean isTreeNodeExpanded(java.lang.String treeName, java.lang.String nodeName)
          Tells the client whether the node specified by name is expanded.
 boolean isTreeNodeParentOfSelected(java.lang.String treeName, java.lang.String nodeName)
          Tells the client whether the node specified by name is parent of a selected node.
 boolean isTreeNodePartiallyDisplayed(java.lang.String treeName, java.lang.String nodeName)
          Tells the client whether the node is a multi page node.
 boolean isTreeNodeSelected(java.lang.String treeName, java.lang.String nodeName)
          Tells the client whether the node specified by name is selected.
 

Field Detail

code_id

public static final java.lang.String code_id
See Also:
Constant Field Values
Method Detail

getRenderTreeFlat

public boolean getRenderTreeFlat(java.lang.String treeName)
Causes the tree to be rendered flat

Parameters:
treeName -
Returns:

isSortedOnTree

public boolean isSortedOnTree(java.lang.String treeName)

isSortedOnColumn

public boolean isSortedOnColumn(java.lang.String treeName)

getSortedColumn

public java.lang.String getSortedColumn(java.lang.String treeName)

getColumnNames

public java.util.List getColumnNames(java.lang.String treeName)

getColumnNames

public java.util.List getColumnNames(RequestState state,
                                     java.lang.String treeName)

getDisplayColumnNames

public java.util.List getDisplayColumnNames(java.lang.String treeName)

getDisplayColumnNames

public java.util.List getDisplayColumnNames(RequestState state,
                                            java.lang.String treeName)

getAllowSorting

public boolean getAllowSorting(java.lang.String treeName)

isSortAscending

public boolean isSortAscending(java.lang.String treeName)

isSortDescending

public boolean isSortDescending(java.lang.String treeName)

isTreeNodeSelected

public boolean isTreeNodeSelected(java.lang.String treeName,
                                  java.lang.String nodeName)
Tells the client whether the node specified by name is selected.

Parameters:
treeName - The identifier for the tree
nodeName - The identifier for the node.
Returns:
true or false.

getSelectedNodeNames

public java.lang.String[] getSelectedNodeNames(java.lang.String treeNames)

isTreeNodeParentOfSelected

public boolean isTreeNodeParentOfSelected(java.lang.String treeName,
                                          java.lang.String nodeName)
Tells the client whether the node specified by name is parent of a selected node.

Parameters:
treeName - The identifier for the tree
nodeName - The identifier for the node.
Returns:
true or false.

isTreeNodeExpanded

public boolean isTreeNodeExpanded(java.lang.String treeName,
                                  java.lang.String nodeName)
Tells the client whether the node specified by name is expanded.

Parameters:
treeName - The identifier for the tree.
nodeName - The identifier for the node.
Returns:
true or false.

isTreeNodePartiallyDisplayed

public boolean isTreeNodePartiallyDisplayed(java.lang.String treeName,
                                            java.lang.String nodeName)
Tells the client whether the node is a multi page node.

Parameters:
treeName -
nodeName -
Returns:

getTreeNodePartiallyDisplayedTargetOffset

public int getTreeNodePartiallyDisplayedTargetOffset(java.lang.String treeName,
                                                     java.lang.String nodeName)
Tells the client the target offset for the current page to display.

Parameters:
treeName -
nodeName -
Returns:

getTreeNodePartiallyDisplayedCookie

public java.lang.Object getTreeNodePartiallyDisplayedCookie(java.lang.String treeName,
                                                            java.lang.String nodeName)
Tells the client the cookie value for this node.

Parameters:
treeName -
nodeName -
Returns:

getTreeNodePartiallyDisplayedListSize

public int getTreeNodePartiallyDisplayedListSize(java.lang.String treeName,
                                                 java.lang.String nodeName)
Tells the client the total request size of this partially displayed paged display.

Parameters:
treeName -
nodeName -
Returns: