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

All Superinterfaces:

AccessorFactory

public interface ExpansionStatesAccessorFactory
extends AccessorFactory

Factory interface which provides methods to obtain accessors to read /write navigation expansion information from /to a given state holder or document model.
For instance the controllers may be used to create EngineURLs that modify the expansion states of navigation nodes. Just request a controller that operates on the state holder /document model that has been associated with the respective EngineURL.
The read-only accessors may be used to read the expansion states of navigation nodes. This might be helpful when implementing custom navigation UI controls.

Since:

5.1

Method Summary

ExpansionStatesAccessor	getExpansionStates(Node root, DocumentModel model) Deprecated. since 6.0, use method getExpansionStatesAccessor(Node, DocumentModel) instead
ExpansionStatesAccessor	getExpansionStates(StateHolder state) Deprecated. since 6.0, use the method getExpansionStatesAccessor(StateHolder) instead
ExpansionStatesAccessor	getExpansionStatesAccessor(Node root, DocumentModel model) Returns an interface providing read access to the expansion states of navigation nodes.
ExpansionStatesAccessor	getExpansionStatesAccessor(StateHolder state) Returns an interface providing read access to the expansion states of navigation nodes.
ExpansionStatesAccessorController	getExpansionStatesAccessorController(Node root, DocumentController model) Returns an interface providing read-write access to the expansion states of navigation nodes.
ExpansionStatesAccessorController	getExpansionStatesAccessorController(StateHolderController state) Returns an interface providing read-write access to the expansion states of navigation nodes.
ExpansionStatesAccessorController	getExpansionStatesController(Node root, DocumentController model) Deprecated. since 6.0, use method getExpansionStatesAccessorController(Node, DocumentController) instead
ExpansionStatesAccessorController	getExpansionStatesController(StateHolderController state) Deprecated. since 6.0, use method getExpansionStatesAccessorController(StateHolderController) instead

Methods inherited from interface com.ibm.portal.state.accessors.AccessorFactory

compact

Method Detail

getExpansionStatesAccessor

ExpansionStatesAccessor getExpansionStatesAccessor(StateHolder state)

Returns an interface providing read access to the expansion states of navigation nodes. The information is read from the given state holder.

Parameters:

state - Read-only interface to untyped state document model. Must not be null.

Returns:

Read-only interface to expansion state information. Not null.

getExpansionStatesAccessor

ExpansionStatesAccessor getExpansionStatesAccessor(Node root,
                                                   DocumentModel model)

Returns an interface providing read access to the expansion states of navigation nodes. The information is read from the given node being part of the given document model.

Parameters:

root - Node representing the root of expansion state information (must not be null).

model - The state document model which contains root. Must not be null.

Returns:

Read-only interface to expansion state information. Not null.

getExpansionStatesAccessorController

ExpansionStatesAccessorController getExpansionStatesAccessorController(StateHolderController state)

Returns an interface providing read-write access to the expansion states of navigation nodes. The returned controller will operate on the given state holder.

Parameters:

state - Read-write interface to untyped state document model. Must not be null.

Returns:

Read-write interface to expansion state information. Not null.

getExpansionStatesAccessorController

ExpansionStatesAccessorController getExpansionStatesAccessorController(Node root,
                                                                       DocumentController model)

Returns an interface providing read-write access to the expansion states of navigation nodes. The returned controller will operate on the given document model.

Parameters:

root - Node representing the root of expansion state information (must not be null).

model - The modifiable state document model which contains root. Must not be null.

Returns:

Read-only interface to expansion state information. Not null.

getExpansionStates

ExpansionStatesAccessor getExpansionStates(StateHolder state)

Deprecated. since 6.0, use the method getExpansionStatesAccessor(StateHolder) instead

Returns an interface providing read access to the expansion states of navigation nodes. The information is read from the given state holder.

Parameters:

state - Read-only interface to untyped state document model. Must not be null.

Returns:

Read-only interface to expansion state information. Not null.

getExpansionStates

ExpansionStatesAccessor getExpansionStates(Node root,
                                           DocumentModel model)

Deprecated. since 6.0, use method getExpansionStatesAccessor(Node, DocumentModel) instead

Returns an interface providing read access to the expansion states of navigation nodes. The information is read from the given node being part of the given document model.

Parameters:

root - Node representing the root of expansion state information (must not be null).

model - The state document model which contains root. Must not be null.

Returns:

Read-only interface to expansion state information. Not null.

getExpansionStatesController

ExpansionStatesAccessorController getExpansionStatesController(StateHolderController state)

Deprecated. since 6.0, use method getExpansionStatesAccessorController(StateHolderController) instead

Returns an interface providing read-write access to the expansion states of navigation nodes. The returned controller will operate on the given state holder.

Parameters:

state - Read-write interface to untyped state document model. Must not be null.

Returns:

Read-write interface to expansion state information. Not null.

getExpansionStatesController

ExpansionStatesAccessorController getExpansionStatesController(Node root,
                                                               DocumentController model)

Deprecated. since 6.0, use method getExpansionStatesAccessorController(Node, DocumentController) instead

Returns an interface providing read-write access to the expansion states of navigation nodes. The returned controller will operate on the given document model.

Parameters:

root - Node representing the root of expansion state information (must not be null).

model - The modifiable state document model which contains root. Must not be null.

Returns:

Read-only interface to expansion state information. Not null.