Home » Mojarra-2.0.1 » javax » faces » component » [javadoc | source]
public class: UIForm [javadoc | source]

All Implemented Interfaces:
    UniqueIdVendor, NamingContainer, PartialStateHolder, ComponentSystemEventListener, SystemEventListenerHolder

Direct Known Subclasses:

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.

Nested Class Summary:
enum class  UIForm.PropertyKeys  Properties that are tracked by state saving. 
Field Summary
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.

Fields inherited from javax.faces.component.UIComponent:
 public UIForm() 
Method from javax.faces.component.UIForm Summary:
createUniqueId,   getContainerClientId,   getFamily,   isPrependId,   isSubmitted,   processDecodes,   processUpdates,   processValidators,   setPrependId,   setSubmitted,   visitTree
Methods from javax.faces.component.UIComponentBase:
addClientBehavior,   addFacesListener,   broadcast,   clearInitialState,   decode,   encodeBegin,   encodeChildren,   encodeEnd,   findComponent,   getAttributes,   getChildCount,   getChildren,   getClientBehaviors,   getClientId,   getDefaultEventName,   getDescriptorMap,   getEventNames,   getFacesContext,   getFacesListeners,   getFacet,   getFacetCount,   getFacets,   getFacetsAndChildren,   getId,   getParent,   getRenderer,   getRendererType,   getRendersChildren,   getValueBinding,   invokeOnComponent,   isRendered,   isTransient,   markInitialState,   processDecodes,   processRestoreState,   processSaveState,   processUpdates,   processValidators,   queueEvent,   removeFacesListener,   restoreAttachedState,   restoreState,   saveAttachedState,   saveState,   setId,   setParent,   setRendered,   setRendererType,   setTransient,   setValueBinding
Methods from javax.faces.component.UIComponent:
addFacesListener,   broadcast,   clearInitialState,   decode,   encodeAll,   encodeBegin,   encodeChildren,   encodeEnd,   findComponent,   getAttributes,   getChildCount,   getChildren,   getClientId,   getClientId,   getCompositeComponentParent,   getContainerClientId,   getCurrentComponent,   getCurrentCompositeComponent,   getFacesContext,   getFacesListeners,   getFacet,   getFacetCount,   getFacets,   getFacetsAndChildren,   getFamily,   getId,   getListenersForEventClass,   getNamingContainer,   getParent,   getRenderer,   getRendererType,   getRendersChildren,   getResourceBundleMap,   getStateHelper,   getStateHelper,   getValueBinding,   getValueExpression,   initialStateMarked,   invokeOnComponent,   isCompositeComponent,   isInView,   isRendered,   isVisitable,   markInitialState,   popComponentFromEL,   processDecodes,   processEvent,   processRestoreState,   processSaveState,   processUpdates,   processValidators,   pushComponentToEL,   queueEvent,   removeFacesListener,   setId,   setInView,   setParent,   setRendered,   setRendererType,   setValueBinding,   setValueExpression,   subscribeToEvent,   unsubscribeFromEvent,   visitTree
Methods from java.lang.Object:
clone,   equals,   finalize,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from javax.faces.component.UIForm Detail:
 public String createUniqueId(FacesContext context,
    String seed) 
 public String getContainerClientId(FacesContext context) 
 public String getFamily() 
 public boolean isPrependId() 

    The prependId flag.

 public boolean isSubmitted() 

    Returns the current value of the submitted property. The default value is false. See #setSubmitted for details.

 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.

 public  void processUpdates(FacesContext context) 
 public  void processValidators(FacesContext context) 
 public  void setPrependId(boolean prependId) 
 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 visitTree(VisitContext context,
    VisitCallback callback)