org.apache.myfaces.custom.imageloop
Class HtmlImageLoop

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

All Implemented Interfaces:

javax.faces.component.StateHolder

public class HtmlImageLoop
extends AbstractHtmlImageLoop

Field Summary

static java.lang.String	COMPONENT_FAMILY
static java.lang.String	COMPONENT_TYPE
static java.lang.String	DEFAULT_RENDERER_TYPE

Fields inherited from class org.apache.myfaces.custom.imageloop.AbstractHtmlImageLoop

VB_DELAY, VB_HEIGHT, VB_MAX_DELAY, VB_MIN_DELAY, VB_TRANSITION_TIME, VB_WIDTH

Constructor Summary

HtmlImageLoop()

Method Summary

java.lang.Integer	getDelay() The delay between transitions
java.lang.String	getFamily()
java.lang.Boolean	getForceId() If true, this component will force the use of the specified id when rendering.
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.)
java.lang.Integer	getHeight() Height
java.lang.Integer	getMaxDelay() The maximum delay allowed when increasing delay time
java.lang.Integer	getMinDelay() The minimum delay allowed when decreasing delay time
java.lang.Integer	getTransitionTime() Transition time in milliseconds.
java.lang.Integer	getWidth() Width
void	restoreState(javax.faces.context.FacesContext facesContext, java.lang.Object state)
java.lang.Object	saveState(javax.faces.context.FacesContext facesContext)
void	setDelay(java.lang.Integer delay)
void	setForceId(java.lang.Boolean forceId)
void	setForceIdIndex(java.lang.Boolean forceIdIndex)
void	setHeight(java.lang.Integer height)
void	setMaxDelay(java.lang.Integer maxDelay)
void	setMinDelay(java.lang.Integer minDelay)
void	setTransitionTime(java.lang.Integer transitionTime)
void	setWidth(java.lang.Integer width)

Methods inherited from class org.apache.myfaces.custom.imageloop.AbstractHtmlImageLoop

getClientId

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, saveAttachedState, 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

Constructor Detail

HtmlImageLoop

public HtmlImageLoop()

Method Detail

getFamily

public java.lang.String getFamily()

Overrides:

getFamily in class AbstractHtmlImageLoop

getDelay

public java.lang.Integer getDelay()

Description copied from class: AbstractHtmlImageLoop

The delay between transitions

Specified by:

getDelay in class AbstractHtmlImageLoop

setDelay

public void setDelay(java.lang.Integer delay)

getMinDelay

public java.lang.Integer getMinDelay()

Description copied from class: AbstractHtmlImageLoop

The minimum delay allowed when decreasing delay time

Specified by:

getMinDelay in class AbstractHtmlImageLoop

setMinDelay

public void setMinDelay(java.lang.Integer minDelay)

getMaxDelay

public java.lang.Integer getMaxDelay()

Description copied from class: AbstractHtmlImageLoop

The maximum delay allowed when increasing delay time

Specified by:

getMaxDelay in class AbstractHtmlImageLoop

setMaxDelay

public void setMaxDelay(java.lang.Integer maxDelay)

getTransitionTime

public java.lang.Integer getTransitionTime()

Description copied from class: AbstractHtmlImageLoop

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

Specified by:

getTransitionTime in class AbstractHtmlImageLoop

setTransitionTime

public void setTransitionTime(java.lang.Integer transitionTime)

getWidth

public java.lang.Integer getWidth()

Description copied from class: AbstractHtmlImageLoop

Width

Specified by:

getWidth in class AbstractHtmlImageLoop

setWidth

public void setWidth(java.lang.Integer width)

getHeight

public java.lang.Integer getHeight()

Description copied from class: AbstractHtmlImageLoop

Height

Specified by:

getHeight in class AbstractHtmlImageLoop

setHeight

public void setHeight(java.lang.Integer height)

getForceId

public java.lang.Boolean getForceId()

Description copied from class: AbstractHtmlImageLoop

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

Specified by:

getForceId in class AbstractHtmlImageLoop

Returns:

setForceId

public void setForceId(java.lang.Boolean forceId)

getForceIdIndex

public java.lang.Boolean getForceIdIndex()

Description copied from class: AbstractHtmlImageLoop

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

Specified by:

getForceIdIndex in class AbstractHtmlImageLoop

Returns:

setForceIdIndex

public void setForceIdIndex(java.lang.Boolean forceIdIndex)

saveState

public java.lang.Object saveState(javax.faces.context.FacesContext facesContext)

Specified by:

saveState in interface javax.faces.component.StateHolder

Overrides:

saveState in class javax.faces.component.UIComponentBase

restoreState

public void restoreState(javax.faces.context.FacesContext facesContext,
                         java.lang.Object state)

Specified by:

restoreState in interface javax.faces.component.StateHolder

Overrides:

restoreState in class javax.faces.component.UIComponentBase