| Info | Value |
|---|---|
| Component Type | org.primefaces.extensions.component.Timer |
| Handler Class | None |
| Renderer Type | None |
| 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)
| If true, timer starts automatically.Default is true. |
binding | false | jakarta.el.ValueExpression
(must evaluate to jakarta.faces.component.UIComponent)
| An EL expression referring to a server side UIComponent instance in a backing bean.Default is generated. |
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. If this option is not specified, or if the value of delay is the literal string 'none' without the quotes, no delay is used. |
form | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Form to serialize for an ajax request.Default is The enclosing form. |
format | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Display 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)
| Timer direction, true is forward.Default is false. |
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.Default is generated. |
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.Default is false. |
ignoreComponentNotFound | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| If true, unresolvable components (ComponentNotFoundException) referenced in the update/process attribute are ignored.Default is false. |
immediate | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Determines the phaseId, true means APPLY_REQUEST_VALUES, false means INVOKE_APPLICATION.Default is false. |
interval | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Integer)
| Interval in milliseconds.Default is 1000. |
listener | false | jakarta.el.ValueExpression
(must evaluate to jakarta.el.MethodExpression)
| A method expression to invoke by polling. |
locale | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Object)
| String or Locale representing user locale. |
oncomplete | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Client-side javascript callback to execute when ajax request is completed. |
onerror | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Client-side javascript callback to execute when ajax request fails. |
onstart | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Client-side javascript callback to execute before ajax request begins. |
onsuccess | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Client-side javascript callback to execute when ajax request succeeds. |
ontimercomplete | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| JavaScript callback before timer completion. |
ontimerstep | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| JavaScript callback on each timer step. |
partialSubmit | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Enables serialization of values belonging to the partially processed components only.Default is false. |
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(s) to process in partial request. |
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.Default is true. |
resetValues | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| If true, local values of input components to be updated within the ajax request would be reset.Default is false. |
singleRun | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| When true, timer executes once and stops.Default is true. |
style | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Inline style of the component. |
styleClass | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Style class of the component. |
timeout | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Integer)
| Timeout in seconds.Default is 10. |
title | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Title rendered on the timer element. |
update | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Component(s) to update with ajax. |
visible | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Controls visibility.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.