Package 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:

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	Description
protected static enum	Timer.PropertyKeys

Field Summary

Fields

Modifier and Type	Field	Description
static final String	COMPONENT_FAMILY
static final String	COMPONENT_TYPE
static final 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

Fields inherited from interface org.primefaces.component.api.Widget

ATTR_WIDGET_VAR_PATTERN, CALLBACK_POST_CONSTRUCT, CALLBACK_POST_REFRESH, CALLBACK_PRE_DESTROY

Constructor Summary

Constructors

Constructor	Description
Timer()

Method Summary

Modifier and Type	Method	Description
void	broadcast(javax.faces.event.FacesEvent event)
Locale	calculateLocale()
String	getDelay()
String	getFamily()
String	getForm()
String	getFormat()
String	getFormatFunction()
int	getInterval()
javax.el.MethodExpression	getListener()
Object	getLocale()
String	getOncomplete()
String	getOnerror()
String	getOnstart()
String	getOnsuccess()
String	getOntimercomplete()
String	getOntimerstep()
String	getPartialSubmitFilter()
String	getProcess()
String	getStyle()
String	getStyleClass()
int	getTimeout()
String	getTitle()
String	getUpdate()
String	getWidgetVar()
boolean	isAjaxified()
boolean	isAsync()
boolean	isAutoStart()
boolean	isForward()
boolean	isGlobal()
boolean	isIgnoreAutoUpdate()
boolean	isIgnoreComponentNotFound()
boolean	isImmediate()
boolean	isPartialSubmit()
boolean	isPartialSubmitSet()
boolean	isResetValues()
boolean	isResetValuesSet()
boolean	isSingleRun()
boolean	isVisible()
Object	saveState(javax.faces.context.FacesContext context)
void	setAsync(boolean async)
void	setAutoStart(boolean autoStart)
void	setDelay(String delay)
void	setForm(String form)
void	setFormat(String format)
void	setFormatFunction(String format)
void	setForward(boolean forward)
void	setGlobal(boolean global)
void	setIgnoreAutoUpdate(boolean ignoreAutoUpdate)
void	setIgnoreComponentNotFound(boolean ignoreComponentNotFound)
void	setImmediate(boolean immediate)
void	setInterval(int interval)
void	setListener(javax.el.MethodExpression listener)
void	setLocale(Object locale)
void	setOncomplete(String oncomplete)
void	setOnerror(String onerror)
void	setOnstart(String onstart)
void	setOnsuccess(String onsuccess)
void	setOntimercomplete(String oncomplete)
void	setOntimerstep(String onstep)
void	setPartialSubmit(boolean partialSubmit)
void	setPartialSubmitFilter(String partialSubmitFilter)
void	setProcess(String process)
void	setResetValues(boolean resetValues)
void	setSingleRun(boolean singleRun)
void	setStyle(String style)
void	setStyleClass(String styleClass)
void	setTimeout(int timeout)
void	setTitle(String title)
void	setUpdate(String update)
void	setVisible(boolean visible)
void	setWidgetVar(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, 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

Methods inherited from interface org.primefaces.component.api.Widget

resolveWidgetVar, resolveWidgetVar

Field Details

COMPONENT_TYPE

public static final String COMPONENT_TYPE

See Also:

• Constant Field Values

COMPONENT_FAMILY

public static final String COMPONENT_FAMILY

See Also:

• Constant Field Values

STYLE_CLASS

public static final String STYLE_CLASS

See Also:

• Constant Field Values

Constructor Details

Timer

public Timer()

Method Details

getFamily

public String getFamily()

Specified by:

getFamily in class javax.faces.component.UIComponent

calculateLocale

public Locale calculateLocale()

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)

getInterval

public int getInterval()

setInterval

public void setInterval(int interval)

getWidgetVar

public String getWidgetVar()

setWidgetVar

public void setWidgetVar(String widgetVar)

getUpdate

public String getUpdate()

Specified by:

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

setUpdate

public void setUpdate(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 String getOnstart()

Specified by:

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

setOnstart

public void setOnstart(String onstart)

getOncomplete

public String getOncomplete()

Specified by:

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

setOncomplete

public void setOncomplete(String oncomplete)

getOntimercomplete

public String getOntimercomplete()

setOntimercomplete

public void setOntimercomplete(String oncomplete)

getOntimerstep

public String getOntimerstep()

setOntimerstep

public void setOntimerstep(String onstep)

getProcess

public String getProcess()

Specified by:

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

setProcess

public void setProcess(String process)

getOnerror

public String getOnerror()

Specified by:

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

setOnerror

public void setOnerror(String onerror)

getOnsuccess

public String getOnsuccess()

Specified by:

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

setOnsuccess

public void setOnsuccess(String onsuccess)

isGlobal

public boolean isGlobal()

Specified by:

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

setGlobal

public void setGlobal(boolean global)

getDelay

public String getDelay()

Specified by:

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

setDelay

public void setDelay(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 String getStyle()

setFormat

public void setFormat(String format)

getFormat

public String getFormat()

setFormatFunction

public void setFormatFunction(String format)

getFormatFunction

public String getFormatFunction()

setStyle

public void setStyle(String style)

getStyleClass

public String getStyleClass()

setStyleClass

public void setStyleClass(String styleClass)

getTitle

public String getTitle()

setTitle

public void setTitle(String title)

isVisible

public boolean isVisible()

setVisible

public void setVisible(boolean visible)

isForward

public boolean isForward()

setForward

public void setForward(boolean forward)

getLocale

public Object getLocale()

setLocale

public void setLocale(Object locale)

getPartialSubmitFilter

public String getPartialSubmitFilter()

Specified by:

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

setPartialSubmitFilter

public void setPartialSubmitFilter(String partialSubmitFilter)

getForm

public String getForm()

Specified by:

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

setForm

public void setForm(String form)

broadcast

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

Overrides:

broadcast in class javax.faces.component.UIComponentBase

isIgnoreComponentNotFound

public boolean isIgnoreComponentNotFound()

Specified by:

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

setIgnoreComponentNotFound

public void setIgnoreComponentNotFound(boolean ignoreComponentNotFound)

saveState

public Object saveState(javax.faces.context.FacesContext context)

Specified by:

saveState in interface javax.faces.component.StateHolder

Overrides:

saveState in class javax.faces.component.UIComponentBase