org.apache.myfaces.view.facelets
Class DefaultFaceletsStateManagementStrategy
java.lang.Object
javax.faces.view.StateManagementStrategy
org.apache.myfaces.view.facelets.DefaultFaceletsStateManagementStrategy
public class DefaultFaceletsStateManagementStrategy
- extends StateManagementStrategy
This class implements partial state saving feature when facelets
is used to render pages. (Theorically it could be applied on jsp case too,
but all considerations below should be true before apply it).
The following considerations apply for this class:
1. This StateManagementStrategy should only be active if javax.faces.PARTIAL_STATE_SAVING
config param is active(true). See javadoc on StateManager for details.
2. A map using component clientId as keys are used to hold the state.
3. Each component has a valid id after ViewDeclarationLanguage.buildView().
This implies that somewhere, every TagHandler that create an UIComponent
instance should call setId and assign it.
4. Every TagHandler that create an UIComponent instance should call markInitialState
after the component is populated. Otherwise, full state is always saved.
5. A SystemEventListener is used to keep track for added and removed components, listen
PostAddToViewEvent and PreRemoveFromViewEvent event triggered by UIComponent.setParent()
method.
6. It is not possible to use javax.faces.component.visit API to traverse the component
tree during save/restore, because UIData.visitTree traverse all rows and we only need
to restore state per component (not per row).
7. It is necessary to preserve the order of the children added/removed between requests.
8. Added and removed components could be seen as subtrees. This imply that we need to save
the structure of the added components subtree and remove one component could be remove
all its children and facets from view inclusive.
9. It is necessary to save and restore the list of added/removed components between several
requests.
- Since:
- 2.0
- Version:
- $Revision: 793245 $ $Date: 2009-07-11 18:50:53 -0500 (Sat, 11 Jul 2009) $
- Author:
- Leonardo Uribe (latest modification by $Author: lu4242 $)
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
CLIENTIDS_ADDED
public static final java.lang.String CLIENTIDS_ADDED
- See Also:
- Constant Field Values
CLIENTIDS_REMOVED
public static final java.lang.String CLIENTIDS_REMOVED
- See Also:
- Constant Field Values
COMPONENT_ADDED_AFTER_BUILD_VIEW
public static final java.lang.String COMPONENT_ADDED_AFTER_BUILD_VIEW
- Key used on component attribute map to indicate if a component was added
after build view, so itself and all descendants should not use partial
state saving. There are two possible values:
Key not present: The component uses pss.
Boolean.TRUE: The component was added to the view after build view.
Boolean.FALSE: The component was removed/added to the view. Itself and all
descendants should be saved and restored, but we have to unregister/register
from CLIENTIDS_ADDED and CLIENTIDS_REMOVED lists.
- See Also:
- Constant Field Values
DefaultFaceletsStateManagementStrategy
public DefaultFaceletsStateManagementStrategy()
restoreView
public UIViewRoot restoreView(FacesContext context,
java.lang.String viewId,
java.lang.String renderKitId)
- Specified by:
restoreView
in class StateManagementStrategy
saveView
public java.lang.Object saveView(FacesContext context)
- Specified by:
saveView
in class StateManagementStrategy
ensureClearInitialState
protected void ensureClearInitialState(UIComponent c)
suscribeListeners
public void suscribeListeners(UIViewRoot uiViewRoot)
Copyright © 2010 The Apache Software Foundation. All Rights Reserved.