Package jakarta.faces.component.html

Class HtmlGraphicImage

java.lang.Object
jakarta.faces.component.UIComponent
jakarta.faces.component.UIComponentBase
jakarta.faces.component.UIGraphic
jakarta.faces.component.html.HtmlGraphicImage
All Implemented Interfaces:
ClientBehaviorHolder, PartialStateHolder, StateHolder, TransientStateHolder, ComponentSystemEventListener, FacesListener, SystemEventListenerHolder, EventListener
public class HtmlGraphicImage extends UIGraphic implements ClientBehaviorHolder

Represents an HTML img element, used to retrieve and render a graphical image.

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

  • Field Details

    • COMPONENT_TYPE

      public static final String COMPONENT_TYPE

      The standard component type for this component.

      See Also:

  • Constructor Details

    • HtmlGraphicImage

      public HtmlGraphicImage()

  • Method Details

    • getAlt

      public String getAlt()

      Return the value of the alt property.

      Returns:
      the property value

      Contents: Alternate textual description of the element rendered by this component.

    • setAlt

      public void setAlt(String alt)

      Set the value of the alt property.

      Parameters:
      alt - the new property value

    • getDir

      public String getDir()

      Return the value of the dir property.

      Returns:
      the property value

      Contents: Direction indication for text that does not inherit directionality. Valid values are "LTR" (left-to-right) and "RTL" (right-to-left). These attributes are case sensitive when rendering to XHTML, so care must be taken to have the correct case.

    • setDir

      public void setDir(String dir)

      Set the value of the dir property.

      Parameters:
      dir - the new property value

    • getHeight

      public String getHeight()

      Return the value of the height property.

      Returns:
      the property value

      Contents: Override for the height of this image.

    • setHeight

      public void setHeight(String height)

      Set the value of the height property.

      Parameters:
      height - the new property value

    • isIsmap

      public boolean isIsmap()

      Return the value of the ismap property.

      Returns:
      the property value

      Contents: Flag indicating that this image is to be used as a server side image map. Such an image must be enclosed within a hyperlink ("a"). A value of false causes no attribute to be rendered, while a value of true causes the attribute to be rendered as ismap="ismap".

    • setIsmap

      public void setIsmap(boolean ismap)

      Set the value of the ismap property.

      Parameters:
      ismap - the new property value

    • getLang

      public String getLang()

      Return the value of the lang property.

      Returns:
      the property value

      Contents: Code describing the language used in the generated markup for this component.

    • setLang

      public void setLang(String lang)

      Set the value of the lang property.

      Parameters:
      lang - the new property value

    • getLongdesc

      public String getLongdesc()

      Return the value of the longdesc property.

      Returns:
      the property value

      Contents: URI to a long description of the image represented by this element.

    • setLongdesc

      public void setLongdesc(String longdesc)

      Set the value of the longdesc property.

      Parameters:
      longdesc - the new property value

    • getOnclick

      public String getOnclick()

      Return the value of the onclick property.

      Returns:
      the property value

      Contents: Javascript code executed when a pointer button is clicked over this element.

    • setOnclick

      public void setOnclick(String onclick)

      Set the value of the onclick property.

      Parameters:
      onclick - the new property value

    • getOndblclick

      public String getOndblclick()

      Return the value of the ondblclick property.

      Returns:
      the property value

      Contents: Javascript code executed when a pointer button is double clicked over this element.

    • setOndblclick

      public void setOndblclick(String ondblclick)

      Set the value of the ondblclick property.

      Parameters:
      ondblclick - the new property value

    • getOnkeydown

      public String getOnkeydown()

      Return the value of the onkeydown property.

      Returns:
      the property value

      Contents: Javascript code executed when a key is pressed down over this element.

    • setOnkeydown

      public void setOnkeydown(String onkeydown)

      Set the value of the onkeydown property.

      Parameters:
      onkeydown - the new property value

    • getOnkeypress

      public String getOnkeypress()

      Return the value of the onkeypress property.

      Returns:
      the property value

      Contents: Javascript code executed when a key is pressed and released over this element.

    • setOnkeypress

      public void setOnkeypress(String onkeypress)

      Set the value of the onkeypress property.

      Parameters:
      onkeypress - the new property value

    • getOnkeyup

      public String getOnkeyup()

      Return the value of the onkeyup property.

      Returns:
      the property value

      Contents: Javascript code executed when a key is released over this element.

    • setOnkeyup

      public void setOnkeyup(String onkeyup)

      Set the value of the onkeyup property.

      Parameters:
      onkeyup - the new property value

    • getOnmousedown

      public String getOnmousedown()

      Return the value of the onmousedown property.

      Returns:
      the property value

      Contents: Javascript code executed when a pointer button is pressed down over this element.

    • setOnmousedown

      public void setOnmousedown(String onmousedown)

      Set the value of the onmousedown property.

      Parameters:
      onmousedown - the new property value

    • getOnmousemove

      public String getOnmousemove()

      Return the value of the onmousemove property.

      Returns:
      the property value

      Contents: Javascript code executed when a pointer button is moved within this element.

    • setOnmousemove

      public void setOnmousemove(String onmousemove)

      Set the value of the onmousemove property.

      Parameters:
      onmousemove - the new property value

    • getOnmouseout

      public String getOnmouseout()

      Return the value of the onmouseout property.

      Returns:
      the property value

      Contents: Javascript code executed when a pointer button is moved away from this element.

    • setOnmouseout

      public void setOnmouseout(String onmouseout)

      Set the value of the onmouseout property.

      Parameters:
      onmouseout - the new property value

    • getOnmouseover

      public String getOnmouseover()

      Return the value of the onmouseover property.

      Returns:
      the property value

      Contents: Javascript code executed when a pointer button is moved onto this element.

    • setOnmouseover

      public void setOnmouseover(String onmouseover)

      Set the value of the onmouseover property.

      Parameters:
      onmouseover - the new property value

    • getOnmouseup

      public String getOnmouseup()

      Return the value of the onmouseup property.

      Returns:
      the property value

      Contents: Javascript code executed when a pointer button is released over this element.

    • setOnmouseup

      public void setOnmouseup(String onmouseup)

      Set the value of the onmouseup property.

      Parameters:
      onmouseup - the new property value

    • getRole

      public String getRole()

      Return the value of the role property.

      Returns:
      the property value

      Contents:

      Per the WAI-ARIA spec and its relationship to HTML5 (Section title ARIA Role Attriubute), every HTML element may have a "role" attribute whose value must be passed through unmodified on the element on which it is declared in the final rendered markup. The attribute, if specified, must have a value that is a string literal that is, or an EL Expression that evaluates to, a set of space-separated tokens representing the various WAI-ARIA roles that the element belongs to.

      It is the page author's responsibility to ensure that the user agent is capable of correctly interpreting the value of this attribute.

    • setRole

      public void setRole(String role)

      Set the value of the role property.

      Parameters:
      role - the new property value

    • getStyle

      public String getStyle()

      Return the value of the style property.

      Returns:
      the property value

      Contents: CSS style(s) to be applied when this component is rendered.

    • setStyle

      public void setStyle(String style)

      Set the value of the style property.

      Parameters:
      style - the new property value

    • getStyleClass

      public String getStyleClass()

      Return the value of the styleClass property.

      Returns:
      the property value

      Contents: Space-separated list of CSS style class(es) to be applied when this element is rendered. This value must be passed through as the "class" attribute on generated markup.

    • setStyleClass

      public void setStyleClass(String styleClass)

      Set the value of the styleClass property.

      Parameters:
      styleClass - the new property value

    • getTitle

      public String getTitle()

      Return the value of the title property.

      Returns:
      the property value

      Contents: Advisory title information about markup elements generated for this component.

    • setTitle

      public void setTitle(String title)

      Set the value of the title property.

      Parameters:
      title - the new property value

    • getUsemap

      public String getUsemap()

      Return the value of the usemap property.

      Returns:
      the property value

      Contents: The name of a client side image map (an HTML "map" element) for which this element provides the image.

    • setUsemap

      public void setUsemap(String usemap)

      Set the value of the usemap property.

      Parameters:
      usemap - the new property value

    • getWidth

      public String getWidth()

      Return the value of the width property.

      Returns:
      the property value

      Contents: Override for the width of this image.

    • setWidth

      public void setWidth(String width)

      Set the value of the width property.

      Parameters:
      width - the new property value

    • getEventNames

      public Collection<String> getEventNames()
      Description copied from class: UIComponentBase

      This is a default implementation of ClientBehaviorHolder.getEventNames(). UIComponent does not implement the ClientBehaviorHolder interface, but provides default implementations for the methods defined by ClientBehaviorHolder to simplify subclass implementations. Subclasses that wish to support the ClientBehaviorHolder contract must declare that the subclass implements ClientBehaviorHolder, and must override this method to return a non-Empty Collection of the client event names that the component supports.

      Specified by:
      getEventNames in interface ClientBehaviorHolder
      Overrides:
      getEventNames in class UIComponentBase
      Returns:
      the collection of event names.

    • getDefaultEventName

      public String getDefaultEventName()
      Description copied from class: UIComponentBase

      This is a default implementation of ClientBehaviorHolder.getDefaultEventName(). UIComponent does not implement the ClientBehaviorHolder interface, but provides default implementations for the methods defined by ClientBehaviorHolder to simplify subclass implementations. Subclasses that wish to support the ClientBehaviorHolder contract must declare that the subclass implements ClientBehaviorHolder, and must provide an implementation of ClientBehaviorHolder.getEventNames().

      Specified by:
      getDefaultEventName in interface ClientBehaviorHolder
      Overrides:
      getDefaultEventName in class UIComponentBase
      Returns:
      the default event name.