graphicImage (OmniFaces VDL Documentation

Description:

The <o:graphicImage> is a component that extends the standard <h:graphicImage> with support for referencing an InputStream or byte[] property in value attribute. This property must point to a stateless @ApplicationScoped bean (both JSF and CDI scopes are supported).

Component Information
Info	Value
Component Type	`org.omnifaces.component.output.GraphicImage`
Handler Class	None
Renderer Type	None
Description	None

Attributes
Name	Required	Type	Description
`alt`	`false`	`jakarta.el.ValueExpression` (must evaluate to `java.lang.String`)	Alternate textual description of the element rendered by this component.
`binding`	`false`	`jakarta.el.ValueExpression` (must evaluate to `jakarta.faces.component.UIComponent`)	The `ValueExpression` linking this component to a property in a backing bean.
`dataURI`	`false`	`jakarta.el.ValueExpression` (must evaluate to `boolean`)	When set to `true` then the value will be rendered in data URI format instead of request URI format. This attribute is ignored when 'name' attribute is specified. When this attribute is set to 'true', 'lastModified' and 'fragment' attributes are ignored.
`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). These attributes are case sensitive when rendering to XHTML, so care must be taken to have the correct case.
`fragment`	`false`	`jakarta.el.ValueExpression` (must evaluate to `java.lang.String`)	The URL fragment identifier, which will be appended to generated resource URL. This is particularly useful with SVG images with view modes. The value does not necessarily need to start with '#', this will be checked. This attribute is ignored when 'dataURI' attribute is set to 'true'.
`height`	`false`	`jakarta.el.ValueExpression` (must evaluate to `java.lang.String`)	Override for the height of this image.
`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.
`ismap`	`false`	`jakarta.el.ValueExpression` (must evaluate to `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.
`lastModified`	`false`	`jakarta.el.ValueExpression` (must evaluate to `java.lang.Object`)	The "last modified" timestamp, can be either a java.lang.Long, or java.util.Date, or java.lang.String which is parseable as java.lang.Long. This attribute is ignored when 'name' attribute is specified or when 'dataURI' attribute is set to 'true'.
`lazy`	`false`	`jakarta.el.ValueExpression` (must evaluate to `boolean`)	When set to `true` then the referenced image will only be loaded when the window is finished loading and the image is visible in the viewport. This attribute is ignored when 'dataURI' attribute is specified.
`library`	`false`	`jakarta.el.ValueExpression` (must evaluate to `java.lang.String`)	The resource library name of the resource. Works the same way as on `<h:graphicImage>`. This attribtue is only used when 'name' attribute is specified.
`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 resource name of the resource. Works the same way as on `<h:graphicImage>`. When this attribute is specified, 'value', 'type' and 'lastModified' attributes are ignored.
`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.
`rendered`	`false`	`jakarta.el.ValueExpression` (must evaluate to `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.
`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.
`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 (simply put: the tooltip).
`type`	`false`	`jakarta.el.ValueExpression` (must evaluate to `java.lang.String`)	The image type, represented as file extension. E.g. "webp", "jpg", "png", "gif", "ico", "svg", "bmp", "tiff", etc. This attribute is ignored when 'name' attribute is specified.
`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.
`value`	`false`	`jakarta.el.ValueExpression` (must evaluate to `java.lang.Object`)	The value that will be rendered as the content of the HTML img element. It must represent a method expression referring a stateless backing bean method returning either byte[] or InputStream. Thus, NOT a view or session scoped bean, but a request or application scoped one. This attribute is ignored when 'name' attribute is specified.
`width`	`false`	`jakarta.el.ValueExpression` (must evaluate to `java.lang.String`)	Override for the width of this image.

o

Tag graphicImage