| Info | Value |
|---|---|
| Component Type | org.primefaces.component.Poll |
| Display Name | None |
| Handler Class | org.primefaces.component.poll.PollHandler |
| Renderer Type | org.primefaces.component.PollRenderer |
| Description | None |
| Name | Required | Type | Description |
|---|---|---|---|
id | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| Unique identifier of the component in a namingContainer. |
rendered | false | javax.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. |
binding | false | javax.el.ValueExpression
(must evaluate to javax.faces.component.UIComponent)
| An el expression referring to a server side UIComponent instance in a backing bean. |
widgetVar | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| Name of the client side widget. |
interval | false | javax.el.ValueExpression
(must evaluate to java.lang.Integer)
| Interval in seconds to do periodic ajax requests. Default is 2. |
update | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| Component(s) to be updated with ajax. |
listener | false | javax.el.ValueExpression
(must evaluate to javax.el.MethodExpression)
| A method expression to invoke by polling. |
immediate | false | javax.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. |
onstart | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| Javascript handler to execute before ajax request is begins. |
oncomplete | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| Javascript handler to execute when ajax request is completed. |
process | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| Component id(s) to process partially instead of whole view. |
onerror | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| Javascript handler to execute when ajax request fails. |
onsuccess | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| Javascript handler to execute when ajax request succeeds. |
global | false | javax.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. |
async | false | javax.el.ValueExpression
(must evaluate to java.lang.Boolean)
| When set to true, ajax requests are not queued. Default is false. |
autoStart | false | javax.el.ValueExpression
(must evaluate to java.lang.Boolean)
| In autoStart mode, polling starts automatically on page load, to start polling on demand set to false. Default is true. |
stop | false | javax.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Stops polling when true. |
partialSubmit | false | javax.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. |
Output generated by Vdldoc View Declaration Language Documentation Generator.