|
DRAFT | ||||||||
| 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 java.lang.String |
COMPONENT_FAMILY
The standard component family for this component. |
static java.lang.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, VIEW_LOCATION_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 | |
|---|---|
java.lang.String |
createUniqueId(FacesContext context,
java.lang.String seed)
Generate an identifier for a component. |
java.lang.String |
getContainerClientId(FacesContext context)
Override the UIComponent#getContainerClientId 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. |
java.lang.String |
getFamily()
Return the identifier of the component family to which this component belongs. |
boolean |
isPrependId()
The prependId flag. |
boolean |
isSubmitted()
Returns the current value of the submitted
property. |
void |
processDecodes(FacesContext context)
Override UIComponent#processDecodes to ensure that the
form is decoded before its children. |
void |
processUpdates(FacesContext context)
Override UIComponent#processUpdates to ensure that the
children of this UIForm instance are only processed
if isSubmitted() returns true. |
void |
processValidators(FacesContext context)
Override UIComponent#processValidators 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 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 java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Field Detail |
|---|
public static final java.lang.String COMPONENT_TYPE
The standard component type for this component.
public static final java.lang.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 java.lang.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 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 for this UIForm
instance.
The value of a UIForm's submitted property must
not be saved as part of its state.
public boolean isPrependId()
The prependId flag.
public void setPrependId(boolean prependId)
public void processDecodes(FacesContext context)
Override UIComponent#processDecodes 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
java.lang.NullPointerException - if context
is nullpublic void processValidators(FacesContext context)
Override UIComponent#processValidators 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
java.lang.NullPointerException - if context
is nullpublic void processUpdates(FacesContext context)
Override UIComponent#processUpdates 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
java.lang.NullPointerException - if context
is null
public java.lang.String createUniqueId(FacesContext context,
java.lang.String seed)
UniqueIdVendorGenerate an identifier for a component. The identifier will be prefixed with UNIQUE_ID_PREFIX, and will be unique within this component-container. Optionally, a unique seed value can be supplied by component creators which should be included in the generated unique id.
createUniqueId in interface UniqueIdVendorcontext - FacesContextseed - an optional seed value - e.g. based on the position of the component in the VDL-template
public java.lang.String getContainerClientId(FacesContext context)
Override the UIComponent#getContainerClientId 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 boolean visitTree(VisitContext context,
VisitCallback callback)
UIComponentPerform a tree visit starting at this node in the tree.
UIComponent.visitTree() implementations do not invoke the
VisitCallback directly, but instead call 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 UIComponentcontext - 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
|
DRAFT | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
Copyright © 2009 Sun Microsystems, Inc. All Rights Reserved. Use is subject to license terms.
Generated on 24-November-2009 03:24