public abstract class StateManagementStrategy extends Object
Encapsulate the saving and restoring of
the view to enable the VDL to take over the responsibility for
handling this feature. Because ViewDeclarationLanguage.getStateManagementStrategy(javax.faces.context.FacesContext, java.lang.String)
is required to
return null
for JSP views and non-null
for
views authored in Facelets for JSF 2, this specification only applys
to Facelets for JSF 2.
Constructor and Description |
---|
StateManagementStrategy() |
Modifier and Type | Method and Description |
---|---|
abstract UIViewRoot |
restoreView(FacesContext context,
String viewId,
String renderKitId)
Restore the state of the view with information in the request. |
abstract Object |
saveView(FacesContext context)
Return the state of the current view
in an |
public abstract Object saveView(FacesContext context)
Return the state of the current view
in an Object
that implements
Serializable
. The default implementation must
perform the following algorithm or its semantic equivalent.
If the UIViewRoot
of the current view is
marked transient
, return null
immediately.
Traverse the view and verify that each of the client ids
are unique. Throw IllegalStateException
if more
than one client id are the same.
Visit the tree using javax.faces.component.UIComponent#visitTree
. For each node,
call StateHolder.saveState(javax.faces.context.FacesContext)
,
saving the returned Object
in a way such that it
can be restored given only its client id. Special care must
be taken to handle the case of components that were added or
deleted programmatically during this lifecycle traversal,
rather than by the VDL.
The implementation must ensure that the StateHolder.saveState(javax.faces.context.FacesContext)
method is called for
each node in the tree.
The data structure used to save the state obtained by
executing the above algorithm must be Serializable
,
and all of the elements within the data structure must also be
Serializable
.
context
- the FacesContext
for this request.public abstract UIViewRoot restoreView(FacesContext context, String viewId, String renderKitId)
Restore the state of the view with information in the request. The default implementation must perform the following algorithm or its semantic equivalent.
Build the view from the markup. For all components in the view that do not have an explicitly assigned id in the markup, the values of those ids must be the same as on an initial request for this view. This view will not contain any components programmatically added during the previous lifecycle run, and it will contain components that were programmatically deleted on the previous lifecycle run. Both of these cases must be handled.
Call ResponseStateManager.getState(javax.faces.context.FacesContext, java.lang.String)
to obtain
the data structure returned from the previous call to saveView(javax.faces.context.FacesContext)
.
Visit the tree using javax.faces.component.UIComponent#visitTree
. For each node,
call StateHolder.restoreState(javax.faces.context.FacesContext, java.lang.Object)
,
passing the state saved corresponding to the current client
id.
Ensure that any programmatically deleted components are removed.
Ensure any programmatically added components are added.
The implementation must ensure that the StateHolder.restoreState(javax.faces.context.FacesContext, java.lang.Object)
method is called
for each node in the tree, except for those that were
programmatically deleted on the previous run through the
lifecycle.
context
- the FacesContext
for this requestviewId
- the view identifier for which the state should be restoredrenderKitId
- the render kit id for this state.Copyright © 2018 JBoss by Red Hat. All rights reserved.