public class ComponentStruct extends Object implements StateHolder
Modifier and Type | Field and Description |
---|---|
static String |
ADD
Marker that specifies this is an ADD.
|
static String |
REMOVE
Marker that specifies this is a REMOVE.
|
Constructor and Description |
---|
ComponentStruct() |
ComponentStruct(String action,
String clientId,
String id) |
ComponentStruct(String action,
String facetName,
String parentClientId,
String clientId,
String id) |
Modifier and Type | Method and Description |
---|---|
boolean |
equals(Object obj) |
String |
getAction() |
String |
getClientId() |
String |
getFacetName() |
String |
getId() |
String |
getParentClientId() |
int |
hashCode()
Hash code.
|
boolean |
isTransient()
If true, the Object implementing this interface must not
participate in state saving or restoring.
|
void |
restoreState(FacesContext ctx,
Object state)
Perform any
processing required to restore the state from the entries in the
state Object.
|
Object |
saveState(FacesContext ctx)
Gets the state of the instance as a
Serializable Object. |
void |
setTransient(boolean trans)
Denotes
whether or not the Object implementing this interface must or
must not participate in state saving or restoring.
|
public static final String ADD
public static final String REMOVE
public boolean isTransient()
StateHolder
If true, the Object implementing this interface must not participate in state saving or restoring.
isTransient
in interface StateHolder
true
if transient, false
otherwise.public void restoreState(FacesContext ctx, Object state)
StateHolder
Perform any processing required to restore the state from the entries in the state Object.
If the class that implements this interface has references to
instances that also implement StateHolder (such as a
UIComponent
with event handlers, validators, etc.)
this method must call the StateHolder.restoreState(javax.faces.context.FacesContext, java.lang.Object)
method on all those
instances as well.
If the state
argument is null
, take no action and return.
restoreState
in interface StateHolder
ctx
- the Faces context.state
- the state.public Object saveState(FacesContext ctx)
StateHolder
Gets the state of the instance as a
Serializable
Object.
If the class that implements this interface has references to
instances that implement StateHolder (such as a
UIComponent
with event handlers, validators, etc.)
this method must call the StateHolder.saveState(javax.faces.context.FacesContext)
method on all those
instances as well. This method must not save the state
of children and facets. That is done via the StateManager
This method must not alter the state of the implementing object. In other words, after executing this code:
Object state = component.saveState(facesContext);
component
should be the same as before executing
it.
The return from this method must be Serializable
saveState
in interface StateHolder
ctx
- the Faces context.public void setTransient(boolean trans)
StateHolder
Denotes whether or not the Object implementing this interface must or must not participate in state saving or restoring.
setTransient
in interface StateHolder
trans
- boolean pass true
if this
Object will not
participate in state saving or restoring, otherwise pass
false
.public int hashCode()
public String getAction()
public String getFacetName()
public String getParentClientId()
public String getClientId()
public String getId()
Comments to: faces-dev@eclipse.org.
Copyright © 2019 Eclipse Foundation. All rights reserved.
Use is subject to license terms.