Start line:  
End line:  

Snippet Preview

Snippet HTML Code

Stack Overflow Questions
  /*
   * $Id: UIForm.java,v 1.52.4.1 2007/10/18 16:57:29 rlubke Exp $
   */
  
  /*
   * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
   * 
   * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
   * 
  * The contents of this file are subject to the terms of either the GNU
  * General Public License Version 2 only ("GPL") or the Common Development
  * and Distribution License("CDDL") (collectively, the "License").  You
  * may not use this file except in compliance with the License. You can obtain
  * a copy of the License at https://glassfish.dev.java.net/public/CDDL+GPL.html
  * or glassfish/bootstrap/legal/LICENSE.txt.  See the License for the specific
  * language governing permissions and limitations under the License.
  * 
  * When distributing the software, include this License Header Notice in each
  * file and include the License file at glassfish/bootstrap/legal/LICENSE.txt.
  * Sun designates this particular file as subject to the "Classpath" exception
  * as provided by Sun in the GPL Version 2 section of the License file that
  * accompanied this code.  If applicable, add the following below the License
  * Header, with the fields enclosed by brackets [] replaced by your own
  * identifying information: "Portions Copyrighted [year]
  * [name of copyright owner]"
  * 
  * Contributor(s):
  * 
  * If you wish your version of this file to be governed by only the CDDL or
  * only the GPL Version 2, indicate your decision by adding "[Contributor]
  * elects to include this software in this distribution under the [CDDL or GPL
  * Version 2] license."  If you don't indicate a single choice of license, a
  * recipient has the option to distribute your version of this file under
  * either the CDDL, the GPL Version 2 or to extend the choice of license to
  * its licensees as provided above.  However, if you add GPL Version 2 code
  * and therefore, elected the GPL Version 2 license, then the option applies
  * only if the new code is made subject to such option by the copyright
  * holder.
  */
 
 package javax.faces.component;
 
 

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.

 
 
 public class UIForm extends UIComponentBase implements NamingContainer {
 
 
     // ------------------------------------------------------ Manifest Constants
 

    

The standard component type for this component.

 
     public static final String COMPONENT_TYPE = "javax.faces.Form";


    

The standard component family for this component.

 
     public static final String COMPONENT_FAMILY = "javax.faces.Form";
 
 
     // ------------------------------------------------------------ Constructors
 

    

Create a new UIForm instance with default property values.

 
     public UIForm() {
 
         super();
         setRendererType("javax.faces.Form");
 
     }
 
 
     // ------------------------------------------------------ Instance Variables
 
 
     // -------------------------------------------------------------- Properties
 
    public String getFamily() {
        return ();
    }


    

The form submitted flag for this UIForm.

    private boolean submitted = false;


    

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

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


    

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

The prependId flag.

    private Boolean prependId;
    public boolean isPrependId() {
	if (this. != null) {
	    return (this.);
	}
	ValueExpression ve = getValueExpression("prependId");
	if (ve != null) {
	    try {
	    }
	    catch (ELException e) {
		throw new FacesException(e);
	    }
else {
	    return (true);
	}
    }
    public void setPrependId(boolean prependId) {
        this. = prependId;
    }
    // ----------------------------------------------------- UIComponent Methods


    

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.

    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 = (UIComponentkids.next();
            kid.processDecodes(context);
        }
    }


    

Override UIComponent.processValidators(javax.faces.context.FacesContext) 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 = (UIComponentkids.next();
            kid.processValidators(context);
        }
    }


    

Override UIComponent.processUpdates(javax.faces.context.FacesContext) to ensure that the children of this UIForm instance are only processed if isSubmitted() returns true.

    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 = (UIComponentkids.next();
            kid.processUpdates(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.

    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;
    }
New to GrepCode? Check out our FAQ X