|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface SelectionAccessorFactory
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.
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 |
---|
SelectionAccessor getSelectionAccessor(StateHolder state)
StateHolder
interface. The returned accessor operates on the default selection node
in the state hierarchy.
state
- State holder that contains the selection. Must not be
null
.
null
.SelectionAccessor getSelectionAccessor(Node root, DocumentModel model)
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.
root
- Root node for selection information. Must not be
null
.model
- Model that contains the given root. Must not be
null
.
null
.SelectionAccessorController getSelectionAccessorController(StateHolderController state)
StateHolderController
interface.
state
- State holder that contains the selection and allows to modify
it. Must not be null
.
null
.SelectionAccessorController getSelectionAccessorController(Node root, DocumentController model)
DocumentController
interface. The returned controller
operates on the subtree rooted at the given node.
root
- Root node for selection information. Must not be
null
.model
- Model that contains the root. Must not be null
.
null
.SelectionAccessor getSelection(StateHolder state)
getSelectionAccessor(StateHolder)
instead
StateHolder
interface. The returned accessor operates on the default selection node
in the state hierarchy.
state
- State holder that contains the selection. Must not be
null
.
null
.SelectionAccessor getSelection(Node root, DocumentModel model)
getSelectionAccessor(Node, DocumentModel)
instead
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.
root
- Root node for selection information. Must not be
null
.model
- Model that contains the given root. Must not be
null
.
null
.SelectionAccessorController getSelectionController(StateHolderController state)
getSelectionAccessorController(StateHolderController)
instead
StateHolderController
interface.
state
- State holder that contains the selection and allows to modify
it. Must not be null
.
null
.SelectionAccessorController getSelectionController(Node root, DocumentController model)
getSelectionAccessorController(Node, DocumentController)
instead
DocumentController
interface. The returned controller
operates on the subtree rooted at the given node.
root
- Root node for selection information. Must not be
null
.model
- Model that contains the root. Must not be null
.
null
.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |