com.cc.framework.ui.model
Interface TreeStateModel

All Superinterfaces:
StateModel
All Known Subinterfaces:
TreelistStateModel
All Known Implementing Classes:
TreeControl, TreelistControl, TreelistStateModelImp, TreeStateModelImp

public interface TreeStateModel
extends StateModel

Interface TreeStateModel

Since:
1.0
Version:
$Revision: 1.16 $
Author:
Harald Schulz

Field Summary
static java.lang.String PROP_EXPANDED
          State property for the expanded nodes
static java.lang.String PROP_SELECTED
          State property for the selected node
 
Fields inherited from interface com.cc.framework.ui.model.StateModel
PROP_CONTROL
 
Method Summary
 void collapse(java.lang.String nodeKey)
          The specified group node will be collapsed
 void collapseAll()
          Collapses all tree nodes
 void expand(java.lang.String nodeKey)
          The specified group node will be expanded
 java.lang.String[] getMarked()
          Retrieves all marked items
 java.lang.String getSelected()
          Returns the key of the selected node
 boolean isExpanded(java.lang.String nodeKey)
          Checks if the specified group node is expanded
 boolean isMarked(java.lang.String nodeKey)
          Checks if the specified row is highlighted.
 boolean isSelected(java.lang.String nodeKey)
          Checks if the specified node is selected.
 void mark(java.lang.String uniqueKey)
          Selects a specified row.
 void select(java.lang.String nodeKey)
          Selects the specified node.
 void unmark(java.lang.String nodeKey)
          Highlights a specified row.
 void unmarkAll()
          Resets all highlighted rows
 void unselectAll()
          Unselects the current selection of the tree
 
Methods inherited from interface com.cc.framework.ui.model.StateModel
reset, synchronizeState
 

Field Detail

PROP_EXPANDED

public static final java.lang.String PROP_EXPANDED
State property for the expanded nodes

See Also:
Constant Field Values

PROP_SELECTED

public static final java.lang.String PROP_SELECTED
State property for the selected node

See Also:
Constant Field Values
Method Detail

isExpanded

public boolean isExpanded(java.lang.String nodeKey)
Checks if the specified group node is expanded

Parameters:
nodeKey - the nodes unique key
Returns:
boolean

expand

public void expand(java.lang.String nodeKey)
The specified group node will be expanded

Parameters:
nodeKey - the nodes unique key

collapseAll

public void collapseAll()
Collapses all tree nodes


collapse

public void collapse(java.lang.String nodeKey)
The specified group node will be collapsed

Parameters:
nodeKey - the nodes unique key

select

public void select(java.lang.String nodeKey)
Selects the specified node. Within a tree there can only exists one selected node

Parameters:
nodeKey - the nodes unique key

unselectAll

public void unselectAll()
Unselects the current selection of the tree


isSelected

public boolean isSelected(java.lang.String nodeKey)
Checks if the specified node is selected.

Parameters:
nodeKey - the nodes unique key
Returns:
boolean

getSelected

public java.lang.String getSelected()
Returns the key of the selected node

Returns:
Key or null

mark

public void mark(java.lang.String uniqueKey)
Selects a specified row.

Parameters:
uniqueKey - The unique key of the row which should be selected

isMarked

public boolean isMarked(java.lang.String nodeKey)
Checks if the specified row is highlighted.

Parameters:
nodeKey - the nodes unique key
Returns:
boolean Returns true if the row is selected; false otherwise

getMarked

public java.lang.String[] getMarked()
Retrieves all marked items

Returns:
Array with the keys of the marked items

unmark

public void unmark(java.lang.String nodeKey)
Highlights a specified row.

Parameters:
nodeKey - the nodes unique key

unmarkAll

public void unmarkAll()
Resets all highlighted rows



Copyright © 2000-2005 SCC Informationssysteme GmbH. All Rights Reserved.