org.apache.myfaces.custom.scope
Class UIScope

java.lang.Object
  javax.faces.component.UIComponent
      javax.faces.component.UIComponentBase
          javax.faces.component.UIParameter
              org.apache.myfaces.custom.scope.UIScope

All Implemented Interfaces:

javax.faces.component.StateHolder

public class UIScope
extends javax.faces.component.UIParameter

Scope control which does basically the same as savestate but bypasses the serialization and utilizes the session directly

Version:

$Revision$ $Date$

Author:

Werner Punz werpu@gmx.at

Field Summary

static java.lang.String	COMPONENT_FAMILY
static java.lang.String	COMPONENT_TYPE
static java.lang.String	SCOPE_CONTAINER_KEY

Fields inherited from class javax.faces.component.UIComponent

bindings

Constructor Summary

UIScope()

Method Summary

java.lang.String	getFamily()
void	resetScope(javax.faces.context.FacesContext context) reset scope helper which allows to remove the scope from the system within the backend context
void	restoreState(javax.faces.context.FacesContext context, java.lang.Object state) in the restores state phase we get the binding and replace the one from the system with the one from the scope map
java.lang.Object	saveState(javax.faces.context.FacesContext context) save state saves the scope value binding into the holder map

Methods inherited from class javax.faces.component.UIParameter

getName, getValue, setName, setRendered, setValue

Methods inherited from class javax.faces.component.UIComponentBase

addFacesListener, broadcast, decode, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientId, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getParent, getRenderer, getRendererType, getRendersChildren, getValueBinding, invokeOnComponent, isRendered, isTransient, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendererType, setTransient, setValueBinding

Methods inherited from class javax.faces.component.UIComponent

encodeAll, getContainerClientId, getValueExpression, setValueExpression

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

SCOPE_CONTAINER_KEY

public static final java.lang.String SCOPE_CONTAINER_KEY

See Also:

Constant Field Values

COMPONENT_TYPE

public static final java.lang.String COMPONENT_TYPE

See Also:

Constant Field Values

COMPONENT_FAMILY

public static final java.lang.String COMPONENT_FAMILY

See Also:

Constant Field Values

Constructor Detail

UIScope

public UIScope()

Method Detail

getFamily

public java.lang.String getFamily()

Overrides:

getFamily in class javax.faces.component.UIParameter

saveState

public java.lang.Object saveState(javax.faces.context.FacesContext context)

save state saves the scope value binding into the holder map

Specified by:

saveState in interface javax.faces.component.StateHolder

Overrides:

saveState in class javax.faces.component.UIParameter

restoreState

public void restoreState(javax.faces.context.FacesContext context,
                         java.lang.Object state)

in the restores state phase we get the binding and replace the one from the system with the one from the scope map

Specified by:

restoreState in interface javax.faces.component.StateHolder

Overrides:

restoreState in class javax.faces.component.UIParameter

resetScope

public void resetScope(javax.faces.context.FacesContext context)

reset scope helper which allows to remove the scope from the system within the backend context

Parameters:

context -