|
DRAFT | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectjavax.faces.application.StateManager
javax.faces.application.StateManagerWrapper
public abstract class StateManagerWrapper
Provides a simple implementation of StateManager that can
be subclassed by developers wishing to provide specialized behavior
to an existing StateManager instance. The default
implementation of all methods is to call through to the wrapped
StateManager.
Usage: extend this class and override getWrapped() to
return the instance we are wrapping.
| 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, PARTIAL_STATE_SAVING_PARAM_NAME, STATE_SAVING_METHOD_CLIENT, STATE_SAVING_METHOD_PARAM_NAME, STATE_SAVING_METHOD_SERVER |
| Constructor Summary | |
|---|---|
StateManagerWrapper()
|
|
| Method Summary | |
|---|---|
protected java.lang.Object |
getComponentStateToSave(FacesContext context)
The default behavior of this method is to call StateManager#getComponentStateToSave(javax.faces.context.FacesContext)
on the wrapped StateManager object. |
protected java.lang.Object |
getTreeStructureToSave(FacesContext context)
The default behavior of this method is to call StateManager#getTreeStructureToSave(javax.faces.context.FacesContext)
on the wrapped StateManager object. |
java.lang.String |
getViewState(FacesContext context)
The default behavior of this method
is to call |
abstract StateManager |
getWrapped()
A class that implements this interface uses this method to return an instance of the class being wrapped. |
boolean |
isSavingStateInClient(FacesContext context)
The default behavior of this method is to call StateManager#isSavingStateInClient(javax.faces.context.FacesContext)
on the wrapped StateManager object. |
protected void |
restoreComponentState(FacesContext context,
UIViewRoot viewRoot,
java.lang.String renderKitId)
The default behavior of this method is to call StateManager#restoreComponentState(javax.faces.context.FacesContext, javax.faces.component.UIViewRoot, String)
on the wrapped StateManager object. |
protected UIViewRoot |
restoreTreeStructure(FacesContext context,
java.lang.String viewId,
java.lang.String renderKitId)
The default behavior of this method is to call StateManager#restoreTreeStructure(javax.faces.context.FacesContext, String, String)
on the wrapped StateManager object. |
UIViewRoot |
restoreView(FacesContext context,
java.lang.String viewId,
java.lang.String renderKitId)
The default behavior of this method is to call StateManager#restoreView(javax.faces.context.FacesContext, String, String)
on the wrapped StateManager object. |
StateManager.SerializedView |
saveSerializedView(FacesContext context)
The default behavior of this method is to call StateManager#saveSerializedView(javax.faces.context.FacesContext)
on the wrapped StateManager object. |
java.lang.Object |
saveView(FacesContext context)
The default behavior of this method is to call StateManager#saveView(javax.faces.context.FacesContext)
on the wrapped StateManager object. |
void |
writeState(FacesContext context,
java.lang.Object state)
The default behavior of this method is to call StateManager#writeState(javax.faces.context.FacesContext,
java.lang.Object) on the wrapped StateManager
object. |
void |
writeState(FacesContext context,
StateManager.SerializedView state)
The default behavior of this method is to call StateManager#writeState(javax.faces.context.FacesContext, javax.faces.application.StateManager.SerializedView)
on the wrapped StateManager object. |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Constructor Detail |
|---|
public StateManagerWrapper()
| Method Detail |
|---|
public abstract StateManager getWrapped()
FacesWrapperA class that implements this interface uses this method to return an instance of the class being wrapped.
getWrapped in interface FacesWrapper<StateManager>public StateManager.SerializedView saveSerializedView(FacesContext context)
The default behavior of this method is to
call StateManager#saveSerializedView(javax.faces.context.FacesContext)
on the wrapped StateManager object.
saveSerializedView in class StateManagercontext - FacesContext for the current requestStateManager#saveSerializedView(javax.faces.context.FacesContext)public java.lang.Object saveView(FacesContext context)
The default behavior of this method is to
call StateManager#saveView(javax.faces.context.FacesContext)
on the wrapped StateManager object.
saveView in class StateManagercontext - FacesContext for the current requestStateManager#saveView(javax.faces.context.FacesContext)protected java.lang.Object getTreeStructureToSave(FacesContext context)
The default behavior of this method is to
call StateManager#getTreeStructureToSave(javax.faces.context.FacesContext)
on the wrapped StateManager object.
getTreeStructureToSave in class StateManagercontext - FacesContext for the current requestStateManager#getTreeStructureToSave(javax.faces.context.FacesContext)protected java.lang.Object getComponentStateToSave(FacesContext context)
The default behavior of this method is to
call StateManager#getComponentStateToSave(javax.faces.context.FacesContext)
on the wrapped StateManager object.
getComponentStateToSave in class StateManagercontext - FacesContext for the current requestStateManager#getComponentStateToSave(javax.faces.context.FacesContext)
public void writeState(FacesContext context,
java.lang.Object state)
throws java.io.IOException
The default behavior of this method is to call StateManager#writeState(javax.faces.context.FacesContext,
java.lang.Object) on the wrapped StateManager
object.
writeState in class StateManagercontext - FacesContext for the current requeststate - the Serializable state to be written,
as returned by StateManager.saveSerializedView(javax.faces.context.FacesContext)
java.io.IOExceptionStateManager#writeState(javax.faces.context.FacesContext,
java.lang.Object)
public void writeState(FacesContext context,
StateManager.SerializedView state)
throws java.io.IOException
The default behavior of this method is to
call StateManager#writeState(javax.faces.context.FacesContext, javax.faces.application.StateManager.SerializedView)
on the wrapped StateManager object.
writeState in class StateManagercontext - FacesContext for the current requeststate - the serialized state to be written
java.io.IOExceptionStateManager#writeState(javax.faces.context.FacesContext, javax.faces.application.StateManager.SerializedView)
public UIViewRoot restoreView(FacesContext context,
java.lang.String viewId,
java.lang.String renderKitId)
The default behavior of this method is to
call StateManager#restoreView(javax.faces.context.FacesContext, String, String)
on the wrapped StateManager object.
restoreView in class StateManagercontext - FacesContext for the current requestviewId - View identifier of the view to be restoredrenderKitId - the renderKitId used to render this response.
Must not be null.StateManager#restoreView(javax.faces.context.FacesContext, String, String)
protected UIViewRoot restoreTreeStructure(FacesContext context,
java.lang.String viewId,
java.lang.String renderKitId)
The default behavior of this method is to
call StateManager#restoreTreeStructure(javax.faces.context.FacesContext, String, String)
on the wrapped StateManager object.
restoreTreeStructure in class StateManagercontext - FacesContext for the current requestviewId - View identifier of the view to be restoredrenderKitId - the renderKitId used to render this response.
Must not be null.StateManager#restoreTreeStructure(javax.faces.context.FacesContext, String, String)
protected void restoreComponentState(FacesContext context,
UIViewRoot viewRoot,
java.lang.String renderKitId)
The default behavior of this method is to
call StateManager#restoreComponentState(javax.faces.context.FacesContext, javax.faces.component.UIViewRoot, String)
on the wrapped StateManager object.
restoreComponentState in class StateManagercontext - FacesContext for the current requestviewRoot - UIViewRoot returned by a previous call
to restoreTreeStructure()renderKitId - the renderKitId used to render this response.
Must not be null.StateManager#restoreComponentState(javax.faces.context.FacesContext, javax.faces.component.UIViewRoot, String)public boolean isSavingStateInClient(FacesContext context)
The default behavior of this method is to
call StateManager#isSavingStateInClient(javax.faces.context.FacesContext)
on the wrapped StateManager object.
isSavingStateInClient in class StateManagertrue if and only if the value of the
ServletContext init parameter named by the value of
the constant StateManager.STATE_SAVING_METHOD_PARAM_NAME is equal to
the value of the constant StateManager.STATE_SAVING_METHOD_CLIENT.
false otherwise.StateManager#isSavingStateInClient(javax.faces.context.FacesContext)public java.lang.String getViewState(FacesContext context)
The default behavior of this method
is to call StateManager#getViewState(javax.faces.context.FacesContext) on the
wrapped StateManager object.
getViewState in class StateManagercontext - FacesContext for the current request
|
DRAFT | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
Copyright © 2009 Sun Microsystems, Inc. All Rights Reserved. Use is subject to license terms.
Generated on 24-November-2009 03:24