javax.faces.component.UIGraphic Maven / Gradle / Ivy
/*
* $Id: UIGraphic.java,v 1.42 2006/06/05 21:14:25 rlubke Exp $
*/
/*
* The contents of this file are subject to the terms
* of the Common Development and Distribution License
* (the License). You may not use this file except in
* compliance with the License.
*
* You can obtain a copy of the License at
* https://javaserverfaces.dev.java.net/CDDL.html or
* legal/CDDLv1.0.txt.
* See the License for the specific language governing
* permission and limitations under the License.
*
* When distributing Covered Code, include this CDDL
* Header Notice in each file and include the License file
* at legal/CDDLv1.0.txt.
* If applicable, add the following below the CDDL Header,
* with the fields enclosed by brackets [] replaced by
* your own identifying information:
* "Portions Copyrighted [year] [name of copyright owner]"
*
* [Name of File] [ver.__] [Date]
*
* Copyright 2005 Sun Microsystems Inc. All Rights Reserved
*/
package javax.faces.component;
import javax.el.ELException;
import javax.el.ValueExpression;
import javax.faces.FacesException;
import javax.faces.context.FacesContext;
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 {
// ------------------------------------------------------ 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() {
if (this.value != null) {
return (this.value);
}
ValueExpression ve = getValueExpression("value");
if (ve != null) {
try {
return (ve.getValue(getFacesContext().getELContext()));
}
catch (ELException e) {
throw new FacesException(e);
}
} else {
return (null);
}
}
/**
* 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) {
this.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
private Object[] values;
public Object saveState(FacesContext context) {
if (values == null) {
values = new Object[2];
}
values[0] = super.saveState(context);
values[1] = value;
return (values);
}
public void restoreState(FacesContext context, Object state) {
values = (Object[]) state;
super.restoreState(context, values[0]);
value = values[1];
}
}