|
Java EE 5 SDK | ||||||||
| 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 |
|---|
bindings |
| 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 |
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. |
| Methods inherited from class javax.faces.component.UIComponent |
|---|
encodeAll |
| 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()
UIComponentReturn 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 UIComponentpublic 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 UIComponentBasecontext - FacesContext for the request we are processing
NullPointerException - if context
is nullpublic 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 UIComponentBasecontext - FacesContext for the request we are processing
NullPointerException - if context
is nullpublic 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 UIComponentBasecontext - FacesContext for the request we are processing
NullPointerException - if context
is nullpublic 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
|
Java EE 5 SDK | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
Copyright 2006 Sun Microsystems, Inc. All rights reserved.