Project Documentation


Tag name: <s:imageLoop>
UIComponent class: org.apache.myfaces.custom.imageloop.HtmlImageLoop
Tag class: org.apache.myfaces.custom.imageloop.HtmlImageLoopTag
Component type: org.apache.myfaces.HtmlImageLoop
Component family: javax.faces.Output
Renderer type: org.apache.myfaces.HtmlImageLoop
Renderer class: org.apache.myfaces.custom.imageloop.HtmlImageLoopRenderer

HTML image loop component. Image loop/slide show component. Provides Javascript methods to control image loop behaviour. Methods: getImageLoop(id) - get image loop object with id, play() - play loop, stop() - stop loop, accelerate() - accelerate loop until minDelay reached, decelerate() - decelerate loop until maxDelay reached, setImageIndex(index) - show image with index, reset() - reset settings to origin values, getImageCount() - get number of images loaded


Name Type Supports EL? Description
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.
delay Integer Yes The delay between transitions
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 Integer Yes Height
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.

maxDelay Integer Yes The maximum delay allowed when increasing delay time
minDelay Integer Yes The minimum delay allowed when decreasing delay time
rendered boolean Yes A boolean value that indicates whether this component should be rendered. Default value: true.
transitionTime Integer Yes Transition time in milliseconds. Set to -1 for immediate image switch.
width Integer Yes Width