com.ibm.portal.navigation
Interface SelectionModel<T>
- All Superinterfaces:
- Invalidatable, InvalidatableListModel<T>, ListModel<T>, LocatorProvider<T>, SearchableListModel<T>
- All Known Subinterfaces:
- NavigationSelectionModel<E>
-
public interface SelectionModel<T>
- extends SearchableListModel<T>, InvalidatableListModel<T>
A list model representing a selection in a tree. This model describes all elements
of a tree model that are elements of the selection path. The selection path consists
of elements from the tree model where there is exactly one element of the tree model
for each level in that tree between the start and the end of the selection path. "Level"
is the number of elements needed to reach an element of that level counted from the root.
The selected node, if any exists, is always the last element of the selection path. The
following figure depicts the relationship between a selection model and the associated
tree model:
Only elements obtained from the selection model or its associated model are valid
input parameters to the model methods.
- Since:
- 5.1.0.1
|
Method Summary
|
|
T |
getSelectedNode()
Return the currently selected node in the list model. |
|
boolean |
isNodeInSelectionPath(T anObject)
Returns whether the given node is part of the selection path. |
|
boolean |
isNodeSelected(T anObject)
Returns whether the given node is selected. |
isNodeSelected
boolean isNodeSelected(T anObject)
- Returns whether the given node is selected.
If true, this means that the node is the final element of the list that makes
up the selection path.
- Parameters:
- anObject - the node to check
- Returns:
- true if the element is selected,
false otherwise
isNodeInSelectionPath
boolean isNodeInSelectionPath(T anObject)
- Returns whether the given node is part of the selection path.
- Parameters:
- anObject - the node to check
- Returns:
- true if the element is in the selection path
false otherwise.
getSelectedNode
T getSelectedNode()
- Returns the currently selected node in the list model.
- Returns:
- the currently selected node.