com.ibm.portal.state.accessors.expansionstates
Interface ExpansionStatesAccessor
- All Superinterfaces:
- Accessor, Disposable
- All Known Subinterfaces:
- ExpansionStatesAccessorController
public interface ExpansionStatesAccessor
- extends Accessor
Interface providing read-only access to navigation expansion information. The
information is read from the StateHolder
or
DocumentModel this accessor operates on.
In particular, this accessor allows for checking whether a certain navigation
node has been marked as "toggled" in the state. Navigation nodes are marked
as "toggled" in case that their expansion state diverges from the default expansion
state that can be configured. For example, if the default expansion state is
"collapsed" the method isToggled()
returns true
if the
respective navigation node is expanded.
- Since:
- 5.1
Method Summary |
java.util.Set |
getToggled()
Returns an unmodifiable Set containing the
ObjectID s of all navigation nodes that are marked as
"toggled" in the state holder this accessor operates on. |
boolean |
isExpanded(ObjectID objectID)
Deprecated. since 6.0, use method isToggled(ObjectID) instead |
boolean |
isExpanded(java.lang.String uniqueName)
Deprecated. since 6.0, use method isToggled(String) instead |
boolean |
isToggled(ObjectID objectID)
Checks whether the navigation node with the given ObjectID
is marked as "toggled" in the state holder. |
boolean |
isToggled(java.lang.String uniqueName)
Checks whether the navigation node with the given unique name
is marked as "toggled" in the state holder. |
isExpanded
boolean isExpanded(ObjectID objectID)
- Deprecated. since 6.0, use method
isToggled(ObjectID)
instead
- Checks whether the navigation node with the given
ObjectID
is expanded or not.
- Parameters:
objectID
- The object identifier of a node
(must not be null
).
- Returns:
true
if the addressed node is expanded,
otherwise false
.
isExpanded
boolean isExpanded(java.lang.String uniqueName)
throws MissingUniqueNameException,
UnknownUniqueNameException
- Deprecated. since 6.0, use method
isToggled(String)
instead
- Checks whether the navigation node with the given
uniqueName
is expanded or not.
- Parameters:
uniqueName
- The object identifier of a node
(must not be null
).
- Returns:
true
if the addressed node is expanded,
otherwise false
.
- Throws:
UnknownUniqueNameException
- - the unique name could not be mapped to an object ID
MissingUniqueNameException
- - the unique name was null or empty
isToggled
boolean isToggled(ObjectID objectID)
- Checks whether the navigation node with the given
ObjectID
is marked as "toggled" in the state holder. "Toggled" means that
the expansion state of the addressed node diverges from the configured
default expansion state. For example, if the default expansion state is
"collapsed", this method will return true
if the current
expansion state of the node is "expanded".
- Parameters:
objectID
- The ObjectID
of the navigation node that should
be checked. Must not be null
.
- Returns:
true
if the navigation node is marked "toggled" in
the state, false
otherwise.
isToggled
boolean isToggled(java.lang.String uniqueName)
throws MissingUniqueNameException,
UnknownUniqueNameException
- Checks whether the navigation node with the given unique name
is marked as "toggled" in the state holder. "Toggled" means that
the expansion state of the addressed node diverges from the configured
default expansion state. For example, if the default expansion state is
"collapsed", this method will return
true
if the current
expansion state of the node is "expanded".
- Parameters:
uniqueName
- String
representing the unique name of the
navigation node that should be checked. Must not be
null
.
- Returns:
true
if the navigation node is marked "toggled" in
the state, false
otherwise.
- Throws:
UnknownUniqueNameException
- If the unique name cannot be mapped to an
ObjectID
.
MissingUniqueNameException
- If the unique name was null
or empty.
getToggled
java.util.Set getToggled()
- Returns an unmodifiable
Set
containing the
ObjectID
s of all navigation nodes that are marked as
"toggled" in the state holder this accessor operates on. That means that
the list will contain the ObjectID
s of those navigation
nodes that diverge from the default expansion state. Returns an empty
Set
if no such nodes can be found.
- Returns:
- An unmodifiable
Set
containing
ObjectID
s. Not null
.