com.ibm.portal.state.accessors.showtools
Interface ShowToolsAccessorFactory

All Superinterfaces:

AccessorFactory

public interface ShowToolsAccessorFactory
extends AccessorFactory

Factory providing read-only as well as read-write accessors to the Show Tools flag in the navigational state. If Show Tools is enabled the decorations (skin) of portlet windows provide additional icons to modify the page layout in-place, e.g. to move the portlet, to delete it etc.

Since:

5.1

Method Summary

ShowToolsAccessor	getShowTools(Node root, DocumentModel model) Deprecated. since 6.0, use method getShowToolsAccessor(Node, DocumentModel) instead
ShowToolsAccessor	getShowTools(StateHolder state) Deprecated. since 6.0, use method getShowToolsAccessor(StateHolder) instead
ShowToolsAccessor	getShowToolsAccessor(Node root, DocumentModel model) Provides an accessor that allows for reading the value of the Show Tools flag from the navigational state using the given DocumentModel interface.
ShowToolsAccessor	getShowToolsAccessor(StateHolder state) Provides an accessor that allows for reading the value of the Show Tools flag from the navigational state using the given StateHolder interface.
ShowToolsAccessorController	getShowToolsAccessorController(Node root, DocumentController model) Provides a controller that allows for reading and writing the value of the Show Tools flag from /to the navigational state using the given DocumentController interface.
ShowToolsAccessorController	getShowToolsAccessorController(StateHolderController state) Provides a controller that allows for reading and writing the value of the Show Tools flag from /to the navigational state using the given StateHolderController interface.
ShowToolsAccessorController	getShowToolsController(Node root, DocumentController model) Deprecated. since 6.0, use method getShowToolsAccessorController(Node, DocumentController) instead
ShowToolsAccessorController	getShowToolsController(StateHolderController state) Deprecated. since 6.0, use method getShowToolsAccessorController(StateHolderController) instead

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

compact

Method Detail

getShowToolsAccessor

ShowToolsAccessor getShowToolsAccessor(StateHolder state)

Provides an accessor that allows for reading the value of the Show Tools flag from the navigational state using the given StateHolder interface.

Parameters:

state - State holder that contains the Show Tools flag. Must not be null.

Returns:

A read-only accessor to the Show Tools flag. Not null.

getShowToolsAccessor

ShowToolsAccessor getShowToolsAccessor(Node root,
                                       DocumentModel model)

Provides an accessor that allows for reading the value of the Show Tools flag from the navigational state using the given DocumentModel interface.

Parameters:

root - Root node for Show Tools information. Must not be null.

model - Document model that contains the given node. Must not be null.

Returns:

A read-only accessor to the Show Tools flag. Not null.

getShowToolsAccessorController

ShowToolsAccessorController getShowToolsAccessorController(StateHolderController state)

Provides a controller that allows for reading and writing the value of the Show Tools flag from /to the navigational state using the given StateHolderController interface.

Parameters:

state - Controller which allows for modifiying the state holder. Must not be null.

Returns:

Read-write accessor to the Show Tools flag. Not null.

getShowToolsAccessorController

ShowToolsAccessorController getShowToolsAccessorController(Node root,
                                                           DocumentController model)

Provides a controller that allows for reading and writing the value of the Show Tools flag from /to the navigational state using the given DocumentController interface.

Parameters:

root - Root node for Show Tools information. Must not be null.

model - Controller which allows for modifiying the state document model. Must not be null.

Returns:

Read-write accessor to the Show Tools flag. Not null.

getShowTools

ShowToolsAccessor getShowTools(StateHolder state)

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

Provides an accessor that allows for reading the value of the Show Tools flag from the navigational state using the given StateHolder interface.

Parameters:

state - State holder that contains the Show Tools flag. Must not be null.

Returns:

A read-only accessor to the Show Tools flag. Not null.

getShowTools

ShowToolsAccessor getShowTools(Node root,
                               DocumentModel model)

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

Provides an accessor that allows for reading the value of the Show Tools flag from the navigational state using the given DocumentModel interface.

Parameters:

root - Root node for Show Tools information. Must not be null.

model - Document model that contains the given node. Must not be null.

Returns:

A read-only accessor to the Show Tools flag. Not null.

getShowToolsController

ShowToolsAccessorController getShowToolsController(StateHolderController state)

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

Provides a controller that allows for reading and writing the value of the Show Tools flag from /to the navigational state using the given StateHolderController interface.

Parameters:

state - Controller which allows for modifiying the state holder. Must not be null.

Returns:

Read-write accessor to the Show Tools flag. Not null.

getShowToolsController

ShowToolsAccessorController getShowToolsController(Node root,
                                                   DocumentController model)

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

Provides a controller that allows for reading and writing the value of the Show Tools flag from /to the navigational state using the given DocumentController interface.

Parameters:

root - Root node for Show Tools information. Must not be null.

model - Controller which allows for modifiying the state document model. Must not be null.

Returns:

Read-write accessor to the Show Tools flag. Not null.