All Downloads are FREE. Search and download functionalities are using the official Maven repository.

javax.faces.component.UIGraphic Maven / Gradle / Ivy

Go to download

This is the master POM file for Oracle's Implementation of the JSF 2.2 Specification.

There is a newer version: 2.2.20
Show newest version
/*
 * 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;


import javax.el.ValueExpression;
import javax.faces.el.ValueBinding;


/**
 * 

UIGraphic is a {@link UIComponent} that displays * a graphical image to the user. The user cannot manipulate this component; * it is for display purposes only.

* *

By default, the rendererType property must be set to * "javax.faces.Image". This value can be changed by calling the * setRendererType() method.

*/ public class UIGraphic extends UIComponentBase { /** * Properties that are tracked by state saving. */ enum PropertyKeys { /** *

The local value of this {@link UIComponent}.

*/ value } // ------------------------------------------------------ Manifest Constants /** *

The standard component type for this component.

*/ public static final String COMPONENT_TYPE = "javax.faces.Graphic"; /** *

The standard component family for this component.

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

Create a new {@link UIGraphic} instance with default property * values.

*/ public UIGraphic() { super(); setRendererType("javax.faces.Image"); } // ------------------------------------------------------ Instance Variables //private Object value = null; // -------------------------------------------------------------- Properties public String getFamily() { return (COMPONENT_FAMILY); } /** *

Return the image URL for this {@link UIGraphic}. This method is a * typesafe alias for getValue().

*/ public String getUrl() { return ((String) getValue()); } /** *

Set the image URL for this {@link UIGraphic}. This method is a * typesafe alias for setValue().

* * @param url The new image URL */ public void setUrl(String url) { setValue(url); } /** *

Returns the value property of the * UIGraphic. This will typically be rendered as an URL.

*/ public Object getValue() { return getStateHelper().eval(PropertyKeys.value); } /** *

Sets the value property of the UIGraphic. * This will typically be rendered as an URL.

* * @param value the new value */ public void setValue(Object value) { getStateHelper().put(PropertyKeys.value, value); } // ---------------------------------------------------------------- Bindings /** *

Return any {@link ValueBinding} set for value if a * {@link ValueBinding} for url is requested; otherwise, * perform the default superclass processing for this method.

* * @param name Name of the attribute or property for which to retrieve * a {@link ValueBinding} * * @throws NullPointerException if name * is null * * @deprecated This has been replaced by {@link #getValueExpression(java.lang.String)}. */ public ValueBinding getValueBinding(String name) { if ("url".equals(name)) { return (super.getValueBinding("value")); } else { return (super.getValueBinding(name)); } } /** *

Store any {@link ValueBinding} specified for url * under value instead; otherwise, perform the default * superclass processing for this method. In all cases, the * superclass is relied on to convert the ValueBinding * to a ValueExpression.

* * @param name Name of the attribute or property for which to set * a {@link ValueBinding} * @param binding The {@link ValueBinding} to set, or null * to remove any currently set {@link ValueBinding} * * @throws NullPointerException if name * is null * * @deprecated This has been replaced by {@link #setValueExpression}. */ public void setValueBinding(String name, ValueBinding binding) { if ("url".equals(name)) { super.setValueBinding("value", binding); } else { super.setValueBinding(name, binding); } } /** *

Return any {@link ValueExpression} set for value if a * {@link ValueExpression} for url is requested; otherwise, * perform the default superclass processing for this method.

* * @param name Name of the attribute or property for which to retrieve * a {@link ValueExpression} * * @throws NullPointerException if name * is null * @since 1.2 */ public ValueExpression getValueExpression(String name) { if ("url".equals(name)) { return (super.getValueExpression("value")); } else { return (super.getValueExpression(name)); } } /** *

Store any {@link ValueExpression} specified for url under * value instead; otherwise, perform the default superclass * processing for this method.

* * @param name Name of the attribute or property for which to set * a {@link ValueExpression} * @param binding The {@link ValueExpression} to set, or null * to remove any currently set {@link ValueExpression} * * @throws NullPointerException if name * is null * @since 1.2 */ public void setValueExpression(String name, ValueExpression binding) { if ("url".equals(name)) { super.setValueExpression("value", binding); } else { super.setValueExpression(name, binding); } } // ----------------------------------------------------- StateHolder Methods }




© 2015 - 2024 Weber Informatics LLC | Privacy Policy