| Info | Value |
|---|---|
| Component Type | org.primefaces.extensions.component.Timer |
| Handler Class | org.primefaces.extensions.component.timer.TimerHandler |
| Renderer Type | org.primefaces.extensions.component.TimerRenderer |
| Description | None |
| Name | Required | Type | Description |
|---|---|---|---|
async | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| When set to true, ajax requests are not queued. Default is false. |
autoStart | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| In autoStart mode, the timer will start immediatly. Default is true. |
binding | false | jakarta.el.ValueExpression
(must evaluate to javax.faces.component.UIComponent)
| An el expression referring to a server side UIComponent instance in a backing bean. |
delay | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| If less than delay milliseconds elapses between calls to request() only the most recent one is sent and all other requests are discarded. The default value of this option is 300. If the value of delay is the literal string 'none' without the quotes, no delay is used. |
format | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| The format to use when displaying the value. Accepted values are: 'percentage' to display the remaining time as percentage. 'Human' to print a human-readable interval. Any other value will be evaluated as a moment.js format |
formatFunction | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| client-side function used to format the remaining duration |
forward | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Use this attribute to set the timer direction. Default value is false (backward) |
global | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Global ajax requests are listened by ajaxStatus component, setting global to false will not trigger ajaxStatus. Default is true. |
id | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Unique identifier of the component in a namingContainer. |
ignoreAutoUpdate | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| If true, components which autoUpdate="true" will not be updated for this request. If not specified, or the value is false, no such indication is made. |
ignoreComponentNotFound | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| If true, unresolvable components referenced in the update/process attribute are ignored. Default is 'false' and therefore a ComponentNotFoundException will be thrown. |
immediate | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Boolean value that determines the phaseId, when true actions are processed at apply_request_values, when false at invoke_application phase. |
interval | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Integer)
| Interval in milliseconds the timer fires. Default is 1000. |
listener | false | jakarta.el.ValueExpression
(must evaluate to javax.el.MethodExpression)
| A method expression to invoke by polling. |
locale | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Object)
| String or java.util.Locale representing user locale. Default is a locale specified in view root. |
oncomplete | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Javascript handler to execute when ajax request is completed. |
onerror | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Javascript handler to execute when ajax request fails. |
onstart | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Javascript handler to execute before ajax request is begins. |
onsuccess | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Javascript handler to execute when ajax request succeeds. |
ontimercomplete | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Javascript handler executed the timeout stops |
ontimerstep | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Javascript handler executed every second |
partialSubmit | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| When enabled, only values related to partially processed components would be serialized for ajax instead of whole form. |
partialSubmitFilter | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Selector to use when partial submit is on, default is ":input" to select all descendant inputs of a partially processed components. |
process | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Component id(s) to process partially instead of whole view. |
rendered | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Boolean value to specify the rendering of the component, when set to false component will not be rendered. |
resetValues | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| If true, indicate that this particular Ajax transaction is a value reset transaction. This will cause resetValue() to be called on any EditableValueHolder instances encountered as a result of this ajax transaction. If not specified, or the value is false, no such indication is made. |
singleRun | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| set to true to false the timer periodic. Default is true |
style | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Style of the main container element. Default value is null. |
styleClass | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Style class of the main container element. Default value is null. |
timeout | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Integer)
| Timeout in seconds to do the Ajax request(s). Default is 10. |
title | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Advisory tooltip information. |
update | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Component(s) to be updated with ajax. |
visible | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| set to false to hide the timer. The listener will be fired anyway. Default is true. |
widgetVar | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Name of the client side widget. |
Output generated by Vdldoc View Declaration Language Documentation Generator.