|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface ScreenTemplateAccessorFactory
Factory interface providing accessors that allow for reading
as well as writing screen template information from /to a given state holder
or document model.
A screen template is a name for a screen used to generate parts of a portal page
during portal rendering.
WebSphere Portal provides a set of default screen templates including "Home" (default),
"Login", and "Error". Custom screen templates can also be defined and added to the
portal system.
Method Summary | |
---|---|
ScreenTemplateAccessor |
getScreenTemplateAccessor(Node root,
DocumentModel model)
Get a read-only interface to the screen template. |
ScreenTemplateAccessor |
getScreenTemplateAccessor(StateHolder state)
Get a read-only interface to the screen template. |
ScreenTemplateAccessorController |
getScreenTemplateAccessorController(Node root,
DocumentController model)
Returns a controller that allows to modify the screen template. |
ScreenTemplateAccessorController |
getScreenTemplateAccessorController(StateHolderController state)
Returns a controller that allows to modify the screen template. |
boolean |
removeScreenTemplate(Node node,
DocumentController model)
Removes the screen template information from the given document model. |
boolean |
removeScreenTemplate(StateHolderController state)
Removes the screen template information from the given state. |
Methods inherited from interface com.ibm.portal.state.accessors.AccessorFactory |
---|
compact |
Method Detail |
---|
boolean removeScreenTemplate(StateHolderController state)
state
- the State holder that should be modified. Must not
be null
.
true
if removed, false
if not found.boolean removeScreenTemplate(Node node, DocumentController model)
node
- The node to remove, holding the screen template information.
Must not be null
.model
- The document model that contains node
. Must not
be null
.
true
if removed, false
if not found.ScreenTemplateAccessor getScreenTemplateAccessor(StateHolder state)
state
- State holder that contains the screen template information.
Must not be null
.
ScreenTemplateAccessor getScreenTemplateAccessor(Node root, DocumentModel model)
root
- Root node for screen template information (must not be null
).model
- Model that contains the node root
(must not be null
).
ScreenTemplateAccessorController getScreenTemplateAccessorController(StateHolderController state)
state
- Modifiable state holder to operate on.
ScreenTemplateAccessorController getScreenTemplateAccessorController(Node root, DocumentController model)
root
- Root node for screen template information (must not be null
).model
- Modifiable document model that contains root
(must not be null
).
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |