The standard component type for this component.

The standard component family for this component.

 public UIForm() 
{
    // ------------------------------------------------------------ Constructors
        super();
        setRendererType("javax.faces.Form");
}

Create a new UIForm instance with default property values.

 public String getContainerClientId(FacesContext context) 
{
        if (this.isPrependId()) {
            return super.getContainerClientId(context);
        } else {
            UIComponent parent = this.getParent();
            while (parent != null) {
                if (parent instanceof NamingContainer) {
                    return parent.getContainerClientId(context);
                }
                parent = parent.getParent();
            }
        }
        return null;
}

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.

 public String getFamily() 
{
        return (COMPONENT_FAMILY);
}

 public boolean isPrependId() 
{
	if (this.prependId != null) {
	    return (this.prependId);
	}
	ValueExpression ve = getValueExpression("prependId");
	if (ve != null) {
	    try {
		return (Boolean.TRUE.equals(ve.getValue(getFacesContext().getELContext())));
	    }
	    catch (ELException e) {
		throw new FacesException(e);
	    }
	} else {
	    return (true);
	}
}

 public boolean isSubmitted() 
{
                             
        return (this.submitted);
}

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

 public  void processDecodes(FacesContext context) 
{
        if (context == null) {
            throw new NullPointerException();
        }
        // Process this component itself
        decode(context);
	// if we're not the submitted form, don't process children.
	if (!isSubmitted()) {
	    return;
	}
        // Process all facets and children of this component
        Iterator kids = getFacetsAndChildren();
        while (kids.hasNext()) {
            UIComponent kid = (UIComponent) kids.next();
            kid.processDecodes(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) 
{
        if (context == null) {
            throw new NullPointerException();
        }
	if (!isSubmitted()) {
	    return;
	}
        // Process all facets and children of this component
        Iterator kids = getFacetsAndChildren();
        while (kids.hasNext()) {
            UIComponent kid = (UIComponent) kids.next();
            kid.processUpdates(context);
        }
}

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

 public  void processValidators(FacesContext context) 
{
        if (context == null) {
            throw new NullPointerException();
        }
	if (!isSubmitted()) {
	    return;
	}
        // Process all the facets and children of this component
        Iterator kids = getFacetsAndChildren();
        while (kids.hasNext()) {
            UIComponent kid = (UIComponent) kids.next();
            kid.processValidators(context);
        }
}

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

 public  void restoreState(FacesContext context,
    Object state) 
{
        values = (Object[]) state;
        super.restoreState(context, values[0]);
        prependId = (Boolean) values[1];
}

 public Object saveState(FacesContext context) 
{
        if (values == null) {
             values = new Object[2];
        }
        values[0] = super.saveState(context);
        values[1] = prependId;
        return values;
}

 public  void setPrependId(boolean prependId) 
{
        this.prependId = prependId;
}

 public  void setSubmitted(boolean submitted) 
{
        this.submitted = 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.