Ajax4Jsf
Tag support


Adds the AJAX functionality for those UIComponent-based component that have properties for JavaScript events. During Decoding: If a request is Ajax-performed, obtains the Map from the "requestParameterMap" property of the ExternalContext. If this Map contains non null value for the "clientId" key, creates a javax.faces.event.ActionEvent around the component, passes it to the queueEvent() method of the component, and then appends it's reRender components IDs to a list of rendered areas. During Encoding. Doesn't encode as a component. Instead, it adds ValueBinding for a property of the parent component with the name as a value of its "event" property. As a result, when rendered, the parent component builds JavaScript code for submitting an AJAX request on this event. If the component has child UIParameter components, appends it's name/value as additional request parameters. If a parent component is an instance of UIInput and the ajaxType property is "input", submits the value of the input field, also. In this case, you can submit a single input field outside of UIForm.


Tag Information
Tag Classorg.ajax4jsf.taglib.html.jsp.AjaxSupport
TagExtraInfo ClassNone
Body ContentJSP
Display NameAjax Support

Attributes
NameRequiredRequest-timeTypeDescription
actionfalsefalsejavax.el.MethodExpression
(signature must match java.lang.Object action())
MethodBinding pointing at the application action to be invoked, if this UIComponent is activated by you, during the Apply Request Values or Invoke Application phase of the request processing lifecycle, depending on the value of the immediate property
actionListenerfalsefalsejavax.el.MethodExpression
(signature must match void actionListener(javax.faces.event.ActionEvent))
MethodBinding pointing at method accepting an ActionEvent with return type void
ajaxSinglefalsefalsejavax.el.ValueExpression
(must evaluate to boolean)
Limits JSF tree processing (decoding, conversion, validation and model updating) only to a component that sends the request. Boolean. Default value is "false".
bindingfalsefalsejavax.el.ValueExpression
(must evaluate to javax.faces.component.UIComponent)
The attribute takes a value-binding expression for a component property of a backing bean
bypassUpdatesfalsefalsejavax.el.ValueExpression
(must evaluate to 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
datafalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.Object)
Serialized (on default with JSON) data passed on the client by a developer on AJAX request. It's accessible via "data.foo" syntax
disableDefaultfalsefalsejavax.el.ValueExpression
(must evaluate to boolean)
Disables default action for target event ( append "return false;" to JavaScript ). Default value is "false"
disabledfalsefalsejavax.el.ValueExpression
(must evaluate to boolean)
If "true", disable this component on page.
eventfalsefalsejava.lang.StringName of JavaScript event property ( onclick, onchange, etc.) of parent component, for which we will build AJAX submission code
eventsQueuefalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
Name of requests queue to avoid send next request before complete other from same event. Can be used to reduce number of requests of frequently events (key press, mouse move etc.)
focusfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
ID of an element to set focus after request is completed on client side
idfalsefalsejava.lang.StringEvery component may have a unique id that is automatically created if omitted
ignoreDupResponsesfalsefalsejavax.el.ValueExpression
(must evaluate to boolean)
Attribute allows to ignore an Ajax Response produced by a request if the newest 'similar' request is in a queue already. ignoreDupResponses="true" does not cancel the request while it is processed on the server, but just allows to avoid unnecessary updates on the client side if the response isn't actual now
immediatefalsefalsejavax.el.ValueExpression
(must evaluate to boolean)
True means, that the default ActionListener should be executed immediately (i.e. during Apply Request Values phase of the request processing lifecycle), rather than waiting until the Invoke Application phase
limitToListfalsefalsejavax.el.ValueExpression
(must evaluate to boolean)
If "true", then of all AJAX-rendered on the page components only those will be updated, which ID's are passed to the "reRender" attribute of the describable component. "false"-the default value-means that all components with ajaxRendered="true" will be updated.
onbeforedomupdatefalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
The client-side script method to be called before DOM is updated
oncompletefalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
The client-side script method to be called after the request is completed
onsubmitfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
The client-side script method to be called before an ajax request is submitted
processfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.Object)
Id['s] (in format of call UIComponent.findComponent()) of components, processed at the phases 2-5 in case of AjaxRequest caused by this component. Can be single id, comma-separated list of Id's, or EL Expression with array or Collection
reRenderfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.Object)
Id['s] (in format of call UIComponent.findComponent()) of components, rendered in case of AjaxRequest caused by this component. Can be single id, comma-separated list of Id's, or EL Expression with array or Collection
renderedfalsefalsejavax.el.ValueExpression
(must evaluate to boolean)
If "false", this component is not rendered
requestDelayfalsefalsejavax.el.ValueExpression
(must evaluate to int)
Attribute defines the time (in ms.) that the request will be wait in the queue before it is ready to send. When the delay time is over, the request will be sent to the server or removed if the newest 'similar' request is in a queue already
similarityGroupingIdfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
If there are any component requests with identical IDs then these requests will be grouped.
statusfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
ID (in format of call UIComponent.findComponent()) of Request status component
timeoutfalsefalsejavax.el.ValueExpression
(must evaluate to int)
Timeout (in ms) for request

Variables
No Variables Defined.


Output Generated by Tag Library Documentation Generator. Java, JSP, and JavaServer Pages are trademarks or registered trademarks of Sun Microsystems, Inc. in the US and other countries. Copyright 2002-4 Sun Microsystems, Inc. 4150 Network Circle Santa Clara, CA 95054, U.S.A. All Rights Reserved.