Ajax4Jsf
3.3.2
a4j
http://richfaces.org/a4j
A combination of the functionality of two JSF tags,
<f:actionListener>; and <f:param>. At the
render phase, it's decoded by parent component
(<h:commandLink>; or like) as usual.
<br />
At the process request phase, if the parent component
performs an action event, update the value specified in
the "assignTo" attribute as its value.
<br />
If a converter attribute is specified, use it to encode
and decode the value to a string stored in the html
parameter.
<br />
actionparam
org.ajax4jsf.taglib.html.jsp.ActionParam
JSP
A method binding that refers to a method with this signature: void methodName(ActionEvent)
actionListener
void actionListener(javax.faces.event.ActionEvent)
EL expression for updatable bean property. This property
will be updated if the parent command component performs
an actionEvent.
assignTo
java.lang.String
The attribute takes a value-binding expression for a component property of
a backing bean
binding
javax.faces.component.UIComponent
ID of a converter to be used or a reference to a
converter.
converter
javax.faces.convert.Converter
Every component may have a unique id that is automatically created if omitted
id
false
java.lang.String
A name of this parameter
name
java.lang.String
If set to true, the value will not enclosed within
single quotes and there will be no escaping of
characters. This allows the use of the value as
JavaScript code for calculating value on the
client-side. This doesn't work with non-AJAX components.
noEscape
boolean
An initial value or a value binding
value
java.lang.Object
This works the same as ActionListener or ValueChangeListener, but for an AJAX container. Add the specified class
as a listener for AjaxEvent (sent in case of an AJAX request
for this container).
ajaxListener
org.ajax4jsf.taglib.html.jsp.AjaxListenerTag
JSP
Fully qualified Java class name of an AjaxListener to be created and registered.
type
true
java.lang.String
Renders an HTML "input" element.
<br />
During Decoding: Obtains the Map from the
"requestParameterMap" property of the ExternalContext. If
the value in the Map for the value of the "clientId"
property of the component is not null, create a
javax.faces.event.ActionEvent around the component, and pass
it to the queueEvent() method of the component. If the
request is Ajax-performed, add its target IDs of the
reRender property to the rendered areas list of the nesting
AjaxContainer.
<br />
During Encoding: Builds an AJAX.Submit JavaScript call for
the "onclick" event. Renders the clientId of the component
as the value of the "name" attribute. Renders the current
value of the component as the value of the "value"
attribute. If the "styleClass" attribute is specified,
render its value as the value of the "class" attribute.
Renders child components inside the HTML "input" element.
Ajax CommandButton
commandButton
org.ajax4jsf.taglib.html.jsp.AjaxCommandButton
JSP
This attribute assigns an access key to an element. An access key is a single character from the document character set. Note: Authors should consider the input method of the expected reader when specifying an accesskey
accesskey
java.lang.String
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
action
java.lang.Object action()
MethodBinding pointing at method accepting an ActionEvent with return type void
actionListener
void actionListener(javax.faces.event.ActionEvent)
Limits JSF tree processing (decoding, conversion, validation and model updating) only to a component that sends the request. Boolean. Default value is "false".
ajaxSingle
boolean
Alternate textual description of the element rendered by this component.
alt
java.lang.String
The attribute takes a value-binding expression for a component property of
a backing bean
binding
javax.faces.component.UIComponent
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
bypassUpdates
boolean
Serialized (on default with JSON) data passed on the client by a developer on AJAX request. It's accessible via "data.foo" syntax
data
java.lang.Object
Direction indication for text that does not inherit
directionality. Valid values are "LTR" (left-to-right)
and "RTL" (right-to-left)
dir
java.lang.String
If "true", disable this component on page.
disabled
boolean
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.)
eventsQueue
java.lang.String
ID of an element to set focus after request is completed on client side
focus
java.lang.String
Every component may have a unique id that is automatically created if omitted
id
false
java.lang.String
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.
ignoreDupResponses
boolean
Absolute or relative URL of the image to be displayed for this button. If specified, this "input" element will be of type "image". Otherwise, it will be of the type specified by the "type" property with a label specified by the "value" property.
image
java.lang.String
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
immediate
boolean
Code describing the language used in the generated markup for this component
lang
java.lang.String
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.
limitToList
boolean
The client-side script method to be called before DOM is updated
onbeforedomupdate
java.lang.String
The client-side script method to be called when the element loses the focus
onblur
java.lang.String
The client-side script method to be called when the element value is changed
onchange
java.lang.String
The client-side script method to be called when the element is clicked
onclick
java.lang.String
The client-side script method to be called after the request is completed
oncomplete
java.lang.String
The client-side script method to be called when the element is double-clicked
ondblclick
java.lang.String
The client-side script method to be called when the element gets the focus
onfocus
java.lang.String
The client-side script method to be called when a key is pressed down over the element
onkeydown
java.lang.String
The client-side script method to be called when a key is pressed over the element and released
onkeypress
java.lang.String
The client-side script method to be called when a key is released
onkeyup
java.lang.String
The client-side script method to be called when a mouse button is pressed down over the element
onmousedown
java.lang.String
The client-side script method to be called when a pointer is moved within the element
onmousemove
java.lang.String
The client-side script method to be called when a pointer is moved away from the element
onmouseout
java.lang.String
The client-side script method to be called when a pointer is moved onto the element
onmouseover
java.lang.String
The client-side script method to be called when a mouse button is released
onmouseup
java.lang.String
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
process
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
reRender
java.lang.Object
If "false", this component is not rendered
rendered
boolean
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
requestDelay
int
If there are any component requests with identical IDs then these requests will be grouped.
similarityGroupingId
java.lang.String
This attribute tells the user agent the initial width of the control. The width is given in pixels except when type attribute has the value "text" or "password". In that case, its value refers to the (integer) number of characters
size
int
ID (in format of call UIComponent.findComponent()) of Request status component
status
java.lang.String
CSS style rules to be applied to the component
style
java.lang.String
Assigns one or more CSS class names to the component. Corresponds to the HTML "class" attribute.
styleClass
java.lang.String
This attribute specifies the position of the current element in the tabbing order for the current document. This value must be a number between 0 and 32767. User agents should ignore leading zeros
tabindex
java.lang.String
Timeout ( in ms ) for request.
timeout
int
Advisory title information about markup elements generated for this component
title
java.lang.String
This attribute specifies a type of control to create. The possible values are "submit", "reset", "image" and "button". The default value for this attribute is "submit"
type
java.lang.String
The current value for this component
value
java.lang.Object
Renders an HTML "a" anchor element that acts like a form
submit button when clicked.
<br />
During Decoding: 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
and passes it to the queueEvent() method of the component.
If the request is Ajax-performed, adds its target IDs from
the reRender property to the rendered areas list of the
nesting AjaxContainer.
<br />
element for decoding as described above with the parameters
of the component. (PARAM_NAME and PARAM_VALUE are the names
and values, respectively, of any nested UIParameter
children.) The name and the value must be URLEncoded. If the
"styleClass" attribute is specified, render its value as the
value of the "class" attribute. Render any non-UIParameter
children as normal inside of the "a" element. These will
appear as the link text.
Ajax commandLink
commandLink
org.ajax4jsf.taglib.html.jsp.AjaxCommandLink
JSP
This attribute assigns an access key to an element. An access key is a single character from the document character set. Note: Authors should consider the input method of the expected reader when specifying an accesskey
accesskey
java.lang.String
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
action
java.lang.Object action()
MethodBinding pointing at method accepting an ActionEvent with return type void
actionListener
void actionListener(javax.faces.event.ActionEvent)
Limits JSF tree processing (decoding, conversion, validation and model updating) only to a component that sends the request. Boolean. Default value is "false".
ajaxSingle
boolean
The attribute takes a value-binding expression for a component property of
a backing bean
binding
javax.faces.component.UIComponent
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
bypassUpdates
boolean
The character encoding of a resource designated by this hyperlink
charset
java.lang.String
The attribute specifies shape and it position on the screen.
Possible values: "rect: left-x, top-y, right-x, bottom-y", "circle: center-x, center-y, radius", "poly: x1, y1, x2, y2, ..., xN, yN".
Notes:
a) when giving the radius value in percents, user agents should calculate the final radius value in pixels based on the associated object's width and height;
b) the radius value should be smaller than center-x and center-y values;
c) for a polygon, the first and last coordinate pairs should have same x and y to close the shape (x1=xN; y1=yN)
(when these coordinates are different, user agents should infer an additional pair to close a polygon).
Coordinates are relative to the top left corner of an object. All values are lengths. All values are comma separated.
coords
java.lang.String
Serialized (on default with JSON) data passed on the client by a developer on AJAX request. It's accessible via "data.foo" syntax
data
java.lang.Object
Direction indication for text that does not inherit
directionality. Valid values are "LTR" (left-to-right)
and "RTL" (right-to-left)
dir
java.lang.String
Disables the component on page. Boolean.
disabled
boolean
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.)
eventsQueue
java.lang.String
ID of an element to set focus after request is completed on client side
focus
java.lang.String
Base language of a resource specified with the href attribute; hreflang may only be used with href
hreflang
java.lang.String
Every component may have a unique id that is automatically created if omitted
id
false
java.lang.String
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
ignoreDupResponses
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
immediate
boolean
Code describing the language used in the generated markup for this component
lang
java.lang.String
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.
limitToList
boolean
The client-side script method to be called before DOM is updated
onbeforedomupdate
java.lang.String
The client-side script method to be called when the element loses the focus either when pointing a device or tabbing navigation. The attribute may be used with the same elements as onfocus
onblur
java.lang.String
The client-side script method to be called when the element is clicked
onclick
java.lang.String
The client-side script method to be called after the request is completed
oncomplete
java.lang.String
The client-side script method to be called when the element is double-clicked
ondblclick
java.lang.String
The client-side script method to be called when the element gets the focus
onfocus
java.lang.String
The client-side script method to be called when a key is pressed down over the element
onkeydown
java.lang.String
The client-side script method to be called when a key is pressed over the element and released
onkeypress
java.lang.String
The client-side script method to be called when a key is released
onkeyup
java.lang.String
The client-side script method to be called when a mouse button is pressed down over the element
onmousedown
java.lang.String
The client-side script method to be called when a pointer is moved within the element
onmousemove
java.lang.String
The client-side script method to be called when a pointer is moved away from the element
onmouseout
java.lang.String
The client-side script method to be called when a pointer is moved onto the element
onmouseover
java.lang.String
The client-side script method to be called when a mouse button is released
onmouseup
java.lang.String
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
process
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
reRender
java.lang.Object
The relationship from the current document to the anchor specified by this hyperlink. The value of this attribute is a space-separated list of link types
rel
java.lang.String
If "false", this component is not rendered
rendered
boolean
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
requestDelay
int
A reverse link from the anchor specified by this hyperlink to the current document. The value of this attribute is a space-separated list of link types
rev
java.lang.String
This attribute specifies the shape of a region. The possible values are "default", "rect", "circle" and "poly".
shape
java.lang.String
If there are any component requests with identical IDs then these requests will be grouped.
similarityGroupingId
java.lang.String
ID (in format of call UIComponent.findComponent()) of Request status component
status
java.lang.String
CSS style rules to be applied to the component
style
java.lang.String
Assigns one or more CSS class names to the component. Corresponds to the HTML "class" attribute.
styleClass
java.lang.String
This attribute specifies the position of the current element in the tabbing order for the current document. This value must be a number between 0 and 32767. User agents should ignore leading zeros
tabindex
java.lang.String
This attribute specifies the name of a frame where a document is to be opened.
By assigning a name to a frame via the name attribute, authors can refer to it as the "target" of links defined by other elements
target
java.lang.String
Timeout ( in ms ) for request.
timeout
int
Advisory title information about markup elements generated for this component
title
java.lang.String
The content type of the resource designated by this hyperlink
type
java.lang.String
The current value for this component
value
java.lang.Object
Ajax-related version of html form. Main difference with original component - all hidden fields,
necessary to command links alwais rendered, not depended of rendering links on initial page.
Ajax-related version of html form
form
org.ajax4jsf.taglib.html.jsp.FormTag
JSP
This attribute specifies a comma-separated list of content types that a server processing this form will handle correctly. User agents may use this information to filter out non-conforming files when prompting you to select files to be sent to the server (cf. the INPUT element when type="file")
accept
java.lang.String
This attribute specifies the list of character encodings for input data that is accepted by the server processing this form. The value is a space- and/or comma-delimited list of charset values. The client must interpret this list as an exclusive-or list, i.e., the server is able to accept any single character encoding per entity received.
The default value for this attribute is the reserved string "UNKNOWN". User agents may interpret this value as the character encoding that was used to transmit the document containing this FORM element
acceptCharset
java.lang.String
Limits JSF tree processing (decoding, conversion, validation and model updating) only to a component that sends the request. Boolean. Default value is "false".
ajaxSingle
boolean
If "true", it becomes possible to set AJAX submission way for any components inside .
ajaxSubmit
boolean
The attribute takes a value-binding expression for a component property of
a backing bean
binding
javax.faces.component.UIComponent
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
bypassUpdates
boolean
Serialized (on default with JSON) data passed on the client by a developer on AJAX request. It's accessible via "data.foo" syntax
data
java.lang.Object
This attribute specifies the content type used to submit the form to the server (when the value of method is "post"). The default value for this attribute is "application/x-www-form-urlencoded". The value "multipart/form-data" should be used in combination with the INPUT element, type="file"
enctype
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.)
eventsQueue
java.lang.String
ID of an element to set focus after request is completed on client side
focus
java.lang.String
Every component may have a unique id that is automatically created if omitted
id
false
java.lang.String
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
ignoreDupResponses
boolean
iterationState
iterationState
java.lang.Object
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.
limitToList
boolean
The client-side script method to be called before DOM is updated
onbeforedomupdate
java.lang.String
The client-side script method to be called after the request is completed
oncomplete
java.lang.String
The client-side script method to be called when a form is reset. It is only applied to the FORM element
onreset
java.lang.String
The client-side script method to be called when a form is submitted. It is only applied to the FORM element
onsubmit
java.lang.String
The flag indicating whether or not this form should prepend its id to its descendent id during the clientId generation process. If this flag is not set, the default value is "true".
prependId
boolean
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
process
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
reRender
java.lang.Object
If "false", this component is not rendered
rendered
boolean
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
requestDelay
int
If there are any component requests with identical IDs then these requests will be grouped.
similarityGroupingId
java.lang.String
ID (in format of call UIComponent.findComponent()) of Request status component
status
java.lang.String
CSS style rules to be applied to the component
style
java.lang.String
Assigns one or more CSS class names to the component. Corresponds to the HTML "class" attribute.
styleClass
java.lang.String
This attribute specifies the name of a frame where a document is to be opened.
By assigning a name to a frame via the name attribute, authors can refer to it as the "target" of links defined by other elements
target
java.lang.String
Timeout ( in ms ) for request.
timeout
int
Ajax-related version of html commandLink. Single difference with original component - all hidden fields,
necessary to command links alwais rendered, not depended of rendering links on initial page.
Ajax-related version of html command link
htmlCommandLink
org.ajax4jsf.taglib.html.jsp.HtmlCommandLinkTag
JSP
This attribute assigns an access key to an element. An access key is a single character from the document character set. Note: Authors should consider the input method of the expected reader when specifying an accesskey
accesskey
java.lang.String
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
action
java.lang.Object action()
MethodBinding pointing at method accepting an ActionEvent with return type void
actionListener
void actionListener(javax.faces.event.ActionEvent)
The attribute takes a value-binding expression for a component property of
a backing bean
binding
javax.faces.component.UIComponent
The character encoding of a resource designated by this hyperlink
charset
java.lang.String
The attribute specifies shape and it position on the screen.
Possible values: "rect: left-x, top-y, right-x, bottom-y", "circle: center-x, center-y, radius", "poly: x1, y1, x2, y2, ..., xN, yN".
Notes:
a) when giving the radius value in percents, user agents should calculate the final radius value in pixels based on the associated object's width and height;
b) the radius value should be smaller than center-x and center-y values;
c) for a polygon, the first and last coordinate pairs should have same x and y to close the shape (x1=xN; y1=yN)
(when these coordinates are different, user agents should infer an additional pair to close a polygon).
Coordinates are relative to the top left corner of an object. All values are lengths. All values are comma separated.
coords
java.lang.String
Direction indication for text that does not inherit
directionality. Valid values are "LTR" (left-to-right)
and "RTL" (right-to-left)
dir
java.lang.String
When set for a form control, this boolean attribute disables the control for your input.
disabled
boolean
Base language of a resource specified with the href attribute; hreflang may only be used with href
hreflang
java.lang.String
Every component may have a unique id that is automatically created if omitted
id
false
java.lang.String
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
immediate
boolean
Code describing the language used in the generated markup for this component
lang
java.lang.String
The client-side script method to be called when the element loses the focus either when pointing a device or tabbing navigation. The attribute may be used with the same elements as onfocus
onblur
java.lang.String
The client-side script method to be called when the element is clicked
onclick
java.lang.String
The client-side script method to be called when the element is double-clicked
ondblclick
java.lang.String
The client-side script method to be called when the element gets the focus
onfocus
java.lang.String
The client-side script method to be called when a key is pressed down over the element
onkeydown
java.lang.String
The client-side script method to be called when a key is pressed over the element and released
onkeypress
java.lang.String
The client-side script method to be called when a key is released
onkeyup
java.lang.String
The client-side script method to be called when a mouse button is pressed down over the element
onmousedown
java.lang.String
The client-side script method to be called when a pointer is moved within the element
onmousemove
java.lang.String
The client-side script method to be called when a pointer is moved away from the element
onmouseout
java.lang.String
The client-side script method to be called when a pointer is moved onto the element
onmouseover
java.lang.String
The client-side script method to be called when a mouse button is released
onmouseup
java.lang.String
The relationship from the current document to the anchor specified by this hyperlink. The value of this attribute is a space-separated list of link types
rel
java.lang.String
If "false", this component is not rendered
rendered
boolean
A reverse link from the anchor specified by this hyperlink to the current document. The value of this attribute is a space-separated list of link types
rev
java.lang.String
This attribute specifies the shape of a region. The possible values are "default", "rect", "circle" and "poly".
shape
java.lang.String
CSS style rules to be applied to the component
style
java.lang.String
Assigns one or more CSS class names to the component. Corresponds to the HTML "class" attribute.
styleClass
java.lang.String
This attribute specifies the position of the current element in the tabbing order for the current document. This value must be a number between 0 and 32767. User agents should ignore leading zeros
tabindex
java.lang.String
This attribute specifies the name of a frame where a document is to be opened.
By assigning a name to a frame via the name attribute, authors can refer to it as the "target" of links defined by other elements
target
java.lang.String
Advisory title information about markup elements generated for this component
title
java.lang.String
The content type of the resource designated by this hyperlink
type
java.lang.String
The current value for this component
value
java.lang.Object
include content of external view. Navigation cases in included file change only viewId of included page,
and don't perform navigation in root view.
include content of external view
include
org.ajax4jsf.taglib.html.jsp.HtmlIncludeTag
JSP
Defines, whether the content of this component must be
(or not) included in AJAX response created by parent
AJAX Container, even if it is not forced by reRender
list of ajax action. Ignored if component marked to output by some Ajax action component.
Default value is "true".
ajaxRendered
boolean
The attribute takes a value-binding expression for a component property of
a backing bean
binding
javax.faces.component.UIComponent
Direction indication for text that does not inherit
directionality. Valid values are "LTR" (left-to-right)
and "RTL" (right-to-left)
dir
java.lang.String
Every component may have a unique id that is automatically created if omitted
id
false
java.lang.String
Flag for mark all child components to non-transient. If
true, all children components will be set to non-transient state
and keep in saved components tree. For output in self-renderer
region all content ( By default, all content in <f:verbatim>
tags and non-jsf elements in facelets, marked as transient -
since, self-rendered ajax regions don't plain output for ajax
processing ).
keepTransient
boolean
Code describing the language used in the generated markup for this component
lang
java.lang.String
HTML layout for generated markup. Possible values: "block"
for generating an HTML <div> element, "inline" for
generating an HTML <span> element, and "none" for generating
no HTML element. There is a minor exception for the "none" case
where a child element has the property "rendered" set to "false".
In this case, we create an empty <span> element with same ID
as the child element to use as a placeholder for later
processing. Default value is "inline"
layout
java.lang.String
If "false", this component is not rendered
rendered
boolean
CSS style rules to be applied to the component
style
java.lang.String
Assigns one or more CSS class names to the component. Corresponds to the HTML "class" attribute.
styleClass
java.lang.String
Advisory title information about markup elements generated for this component
title
java.lang.String
Specifies the view id of a page that is included.
viewId
java.lang.String
Ajax Function
jsFunction
org.ajax4jsf.taglib.html.jsp.AjaxFunction
JSP
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
action
java.lang.Object action()
MethodBinding pointing at method accepting an ActionEvent with return type void
actionListener
void actionListener(javax.faces.event.ActionEvent)
Limits JSF tree processing (decoding, conversion, validation and model updating) only to a component that sends the request. Boolean. Default value is "false".
ajaxSingle
boolean
The attribute takes a value-binding expression for a component property of
a backing bean
binding
javax.faces.component.UIComponent
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
bypassUpdates
boolean
Serialized (on default with JSON) data passed on the client by a developer on AJAX request. It's accessible via "data.foo" syntax
data
java.lang.Object
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.)
eventsQueue
java.lang.String
ID of an element to set focus after request is completed on client side
focus
java.lang.String
Every component may have a unique id that is automatically created if omitted
id
false
java.lang.String
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
ignoreDupResponses
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
immediate
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.
limitToList
boolean
Name of generated JavaScript function definition
name
java.lang.String
The client-side script method to be called before DOM is updated
onbeforedomupdate
java.lang.String
The client-side script method to be called after the request is completed
oncomplete
java.lang.String
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
process
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
reRender
java.lang.Object
If "false", this component is not rendered
rendered
boolean
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
requestDelay
int
If there are any component requests with identical IDs then these requests will be grouped.
similarityGroupingId
java.lang.String
ID (in format of call UIComponent.findComponent()) of Request status component
status
java.lang.String
Response waiting time on a particular request. If a response is not received during this time, the request is aborted
timeout
int
This tag get bean by EL expression '#{'+name+'}' and store bean instance in component tree. After restoring view state, bean is putted to request-scope attributes with name.
Since, every view will be use own instance of bean for expressions '#{name....}'
keepAlive
org.ajax4jsf.taglib.html.jsp.KeepAliveTag
JSP
name of bean for EL-expressions.
beanName
true
if true, bean value restored in ajax requests only.
ajaxOnly
false
java.lang.String
Load a resource bundle localized for the Locale of the current view, and expose it (as a Map)
in the request attributes of the current request.
In difference of original f:loadBundle tag, stored in components tree and activate on ajax/non ajax responses
Ajax-compatible version of f:loadBundle
loadBundle
org.ajax4jsf.taglib.html.jsp.LoadBundle
JSP
Base name of the resource bundle to be loaded.
basename
java.lang.String
The attribute takes a value-binding expression for a component property of
a backing bean
binding
javax.faces.component.UIComponent
Every component may have a unique id that is automatically created if omitted
id
false
java.lang.String
If "false", this component is not rendered
rendered
boolean
Name of a request scope attribute under which the
resource bundle will be exposed as a Map.
var
false
java.lang.String
loadScript
org.ajax4jsf.taglib.html.jsp.LoadScriptTag
JSP
The attribute takes a value-binding expression for a component property of
a backing bean
binding
javax.faces.component.UIComponent
Every component may have a unique id that is automatically created if omitted
id
false
java.lang.String
If "false", this component is not rendered
rendered
boolean
name of JavaScript resource to load.
src
true
java.lang.Object
loadStyle
org.ajax4jsf.taglib.html.jsp.LoadStyleTag
JSP
The attribute takes a value-binding expression for a component property of
a backing bean
binding
javax.faces.component.UIComponent
Every component may have a unique id that is automatically created if omitted
id
false
java.lang.String
This attribute defines the device to which it is necessary to apply style registration.
The possible values are "all", "screen" (by default), "print", "projection", "projection", "braille" and "speech".
media
java.lang.String
If "false", this component is not rendered
rendered
boolean
Defines the context relative path to the style sheet file.
src
true
java.lang.Object
Encode javaScript to open popup window with client-side Log information.
pop-up window with request log
log
org.ajax4jsf.taglib.html.jsp.LogTag
JSP
The attribute takes a value-binding expression for a component property of
a backing bean
binding
javax.faces.component.UIComponent
Direction indication for text that does not inherit
directionality. Valid values are "LTR" (left-to-right)
and "RTL" (right-to-left)
dir
java.lang.String
Height of pop-up. Default value is "600".
height
java.lang.String
Keyboard key for activate ( in combination with
CTRL+SHIFT ) log window. Default value is "L"
hotkey
java.lang.String
Every component may have a unique id that is automatically created if omitted
id
false
java.lang.String
Code describing the language used in the generated markup for this component
lang
java.lang.String
Log level. The possible values are
"FATAL", "ERROR", "WARN", "INFO", "DEBUG", "ALL".
Component sets level 'ALL' by default.
level
java.lang.String
Name of pop-up window. Default value is "LogWindow"
name
java.lang.String
The client-side script method to be called when the element is clicked
onclick
java.lang.String
The client-side script method to be called when the element is double-clicked
ondblclick
java.lang.String
The client-side script method to be called when a key is pressed down over the element
onkeydown
java.lang.String
The client-side script method to be called when a key is pressed over the element and released
onkeypress
java.lang.String
The client-side script method to be called when a key is released
onkeyup
java.lang.String
The client-side script method to be called when a mouse button is pressed down over the element
onmousedown
java.lang.String
The client-side script method to be called when a pointer is moved within the element
onmousemove
java.lang.String
The client-side script method to be called when a pointer is moved away from the element
onmouseout
java.lang.String
The client-side script method to be called when a pointer is moved onto the element
onmouseover
java.lang.String
The client-side script method to be called when a mouse button is released
onmouseup
java.lang.String
Renders log as pop-up window or as div element on the page. Default value is "true".
popup
boolean
If "false", this component is not rendered
rendered
boolean
CSS style rules to be applied to the component
style
java.lang.String
Assigns one or more CSS class names to the component. Corresponds to the HTML "class" attribute.
styleClass
java.lang.String
Advisory title information about markup elements generated for this component
title
java.lang.String
Width of pop-up. Default value is "800".
width
java.lang.String
Class for create any link-type elements to user-generated resources :
images, sounds, video, active objects, applets etc.
Method specified in "CreateContent" attribute will put the data from Data Bean specified
in "value" attribute to the OutputStream. Important: Data Bean specified in "value" must implement Serializable.
Link to user-generated resource
mediaOutput
org.ajax4jsf.taglib.html.jsp.MediaOutputTag
JSP
This attribute assigns an access key to an element. An access key is a single character from the document character set. Note: Authors should consider the input method of the expected reader when specifying an accesskey
accesskey
java.lang.String
Deprecated. This attribute specifies the position of an IMG, OBJECT, or APPLET with respect to its context.
The possible values are "bottom", "middle", "top", "left" and "right". The default value is "middle".
align
java.lang.String
Specifies a space-separated list of URIs
archive
java.lang.String
The attribute takes a value-binding expression for a component property of
a backing bean
binding
javax.faces.component.UIComponent
Deprecated. This attribute specifies the width of an IMG or OBJECT border, in pixels. The default value for this attribute depends on the user agent
border
java.lang.String
Attribute is a flag that defines the caching strategy. If 'cacheable' is set to false, the response will not be cached. If it is set to true, it will be cached and the serialized value of 'value' attribute plays the role of a cache key.
cacheable
boolean
The character encoding of a resource designated by this hyperlink
charset
java.lang.String
identifies an implementation
classid
java.lang.String
base URI for classid, data, archive
codebase
java.lang.String
Defines content type for code
codetype
java.lang.String
ID of a converter to be used or a reference to a
converter.
converter
javax.faces.convert.Converter
The attribute specifies shape and it position on the screen.
Possible values: "rect: left-x, top-y, right-x, bottom-y", "circle: center-x, center-y, radius", "poly: x1, y1, x2, y2, ..., xN, yN".
Notes:
a) when giving the radius value in percents, user agents should calculate the final radius value in pixels based on the associated object's width and height;
b) the radius value should be smaller than center-x and center-y values;
c) for a polygon, the first and last coordinate pairs should have same x and y to close the shape (x1=xN; y1=yN)
(when these coordinates are different, user agents should infer an additional pair to close a polygon).
Coordinates are relative to the top left corner of an object. All values are lengths. All values are comma separated.
coords
java.lang.String
Method call expression to send generated resource to OutputStream. It must have two parameter with a type of java.io.OutputStream
and java.lang.Object ( deserialized value of data attribute )
createContent
void createContent(java.io.OutputStream,java.lang.Object)
Attribute references to the method that will be used for content creating. The method accepts two parameters. The first parameter has an OutputStream type. It is a reference to the steam that should be used for output. The second parameter is a reference to a 'value' attribute of the component.
createContentExpression
void createContentExpression(java.io.OutputStream,java.lang.Object)
declare but don't instantiate flag
declare
java.lang.String
Direction indication for text that does not inherit
directionality. Valid values are "LTR" (left-to-right)
and "RTL" (right-to-left)
dir
java.lang.String
Name of html element for resource link - may be <a> <img> <object> <applet> <script> or <link>
element
java.lang.String
The attribute allows to manage caching and defines the period after which a resource is reloaded.
expires
java.util.Date
Base language of a resource specified with the href attribute; hreflang may only be used with href
hreflang
java.lang.String
Deprecated. This attribute specifies the amount of white space to be inserted to the left and right of an IMG, APPLET, or OBJECT. The default value is not specified, but is generally a small, non-zero length
hspace
java.lang.String
Every component may have a unique id that is automatically created if omitted
id
false
java.lang.String
use server-side image map
ismap
boolean
Code describing the language used in the generated markup for this component
lang
java.lang.String
The attribute allows to manage caching. A browser can send request with the header "If-Modified-Since" for necessity of object reloading. If time of modification is earlier, then the framework doesn't call generation and return code 304.
lastModified
java.util.Date
Geterated content mime-type for append to response
header ( 'image/jpeg' etc )
mimeType
java.lang.String
The client-side script method to be called when the element loses the focus either when pointing a device or tabbing navigation. The attribute may be used with the same elements as onfocus
onblur
java.lang.String
The client-side script method to be called when the element is clicked
onclick
java.lang.String
The client-side script method to be called when the element is double-clicked
ondblclick
java.lang.String
The client-side script method to be called when the element gets the focus
onfocus
java.lang.String
The client-side script method to be called when a key is pressed down over the element
onkeydown
java.lang.String
The client-side script method to be called when a key is pressed over the element and released
onkeypress
java.lang.String
The client-side script method to be called when a key is released
onkeyup
java.lang.String
The client-side script method to be called when a mouse button is pressed down over the element
onmousedown
java.lang.String
The client-side script method to be called when a pointer is moved within the element
onmousemove
java.lang.String
The client-side script method to be called when a pointer is moved away from the element
onmouseout
java.lang.String
The client-side script method to be called when a pointer is moved onto the element
onmouseover
java.lang.String
The client-side script method to be called when a mouse button is released
onmouseup
java.lang.String
The relationship from the current document to the anchor specified by this hyperlink. The value of this attribute is a space-separated list of link types
rel
java.lang.String
If "false", this component is not rendered
rendered
boolean
A reverse link from the anchor specified by this hyperlink to the current document. The value of this attribute is a space-separated list of link types
rev
java.lang.String
If "true", a session for an object generation is restored.
session
boolean
This attribute specifies the shape of a region. The possible values are "default", "rect", "circle" and "poly".
shape
java.lang.String
message to show while loading
standby
java.lang.String
CSS style rules to be applied to the component
style
java.lang.String
Assigns one or more CSS class names to the component. Corresponds to the HTML "class" attribute.
styleClass
java.lang.String
This attribute specifies the position of the current element in the tabbing order for the current document. This value must be a number between 0 and 32767. User agents should ignore leading zeros
tabindex
java.lang.String
This attribute specifies the name of a frame where a document is to be opened.
By assigning a name to a frame via the name attribute, authors can refer to it as the "target" of links defined by other elements
target
java.lang.String
Advisory title information about markup elements generated for this component
title
java.lang.String
The content type of the resource designated by this hyperlink
type
java.lang.String
Name of attribute for resource-link attribute ( 'href' for <a>, 'src' for <img> or <script>, etc)
uriAttribute
java.lang.String
Specifies an image as a client-side image-map
usemap
java.lang.String
Data value calculated at render time and stored in URI (also as part of cache Key ),
at generation time passed to send method. Can be used for update cache at change of generating
conditions, and for creating beans as "Lightweight" pattern components (request scope).
IMPORTANT: Since serialized data stored in URI, avoid using big objects.
value
java.lang.Object
Deprecated. This attribute specifies the amount of white space to be inserted above and below an IMG, APPLET, or OBJECT. The default value is not specified, but is generally a small, non-zero length
vspace
java.lang.String
Creates an AJAX-enabled part of the page. For a normal request,
render a &lt;span&gt; or &lt;div&gt; HTML element
depending on the value of the "layout" attribute, "inline" or "block".
(The "id" attribute will be the value of the clientId property.) For an
AJAX request, the content of this element is included in the response if
the value of the property, "ajaxRendered", is set to true.
Ajax OutputPanel
outputPanel
org.ajax4jsf.taglib.html.jsp.AjaxOutputPanel
JSP
Defines, whether the content of this component must be
(or not) included in AJAX response created by parent
AJAX Container, even if it is not forced by reRender
list of ajax action. Ignored if component marked to output by some Ajax action component.
Default value is "false".
ajaxRendered
boolean
The attribute takes a value-binding expression for a component property of
a backing bean
binding
javax.faces.component.UIComponent
Direction indication for text that does not inherit
directionality. Valid values are "LTR" (left-to-right)
and "RTL" (right-to-left)
dir
java.lang.String
Every component may have a unique id that is automatically created if omitted
id
false
java.lang.String
Flag to mark all child components to non-transient. If
true, all children components will be set to non-transient state
and keep in saved components tree. For output in self-renderer
region all content ( By default, all content in <f:verbatim>
tags and non-jsf elements in facelets, marked as transient -
since, self-rendered ajax regions don't plain output for ajax
processing ). Default value is "true"
keepTransient
boolean
Code describing the language used in the generated markup for this component
lang
java.lang.String
HTML layout for generated markup. Possible values: "block"
for generating an HTML <div> element, "inline" for
generating an HTML <span> element, and "none" for generating
no HTML element. There is a minor exception for the "none" case
where a child element has the property "rendered" set to "false".
In this case, we create an empty <span> element with same ID
as the child element to use as a placeholder for later
processing. Default value is "inline"
layout
java.lang.String
The client-side script method to be called when the element is clicked
onclick
java.lang.String
The client-side script method to be called when the element is double-clicked
ondblclick
java.lang.String
The client-side script method to be called when a key is pressed down over the element
onkeydown
java.lang.String
The client-side script method to be called when a key is pressed over the element and released
onkeypress
java.lang.String
The client-side script method to be called when a key is released
onkeyup
java.lang.String
The client-side script method to be called when a mouse button is pressed down over the element
onmousedown
java.lang.String
The client-side script method to be called when a pointer is moved within the element
onmousemove
java.lang.String
The client-side script method to be called when a pointer is moved away from the element
onmouseout
java.lang.String
The client-side script method to be called when a pointer is moved onto the element
onmouseover
java.lang.String
The client-side script method to be called when a mouse button is released
onmouseup
java.lang.String
If "false", this component is not rendered
rendered
boolean
CSS style rules to be applied to the component
style
java.lang.String
Assigns one or more CSS class names to the component. Corresponds to the HTML "class" attribute.
styleClass
java.lang.String
Advisory title information about markup elements generated for this component
title
java.lang.String
This component renders a full HTML page structure. It must
be the first (and only) child for the view root (JSP
<f:view> tag). No HTML code can be outside of this
component. It also has support for processing child
components in AJAX requests, just like <a4j:region>.
For a normal request, it will render the results of a
<script> element with a client-side library at the
page's <head>. If this component includes a "head"
facet, the facet's content will also be rendered at the
<head> element. For an AJAX request, only affected
components in the full document structure will be rendered.
Here's an example of using it in JSP (jspx version):
<jsp:root xmlns:.... <f:view>
<a4j:page><f:facet name="head"> ...
</f:facet> <!-- page content here -->
</a4j:page> </f:view></jsp:root>
Ajax Page
page
org.ajax4jsf.taglib.html.jsp.AjaxPage
JSP
MethodExpression representing an action listener method that will be notified when this component is activated by the ajax Request and handle it. The expression must evaluate to a public method that takes an AjaxEvent parameter, with a return type of void
ajaxListener
void ajaxListener(org.ajax4jsf.event.AjaxEvent)
The attribute takes a value-binding expression for a component property of
a backing bean
binding
javax.faces.component.UIComponent
Set custom mime content type to response
contentType
java.lang.String
Direction indication for text that does not inherit
directionality. Valid values are "LTR" (left-to-right)
and "RTL" (right-to-left)
dir
java.lang.String
Page layout format ( html, xhtml, html-transitional, html-3.2 ) for encoding DOCTYPE, namespace and Content-Type definitions
format
java.lang.String
Every component may have a unique id that is automatically created if omitted
id
false
java.lang.String
Flag indicating that, if this component is activated by ajaxrequest, notifications should be delivered to interested listeners and actions immediately (that is, during Apply Request Values phase) rather than waiting until Invoke Application phase
immediate
boolean
Code describing the language used in the generated markup for this component
lang
java.lang.String
Set html element default namespace
namespace
java.lang.String
The client-side script method to be called before a page is loaded
onload
java.lang.String
The client-side script method to be called when a page is unloaded
onunload
java.lang.String
String for output as a page title.
pageTitle
java.lang.String
If "false", this component is not rendered
rendered
boolean
if "true", self-render subtree at InvokeApplication ( or Decode, if immediate property set to true ) phase
selfRendered
boolean
CSS style rules to be applied to the component
style
java.lang.String
Assigns one or more CSS class names to the component. Corresponds to the HTML "class" attribute.
styleClass
java.lang.String
Advisory title information about markup elements generated for this component
title
java.lang.String
Periodically perform AJAX request to server, to simulate
'poll' data.
Ajax Poll
poll
org.ajax4jsf.taglib.html.jsp.AjaxPollTag
JSP
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
action
java.lang.Object action()
MethodBinding pointing at method accepting an ActionEvent with return type void
actionListener
void actionListener(javax.faces.event.ActionEvent)
Limits JSF tree processing (decoding, conversion, validation and model updating) only to a component that sends the request. Boolean. Default value is "false".
ajaxSingle
boolean
The attribute takes a value-binding expression for a component property of
a backing bean
binding
javax.faces.component.UIComponent
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
bypassUpdates
boolean
Serialized (on default with JSON) data passed on the client by a developer on AJAX request. It's accessible via "data.foo" syntax
data
java.lang.Object
Enables/disables polling. Default value is "true".
enabled
boolean
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.)
eventsQueue
java.lang.String
ID of an element to set focus after request is completed on client side
focus
java.lang.String
Every component may have a unique id that is automatically created if omitted
id
false
java.lang.String
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
ignoreDupResponses
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
immediate
boolean
Interval (in ms) for call poll requests. Default value is "1000"ms (1 second).
interval
int
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.
limitToList
boolean
The client-side script method to be called before DOM is updated
onbeforedomupdate
java.lang.String
The client-side script method to be called after the request is completed
oncomplete
java.lang.String
The client-side script method to be called before an ajax request is submitted
onsubmit
java.lang.String
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
process
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
reRender
java.lang.Object
If "false", this component is not rendered
rendered
boolean
If there are any component requests with identical IDs then these requests will be grouped.
similarityGroupingId
java.lang.String
ID (in format of call UIComponent.findComponent()) of Request status component
status
java.lang.String
Timeout (in ms) for request
timeout
int
portlet
org.ajax4jsf.taglib.html.jsp.Portlet
JSP
The attribute takes a value-binding expression for a component property of
a backing bean
binding
javax.faces.component.UIComponent
Every component may have a unique id that is automatically created if omitted
id
false
java.lang.String
If "false", this component is not rendered
rendered
boolean
Periodically perform AJAX request to server, to simulate
'push' data.
Ajax Push
push
org.ajax4jsf.taglib.html.jsp.AjaxPushTag
JSP
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
action
java.lang.Object action()
MethodBinding pointing at method accepting an ActionEvent with return type void
actionListener
void actionListener(javax.faces.event.ActionEvent)
Limits JSF tree processing (decoding, conversion, validation and model updating) only to a component that sends the request. Boolean. Default value is "false".
ajaxSingle
boolean
The attribute takes a value-binding expression for a component property of
a backing bean
binding
javax.faces.component.UIComponent
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
bypassUpdates
boolean
Serialized (on default with JSON) data passed on the client by a developer on AJAX request. It's accessible via "data.foo" syntax
data
java.lang.Object
Enables/disables pushing. Default value is "true".
enabled
boolean
MethodBinding pointing at method accepting an PushEventListener with return type void.
User bean must register this listener and send EventObject to this listener on ready.
eventProducer
void eventProducer(java.util.EventListener)
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.)
eventsQueue
java.lang.String
ID of an element to set focus after request is completed on client side
focus
java.lang.String
Every component may have a unique id that is automatically created if omitted
id
false
java.lang.String
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
ignoreDupResponses
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
immediate
boolean
Interval (in ms) for call push requests. Default value is "1000"ms (1 second).
interval
int
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.
limitToList
boolean
The client-side script method to be called before DOM is updated
onbeforedomupdate
java.lang.String
The client-side script method to be called after the request is completed
oncomplete
java.lang.String
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
process
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
reRender
java.lang.Object
If "false", this component is not rendered
rendered
boolean
If there are any component requests with identical IDs then these requests will be grouped.
similarityGroupingId
java.lang.String
ID (in format of call UIComponent.findComponent()) of Request status component
status
java.lang.String
Timeout (in ms) for request
timeout
int
The <a4j:queue> tag.
queue
org.ajax4jsf.taglib.html.jsp.QueueTag
empty
The attribute takes a value-binding expression for a component property of
a backing bean
binding
javax.faces.component.UIComponent
If "true", disables this component on page.
disabled
boolean
Every component may have a unique id that is automatically created if omitted
id
false
java.lang.String
Attribute allows you to ignore an Ajax response produced by a request if the newest 'similar' request is in the queue already.
ignoreDupResponses="true" does not cancel the request while it is processed on the server, but just allows avoiding unnecessary updates on the client side if the response isn't actual now
ignoreDupResponses
boolean
Specifies to name for the named queue.
name
java.lang.String
The client-side script method to be called before DOM is updated
onbeforedomupdate
java.lang.String
The client-side script method to be called after the request is completed
oncomplete
java.lang.String
The client-side script method to be called whenever a JavaScript error occurs
onerror
java.lang.String
The client-side script method to be called after the request is removed from the queue
onrequestdequeue
java.lang.String
The client-side script method to be called when the request is added to the queue
onrequestqueue
java.lang.String
The client-side script method to be called when a size is exceeded
onsizeexceeded
java.lang.String
The client-side script method to be called before an ajax request is submitted
onsubmit
java.lang.String
Attribute defines the time (in ms) the request will be waiting in the queue before it is ready to be sent.
requestDelay
int
Defines the number of requests allowed in the queue at one time.
size
int
Defines the strategies of the queue's behavior if the number of the requests waiting in the queue is exceeded.
There are four strategies: dropNext (by default), dropNew, fireNext , fireNew.
sizeExceededBehavior
java.lang.String
ID (in format of call UIComponent.findComponent()) of Request status component
status
java.lang.String
Waiting time for response on a particular request. If no response is received during this time, the request is aborted
timeout
int
This tag defines a part of the JSF Tree that is to be decoded on the
server side during AJAX request processing
Ajax Region
region
org.ajax4jsf.taglib.html.jsp.AjaxRegion
JSP
MethodExpression representing an action listener method that will be notified when this component is activated by the ajax Request and handle it. The expression must evaluate to a public method that takes an AjaxEvent parameter, with a return type of void
ajaxListener
void ajaxListener(org.ajax4jsf.event.AjaxEvent)
The attribute takes a value-binding expression for a component property of
a backing bean
binding
javax.faces.component.UIComponent
Every component may have a unique id that is automatically created if omitted
id
false
java.lang.String
Flag indicating that, if this component is activated by ajaxrequest, notifications should be delivered to interested listeners and actions immediately (that is, during Apply Request Values phase) rather than waiting until Invoke Application phase
immediate
boolean
Excludes all the components from the outside of the region from updating on the page on Renderer Response phase.
Default value is "false".
renderRegionOnly
boolean
If "false", this component is not rendered
rendered
boolean
if "true", self-render subtree at InvokeApplication ( or Decode, if immediate property set to true ) phase
selfRendered
boolean
Ajax-enabled repeater
repeat
org.ajax4jsf.taglib.html.jsp.AjaxRepeat
JSP
This attribute defines row keys that are updated after an AJAX request.
ajaxKeys
java.util.Set
The attribute takes a value-binding expression for a component property of
a backing bean
binding
javax.faces.component.UIComponent
It defines EL-binding for a component state for saving or redefinition.
componentState
org.ajax4jsf.model.DataComponentState
A zero-relative row number of the first row to display
first
int
Every component may have a unique id that is automatically created if omitted
id
false
java.lang.String
If "false", this component is not rendered
rendered
boolean
Converter for a row key object
rowKeyConverter
javax.faces.convert.Converter
The attribute provides access to a row key in a Request scope.
rowKeyVar
false
java.lang.String
A number of rows to display, or zero for all remaining
rows in the table
rows
int
The attribute provides access to a component state on the client side.
stateVar
false
java.lang.String
The current value for this component.
value
java.lang.Object
A request-scope attribute via which the data object for the
current row will be used when iterating
var
false
java.lang.String
Renders area for indicating Ajax request status on the
client-side.
<br />
During Encoding: Creates two "span" elements with id created
as clientId of this component or of target AJAX region
(pointed to by the "for" property) with appended
":status.start" and ":status:stop" strings.
<br />
"start" span has "display:none" style (hidden). Inside this
span, renders the value of the startText/stopText properties
or, if they exist, the content of "start" and "stop" facets.
<br />
On performing an AJAX request, the client-side script
changes the visibility of the "start" span and hides "stop".
After all requests for this indicator are completed,
restores "stop" and hide "start" start[style,styleClass] and
stop[style,styleClass] are rendered for spans as style and
class atributes, respectivetly.
<br />
During Encoding: Creates two "span" or "div"(depending on
'layout' attribute) elements with id created as clientId of
this component or of target AJAX region (pointed to by the
"for" property) with appended ":status.start" and
":status:stop" strings. "start" element has "display:none"
style (hidden). Inside this element, renders the value of
the startText/stopText properties or, if they exist, the
content of "start" and "stop" facets. On performing an AJAX
request, the client-side script changes the visibility of
the "start" element and hides "stop". After all requests for
this indicator are completed, restores "stop" and hide
"start"
<br />
start[style,styleClass] and stop[style,styleClass] are
rendered for spans as style and class atributes,
respectivetly.
status
org.ajax4jsf.taglib.html.jsp.AjaxStatus
JSP
The attribute takes a value-binding expression for a component property of
a backing bean
binding
javax.faces.component.UIComponent
Direction indication for text that does not inherit
directionality. Valid values are "LTR" (left-to-right)
and "RTL" (right-to-left)
dir
java.lang.String
ID of the AjaxContainer component whose status is
indicated (in the format of a
javax.faces.UIComopnent.findComponent() call).
for
java.lang.String
If true, render the ID of the component in HTML code
without JSF modifications.
forceId
boolean
Every component may have a unique id that is automatically created if omitted
id
false
java.lang.String
Code describing the language used in the generated markup for this component
lang
java.lang.String
Define visual layout of panel, can be "block" or
"inline".
layout
java.lang.String
The client-side script method to be called when the element is clicked
onclick
java.lang.String
The client-side script method to be called when the element is double-clicked
ondblclick
java.lang.String
The client-side script method to be called when a key is pressed down over the element
onkeydown
java.lang.String
The client-side script method to be called when a key is pressed over the element and released
onkeypress
java.lang.String
The client-side script method to be called when a key is released
onkeyup
java.lang.String
The client-side script method to be called when a mouse button is pressed down over the element
onmousedown
java.lang.String
The client-side script method to be called when a pointer is moved within the element
onmousemove
java.lang.String
The client-side script method to be called when a pointer is moved away from the element
onmouseout
java.lang.String
The client-side script method to be called when a pointer is moved onto the element
onmouseover
java.lang.String
The client-side script method to be called when a mouse button is released
onmouseup
java.lang.String
The client-side script method to be called at the start
of the request
onstart
java.lang.String
The client-side script method to be called when the request is finished
onstop
java.lang.String
If "false", this component is not rendered
rendered
boolean
CSS style rules to be applied to the element displayed when a request is in progress
startStyle
java.lang.String
Assigns one or more space-separated CSS class names to the element displayed when a request is in progress
startStyleClass
java.lang.String
Text to display on starting request.
startText
java.lang.String
CSS style rules to be applied to the element displayed on a request completion
stopStyle
java.lang.String
Assigns one or more space-separated CSS class names to the element displayed on a request completion
stopStyleClass
java.lang.String
Text for display on request complete.
stopText
java.lang.String
CSS style rules to be applied to the component
style
java.lang.String
Assigns one or more CSS class names to the component. Corresponds to the HTML "class" attribute.
styleClass
java.lang.String
Advisory title information about markup elements generated for this component
title
java.lang.String
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.
Ajax Support
support
org.ajax4jsf.taglib.html.jsp.AjaxSupport
JSP
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
action
java.lang.Object action()
MethodBinding pointing at method accepting an ActionEvent with return type void
actionListener
void actionListener(javax.faces.event.ActionEvent)
Limits JSF tree processing (decoding, conversion, validation and model updating) only to a component that sends the request. Boolean. Default value is "false".
ajaxSingle
boolean
The attribute takes a value-binding expression for a component property of
a backing bean
binding
javax.faces.component.UIComponent
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
bypassUpdates
boolean
Serialized (on default with JSON) data passed on the client by a developer on AJAX request. It's accessible via "data.foo" syntax
data
java.lang.Object
Disables default action for target event ( append "return false;" to JavaScript ). Default value is "false"
disableDefault
boolean
If "true", disable this component on page.
disabled
boolean
Name of JavaScript event property ( onclick, onchange,
etc.) of parent component, for which we will build AJAX
submission code
event
false
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.)
eventsQueue
java.lang.String
ID of an element to set focus after request is completed on client side
focus
java.lang.String
Every component may have a unique id that is automatically created if omitted
id
false
java.lang.String
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
ignoreDupResponses
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
immediate
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.
limitToList
boolean
The client-side script method to be called before DOM is updated
onbeforedomupdate
java.lang.String
The client-side script method to be called after the request is completed
oncomplete
java.lang.String
The client-side script method to be called before an ajax request is submitted
onsubmit
java.lang.String
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
process
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
reRender
java.lang.Object
If "false", this component is not rendered
rendered
boolean
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
requestDelay
int
If there are any component requests with identical IDs then these requests will be grouped.
similarityGroupingId
java.lang.String
ID (in format of call UIComponent.findComponent()) of Request status component
status
java.lang.String
Timeout (in ms) for request
timeout
int