com.ibm.portal.state.accessors.expansionstates
Interface ExpansionStatesAccessorController

All Superinterfaces:

Accessor, Disposable, ExpansionStatesAccessor

public interface ExpansionStatesAccessorController
extends ExpansionStatesAccessor

Controller providing read-write access to navigation expansion information. The information is written to the state holder /document model this controller operates on.
This controller allows for marking navigation nodes as "toggled" which means that the expansion states of these nodes diverges from the default expansion state that can be configured. For example, if the default expansion state is "collapsed" this controller will only mark nodes in the state that are "expanded".

Since:

5.1

Method Summary

java.util.Set	getToggled() Returns a modifiable Set containing the ObjectIDs of all navigation nodes that are marked as "toggled" in the state holder this accessor operates on.
void	setExpansionState(ListModel objectIDSet, boolean newExpansionState) Deprecated. since 6.0, use method setToggled(ObjectID) instead
void	setExpansionState(ObjectID objectID, boolean newExpansionState) Deprecated. since 6.0, use method setToggled(ObjectID) instead
void	setExpansionState(java.lang.String uniqueName, boolean newExpansionState) Deprecated. since 6.0, use method setToggled(String) instead
void	setToggled(ObjectID objectID, boolean toggled) Sets the toggle state of the navigation node that corresponds with the given ObjectID according to the given toggled flag.
void	setToggled(java.lang.String uniqueName, boolean toggled) Sets the toggle state of the navigation node that corresponds with the given unique name according to the given toggled flag.

Methods inherited from interface com.ibm.portal.state.accessors.expansionstates.ExpansionStatesAccessor

isExpanded, isExpanded, isToggled, isToggled

Methods inherited from interface com.ibm.portal.Disposable

dispose

Method Detail

setExpansionState

void setExpansionState(ObjectID objectID,
                       boolean newExpansionState)

Deprecated. since 6.0, use method setToggled(ObjectID) instead

Modifies the expansion state of the navigation node which corresponds to the given ObjectID.

Parameters:

objectID - The ObjectID identifying the navigation node to be modified (must not be null).

newExpansionState - The new expansion state which should be set.

setExpansionState

void setExpansionState(java.lang.String uniqueName,
                       boolean newExpansionState)
                       throws MissingUniqueNameException,
                              UnknownUniqueNameException

Deprecated. since 6.0, use method setToggled(String) instead

Modifies the expansion state of the navigation node which corresponds to the given uniqueName.

Parameters:

uniqueName - The uniqueName identifying the navigation node to be modified (must not be null).

newExpansionState - The new expansion state which should be set.

Throws:

UnknownUniqueNameException - - the unique name could not be mapped to an object ID

MissingUniqueNameException - - the unique name was null or empty

setExpansionState

void setExpansionState(ListModel objectIDSet,
                       boolean newExpansionState)

Deprecated. since 6.0, use method setToggled(ObjectID) instead

Modifies the expansion states of a given (unordered) set of ObjectIDs representing navigation nodes.

Parameters:

objectIDSet - A ListModel representing an unordered set of ObjectIDs representing navigation nodes (must not be null but may be empty).

newExpansionState - The new expansion state which should be set for all nodes addessed by anObjectIDSet.

setToggled

void setToggled(ObjectID objectID,
                boolean toggled)

Sets the toggle state of the navigation node that corresponds with the given ObjectID according to the given toggled flag.

Parameters:

objectID - ObjectID of the navigation node that should be modified. Must not be null.

toggled - Flag indicating whether the addressed navigation node should be marked as "toggled" or not. true indicates that the node should be marked as "toggled" in the state. false means that the addressed navigation node must no longer be marked as "toggled" after invoking this method.

setToggled

void setToggled(java.lang.String uniqueName,
                boolean toggled)
                throws MissingUniqueNameException,
                       UnknownUniqueNameException

Sets the toggle state of the navigation node that corresponds with the given unique name according to the given toggled flag.

Parameters:

uniqueName - String representing the unique name of the navigation node that should be toggled. Must not be null.

toggled - Flag indicating whether the addressed navigation node should be marked as "toggled" or not. true indicates that the node should be marked as "toggled" in the state. false means that the addressed navigation node must no longer be marked as "toggled" after invoking this method.

Throws:

UnknownUniqueNameException - If the unique name cannot be mapped to an ObjectID.

MissingUniqueNameException - If the unique name is null or empty.

getToggled

java.util.Set getToggled()

Returns a modifiable Set containing the ObjectIDs of all navigation nodes that are marked as "toggled" in the state holder this accessor operates on. Returns an empty Set if no such nodes can be found.

Specified by:

getToggled in interface ExpansionStatesAccessor

Returns:

An modifiable Set containing ObjectIDs. Not null.