Tag GraphicImage (JSF 2.0)

Monday, 09 April 2012 15:01

Tag GraphicImage with JSF 2.0

GraphicImage tag displays image on the page.�It renders an html "img" element. This tag renders the image file stored in the location specified in the "value" attribute of "graphicImage" tag.

Value Handling

If the "name" attribute is present, it executes 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.

Using resource library with JSF 2.0

In JSF 2.0, all your resources files like css , images or JavaScript , should be located into a �resources� folder in the root of your web application (same folder level as �WEB-INF� folder).

In the following example :

 
<h:graphicImage library="images" name="mylogo.png" />

The image "mylogo.png" should be located in :

+web_app root
   +resources
      +images
         +mylogo.png 

Tag Information

Tag Information
Tag Class .GraphicImageTag
TagExtraInfo Class None
Body Content JSP
Display Name None

GraphicImage Attributes

Attributes
Name Required Request-time Type Description
id false true 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 false javax.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.
url false false javax.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 false javax.el.ValueExpression
( must evaluate to java.lang.Object )
The current value of this component.
alt false false javax.el.ValueExpression
( must evaluate to java.lang.String )
Alternate textual description of the element rendered by this component.
dir false false javax.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 false javax.el.ValueExpression
( must evaluate to java.lang.String )
Override for the height of this image.
ismap false false javax.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 false javax.el.ValueExpression
( must evaluate to java.lang.String )
Code describing the language used in the generated markup for this component.
library false false javax.el.ValueExpression
( must evaluate to java.lang.String )

The libraryName for this resource.

longdesc false false javax.el.ValueExpression
( must evaluate to java.lang.String )
URI to a long description of the image represented by this element.
name false false javax.el.ValueExpression
( must evaluate to java.lang.String )

The resourceName for this resource.

onclick false false javax.el.ValueExpression
( must evaluate to java.lang.String )
Javascript code executed when a pointer button is clicked over this element.
ondblclick false false javax.el.ValueExpression
( must evaluate to java.lang.String )
Javascript code executed when a pointer button is double clicked over this element.
onkeydown false false javax.el.ValueExpression
( must evaluate to java.lang.String )
Javascript code executed when a key is pressed down over this element.
onkeypress false false javax.el.ValueExpression
( must evaluate to java.lang.String )
Javascript code executed when a key is pressed and released over this element.
onkeyup false false javax.el.ValueExpression
( must evaluate to java.lang.String )
Javascript code executed when a key is released over this element.
onmousedown false false javax.el.ValueExpression
( must evaluate to java.lang.String )
Javascript code executed when a pointer button is pressed down over this element.
onmousemove false false javax.el.ValueExpression
( must evaluate to java.lang.String )
Javascript code executed when a pointer button is moved within this element.
onmouseout false false javax.el.ValueExpression
( must evaluate to java.lang.String )
Javascript code executed when a pointer button is moved away from this element.
onmouseover false false javax.el.ValueExpression
( must evaluate to java.lang.String )
Javascript code executed when a pointer button is moved onto this element.
onmouseup false false javax.el.ValueExpression
( must evaluate to java.lang.String )
Javascript code executed when a pointer button is released over this element.
style false false javax.el.ValueExpression
( must evaluate to java.lang.String )
CSS style(s) to be applied when this component is rendered.
styleClass false false javax.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 false javax.el.ValueExpression
( must evaluate to java.lang.String )
Advisory title information about markup elements generated for this component.
usemap false false javax.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 false javax.el.ValueExpression
( must evaluate to java.lang.String )
Override for the width of this image.
binding false false javax.el.ValueExpression
( must evaluate to javax.faces.component.UIComponent )
The ValueExpression linking this component to a property in a backing bean
Tags: class , attribute , graphicimage , present , render

Add comment


Security code
Refresh