UIGraphic

java.lang.Object
- jakarta.faces.component.UIComponent
- - jakarta.faces.component.UIComponentBase
  - - jakarta.faces.component.UIGraphic

All Implemented Interfaces:

PartialStateHolder, StateHolder, TransientStateHolder, ComponentSystemEventListener, FacesListener, SystemEventListenerHolder, java.util.EventListener

Direct Known Subclasses:

HtmlGraphicImage
```
public class UIGraphic
extends UIComponentBase
```
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 "jakarta.faces.Image". This value can be changed by calling the setRendererType() method.

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`COMPONENT_FAMILY` The standard component family for this component.
`static java.lang.String`	`COMPONENT_TYPE` The standard component type for this component.

Fields inherited from class jakarta.faces.component.UIComponent
ATTRS_WITH_DECLARED_DEFAULT_VALUES, BEANINFO_KEY, bindings, COMPOSITE_COMPONENT_TYPE_KEY, COMPOSITE_FACET_NAME, CURRENT_COMPONENT, CURRENT_COMPOSITE_COMPONENT, FACETS_KEY, HONOR_CURRENT_COMPONENT_ATTRIBUTES_PARAM_NAME, VIEW_LOCATION_KEY

Constructor Summary

Constructors
Constructor and Description

UIGraphic()
Create a new UIGraphic instance with default property values.

Constructors
Constructor and Description
`UIGraphic()` Create a new `UIGraphic` instance with default property values.

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`java.lang.String`	`getFamily()` Return the identifier of the component family to which this component belongs.
`java.lang.String`	`getUrl()` Return the image URL for this `UIGraphic`.
`java.lang.Object`	`getValue()` Returns the `value` property of the `UIGraphic`.
`ValueBinding`	`getValueBinding(java.lang.String name)` Deprecated. This has been replaced by `getValueExpression(java.lang.String)`.
`ValueExpression`	`getValueExpression(java.lang.String name)` Return any `ValueExpression` set for `value` if a `ValueExpression` for `url` is requested; otherwise, perform the default superclass processing for this method.
`void`	`setUrl(java.lang.String url)` Set the image URL for this `UIGraphic`.
`void`	`setValue(java.lang.Object value)` Sets the `value` property of the `UIGraphic`.
`void`	`setValueBinding(java.lang.String name, ValueBinding binding)` Deprecated. This has been replaced by `setValueExpression(java.lang.String, jakarta.el.ValueExpression)`.
`void`	`setValueExpression(java.lang.String name, ValueExpression binding)` Store any `ValueExpression` specified for `url` under `value` instead; otherwise, perform the default superclass processing for this method.

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

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

- Field Detail
  - COMPONENT_TYPE
```
public static final java.lang.String COMPONENT_TYPE
```
    The standard component type for this component.
    
    See Also:
    
    Constant Field Values
  - COMPONENT_FAMILY
```
public static final java.lang.String COMPONENT_FAMILY
```
    The standard component family for this component.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - UIGraphic
```
public UIGraphic()
```
    Create a new UIGraphic instance with default property values.
- Method Detail
  - getFamily
```
public java.lang.String getFamily()
```
    Description copied from class: UIComponent
    
    Return the identifier of the component family to which this component belongs. This identifier, in conjunction with the value of the rendererType property, may be used to select the appropriate Renderer for this component instance. Note this method should NOT return null
    
    Specified by:
    
    getFamily in class UIComponent
    
    Returns:
    
    the component family (not null).
  - getUrl
```
public java.lang.String getUrl()
```
    Return the image URL for this UIGraphic. This method is a typesafe alias for getValue().
    
    Returns:
    
    the url.
  - setUrl
```
public void setUrl(java.lang.String url)
```
    Set the image URL for this UIGraphic. This method is a typesafe alias for setValue().
    
    Parameters:
    
    url - The new image URL
  - getValue
```
public java.lang.Object getValue()
```
    Returns the value property of the UIGraphic. This will typically be rendered as an URL.
    
    Returns:
    
    the value.
  - setValue
```
public void setValue(java.lang.Object value)
```
    Sets the value property of the UIGraphic. This will typically be rendered as an URL.
    
    Parameters:
    
    value - the new value
  - getValueBinding
```
@Deprecated
public ValueBinding getValueBinding(java.lang.String 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.
    
    Overrides:
    
    getValueBinding in class UIComponentBase
    
    Parameters:
    
    name - Name of the attribute or property for which to retrieve a ValueBinding
    
    Returns:
    
    the value binding, or null.
    
    Throws:
    
    java.lang.NullPointerException - if name is null
  - setValueBinding
```
@Deprecated
public void setValueBinding(java.lang.String name,
                                        ValueBinding binding)
```
    Deprecated. This has been replaced by setValueExpression(java.lang.String, jakarta.el.ValueExpression).
    
    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.
    
    Overrides:
    
    setValueBinding in class UIComponentBase
    
    Parameters:
    
    name - Name of the attribute or property for which to set a ValueBinding
    
    binding - The ValueBinding to set, or null to remove any currently set ValueBinding
    
    Throws:
    
    java.lang.NullPointerException - if name is null
  - getValueExpression
```
public ValueExpression getValueExpression(java.lang.String name)
```
    Return any ValueExpression set for value if a ValueExpression for url is requested; otherwise, perform the default superclass processing for this method.
    
    Overrides:
    
    getValueExpression in class UIComponent
    
    Parameters:
    
    name - Name of the attribute or property for which to retrieve a ValueExpression
    
    Returns:
    
    the value expression, or null.
    
    Throws:
    
    java.lang.NullPointerException - if name is null
    
    Since:
    
    1.2
  - setValueExpression
```
public void setValueExpression(java.lang.String name,
                               ValueExpression binding)
```
    Store any ValueExpression specified for url under value instead; otherwise, perform the default superclass processing for this method.
    
    Overrides:
    
    setValueExpression in class UIComponent
    
    Parameters:
    
    name - Name of the attribute or property for which to set a ValueExpression
    
    binding - The ValueExpression to set, or null to remove any currently set ValueExpression
    
    Throws:
    
    java.lang.NullPointerException - if name is null
    
    Since:
    
    1.2

Class UIGraphic

Field Summary

Fields inherited from class jakarta.faces.component.UIComponent

Constructor Summary

Method Summary

Methods inherited from class jakarta.faces.component.UIComponentBase

Methods inherited from class jakarta.faces.component.UIComponent

Methods inherited from class java.lang.Object

Field Detail

COMPONENT_TYPE

COMPONENT_FAMILY

Constructor Detail

UIGraphic

Method Detail

getFamily

getUrl

setUrl

getValue

setValue

getValueBinding

setValueBinding

getValueExpression

setValueExpression