facesdoc.HTML_BASIC.javax.faces.Graphicjavax.faces.Image.html Maven / Gradle / Ivy
Show all versions of javax.faces-api Show documentation
component-family: javax.faces.Graphic renderer-type: javax.faces.Image
HTML_BASIC render-kit
component-family: javax.faces.Graphic renderer-type: javax.faces.Image
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.
This renderer is responsible for rendering its children.
Note:
Attributes with a pass-through
value of
true
are not interpreted by the renderer and are passed
straight through to the rendered markup, without checking for validity. Attributes with a
pass-through
value of false
are interpreted
by the renderer, and may or may not be checked for validity by the renderer.
Attributes
attribute-name
pass-through
attribute-class
description
default-value
alt
true
java.lang.String
Alternate textual description of the
element rendered by this component.
undefined
dir
true
java.lang.String
Direction indication for text that does not inherit directionality.
Valid values are "LTR" (left-to-right) and "RTL" (right-to-left).
undefined
height
true
java.lang.String
Override for the height of this image.
undefined
ismap
false
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".
undefined
lang
true
java.lang.String
Code describing the language used in the generated markup
for this component.
undefined
library
false
java.lang.String
The libraryName for this resource.
undefined
longdesc
true
java.lang.String
URI to a long description of the image
represented by this element.
undefined
name
false
java.lang.String
The
resourceName for this resource.
undefined
onclick
true
java.lang.String
Javascript code executed when a pointer button is
clicked over this element.
undefined
ondblclick
true
java.lang.String
Javascript code executed when a pointer button is
double clicked over this element.
undefined
onkeydown
true
java.lang.String
Javascript code executed when a key is
pressed down over this element.
undefined
onkeypress
true
java.lang.String
Javascript code executed when a key is
pressed and released over this element.
undefined
onkeyup
true
java.lang.String
Javascript code executed when a key is
released over this element.
undefined
onmousedown
true
java.lang.String
Javascript code executed when a pointer button is
pressed down over this element.
undefined
onmousemove
true
java.lang.String
Javascript code executed when a pointer button is
moved within this element.
undefined
onmouseout
true
java.lang.String
Javascript code executed when a pointer button is
moved away from this element.
undefined
onmouseover
true
java.lang.String
Javascript code executed when a pointer button is
moved onto this element.
undefined
onmouseup
true
java.lang.String
Javascript code executed when a pointer button is
released over this element.
undefined
style
true
java.lang.String
CSS style(s) to be applied when this component is rendered.
undefined
styleClass
false
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.
undefined
title
true
java.lang.String
Advisory title information about markup elements generated
for this component.
undefined
usemap
true
java.lang.String
The name of a client side image map (an HTML "map"
element) for which this element provides the image.
undefined
width
true
java.lang.String
Override for the width of this image.
undefined
Copyright (c) 2003-2010 Oracle America, Inc. All Rights Reserved.