com.ibm.portal.state.accessors.selection
Interface SelectionAccessorFactory

All Superinterfaces:

AccessorFactory

public interface SelectionAccessorFactory
extends AccessorFactory

Factory that provides read-only as well as read-write accessors to selection information. The so-called selection denotes the navigation element the user has currently selected. Typically the selection refers to a portal page or label.

Since:

5.1

Method Summary

SelectionAccessor	getSelection(Node root, DocumentModel model) Deprecated. since 6.0, use method getSelectionAccessor(Node, DocumentModel) instead
SelectionAccessor	getSelection(StateHolder state) Deprecated. since 6.0, use method getSelectionAccessor(StateHolder) instead
SelectionAccessor	getSelectionAccessor(Node root, DocumentModel model) Provides an accessor that allows for reading the selection information from the navigational state using the given DocumentModel interface.
SelectionAccessor	getSelectionAccessor(StateHolder state) Provides an accessor that allows for reading the selection information from the navigational state using the given StateHolder interface.
SelectionAccessorController	getSelectionAccessorController(Node root, DocumentController model) Provides a controller that allows for reading and writing selection information from /to the navigational state using the given DocumentController interface.
SelectionAccessorController	getSelectionAccessorController(StateHolderController state) Provides a controller that allows for reading and writing selection information from /to the navigational state using the given StateHolderController interface.
SelectionAccessorController	getSelectionController(Node root, DocumentController model) Deprecated. since 6.0, use method getSelectionAccessorController(Node, DocumentController) instead
SelectionAccessorController	getSelectionController(StateHolderController state) Deprecated. since 6.0, use method getSelectionAccessorController(StateHolderController) instead

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

compact

Method Detail

getSelectionAccessor

SelectionAccessor getSelectionAccessor(StateHolder state)

Provides an accessor that allows for reading the selection information from the navigational state using the given StateHolder interface. The returned accessor operates on the default selection node in the state hierarchy.

Parameters:

state - State holder that contains the selection. Must not be null.

Returns:

Read-only accessor to the current selection. Not null.

getSelectionAccessor

SelectionAccessor getSelectionAccessor(Node root,
                                       DocumentModel model)

Provides an accessor that allows for reading the selection information from the navigational state using the given DocumentModel interface. The returned accessor operates on the subtree rooted at the given node i.e. it expects the selection information to be located in that subtree.

Parameters:

root - Root node for selection information. Must not be null.

model - Model that contains the given root. Must not be null.

Returns:

Read-only accessor to the current selection. Not null.

getSelectionAccessorController

SelectionAccessorController getSelectionAccessorController(StateHolderController state)

Provides a controller that allows for reading and writing selection information from /to the navigational state using the given StateHolderController interface.

Parameters:

state - State holder that contains the selection and allows to modify it. Must not be null.

Returns:

Read-write accessor to the selection state. Not null.

getSelectionAccessorController

SelectionAccessorController getSelectionAccessorController(Node root,
                                                           DocumentController model)

Provides a controller that allows for reading and writing selection information from /to the navigational state using the given DocumentController interface. The returned controller operates on the subtree rooted at the given node.

Parameters:

root - Root node for selection information. Must not be null.

model - Model that contains the root. Must not be null.

Returns:

Read-write accessor to the selection state. Not null.

getSelection

SelectionAccessor getSelection(StateHolder state)

Deprecated. since 6.0, use method getSelectionAccessor(StateHolder) instead

Provides an accessor that allows for reading the selection information from the navigational state using the given StateHolder interface. The returned accessor operates on the default selection node in the state hierarchy.

Parameters:

state - State holder that contains the selection. Must not be null.

Returns:

Read-only accessor to the current selection. Not null.

getSelection

SelectionAccessor getSelection(Node root,
                               DocumentModel model)

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

Provides an accessor that allows for reading the selection information from the navigational state using the given DocumentModel interface. The returned accessor operates on the subtree rooted at the given node i.e. it expects the selection information to be located in that subtree.

Parameters:

root - Root node for selection information. Must not be null.

model - Model that contains the given root. Must not be null.

Returns:

Read-only accessor to the current selection. Not null.

getSelectionController

SelectionAccessorController getSelectionController(StateHolderController state)

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

Provides a controller that allows for reading and writing selection information from /to the navigational state using the given StateHolderController interface.

Parameters:

state - State holder that contains the selection and allows to modify it. Must not be null.

Returns:

Read-write accessor to the selection state. Not null.

getSelectionController

SelectionAccessorController getSelectionController(Node root,
                                                   DocumentController model)

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

Provides a controller that allows for reading and writing selection information from /to the navigational state using the given DocumentController interface. The returned controller operates on the subtree rooted at the given node.

Parameters:

root - Root node for selection information. Must not be null.

model - Model that contains the root. Must not be null.

Returns:

Read-write accessor to the selection state. Not null.