Overview     Library     Tag     Help  
  FRAMES     NO FRAMES  

a4j
Tag poll

The <a4j:poll> component allows periodical sending of Ajax requests to the server. It is used for repeatedly updating a page at specific time intervals.

@author shura

Tag Information
Component type org.richfaces.Poll
Tag Name a4j:poll
Renderer Type org.richfaces.PollRenderer
Handler Class org.richfaces.view.facelets.html.AjaxPollHandler

Attributes
Name Required Type Description
action false javax.faces.el.MethodBinding MethodExpression representing the application action to invoke when this component is activated by the user. The expression must evaluate to a public method that takes no parameters, and returns an Object (the toString() of which is called to derive the logical outcome) which is passed to the NavigationHandler for this application.
actionListener false javax.faces.el.MethodBinding

MethodExpression representing an action listener method that will be notified when this component is activated by the user. The expression must evaluate to a public method that takes an ActionEvent parameter, with a return type of void, or to a public method that takes no arguments with a return type of void. In the latter case, the method has no way of easily knowing where the event came from, but this can be useful in cases where a notification is needed that "some action happened".

binding false javax.faces.component.UIComponent The value binding expression used to wire up this component to a component property of a JavaBean class
bypassUpdates false boolean If "true", after process validations phase it skips updates of model beans on a force render response. It can be used for validating components input
data false java.lang.Object Serialized (on default with JSON) data passed to the client by a developer on an AJAX request. It's accessible via "event.data" syntax. Both primitive types and complex types such as arrays and collections can be serialized and used with data
enabled false boolean Enables/disables polling to the server. Using Expression Language (EL), the enabled attribute can point to a bean property to apply a particular attribute value
execute false java.lang.Object Ids of components that will participate in the "execute" portion of the Request Processing Lifecycle. Can be a single id, a space or comma separated list of Id's, or an EL Expression evaluating to an array or Collection. Any of the keywords "@this", "@form", "@all", "@none", "@region" may be specified in the identifier list. Some components make use of additional keywords
id false java.lang.String The component identifier for this component. This value must be unique within the closest parent component that is a naming container.
immediate false boolean Flag indicating that, if this component is activated by the user, notifications should be delivered to interested listeners and actions immediately (that is, during Apply Request Values phase) rather than waiting until Invoke Application phase.
interval false int Specifies the time in milliseconds between requests. The default for this value is 1000 ms (1 second)
limitRender false boolean If "true", render only those ids specified in the "render" attribute, forgoing the render of the auto-rendered panels
onbeforedomupdate false java.lang.String The client-side script method to be called after the ajax response comes back, but before the DOM is updated
onbegin false java.lang.String The client-side script method to be called before an ajax request.
oncomplete false java.lang.String The client-side script method to be called after the DOM is updated
ontimer false java.lang.String The client-side script method to be called after the timer counts down, but before the Ajax request is initiated
render false java.lang.Object Ids of components that will participate in the "render" portion of the Request Processing Lifecycle. Can be a single id, a space or comma separated list of Id's, or an EL Expression evaluating to an array or Collection. Any of the keywords "@this", "@form", "@all", "@none", "@region" may be specified in the identifier list. Some components make use of additional keywords
rendered false boolean Flag indicating whether or not this component should be rendered (during Render Response Phase), or processed on any subsequent form submit. The default value for this property is true.
status false java.lang.String Name of the request status component that will indicate the status of the Ajax request
value false java.lang.Object The current value of this component.

  Overview     Library     Tag     Help  
  FRAMES     NO FRAMES  
Output Generated by Tag Library Documentation Generator.