org.primefaces.extensions.component.timer

Class Timer

java.lang.Object

javax.faces.component.UIComponent

javax.faces.component.UIComponentBase

org.primefaces.extensions.component.timer.Timer

All Implemented Interfaces:

java.util.EventListener, javax.faces.component.PartialStateHolder, javax.faces.component.StateHolder, javax.faces.component.TransientStateHolder, javax.faces.event.ComponentSystemEventListener, javax.faces.event.FacesListener, javax.faces.event.SystemEventListenerHolder, org.primefaces.component.api.AjaxSource, org.primefaces.component.api.Widget

public class Timer
extends javax.faces.component.UIComponentBase
implements org.primefaces.component.api.Widget, org.primefaces.component.api.AjaxSource

Timer component

Author:

f.strazzullo

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	Timer.PropertyKeys

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	COMPONENT_FAMILY
static java.lang.String	COMPONENT_TYPE
static java.lang.String	STYLE_CLASS

Fields inherited from class javax.faces.component.UIComponent

ATTRS_WITH_DECLARED_DEFAULT_VALUES, BEANINFO_KEY, bindings, COMPOSITE_COMPONENT_TYPE_KEY, COMPOSITE_FACET_NAME, CURRENT_COMPONENT, CURRENT_COMPOSITE_COMPONENT, FACETS_KEY, HONOR_CURRENT_COMPONENT_ATTRIBUTES_PARAM_NAME, VIEW_LOCATION_KEY

Constructor Summary

Constructors

Constructor and Description
Timer()

Method Summary

Methods

Modifier and Type	Method and Description
void	broadcast(javax.faces.event.FacesEvent event)
java.lang.String	getDelay()
java.lang.String	getFamily()
java.lang.String	getForm()
java.lang.String	getFormat()
java.lang.String	getFormatFunction()
javax.el.MethodExpression	getListener()
java.lang.String	getOncomplete()
java.lang.String	getOnerror()
java.lang.String	getOnstart()
java.lang.String	getOnsuccess()
java.lang.String	getOntimercomplete()
java.lang.String	getOntimerstep()
java.lang.String	getPartialSubmitFilter()
java.lang.String	getProcess()
java.lang.String	getStyle()
java.lang.String	getStyleClass()
int	getTimeout()
java.lang.String	getUpdate()
java.lang.String	getWidgetVar()
boolean	isAjaxified()
boolean	isAsync()
boolean	isAutoStart()
boolean	isForward()
boolean	isGlobal()
boolean	isIgnoreAutoUpdate()
boolean	isImmediate()
boolean	isPartialSubmit()
boolean	isPartialSubmitSet()
boolean	isResetValues()
boolean	isResetValuesSet()
boolean	isSingleRun()
boolean	isVisible()
java.lang.String	resolveWidgetVar()
void	setAsync(boolean _async)
void	setAutoStart(boolean _autoStart)
void	setDelay(java.lang.String _delay)
void	setForm(java.lang.String _form)
void	setFormat(java.lang.String format)
void	setFormatFunction(java.lang.String format)
void	setForward(boolean _forward)
void	setGlobal(boolean _global)
void	setIgnoreAutoUpdate(boolean _ignoreAutoUpdate)
void	setImmediate(boolean _immediate)
void	setListener(javax.el.MethodExpression _listener)
void	setOncomplete(java.lang.String _oncomplete)
void	setOnerror(java.lang.String _onerror)
void	setOnstart(java.lang.String _onstart)
void	setOnsuccess(java.lang.String _onsuccess)
void	setOntimercomplete(java.lang.String _oncomplete)
void	setOntimerstep(java.lang.String onstep)
void	setPartialSubmit(boolean _partialSubmit)
void	setPartialSubmitFilter(java.lang.String _partialSubmitFilter)
void	setProcess(java.lang.String _process)
void	setResetValues(boolean _resetValues)
void	setSingleRun(boolean singleRun)
void	setStyle(java.lang.String style)
void	setStyleClass(java.lang.String styleClass)
void	setTimeout(int timeout)
void	setUpdate(java.lang.String _update)
void	setVisible(boolean _visible)
void	setWidgetVar(java.lang.String _widgetVar)

Methods inherited from class javax.faces.component.UIComponentBase

addClientBehavior, addFacesListener, clearInitialState, decode, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getClientId, getDefaultEventName, getEventNames, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getListenersForEventClass, getParent, getPassThroughAttributes, getRenderer, getRendererType, getRendersChildren, getValueBinding, invokeOnComponent, isRendered, isTransient, markInitialState, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, removeFacesListener, restoreAttachedState, restoreState, saveAttachedState, saveState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding, subscribeToEvent, unsubscribeFromEvent

Methods inherited from class javax.faces.component.UIComponent

encodeAll, getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getNamingContainer, getPassThroughAttributes, getResourceBundleMap, getStateHelper, getStateHelper, getTransientStateHelper, getTransientStateHelper, getValueExpression, initialStateMarked, isCompositeComponent, isInView, isVisitable, popComponentFromEL, processEvent, pushComponentToEL, restoreTransientState, saveTransientState, setInView, setValueExpression, visitTree

Methods inherited from class java.lang.Object

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

Field Detail

COMPONENT_TYPE

public static final java.lang.String COMPONENT_TYPE

See Also:

Constant Field Values

COMPONENT_FAMILY

public static final java.lang.String COMPONENT_FAMILY

See Also:

Constant Field Values

STYLE_CLASS

public static final java.lang.String STYLE_CLASS

See Also:

Constant Field Values

Constructor Detail

Timer

public Timer()

Method Detail

getFamily

public java.lang.String getFamily()

Specified by:

getFamily in class javax.faces.component.UIComponent

isSingleRun

public boolean isSingleRun()

setSingleRun

public void setSingleRun(boolean singleRun)

getTimeout

public int getTimeout()

Specified by:

getTimeout in interface org.primefaces.component.api.AjaxSource

setTimeout

public void setTimeout(int timeout)

getWidgetVar

public java.lang.String getWidgetVar()

setWidgetVar

public void setWidgetVar(java.lang.String _widgetVar)

getUpdate

public java.lang.String getUpdate()

Specified by:

getUpdate in interface org.primefaces.component.api.AjaxSource

setUpdate

public void setUpdate(java.lang.String _update)

getListener

public javax.el.MethodExpression getListener()

setListener

public void setListener(javax.el.MethodExpression _listener)

isImmediate

public boolean isImmediate()

setImmediate

public void setImmediate(boolean _immediate)

getOnstart

public java.lang.String getOnstart()

Specified by:

getOnstart in interface org.primefaces.component.api.AjaxSource

setOnstart

public void setOnstart(java.lang.String _onstart)

getOncomplete

public java.lang.String getOncomplete()

Specified by:

getOncomplete in interface org.primefaces.component.api.AjaxSource

setOncomplete

public void setOncomplete(java.lang.String _oncomplete)

getOntimercomplete

public java.lang.String getOntimercomplete()

setOntimercomplete

public void setOntimercomplete(java.lang.String _oncomplete)

getOntimerstep

public java.lang.String getOntimerstep()

setOntimerstep

public void setOntimerstep(java.lang.String onstep)

getProcess

public java.lang.String getProcess()

Specified by:

getProcess in interface org.primefaces.component.api.AjaxSource

setProcess

public void setProcess(java.lang.String _process)

getOnerror

public java.lang.String getOnerror()

Specified by:

getOnerror in interface org.primefaces.component.api.AjaxSource

setOnerror

public void setOnerror(java.lang.String _onerror)

getOnsuccess

public java.lang.String getOnsuccess()

Specified by:

getOnsuccess in interface org.primefaces.component.api.AjaxSource

setOnsuccess

public void setOnsuccess(java.lang.String _onsuccess)

isGlobal

public boolean isGlobal()

Specified by:

isGlobal in interface org.primefaces.component.api.AjaxSource

setGlobal

public void setGlobal(boolean _global)

getDelay

public java.lang.String getDelay()

Specified by:

getDelay in interface org.primefaces.component.api.AjaxSource

setDelay

public void setDelay(java.lang.String _delay)

isAsync

public boolean isAsync()

Specified by:

isAsync in interface org.primefaces.component.api.AjaxSource

setAsync

public void setAsync(boolean _async)

isAutoStart

public boolean isAutoStart()

setAutoStart

public void setAutoStart(boolean _autoStart)

isPartialSubmit

public boolean isPartialSubmit()

Specified by:

isPartialSubmit in interface org.primefaces.component.api.AjaxSource

setPartialSubmit

public void setPartialSubmit(boolean _partialSubmit)

isResetValues

public boolean isResetValues()

Specified by:

isResetValues in interface org.primefaces.component.api.AjaxSource

setResetValues

public void setResetValues(boolean _resetValues)

isIgnoreAutoUpdate

public boolean isIgnoreAutoUpdate()

Specified by:

isIgnoreAutoUpdate in interface org.primefaces.component.api.AjaxSource

setIgnoreAutoUpdate

public void setIgnoreAutoUpdate(boolean _ignoreAutoUpdate)

isPartialSubmitSet

public boolean isPartialSubmitSet()

Specified by:

isPartialSubmitSet in interface org.primefaces.component.api.AjaxSource

isResetValuesSet

public boolean isResetValuesSet()

Specified by:

isResetValuesSet in interface org.primefaces.component.api.AjaxSource

isAjaxified

public boolean isAjaxified()

Specified by:

isAjaxified in interface org.primefaces.component.api.AjaxSource

getStyle

public java.lang.String getStyle()

setFormat

public void setFormat(java.lang.String format)

getFormat

public java.lang.String getFormat()

setFormatFunction

public void setFormatFunction(java.lang.String format)

getFormatFunction

public java.lang.String getFormatFunction()

setStyle

public void setStyle(java.lang.String style)

getStyleClass

public java.lang.String getStyleClass()

setStyleClass

public void setStyleClass(java.lang.String styleClass)

isVisible

public boolean isVisible()

setVisible

public void setVisible(boolean _visible)

isForward

public boolean isForward()

setForward

public void setForward(boolean _forward)

getPartialSubmitFilter

public java.lang.String getPartialSubmitFilter()

Specified by:

getPartialSubmitFilter in interface org.primefaces.component.api.AjaxSource

setPartialSubmitFilter

public void setPartialSubmitFilter(java.lang.String _partialSubmitFilter)

getForm

public java.lang.String getForm()

Specified by:

getForm in interface org.primefaces.component.api.AjaxSource

setForm

public void setForm(java.lang.String _form)

broadcast

public void broadcast(javax.faces.event.FacesEvent event)
               throws javax.faces.event.AbortProcessingException

Overrides:

broadcast in class javax.faces.component.UIComponentBase

Throws:

javax.faces.event.AbortProcessingException

resolveWidgetVar

public java.lang.String resolveWidgetVar()

Specified by:

resolveWidgetVar in interface org.primefaces.component.api.Widget