Start line:  
End line:  

Snippet Preview

Snippet HTML Code

Stack Overflow Questions
  /*
   * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
   *
   * Copyright (c) 1997-2010 Oracle and/or its affiliates. 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_1_1.html
  * or packager/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 packager/legal/LICENSE.txt.
  *
  * GPL Classpath Exception:
  * Oracle designates this particular file as subject to the "Classpath"
  * exception as provided by Oracle in the GPL Version 2 section of the License
  * file that accompanied this code.
  *
  * Modifications:
  * If applicable, add the following below the License Header, with the fields
  * enclosed by brackets [] replaced by your own identifying information:
  * "Portions Copyright [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;



UIParameter is a UIComponent that represents an optionally named configuration parameter for a parent component.

Parent components should retrieve the value of a parameter by calling getValue(). In this way, the parameter value can be set directly on the component (via setValue()), or retrieved indirectly via the value binding expression.

In some scenarios, it is necessary to provide a parameter name, in addition to the parameter value that is accessible via the getValue() method. javax.faces.render.Renderers that support parameter names on their nested UIParameter child components should document their use of this property.

 
 
 public class UIParameter extends UIComponentBase {
 
 
     // ------------------------------------------------------ Manifest Constants
 

    

The standard component type for this component.

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


    

The standard component family for this component.

 
     public static final String COMPONENT_FAMILY = "javax.faces.Parameter";
 
 
     enum PropertyKeys {
         name,
         value,
         disable
     }
 
 
     // ------------------------------------------------------------ Constructors
 

    

Create a new UIParameter instance with default property values.

 
     public UIParameter() {
 
         super();
         setRendererType(null);
 
    }
    // -------------------------------------------------------------- Properties
    public String getFamily() {
        return ();
    }


    

Return the optional parameter name for this parameter.

    public String getName() {
        return (StringgetStateHelper().eval(.);
    }


    

Set the optional parameter name for this parameter.

Parameters:
name The new parameter name, or null for no name
    public void setName(String name) {
        getStateHelper().put(.name);
    }



    

Returns the value property of the UIParameter.

    public Object getValue() {
        return getStateHelper().eval(.);
    }


    

Sets the value property of the\ UIParameter.

Parameters:
value the new value
    public void setValue(Object value) {
        getStateHelper().put(.value);
    }

    

Return the value of the disable directive for this component. This directive determines whether the parameter value should be disabled by assigning it a null value. If true, the value set on this component is ignored.

Since:
2.0
    public boolean isDisable() {
        return (BooleangetStateHelper().eval(.false);
    }

    

Sets the disable property of the UIParameter.

Parameters:
disable
Since:
2.0
    public void setDisable(boolean disable) {
        getStateHelper().put(.disable);
    }
New to GrepCode? Check out our FAQ X