org.apache.myfaces.custom.imageloop
Class AbstractHtmlImageLoop

java.lang.Object
  javax.faces.component.UIComponent
      javax.faces.component.UIComponentBase
          org.apache.myfaces.custom.imageloop.AbstractHtmlImageLoop

All Implemented Interfaces:

javax.faces.component.StateHolder

Direct Known Subclasses:

HtmlImageLoop

public abstract class AbstractHtmlImageLoop
extends javax.faces.component.UIComponentBase

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

Version:

$Revision: 663481 $ $Date: 2008-06-05 02:00:34 -0500 (Thu, 05 Jun 2008) $

Author:

Felix Röthenbacher (latest modification by $Author: lu4242 $)

Field Summary

static java.lang.String	COMPONENT_FAMILY
static java.lang.String	COMPONENT_TYPE
static java.lang.String	DEFAULT_RENDERER_TYPE
static java.lang.String	VB_DELAY
static java.lang.String	VB_HEIGHT
static java.lang.String	VB_MAX_DELAY
static java.lang.String	VB_MIN_DELAY
static java.lang.String	VB_TRANSITION_TIME
static java.lang.String	VB_WIDTH

Constructor Summary

AbstractHtmlImageLoop()

Method Summary

java.lang.String	getClientId(javax.faces.context.FacesContext context)
abstract java.lang.Integer	getDelay() The delay between transitions
java.lang.String	getFamily()
abstract java.lang.Boolean	getForceId() If true, this component will force the use of the specified id when rendering.
abstract java.lang.Boolean	getForceIdIndex() 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.)
abstract java.lang.Integer	getHeight() Height
abstract java.lang.Integer	getMaxDelay() The maximum delay allowed when increasing delay time
abstract java.lang.Integer	getMinDelay() The minimum delay allowed when decreasing delay time
abstract java.lang.Integer	getTransitionTime() Transition time in milliseconds.
abstract java.lang.Integer	getWidth() Width

Methods inherited from class javax.faces.component.UIComponentBase

addFacesListener, broadcast, decode, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getFacesContext, getFacesListeners, getFacet, getFacets, getFacetsAndChildren, getId, getParent, getRenderer, getRendererType, getRendersChildren, getValueBinding, isRendered, isTransient, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, removeFacesListener, restoreAttachedState, restoreState, saveAttachedState, saveState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

COMPONENT_FAMILY

public static final java.lang.String COMPONENT_FAMILY

See Also:

Constant Field Values

COMPONENT_TYPE

public static final java.lang.String COMPONENT_TYPE

See Also:

Constant Field Values

DEFAULT_RENDERER_TYPE

public static final java.lang.String DEFAULT_RENDERER_TYPE

See Also:

Constant Field Values

VB_DELAY

public static final java.lang.String VB_DELAY

See Also:

Constant Field Values

VB_MIN_DELAY

public static final java.lang.String VB_MIN_DELAY

See Also:

Constant Field Values

VB_MAX_DELAY

public static final java.lang.String VB_MAX_DELAY

See Also:

Constant Field Values

VB_TRANSITION_TIME

public static final java.lang.String VB_TRANSITION_TIME

See Also:

Constant Field Values

VB_WIDTH

public static final java.lang.String VB_WIDTH

See Also:

Constant Field Values

VB_HEIGHT

public static final java.lang.String VB_HEIGHT

See Also:

Constant Field Values

Constructor Detail

AbstractHtmlImageLoop

public AbstractHtmlImageLoop()

Method Detail

getClientId

public java.lang.String getClientId(javax.faces.context.FacesContext context)

Overrides:

getClientId in class javax.faces.component.UIComponentBase

getFamily

public java.lang.String getFamily()

Specified by:

getFamily in class javax.faces.component.UIComponent

getDelay

public abstract java.lang.Integer getDelay()

The delay between transitions

getMinDelay

public abstract java.lang.Integer getMinDelay()

The minimum delay allowed when decreasing delay time

getMaxDelay

public abstract java.lang.Integer getMaxDelay()

The maximum delay allowed when increasing delay time

getTransitionTime

public abstract java.lang.Integer getTransitionTime()

Transition time in milliseconds. Set to -1 for immediate image switch.

getWidth

public abstract java.lang.Integer getWidth()

Width

getHeight

public abstract java.lang.Integer getHeight()

Height

getForceId

public abstract java.lang.Boolean getForceId()

If true, this component will force the use of the specified id when rendering.

Returns:

getForceIdIndex

public abstract java.lang.Boolean getForceIdIndex()

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.)

Returns: