Class Hierarchy All Classes All Fields and Methods

 

Class javax.faces.component.UIForm

java.lang.Object
        javax.faces.component.UIComponent
                javax.faces.component.UIComponentBase
                        javax.faces.component.UIForm

public class UIForm
implements NamingContainer
extends UIComponentBase

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 Index

Field	Description
COMPONENT_FAMILY	The standard component family for this component.
COMPONENT_TYPE	The standard component type for this component.

Constructor Index

Constructor	Description
UIForm()	Create a new UIForm instance with default property values.

Method Index

Method	Description
String getFamily()
boolean isSubmitted()	Returns the current value of the submitted property.
void processDecodes(FacesContext)	Override processDecodes to ensure that the form is decoded before its children.
void processUpdates(FacesContext)	Override processUpdates to ensure that the children of this UIForm instance are only processed if isSubmitted returns true.
void processValidators(FacesContext)	Override processValidators to ensure that the children of this UIForm instance are only processed if isSubmitted returns true.
Object saveState(FacesContext)	Override saveState() to call setSubmitted(false).
void setSubmitted(boolean)	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, passing true, during the decode for this UIForm instance.

 

Fields

 

COMPONENT_FAMILY

public static final java.lang.String COMPONENT_FAMILY

The standard component family for this component.

 

COMPONENT_TYPE

public static final java.lang.String COMPONENT_TYPE

The standard component type for this component.

 

Constructors

 

UIForm

public UIForm() 

Create a new UIForm instance with default property values.

 

Methods

 

getFamily

public String getFamily() 

 

isSubmitted

public boolean isSubmitted() 

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

 

processDecodes

public void processDecodes(FacesContext context) 

Override processDecodes to ensure that the form is decoded before its children. This is necessary to allow the submitted property to be correctly set.

• Throws

  • NullPointerException {@inheritDoc}

• Overrides

  • processDecodes in class UIComponentBase

 

processUpdates

public void processUpdates(FacesContext context) 

Override processUpdates to ensure that the children of this UIForm instance are only processed if isSubmitted returns true.

• Throws

  • NullPointerException {@inheritDoc}

• Overrides

  • processUpdates in class UIComponentBase

 

processValidators

public void processValidators(FacesContext context) 

Override processValidators to ensure that the children of this UIForm instance are only processed if isSubmitted returns true.

• Throws

  • NullPointerException {@inheritDoc}

• Overrides

  • processValidators in class UIComponentBase

 

saveState

public Object saveState(FacesContext context) 

Override saveState() to call setSubmitted(false).

 

setSubmitted

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, passing true, during the decode for this UIForm instance.

The value of a UIForm's submitted property must not be saved as part of its state.

Class Hierarchy All Classes All Fields and Methods