Interface PartialStateHolder
- All Superinterfaces:
StateHolder
- All Known Implementing Classes:
AjaxBehavior
,BeanValidator
,BehaviorBase
,ClientBehaviorBase
,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
,RegexValidator
,UIColumn
,UICommand
,UIComponent
,UIComponentBase
,UIData
,UIForm
,UIGraphic
,UIImportConstants
,UIInput
,UIMessage
,UIMessages
,UINamingContainer
,UIOutcomeTarget
,UIOutput
,UIPanel
,UIParameter
,UISelectBoolean
,UISelectItem
,UISelectItems
,UISelectMany
,UISelectOne
,UIViewAction
,UIViewParameter
,UIViewRoot
,UIWebsocket
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 TypeMethodDescriptionvoid
Reset the PartialStateHolder to a non-delta tracking state.boolean
Returntrue
if delta state changes are being tracked, otherwisefalse
void
The runtime must ensure that themarkInitialState()
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 javax.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 thatinitialStateMarked()
returnstrue
from the timemarkInitialState()
is called untilclearInitialState()
is called, after which timeinitialStateMarked()
must returnfalse
. Also, during the time that the instance returnstrue
frominitialStateMarked()
, the implementation must return only the state that has changed in its implementation ofStateHolder.saveState(javax.faces.context.FacesContext)
.- Since:
- 2.0
-
initialStateMarked
boolean initialStateMarked()Return
true
if delta state changes are being tracked, otherwisefalse
- 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
-