Class StateManagerWrapper
- java.lang.Object
-
- javax.faces.application.StateManager
-
- javax.faces.application.StateManagerWrapper
-
- All Implemented Interfaces:
FacesWrapper<StateManager>
public abstract class StateManagerWrapper extends StateManager implements FacesWrapper<StateManager>
see Javadoc of JSF Specification
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class javax.faces.application.StateManager
StateManager.SerializedView
-
-
Field Summary
-
Fields inherited from class javax.faces.application.StateManager
FULL_STATE_SAVING_VIEW_IDS_PARAM_NAME, IS_BUILDING_INITIAL_STATE, IS_SAVING_STATE, PARTIAL_STATE_SAVING_PARAM_NAME, SERIALIZE_SERVER_STATE_PARAM_NAME, STATE_SAVING_METHOD_CLIENT, STATE_SAVING_METHOD_PARAM_NAME, STATE_SAVING_METHOD_SERVER
-
-
Constructor Summary
Constructors Constructor Description StateManagerWrapper()Deprecated.StateManagerWrapper(StateManager delegate)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected ObjectgetComponentStateToSave(FacesContext context)Return data that can be applied to a component tree created using the "getTreeStructureToSave" method.protected ObjectgetTreeStructureToSave(FacesContext context)Return data that is sufficient to recreate the component tree that is the viewroot of the specified context, but without restoring the state in the components.StringgetViewState(FacesContext context)This method should be called from somewhere when ajax response is created to update the state saving param on client.StateManagergetWrapped()A class that implements this interface uses this method to return an instance of the class being wrapped.booleanisSavingStateInClient(FacesContext context)protected voidrestoreComponentState(FacesContext context, UIViewRoot viewRoot, String renderKitId)protected UIViewRootrestoreTreeStructure(FacesContext context, String viewId, String renderKitId)UIViewRootrestoreView(FacesContext context, String viewId, String renderKitId)StateManager.SerializedViewsaveSerializedView(FacesContext context)Invokes getTreeStructureToSave and getComponentStateToSave, then return an object that wraps the two resulting objects.ObjectsaveView(FacesContext context)Returns an object that is sufficient to recreate the component tree that is the viewroot of the specified context.voidwriteState(FacesContext context, Object state)Associate the provided state object with the current response being generated.voidwriteState(FacesContext context, StateManager.SerializedView state)Associate the provided state object with the current response being generated.
-
-
-
Constructor Detail
-
StateManagerWrapper
@Deprecated public StateManagerWrapper()
Deprecated.
-
StateManagerWrapper
public StateManagerWrapper(StateManager delegate)
-
-
Method Detail
-
getWrapped
public StateManager getWrapped()
Description copied from interface:FacesWrapperA class that implements this interface uses this method to return an instance of the class being wrapped.- Specified by:
getWrappedin interfaceFacesWrapper<StateManager>- Returns:
- the instance of the class being wrapped
-
saveSerializedView
public StateManager.SerializedView saveSerializedView(FacesContext context)
Description copied from class:StateManagerInvokes getTreeStructureToSave and getComponentStateToSave, then return an object that wraps the two resulting objects. This object can then be passed to method writeState.Deprecated; use saveView instead.
- Overrides:
saveSerializedViewin classStateManager
-
saveView
public Object saveView(FacesContext context)
Description copied from class:StateManagerReturns an object that is sufficient to recreate the component tree that is the viewroot of the specified context.The return value is suitable for passing to method writeState.
- Overrides:
saveViewin classStateManager
-
isSavingStateInClient
public boolean isSavingStateInClient(FacesContext context)
- Overrides:
isSavingStateInClientin classStateManager
-
getTreeStructureToSave
protected Object getTreeStructureToSave(FacesContext context)
Description copied from class:StateManagerReturn data that is sufficient to recreate the component tree that is the viewroot of the specified context, but without restoring the state in the components.Using this data, a tree of components which has the same "shape" as the original component tree can be recreated. However the component instances themselves will have only their default values, ie their member fields will not have been set to the original values.
Deprecated; use saveView instead.
- Overrides:
getTreeStructureToSavein classStateManager
-
getComponentStateToSave
protected Object getComponentStateToSave(FacesContext context)
Description copied from class:StateManagerReturn data that can be applied to a component tree created using the "getTreeStructureToSave" method.Deprecated; use saveView instead.
- Overrides:
getComponentStateToSavein classStateManager
-
writeState
public void writeState(FacesContext context, StateManager.SerializedView state) throws IOException
Description copied from class:StateManagerAssociate the provided state object with the current response being generated.When client-side state is enabled, it is expected that method writes the data contained in the state parameter to the response somehow.
When server-side state is enabled, at most a "token" is expected to be written.
Deprecated; use writeState(FacesContext, Object) instead. This method was abstract in JSF1.1, but is now an empty non-abstract method so that old classes that implement this method continue to work, while new classes can just override the new writeState method rather than this one.
- Overrides:
writeStatein classStateManager- Throws:
IOException- never
-
writeState
public void writeState(FacesContext context, Object state) throws IOException
Description copied from class:StateManagerAssociate the provided state object with the current response being generated.When client-side state is enabled, it is expected that method writes the data contained in the state parameter to the response somehow.
When server-side state is enabled, at most a "token" is expected to be written.
This method should be overridden by subclasses. It is not abstract because a default implementation is provided that forwards to the old writeState method; this allows subclasses of StateManager written using the JSF1.1 API to continue to work.
- Overrides:
writeStatein classStateManager- Throws:
IOException
-
restoreView
public UIViewRoot restoreView(FacesContext context, String viewId, String renderKitId)
- Specified by:
restoreViewin classStateManager
-
restoreTreeStructure
protected UIViewRoot restoreTreeStructure(FacesContext context, String viewId, String renderKitId)
- Overrides:
restoreTreeStructurein classStateManager
-
restoreComponentState
protected void restoreComponentState(FacesContext context, UIViewRoot viewRoot, String renderKitId)
- Overrides:
restoreComponentStatein classStateManager
-
getViewState
public String getViewState(FacesContext context)
Description copied from class:StateManagerThis method should be called from somewhere when ajax response is created to update the state saving param on client. The place where this method is called is an implementation detail, so there is no references about from where in the spec javadoc.- Overrides:
getViewStatein classStateManager- Returns:
-
-