Package jakarta.faces.component

Class 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, 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 Details

  • Constructor Details

    • UIGraphic

      public UIGraphic()

      Create a new UIGraphic instance with default property values.

  • Method Details

    • getFamily

      public 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 String getUrl()

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

      Returns:
      the url.

    • setUrl

      public void setUrl​(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 Object getValue()

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

      Returns:
      the value.

    • setValue

      public void setValue​(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​(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:
      NullPointerException - if name is null

    • setValueBinding

      @Deprecated public void setValueBinding​(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:
      NullPointerException - if name is null

    • getValueExpression

      public jakarta.el.ValueExpression getValueExpression​(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:
      NullPointerException - if name is null
      Since:
      1.2

    • setValueExpression

      public void setValueExpression​(String name, jakarta.el.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:
      NullPointerException - if name is null
      Since:
      1.2