javax.faces.component: public class: UIGraphic

javax.faces.component
public class: UIGraphic [javadoc | source]

java.lang.Object
   javax.faces.component.UIComponent
      javax.faces.component.UIComponentBase
         javax.faces.component.UIGraphic

All Implemented Interfaces:
PartialStateHolder, ComponentSystemEventListener, SystemEventListenerHolder

Direct Known Subclasses:
HtmlGraphicImage

UIGraphic is a 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.

Nested Class Summary:
enum class	UIGraphic.PropertyKeys	Properties that are tracked by state saving.

Field Summary
public static final String	COMPONENT_TYPE	The standard component type for this component.
public static final String	COMPONENT_FAMILY	The standard component family for this component.

Fields inherited from javax.faces.component.UIComponent:
CURRENT_COMPONENT, CURRENT_COMPOSITE_COMPONENT, BEANINFO_KEY, FACETS_KEY, VIEW_LOCATION_KEY, COMPOSITE_COMPONENT_TYPE_KEY, COMPOSITE_FACET_NAME, attributesThatAreSet, stateHelper, compositeParent, bindings, initialState, listenersByEventClass

Constructor:
public UIGraphic() { super(); setRendererType("javax.faces.Image"); } Create a new UIGraphic instance with default property values.

Constructor:

 public UIGraphic() {
        super();
        setRendererType("javax.faces.Image");
}

Create a new UIGraphic instance with default property values.

Method from javax.faces.component.UIGraphic Summary:
getFamily, getUrl, getValue, getValueBinding, getValueExpression, setUrl, setValue, setValueBinding, setValueExpression

Methods from javax.faces.component.UIComponentBase:
addClientBehavior, addFacesListener, broadcast, clearInitialState, decode, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getClientId, getDefaultEventName, getDescriptorMap, getEventNames, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getParent, getRenderer, getRendererType, getRendersChildren, getValueBinding, invokeOnComponent, isRendered, isTransient, markInitialState, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, removeFacesListener, restoreAttachedState, restoreState, saveAttachedState, saveState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding

Methods from javax.faces.component.UIComponentBase:

addClientBehavior, addFacesListener, broadcast, clearInitialState, decode, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getClientId, getDefaultEventName, getDescriptorMap, getEventNames, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getParent, getRenderer, getRendererType, getRendersChildren, getValueBinding, invokeOnComponent, isRendered, isTransient, markInitialState, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, removeFacesListener, restoreAttachedState, restoreState, saveAttachedState, saveState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding

Methods from javax.faces.component.UIComponent:
addFacesListener, broadcast, clearInitialState, decode, encodeAll, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientId, getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getFamily, getId, getListenersForEventClass, getNamingContainer, getParent, getRenderer, getRendererType, getRendersChildren, getResourceBundleMap, getStateHelper, getStateHelper, getValueBinding, getValueExpression, initialStateMarked, invokeOnComponent, isCompositeComponent, isInView, isRendered, isVisitable, markInitialState, popComponentFromEL, processDecodes, processEvent, processRestoreState, processSaveState, processUpdates, processValidators, pushComponentToEL, queueEvent, removeFacesListener, setId, setInView, setParent, setRendered, setRendererType, setValueBinding, setValueExpression, subscribeToEvent, unsubscribeFromEvent, visitTree

Methods from javax.faces.component.UIComponent:

addFacesListener, broadcast, clearInitialState, decode, encodeAll, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientId, getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getFamily, getId, getListenersForEventClass, getNamingContainer, getParent, getRenderer, getRendererType, getRendersChildren, getResourceBundleMap, getStateHelper, getStateHelper, getValueBinding, getValueExpression, initialStateMarked, invokeOnComponent, isCompositeComponent, isInView, isRendered, isVisitable, markInitialState, popComponentFromEL, processDecodes, processEvent, processRestoreState, processSaveState, processUpdates, processValidators, pushComponentToEL, queueEvent, removeFacesListener, setId, setInView, setParent, setRendered, setRendererType, setValueBinding, setValueExpression, subscribeToEvent, unsubscribeFromEvent, visitTree

Methods from java.lang.Object:
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method from javax.faces.component.UIGraphic Detail:
public String getFamily() { return (COMPONENT_FAMILY); }
public String getUrl() { return ((String) getValue()); } Return the image URL for this UIGraphic . This method is a typesafe alias for `getValue()`.
public Object getValue() { return getStateHelper().eval(PropertyKeys.value); } Returns the `value` property of the `UIGraphic`. This will typically be rendered as an URL.
public ValueBinding getValueBinding(String name) { if ("url".equals(name)) { return (super.getValueBinding("value")); } else { return (super.getValueBinding(name)); } } Deprecated! `This` - has been replaced by #getValueExpression(java.lang.String) . Return any ValueBinding set for `value` if a ValueBinding for `url` is requested; otherwise, perform the default superclass processing for this method.
public ValueExpression getValueExpression(String name) { if ("url".equals(name)) { return (super.getValueExpression("value")); } else { return (super.getValueExpression(name)); } } Return any ValueExpression set for `value` if a ValueExpression for `url` is requested; otherwise, perform the default superclass processing for this method.
public void setUrl(String url) { setValue(url); } Set the image URL for this UIGraphic . This method is a typesafe alias for `setValue()`.
public void setValue(Object value) { getStateHelper().put(PropertyKeys.value, value); } Sets the `value` property of the `UIGraphic`. This will typically be rendered as an URL.
public void setValueBinding(String name, ValueBinding binding) { if ("url".equals(name)) { super.setValueBinding("value", binding); } else { super.setValueBinding(name, binding); } } Deprecated! `This` - has been replaced by #setValueExpression . Store any 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`.
public void setValueExpression(String name, ValueExpression binding) { if ("url".equals(name)) { super.setValueExpression("value", binding); } else { super.setValueExpression(name, binding); } } Store any ValueExpression specified for `url` under `value` instead; otherwise, perform the default superclass processing for this method.

Method from javax.faces.component.UIGraphic Detail:

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

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

Return the image URL for this UIGraphic . This method is a typesafe alias for getValue().

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

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

 public ValueBinding getValueBinding(String name) {
        if ("url".equals(name)) {
            return (super.getValueBinding("value"));
        } else {
            return (super.getValueBinding(name));
        }
}

Deprecated! This - has been replaced by #getValueExpression(java.lang.String) .

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

 public ValueExpression getValueExpression(String name) {
        if ("url".equals(name)) {
            return (super.getValueExpression("value"));
        } else {
            return (super.getValueExpression(name));
        }
}

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

 public  void setUrl(String url) {
        setValue(url);
}

Set the image URL for this UIGraphic . This method is a typesafe alias for setValue().

 public  void setValue(Object value) {
        getStateHelper().put(PropertyKeys.value, value);
}

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

 public  void setValueBinding(String name,
    ValueBinding binding) {
        if ("url".equals(name)) {
            super.setValueBinding("value", binding);
        } else {
            super.setValueBinding(name, binding);
        }
}

Deprecated! This - has been replaced by #setValueExpression .

Store any 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.

 public  void setValueExpression(String name,
    ValueExpression binding) {
        if ("url".equals(name)) {
            super.setValueExpression("value", binding);
        } else {
            super.setValueExpression(name, binding);
        }
}

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