Module jakarta.faces

Package jakarta.faces.component

Interface PartialStateHolder

All Superinterfaces:

StateHolder

All Known Implementing Classes:

AjaxBehavior, BeanValidator, BehaviorBase, BehaviorHolderWrapper, ClientBehaviorBase, ComponentRef, ComponentResourceContainer, CompositeComponentImpl, DateTimeConverter, DoubleRangeValidator, EnumConverter, HtmlBody, HtmlColumn, HtmlCommandButton, HtmlCommandLink, HtmlCommandScript, HtmlDataTable, HtmlDoctype, HtmlForm, HtmlGraphicImage, HtmlHead, HtmlInputFile, HtmlInputHidden, HtmlInputSecret, HtmlInputText, HtmlInputTextarea, HtmlMessage, HtmlMessages, HtmlOutcomeTargetButton, HtmlOutcomeTargetLink, HtmlOutputFormat, HtmlOutputLabel, HtmlOutputLink, HtmlOutputText, HtmlPanelGrid, HtmlPanelGroup, HtmlSelectBooleanCheckbox, HtmlSelectManyCheckbox, HtmlSelectManyListbox, HtmlSelectManyMenu, HtmlSelectOneListbox, HtmlSelectOneMenu, HtmlSelectOneRadio, LengthValidator, LongRangeValidator, NumberConverter, PassthroughElement, RadioRenderer.GroupSelectItem, RegexValidator, RetargetedAjaxBehavior, UIColumn, UICommand, UIComponent, UIComponentBase, UIData, UIDebug, UIForm, UIGraphic, UIImportConstants, UIInput, UIInstructions, UILeaf, UILiteralText, UIMessage, UIMessages, UINamingContainer, UIOutcomeTarget, UIOutput, UIPanel, UIParameter, UIRepeat, UISelectBoolean, UISelectItem, UISelectItemGroup, UISelectItemGroups, UISelectItems, UISelectMany, UISelectOne, UIText, UIValidateWholeBean, UIViewAction, UIViewParameter, UIViewRoot, UIWebsocket

public interface PartialStateHolder
extends StateHolder

Components that want to leverage the partial state saving feature must implement this interface instead of implementing StateHolder, from which this interface inherits.

Since:

2.0

Method Summary

Modifier and Type	Method	Description
void	clearInitialState()	Reset the PartialStateHolder to a non-delta tracking state.
boolean	initialStateMarked()	Return true if delta state changes are being tracked, otherwise false
void	markInitialState()	The runtime must ensure that the markInitialState() method is called on each instance of this interface in the view at the appropriate time to indicate the component is in its initial state.

Methods inherited from interface jakarta.faces.component.StateHolder

isTransient, restoreState, saveState, setTransient

Method Details

markInitialState

void markInitialState()

The runtime must ensure that the markInitialState() method is called on each instance of this interface in the view at the appropriate time to indicate the component is in its initial state. The implementor of the interface must ensure that initialStateMarked() returns true from the time markInitialState() is called until clearInitialState() is called, after which time initialStateMarked() must return false. Also, during the time that the instance returns true from initialStateMarked(), the implementation must return only the state that has changed in its implementation of StateHolder.saveState(jakarta.faces.context.FacesContext).

Since:

2.0

initialStateMarked

boolean initialStateMarked()

Return true if delta state changes are being tracked, otherwise false

Returns:

true if the initial state is marked, false otherwise.

Since:

2.0

clearInitialState

void clearInitialState()

Reset the PartialStateHolder to a non-delta tracking state.

Since:

2.0