MyFaces Projects
Documentation
Project Documentation
Foundation

Summary

Tag name: <s:graphicImageDynamic>
UIComponent class: org.apache.myfaces.custom.graphicimagedynamic.GraphicImageDynamic
Tag class: org.apache.myfaces.custom.graphicimagedynamic.GraphicImageDynamicTag
Component type: org.apache.myfaces.GraphicImageDynamic
Component family: javax.faces.Graphic
Renderer type: org.apache.myfaces.GraphicImageDynamicRenderer
Renderer class: org.apache.myfaces.custom.graphicimagedynamic.GraphicImageDynamicRenderer

Extends standard graphicImage.

This tag renders a html img tag and can be used to render dynamic images.

Embedding images into html pages requires a second request to get the binary data stream of the image. The result is that the state of the view including the state of request scoped beans will not be available when the image is requested.

The image data is written by an image renderer which can be defined by the imageRendererClass attribute.

This component is able to use nested f:param elements to pass parameters to the image renderer.

Usage

<s:graphicImageDynamic imageRendererClass="ImageRendererClass" >
  <f:param name="param" value="value" />
</s:graphicImageDynamic>

Instructions

see sandbox examples graphicImageDynamic.jsf and graphicImageDynamicText.jsf

Attributes

Name Type Supports EL? Description
align String Yes HTML: Specifies the horizontal alignment of this element. Deprecated in HTML 4.01.
alt String Yes HTML: Specifies alternative text that can be used by a browser that can't show this element.
binding String Only EL Identifies a backing bean property (of type UIComponent or appropriate subclass) to bind to this component instance. This value must be an EL expression.
border String Yes HTML: Specifies the width of the border of this element, in pixels. Deprecated in HTML 4.01.
dir String Yes HTML: The direction of text display, either 'ltr' (left-to-right) or 'rtl' (right-to-left).
enabledOnUserRole String Yes If user is in given role, this component will be rendered normally. If not, no hyperlink is rendered but all nested tags (=body) are rendered.
forceId boolean No If true, this component will force the use of the specified id when rendering.
forceIdIndex boolean No If false, this component will not append a '[n]' suffix (where 'n' is the row index) to components that are contained within a "list." This value will be true by default and the value will be ignored if the value of forceId is false (or not specified.)
height String Yes HTML: Overrides the natural height of this image, by specifying height in pixels.
hspace String Yes HTML: The amount of white space to be inserted to the left and right of this element, in undefined units. Deprecated in HTML 4.01.
id String Yes An identifier for this particular component instance within a component view.

The id must be unique within the scope of the tag's enclosing NamingContainer (eg h:form or f:subview). The id is not necessarily unique across all components in the current view

This value must be a static value, ie not change over the lifetime of a component. It cannot be defined via an EL expression; only a string is permitted.

imageRendererClass Class Yes The class which implements org.apache.myfaces.custom.graphicimagedynamic.ImageRenderer. The image renderer is responsible for loading the image. The class must have a default constructor. Any request scoped attribute or managed bean is not available when this image renderer is instantiated and used. The image renderer must render the binary data for the image by using the parameters passed by nested f:param elements and/or using session or application scoped beans.
ismap boolean Yes HTML: Specifies server-side image map handling for this image.
lang String Yes HTML: The base language of this document.
longdesc String Yes HTML: A link to a long description of the image.
onclick String Yes HTML: Script to be invoked when the element is clicked.
ondblclick String Yes HTML: Script to be invoked when the element is double-clicked.
onkeydown String Yes HTML: Script to be invoked when a key is pressed down over this element.
onkeypress String Yes HTML: Script to be invoked when a key is pressed over this element.
onkeyup String Yes HTML: Script to be invoked when a key is released over this element.
onmousedown String Yes HTML: Script to be invoked when the pointing device is pressed over this element.
onmousemove String Yes HTML: Script to be invoked when the pointing device is moved while it is in this element.
onmouseout String Yes HTML: Script to be invoked when the pointing device is moves out of this element.
onmouseover String Yes HTML: Script to be invoked when the pointing device is moved into this element.
onmouseup String Yes HTML: Script to be invoked when the pointing device is released over this element.
rendered boolean Yes A boolean value that indicates whether this component should be rendered. Default value: true.
style String Yes HTML: CSS styling instructions.
styleClass String Yes The CSS class for this element. Corresponds to the HTML 'class' attribute.
title String Yes HTML: An advisory title for this element. Often used by the user agent as a tooltip.
url String Yes An alias for the "value" attribute.
usemap String Yes HTML: Specifies an image map to use with this image.
value Object Yes A value binding which will be called to get the instance of an org.apache.myfaces.custom.graphicimagedynamic.ImageRenderer.
visibleOnUserRole String Yes If user is in given role, this component will be rendered normally. If not, nothing is rendered and the body of this tag will be skipped.
vspace String Yes HTML: The amount of white space to be inserted above and below this element, in undefined units. Deprecated in HTML 4.01.
width String Yes HTML: Overrides the natural width of this image, by specifying width in pixels.