Renders an HTML "img" element. Render the clientId as the value of the "id" attribute.
Handling the Value
If the "name" attribute is present, execute algorithm Common
Algorithm for Obtaining A Resource to Render to obtain a
Resource instance. Call
Resource.getRequestPath() and output the
result as the
value of the "src" attribute on the rendered markup.
Otherwise, if the "url" attribute is present, treat its
value as
if it was the value of the "value" attribute. Otherwise, if the
"value" attribute is present, render the value of the component as
the value of the "src" attribute, after passing it to the
getResourceURL() method of the ViewHandler
for this application, and passing the result through the
encodeResourceURL() method of the
ExternalContext.
When handling the "src" attribute,
the value must not be escaped. For example, &
must not
be turned into &. If the
"styleClass"
attribute is specified, render its value as the value of the "class"
attribute.
| Info | Value |
|---|---|
| Component Type | jakarta.faces.HtmlGraphicImage |
| Handler Class | None |
| Renderer Type | jakarta.faces.Image |
| Description | None |
| Name | Required | Type | Description |
|---|---|---|---|
id | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| The component identifier for this component. This value must be unique within the closest parent component that is a naming container. |
rendered | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Flag indicating whether or not this component should be rendered (during Render Response Phase), or processed on any subsequent form submit. The default value for this property is true. |
url | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Context-relative URL to retrieve the resource associated with this component. This is an alias for the "value" property. |
value | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Object)
| The current value of this component. |
alt | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Alternate textual description of the element rendered by this component. |
dir | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Direction indication for text that does not inherit directionality. Valid values are "LTR" (left-to-right) and "RTL" (right-to-left). |
height | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Override for the height of this image. |
ismap | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| 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". |
lang | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Code describing the language used in the generated markup for this component. |
library | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
|
The libraryName for this resource. |
longdesc | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| URI to a long description of the image represented by this element. |
name | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
|
The resourceName for this resource. |
onclick | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Javascript code executed when a pointer button is clicked over this element. |
ondblclick | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Javascript code executed when a pointer button is double clicked over this element. |
onkeydown | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Javascript code executed when a key is pressed down over this element. |
onkeypress | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Javascript code executed when a key is pressed and released over this element. |
onkeyup | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Javascript code executed when a key is released over this element. |
onmousedown | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Javascript code executed when a pointer button is pressed down over this element. |
onmousemove | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Javascript code executed when a pointer button is moved within this element. |
onmouseout | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Javascript code executed when a pointer button is moved away from this element. |
onmouseover | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Javascript code executed when a pointer button is moved onto this element. |
onmouseup | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Javascript code executed when a pointer button is released over this element. |
style | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| CSS style(s) to be applied when this component is rendered. |
styleClass | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| 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. |
title | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Advisory title information about markup elements generated for this component. |
usemap | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| The name of a client side image map (an HTML "map" element) for which this element provides the image. |
width | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Override for the width of this image. |
binding | false | jakarta.el.ValueExpression
(must evaluate to jakarta.faces.component.UIComponent)
| The ValueExpression linking this component to a property in a backing bean |
role | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
|
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. |