com.sun.faces.context

Class StateContext

java.lang.Object

com.sun.faces.context.StateContext

public class StateContext
extends Object

Context for dealing with partial state saving mechanics.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	StateContext.DynamicAddRemoveListener A system event listener which is used to listen for changes on the component tree after restore view and before rendering out the view.
class	StateContext.NoopAddRemoveListener
class	StateContext.StatelessAddRemoveListener An AddRemoveListener that implements the new dynamic component strategy where no state is managed by the listener itself.

Method Summary

Modifier and Type	Method and Description
boolean	componentAddedDynamically(jakarta.faces.component.UIComponent c)
List<ComponentStruct>	getDynamicActions() Get the dynamic list (of adds and removes).
HashMap<String,jakarta.faces.component.UIComponent>	getDynamicComponents() Get the hash map of dynamic components.
int	getIndexOfDynamicallyAddedChildInParent(jakarta.faces.component.UIComponent c)
static StateContext	getStateContext(jakarta.faces.context.FacesContext ctx)
boolean	hasOneOrMoreDynamicChild(jakarta.faces.component.UIComponent parent)
boolean	isPartialStateSaving(jakarta.faces.context.FacesContext ctx, String viewId)
static void	release(jakarta.faces.context.FacesContext facesContext) Release the state context.
void	setTrackViewModifications(boolean trackMods) Toggles the current modification tracking status.
void	startTrackViewModifications(jakarta.faces.context.FacesContext ctx, jakarta.faces.component.UIViewRoot root) Installs a SystemEventListener on the UIViewRoot to track components added to or removed from the view.
boolean	trackViewModifications()

Methods inherited from class java.lang.Object

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

Method Detail

release

public static void release(jakarta.faces.context.FacesContext facesContext)

Release the state context.

Parameters:

facesContext - the Faces context.

getStateContext

public static StateContext getStateContext(jakarta.faces.context.FacesContext ctx)

Parameters:

ctx - the FacesContext for the current request

Returns:

StateContext for this request

isPartialStateSaving

public boolean isPartialStateSaving(jakarta.faces.context.FacesContext ctx,
                                    String viewId)

Parameters:

ctx - FacesContext.

viewId - the view ID to check or null if viewId is unknown.

Returns:

true if partial state saving should be used for the specified view ID, otherwise false

trackViewModifications

public boolean trackViewModifications()

Returns:

true if view modifications outside of the initial construction of the view are being tracked.

startTrackViewModifications

public void startTrackViewModifications(jakarta.faces.context.FacesContext ctx,
                                        jakarta.faces.component.UIViewRoot root)

Installs a SystemEventListener on the UIViewRoot to track components added to or removed from the view.

setTrackViewModifications

public void setTrackViewModifications(boolean trackMods)

Toggles the current modification tracking status.

Parameters:

trackMods - if true and the listener installed by {@link #startTrackViewModifications(jakarta.faces.context.FacesContext, jakarta.faces.component.UIViewRoot) is present, then view modifications will be tracked. If false, then modification events will be ignored.

componentAddedDynamically

public boolean componentAddedDynamically(jakarta.faces.component.UIComponent c)

Parameters:

c - the UIComponent to check

Returns:

true if the component was added after the initial view construction

getIndexOfDynamicallyAddedChildInParent

public int getIndexOfDynamicallyAddedChildInParent(jakarta.faces.component.UIComponent c)

hasOneOrMoreDynamicChild

public boolean hasOneOrMoreDynamicChild(jakarta.faces.component.UIComponent parent)

getDynamicActions

public List<ComponentStruct> getDynamicActions()

Get the dynamic list (of adds and removes).

getDynamicComponents

public HashMap<String,jakarta.faces.component.UIComponent> getDynamicComponents()

Get the hash map of dynamic components.

Returns:

the hash map of dynamic components.