|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectjavax.faces.component.UIComponent
javax.faces.component.UIComponentBase
javax.faces.component.UIForm
public class UIForm
UIForm is a UIComponent
that represents an
input form to be presented to the user, and whose child components represent
(among other things) the input fields to be included when the form is
submitted.
By default, the rendererType
property must be set to
"javax.faces.Form
". This value can be changed by calling the
setRendererType()
method.
Field Summary | |
---|---|
static String |
COMPONENT_FAMILY
The standard component family for this component. |
static String |
COMPONENT_TYPE
The standard component type for this component. |
Fields inherited from class javax.faces.component.UIComponent |
---|
BEANINFO_KEY, bindings, COMPOSITE_COMPONENT_TYPE_KEY, COMPOSITE_FACET_NAME, CURRENT_COMPONENT, CURRENT_COMPOSITE_COMPONENT, FACETS_KEY |
Fields inherited from interface javax.faces.component.NamingContainer |
---|
SEPARATOR_CHAR |
Constructor Summary | |
---|---|
UIForm()
Create a new UIForm instance with default property
values. |
Method Summary | |
---|---|
String |
getContainerClientId(FacesContext context)
Override the UIComponent.getContainerClientId(javax.faces.context.FacesContext) to allow
users to disable this form from prepending its clientId to
its descendent's clientIds depending on the value of
this form's isPrependId() property. |
String |
getFamily()
Return the identifier of the component family to which this component belongs. |
boolean |
isPrependId()
|
boolean |
isSubmitted()
Returns the current value of the submitted
property. |
void |
processDecodes(FacesContext context)
Override UIComponent.processDecodes(javax.faces.context.FacesContext) to ensure that the
form is decoded before its children. |
void |
processUpdates(FacesContext context)
Override UIComponent.processUpdates(javax.faces.context.FacesContext) to ensure that the
children of this UIForm instance are only processed
if isSubmitted() returns true . |
void |
processValidators(FacesContext context)
Override UIComponent.processValidators(javax.faces.context.FacesContext) to ensure that
the children of this UIForm instance are only
processed if isSubmitted() returns true . |
void |
restoreState(FacesContext context,
Object state)
Perform any processing required to restore the state from the entries in the state Object. |
Object |
saveState(FacesContext context)
Gets the state of the instance as a Serializable Object. |
void |
setPrependId(boolean prependId)
|
void |
setSubmitted(boolean submitted)
If this UIForm instance (as
opposed to other forms in the page) is experiencing a submit
during this request processing lifecycle, this method must be
called, with true as the argument, during the UIComponent.decode(javax.faces.context.FacesContext) for this UIForm instance. |
boolean |
visitTree(VisitContext context,
VisitCallback callback)
Perform a tree visit starting at this node in the tree. |
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, processRestoreState, processSaveState, queueEvent, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding |
Methods inherited from class javax.faces.component.UIComponent |
---|
encodeAll, getClientId, getCurrentComponent, getCurrentCompositeComponent, getListenersForEventClass, getResourceBundleMap, getValueExpression, isInView, isVisitable, popComponentFromEL, processEvent, pushComponentToEL, setInView, setValueExpression, subscribeToEvent, unsubscribeFromEvent |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final String COMPONENT_TYPE
The standard component type for this component.
public static final String COMPONENT_FAMILY
The standard component family for this component.
Constructor Detail |
---|
public UIForm()
Create a new UIForm
instance with default property
values.
Method Detail |
---|
public String getFamily()
UIComponent
Return the identifier of the component family to which this
component belongs. This identifier, in conjunction with the value
of the rendererType
property, may be used to select
the appropriate Renderer
for this component instance.
getFamily
in class UIComponent
public boolean isSubmitted()
Returns the current value of the submitted
property. The default value is false
. See setSubmitted(boolean)
for details.
public void setSubmitted(boolean submitted)
If this UIForm
instance (as
opposed to other forms in the page) is experiencing a submit
during this request processing lifecycle, this method must be
called, with true
as the argument, during the UIComponent.decode(javax.faces.context.FacesContext)
for this UIForm
instance. If
this UIForm
instance is
not experiencing a submit, this method must be
called, with false
as the argument, during the
UIComponent.decode(javax.faces.context.FacesContext)
for this UIForm
instance.
The value of a UIForm
's submitted property must
not be saved as part of its state.
public boolean isPrependId()
public void setPrependId(boolean prependId)
public void processDecodes(FacesContext context)
Override UIComponent.processDecodes(javax.faces.context.FacesContext)
to ensure that the
form is decoded before its children. This is
necessary to allow the submitted
property to be
correctly set.
processDecodes
in class UIComponentBase
context
- FacesContext
for the request we are processing
NullPointerException
- if context
is null
public void processValidators(FacesContext context)
Override UIComponent.processValidators(javax.faces.context.FacesContext)
to ensure that
the children of this UIForm
instance are only
processed if isSubmitted()
returns true
.
processValidators
in class UIComponentBase
context
- FacesContext
for the request we are processing
NullPointerException
- if context
is null
public void processUpdates(FacesContext context)
Override UIComponent.processUpdates(javax.faces.context.FacesContext)
to ensure that the
children of this UIForm
instance are only processed
if isSubmitted()
returns true
.
processUpdates
in class UIComponentBase
context
- FacesContext
for the request we are processing
NullPointerException
- if context
is null
public String getContainerClientId(FacesContext context)
Override the UIComponent.getContainerClientId(javax.faces.context.FacesContext)
to allow
users to disable this form from prepending its clientId
to
its descendent's clientIds
depending on the value of
this form's isPrependId()
property.
getContainerClientId
in class UIComponent
public Object saveState(FacesContext context)
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
saveState
in class UIComponentBase
public void restoreState(FacesContext context, 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.
restoreState
in interface StateHolder
restoreState
in class UIComponentBase
public boolean visitTree(VisitContext context, VisitCallback callback)
UIComponent
Perform a tree visit starting at this node in the tree.
UIComponent.visitTree() implementations do not invoke the
VisitCallback
directly, but instead cal
VisitContext.invokeVisitCallback()
to invoke the
callback. This allows VisitContext
implementations
to provide optimized tree traversals, for example by only
calling the VisitCallback
for a subset of components.
UIComponent.visitTree() implementations must call UIComponent.pushComponentToEL() before performing the visit and UIComponent.popComponentFromEL() after the visit.
visitTree
in class UIComponent
context
- the VisitContext
for this visitcallback
- the VisitCallback
instance
whose visit
method will be called
for each node visited.
true
to indicate that the tree visit is complete (eg. all components
that need to be visited have been visited). This results in
the tree visit being short-circuited such that no more components
are visited.UIComponent.visitTree(javax.faces.component.visit.VisitContext, javax.faces.component.visit.VisitCallback)
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |