1.2
2.0
a4j
https://ajax4jsf.dev.java.net/ajax
ajaxListener
org.ajax4jsf.taglib.html.jsp.AjaxListenerTag
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).
type
true
false
Fully qualified Java class name of an AjaxListener to be created and registered.
keepAlive
org.ajax4jsf.taglib.html.jsp.KeepAliveTag
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....}'
beanName
true
false
name of bean for EL-expressions.
ajaxOnly
false
false
if true, bean value restored in ajax requests only.
actionparam
org.ajax4jsf.taglib.ajax.ActionParam
JSP
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 />
noEscape
false
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.
value
false
An initial value or a value binding
converter
false
ID of a converter to be used or a reference to a
converter.
assignTo
false
EL expression for updatable bean property. This property
will be updated if the parent command component performs
an actionEvent.
binding
false
The attribute takes a value-binding expression for a component property of
a backing bean
name
false
A name of this parameter
id
false
Every component may have a unique id that is automatically created if
omitted
commandButton
org.ajax4jsf.taglib.ajax.AjaxCommandButton
JSP
Ajax CommandButton
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.
actionListener
false
MethodBinding pointing at method accepting an ActionEvent with return type void
title
false
Advisory title information about markup elements generated for this component
oncomplete
false
JavaScript code for call after request completed on client side
rendered
false
If "false", this component is rendered.
reRender
false
Id['s] (in format of call UIComopnent.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
onchange
false
HTML: script expression; the element value was changed
dir
false
Alternate textual description of the element rendered by this component
id
false
Every component may have a unique id that is automatically created if
omitted
bypassUpdates
false
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
styleClass
false
Corresponds to the HTML class attribute
accesskey
false
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
limitToList
false
If "true", updates on client side ONLY elements from this 'reRender' property. If "false" (default) updates all rendered by ajax region components.
onkeypress
false
HTML: a script expression; a key is pressed and released
ajaxSingle
false
if true , submits ONLY one field/link, instead of all form controls.
ondblclick
false
HTML: a script expression; a pointer button is double-clicked
image
false
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.
style
false
CSS style(s) is/are to be applied when this component is rendered
size
false
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
onblur
false
HTML: script expression; the element lost the focus
onmouseover
false
HTML: a script expression; a pointer is moved onto
value
false
The current value for this component
action
false
MethodBinding pointing at the application action to be invoked,
if this UIComponent is activated by the user, during the Apply
Request Values or Invoke Application phase of the request
processing lifecycle, depending on the value of the immediate
property
onkeyup
false
HTML: a script expression; a key is released
timeout
false
Timeout ( in ms ) for request.
tabindex
false
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
lang
false
Code describing the language used in the generated markup for this component
type
false
submit|reset|image|button This attribute specifies a type of control to create. The default value for this attribute is "submit"
disabled
false
When set for a form control, this boolean attribute disables the control for user input.
onclick
false
HTML: a script expression; a pointer button is clicked
status
false
ID (in format of call UIComopnent.findComponent()) of Request status component.
onmouseout
false
HTML: a script expression; a pointer is moved away
alt
false
Alternate textual description of the element rendered by this component.
onkeydown
false
HTML: a script expression; a key is pressed down
onmousedown
false
HTML: script expression; a pointer button is pressed down
requestDelay
false
Delay (in ms.) for send ajax request on JavaScript event. In conjunction with events queue can reduce number of requests on keyboard or mouse move events.
eventsQueue
false
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.).
immediate
false
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
data
false
Serialized (on default with JSON) data passed on the client by a developer on AJAX request. It's accessible via this.data
onfocus
false
HTML: script expression; the element got the focus
onmouseup
false
HTML: script expression; a pointer button is released
ignoreDupResponses
false
ignoreDupResponses
binding
false
The attribute takes a value-binding expression for a component property of
a backing bean
onmousemove
false
HTML: a script expression; a pointer is moved within
commandLink
org.ajax4jsf.taglib.ajax.AjaxCommandLink
JSP
Ajax commandLink
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.
actionListener
false
MethodBinding pointing at method accepting an ActionEvent with return type void
title
false
Advisory title information about markup elements generated for this component
oncomplete
false
JavaScript code for call after request completed on client side
shape
false
default|rect|circle|poly [CI]
This attribute specifies the shape of a region. Possible values:
* default: Specifies the entire region.
* rect: Define a rectangular region.
* circle: Define a circular region.
* poly: Define a polygonal region.
target
false
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
rendered
false
If "false", this component is rendered.
charset
false
The character encoding of a resource designated by this hyperlink
reRender
false
Id['s] (in format of call UIComopnent.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
id
false
Every component may have a unique id that is automatically created if
omitted
dir
false
Alternate textual description of the element rendered by this component
rev
false
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
bypassUpdates
false
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
styleClass
false
Corresponds to the HTML class attribute
accesskey
false
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
limitToList
false
If "true", updates on client side ONLY elements from this 'reRender' property. If "false" (default) updates all rendered by ajax region components.
onkeypress
false
HTML: a script expression; a key is pressed and released
ajaxSingle
false
if true , submits ONLY one field/link, instead of all form controls.
ondblclick
false
HTML: a script expression; a pointer button is double-clicked
style
false
CSS style(s) is/are to be applied when this component is rendered
onblur
false
JavaScript code. The onblur event occurs when an element loses focus either by the pointing device or by tabbing navigation. It may be used with the same elements as onfocus
onmouseover
false
HTML: a script expression; a pointer is moved onto
onkeyup
false
HTML: a script expression; a key is released
value
false
The current value for this component
action
false
MethodBinding pointing at the application action to be invoked,
if this UIComponent is activated by the user, during the Apply
Request Values or Invoke Application phase of the request
processing lifecycle, depending on the value of the immediate
property
timeout
false
Timeout ( in ms ) for request.
tabindex
false
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
hreflang
false
Base language of a resource specified with the href attribute; hreflang may only be used with href
type
false
The content type of the resource designated by this hyperlink
lang
false
Code describing the language used in the generated markup for this component
onclick
false
HTML: a script expression; a pointer button is clicked
status
false
ID (in format of call UIComopnent.findComponent()) of Request status component.
onmouseout
false
HTML: a script expression; a pointer is moved away
onkeydown
false
HTML: a script expression; a key is pressed down
onmousedown
false
HTML: script expression; a pointer button is pressed down
requestDelay
false
Delay (in ms.) for send ajax request on JavaScript event. In conjunction with events queue can reduce number of requests on keyboard or mouse move events.
eventsQueue
false
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.).
rel
false
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
immediate
false
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
data
false
Serialized (on default with JSON) data passed on the client by a developer on AJAX request. It's accessible via this.data
onfocus
false
JavaScript code
onmouseup
false
HTML: script expression; a pointer button is released
ignoreDupResponses
false
ignoreDupResponses
binding
false
The attribute takes a value-binding expression for a component property of
a backing bean
onmousemove
false
HTML: a script expression; a pointer is moved within
coords
false
This attribute specifies the position and shape on the screen. The number and order of values depends on the shape being defined. Possible combinations:
* rect: left-x, top-y, right-x, bottom-y.
* circle: center-x, center-y, radius. Note. When the radius value is percentage value, user agents should calculate the final radius value based on the associated object's width and height. The radius should be the smaller value of the two.
* poly: x1, y1, x2, y2, ..., xN, yN. The first x and y coordinate pair and the last should be the same to close the polygon. When these coordinate values are not the same, user agents should infer an additional coordinate pair to close the polygon.
Coordinates are relative to the top, left corner of the object. All values are lengths. All values are separated by commas
form
org.ajax4jsf.taglib.ajax.FormTag
JSP
Ajax-related version of html form
Ajax-related version of html form. Main difference with original component - all hidden fields,
nessesary to command links alwais rendered, not depended of rendering links on initial page.
timeout
false
Timeout ( in ms ) for request.
enctype
false
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"
oncomplete
false
JavaScript code for call after request completed on client side
target
false
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
ajaxSubmit
false
ajaxSubmit
status
false
ID (in format of call UIComopnent.findComponent()) of Request status component.
rendered
false
If "false", this component is rendered.
reRender
false
Id['s] (in format of call UIComopnent.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
id
false
Every component may have a unique id that is automatically created if
omitted
requestDelay
false
Delay (in ms.) for send ajax request on JavaScript event. In conjunction with events queue can reduce number of requests on keyboard or mouse move events.
eventsQueue
false
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.).
bypassUpdates
false
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
limitToList
false
If "true", updates on client side ONLY elements from this 'reRender' property. If "false" (default) updates all rendered by ajax region components.
data
false
Serialized (on default with JSON) data passed on the client by a developer on AJAX request. It's accessible via this.data
ajaxSingle
false
if true , submits ONLY one field/link, instead of all form controls.
acceptCharset
false
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
onreset
false
The onreset event occurs when a form is reset. It only applies to the FORM element
onsubmit
false
The onsubmit event occurs when a form is submitted. It only applies to the FORM element
ignoreDupResponses
false
ignoreDupResponses
binding
false
The attribute takes a value-binding expression for a component property of
a backing bean
accept
false
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 a user to select files to be sent to the server (cf. the INPUT element when type="file")
submitted
false
submitted
htmlCommandLink
org.ajax4jsf.taglib.ajax.HtmlCommandLinkTag
JSP
Ajax-related version of html command link
Ajax-related version of html commandLink. Single difference with original component - all hidden fields,
nessesary to command links alwais rendered, not depended of rendering links on initial page.
actionListener
false
MethodBinding pointing at method accepting an ActionEvent with return type void
title
false
title
shape
false
default|rect|circle|poly [CI]
This attribute specifies the shape of a region. Possible values:
* default: Specifies the entire region.
* rect: Define a rectangular region.
* circle: Define a circular region.
* poly: Define a polygonal region.
target
false
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
charset
false
The character encoding of a resource designated by this hyperlink
rendered
false
If "false", this component is rendered.
id
false
Every component may have a unique id that is automatically created if
omitted
dir
false
dir
rev
false
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
styleClass
false
styleClass
accesskey
false
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
onkeypress
false
onkeypress
ondblclick
false
ondblclick
style
false
style
onmouseover
false
onmouseover
onblur
false
JavaScript code. The onblur event occurs when an element loses focus either by the pointing device or by tabbing navigation. It may be used with the same elements as onfocus
onkeyup
false
onkeyup
value
false
The current value for this component
action
false
MethodBinding pointing at the application action to be invoked,
if this UIComponent is activated by the user, during the Apply
Request Values or Invoke Application phase of the request
processing lifecycle, depending on the value of the immediate
property
tabindex
false
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
hreflang
false
Base language of a resource specified with the href attribute; hreflang may only be used with href
type
false
The content type of the resource designated by this hyperlink
lang
false
lang
onclick
false
onclick
onmouseout
false
onmouseout
onkeydown
false
onkeydown
onmousedown
false
onmousedown
rel
false
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
immediate
false
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
onfocus
false
JavaScript code
onmouseup
false
onmouseup
binding
false
The attribute takes a value-binding expression for a component property of
a backing bean
onmousemove
false
onmousemove
coords
false
This attribute specifies the position and shape on the screen. The number and order of values depends on the shape being defined. Possible combinations:
* rect: left-x, top-y, right-x, bottom-y.
* circle: center-x, center-y, radius. Note. When the radius value is percentage value, user agents should calculate the final radius value based on the associated object's width and height. The radius should be the smaller value of the two.
* poly: x1, y1, x2, y2, ..., xN, yN. The first x and y coordinate pair and the last should be the same to close the polygon. When these coordinate values are not the same, user agents should infer an additional coordinate pair to close the polygon.
Coordinates are relative to the top, left corner of the object. All values are lengths. All values are separated by commas
jsFunction
org.ajax4jsf.taglib.ajax.AjaxFunction
JSP
Ajax Function
actionListener
false
MethodBinding pointing at method accepting an ActionEvent with return type void
action
false
MethodBinding pointing at the application action to be invoked,
if this UIComponent is activated by the user, during the Apply
Request Values or Invoke Application phase of the request
processing lifecycle, depending on the value of the immediate
property
timeout
false
response waiting time on a particular request. If a response is not received during this time, the request is aborted
oncomplete
false
JavaScript code for call after request completed on client side
rendered
false
If "false", this component is rendered.
status
false
ID (in format of call UIComopnent.findComponent()) of Request status component.
reRender
false
Id['s] (in format of call UIComopnent.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
id
false
Every component may have a unique id that is automatically created if
omitted
requestDelay
false
Delay (in ms.) for send ajax request on JavaScript event. In conjunction with events queue can reduce number of requests on keyboard or mouse move events.
eventsQueue
false
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.).
bypassUpdates
false
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
immediate
false
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
limitToList
false
If "true", updates on client side ONLY elements from this 'reRender' property. If "false" (default) updates all rendered by ajax region components.
data
false
Serialized (on default with JSON) data passed on the client by a developer on AJAX request. It's accessible via this.data
ajaxSingle
false
if true , submits ONLY one field/link, instead of all form controls.
ignoreDupResponses
false
If true, unfinished request will be aborted on new event
binding
false
The attribute takes a value-binding expression for a component property of
a backing bean
name
false
Name of generated JavaScript function definition
include
org.ajax4jsf.taglib.ajax.HtmlIncludeTag
JSP
include content of external view
include content of external view. Navigation cases in included file change only viewId of included page,
and don't perform navigation in root view.
layout
false
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.
lang
false
Code describing the language used in the generated markup for this component
title
false
Advisory title information about markup elements generated for this component
ajaxRendered
false
ajaxRendered
rendered
false
If "false", this component is rendered.
id
false
Every component may have a unique id that is automatically created if
omitted
dir
false
Alternate textual description of the element rendered by this component
styleClass
false
Corresponds to the HTML class attribute
keepTransient
false
keepTransient
style
false
CSS style(s) is/are to be applied when this component is rendered
binding
false
The attribute takes a value-binding expression for a component property of
a backing bean
viewId
false
viewId for included page.
loadBundle
org.ajax4jsf.taglib.ajax.LoadBundle
JSP
Ajax-compatible version of f:loadBundle
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
var
false
Name of a request scope attribute under which the
resource bundle will be exposed as a Map.
basename
false
Base name of the resource bundle to be loaded.
rendered
false
If "false", this component is rendered.
binding
false
The attribute takes a value-binding expression for a component property of
a backing bean
id
false
Every component may have a unique id that is automatically created if
omitted
loadScript
org.ajax4jsf.taglib.ajax.LoadScriptTag
JSP
src
true
false
name of JavaScript resource to load.
rendered
false
If "false", this component is rendered.
binding
false
The attribute takes a value-binding expression for a component property of
a backing bean
id
false
Every component may have a unique id that is automatically created if
omitted
loadStyle
org.ajax4jsf.taglib.ajax.LoadStyleTag
JSP
src
true
false
name of JavaScript resource to load.
rendered
false
If "false", this component is rendered.
binding
false
The attribute takes a value-binding expression for a component property of
a backing bean
id
false
Every component may have a unique id that is automatically created if
omitted
log
org.ajax4jsf.taglib.ajax.LogTag
JSP
pop-up window with request log
Encode javaScript to open popup window with client-side Log information.
level
false
log level, possible values :
FATAL,ERROR,WARN,INFO,DEBUG,ALL.
Component set level 'ALL' by default.
width
false
width of pop-up.
popup
false
Render log as popup-window or as div element in page
height
false
height of pop-up
hotkey
false
Keyboard key for activate ( in combination with
CTRL+SHIFT ) log window.
rendered
false
If "false", this component is rendered.
binding
false
The attribute takes a value-binding expression for a component property of
a backing bean
name
false
name of pop-up window
id
false
Every component may have a unique id that is automatically created if
omitted
mediaOutput
org.ajax4jsf.taglib.ajax.MediaOutputTag
JSP
Link to user-generated resource
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.
declare
false
declare but don't instantiate flag
dir
false
Alternate textual description of the element rendered by this component
id
false
Every component may have a unique id that is automatically created if
omitted
rev
false
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
mimeType
false
Geterated content mime-type for append to response
header ( 'image/jpeg' etc )
style
false
CSS style(s) is/are to be applied when this component is rendered
onmouseover
false
HTML: a script expression; a pointer is moved onto
onkeyup
false
HTML: a script expression; a key is released
tabindex
false
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
archive
false
space-separated list of URIs
converter
false
converter
lang
false
Code describing the language used in the generated markup for this component
createContent
false
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 )
onmouseout
false
HTML: a script expression; a pointer is moved away
element
false
Name of html element for resource link - may be <a> <img> <object> <applet> <script> or <link>
rel
false
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
onmouseup
false
HTML: script expression; a pointer button is released
cacheable
false
cacheable
binding
false
The attribute takes a value-binding expression for a component property of
a backing bean
onmousemove
false
HTML: a script expression; a pointer is moved within
expires
false
expires
coords
false
This attribute specifies the position and shape on the screen. The number and order of values depends on the shape being defined. Possible combinations:
* rect: left-x, top-y, right-x, bottom-y.
* circle: center-x, center-y, radius. Note. When the radius value is percentage value, user agents should calculate the final radius value based on the associated object's width and height. The radius should be the smaller value of the two.
* poly: x1, y1, x2, y2, ..., xN, yN. The first x and y coordinate pair and the last should be the same to close the polygon. When these coordinate values are not the same, user agents should infer an additional coordinate pair to close the polygon.
Coordinates are relative to the top, left corner of the object. All values are lengths. All values are separated by commas
title
false
Advisory title information about markup elements generated for this component
shape
false
default|rect|circle|poly [CI]
This attribute specifies the shape of a region. Possible values:
* default: Specifies the entire region.
* rect: Define a rectangular region.
* circle: Define a circular region.
* poly: Define a polygonal region.
target
false
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
session
false
session
charset
false
The character encoding of a resource designated by this hyperlink
rendered
false
If "false", this component is rendered.
codetype
false
content type for code
classid
false
identifies an implementation
styleClass
false
Corresponds to the HTML class attribute
accesskey
false
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
onkeypress
false
HTML: a script expression; a key is pressed and released
ondblclick
false
HTML: a script expression; a pointer button is double-clicked
align
false
bottom|middle|top|left|right
Deprecated. This attribute specifies the position of an IMG, OBJECT, or APPLET with respect to its context.
The following values for align concern the object's position with respect to surrounding text:
* bottom: means that the bottom of the object should be vertically aligned with the current baseline. This is the default value.
* middle: means that the center of the object should be vertically aligned with the current baseline.
* top: means that the top of the object should be vertically aligned with the top of the current text line
vspace
false
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
lastModified
false
lastModified
usemap
false
use client-side image map
standby
false
message to show while loading
border
false
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
onblur
false
JavaScript code. The onblur event occurs when an element loses focus either by the pointing device or by tabbing navigation. It may be used with the same elements as onfocus
value
false
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.
hreflang
false
Base language of a resource specified with the href attribute; hreflang may only be used with href
codebase
false
base URI for classid, data, archive
type
false
The content type of the resource designated by this hyperlink
uriAttribute
false
Name of attribute for resource-link attribute ( 'href' for <a>, 'src' for <img> or <script>, etc
onclick
false
HTML: a script expression; a pointer button is clicked
ismap
false
use server-side image map
onkeydown
false
HTML: a script expression; a key is pressed down
onmousedown
false
HTML: script expression; a pointer button is pressed down
hspace
false
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
onfocus
false
JavaScript code
outputPanel
org.ajax4jsf.taglib.ajax.AjaxOutputPanel
JSP
Ajax OutputPanel
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.
onkeyup
false
HTML: a script expression; a key is released
layout
false
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.
lang
false
Code describing the language used in the generated markup for this component
title
false
Advisory title information about markup elements generated for this component
ajaxRendered
false
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 Ajax action. default false
onclick
false
HTML: a script expression; a pointer button is clicked
rendered
false
If "false", this component is rendered.
onmouseout
false
HTML: a script expression; a pointer is moved away
onkeydown
false
HTML: a script expression; a key is pressed down
onmousedown
false
HTML: script expression; a pointer button is pressed down
id
false
Every component may have a unique id that is automatically created if
omitted
dir
false
Alternate textual description of the element rendered by this component
styleClass
false
Corresponds to the HTML class attribute
keepTransient
false
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 ).
onkeypress
false
HTML: a script expression; a key is pressed and released
ondblclick
false
HTML: a script expression; a pointer button is double-clicked
onmouseup
false
HTML: script expression; a pointer button is released
style
false
CSS style(s) is/are to be applied when this component is rendered
binding
false
The attribute takes a value-binding expression for a component property of
a backing bean
onmousemove
false
HTML: a script expression; a pointer is moved within
onmouseover
false
HTML: a script expression; a pointer is moved onto
page
org.ajax4jsf.taglib.ajax.AjaxPage
JSP
Ajax Page
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>
namespace
false
Set html element default namespace
selfRendered
false
if 'true' , self-render subtree at InvokeApplication ( or Decode, if immediate property set to true ) phase
lang
false
Code describing the language used in the generated markup for this component
title
false
Advisory title information about markup elements generated for this component
onunload
false
JavaScript code to execute on a page unload.
rendered
false
If "false", this component is rendered.
contentType
false
Set custom mime content type to response
id
false
Every component may have a unique id that is automatically created if
omitted
dir
false
Alternate textual description of the element rendered by this component
styleClass
false
Corresponds to the HTML class attribute
immediate
false
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.
onload
false
JavaScript code to execute on a page load.
pageTitle
false
String for output as a page title.
style
false
CSS style(s) is/are to be applied when this component is rendered
binding
false
The attribute takes a value-binding expression for a component property of
a backing bean
ajaxListener
false
MethodBinding 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.
format
false
Page layout format ( html, xhtml, html-transitional, html-3.2 ) for encoding DOCTYPE, namespace and Content-Type definitions
poll
org.ajax4jsf.taglib.ajax.AjaxPollTag
JSP
Ajax Poll
Periodically perform AJAX request to server, to simulate
'poll' data.
actionListener
false
MethodBinding pointing at method accepting an ActionEvent with return type void
action
false
MethodBinding pointing at the application action to be invoked,
if this UIComponent is activated by the user, during the Apply
Request Values or Invoke Application phase of the request
processing lifecycle, depending on the value of the immediate
property
timeout
false
Timeout (in ms) for request
oncomplete
false
JavaScript code for call after request completed on client side
rendered
false
If "false", this component is rendered.
status
false
ID (in format of call UIComopnent.findComponent()) of Request status component.
reRender
false
Id['s] (in format of call UIComopnent.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
interval
false
Interval (in ms) for call poll requests. Default value
1000 (1 sec)
id
false
Every component may have a unique id that is automatically created if
omitted
eventsQueue
false
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.).
bypassUpdates
false
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
enabled
false
Enable/disable polling
immediate
false
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
limitToList
false
If "true", updates on client side ONLY elements from this 'reRender' property. If "false" (default) updates all rendered by ajax region components.
data
false
Serialized (on default with JSON) data passed on the client by a developer on AJAX request. It's accessible via this.data
ajaxSingle
false
if true , submits ONLY one field/link, instead of all form controls.
onsubmit
false
JavaScript code for call before submission of ajax
event
ignoreDupResponses
false
ignoreDupResponses
binding
false
The attribute takes a value-binding expression for a component property of
a backing bean
region
org.ajax4jsf.taglib.ajax.AjaxRegion
JSP
Ajax Region
This tag defines a part of the JSF Tree that is to be decoded on the
server side during AJAX request processing
selfRendered
false
if 'true' , self-render subtree at InvokeApplication ( or Decode, if immediate property set to true ) phase
renderRegionOnly
false
Flag to disable rendering in AJAX responses content
outside of active region. If this attribute set to
"true" , no one of the components outside of region will
be included to AJAX response. If set to "false", search
for components to include in response will be performed
on all tree. Default "true"
immediate
false
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.
rendered
false
If "false", this component is rendered.
binding
false
The attribute takes a value-binding expression for a component property of
a backing bean
ajaxListener
false
MethodBinding 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.
id
false
Every component may have a unique id that is automatically created if
omitted
repeat
org.ajax4jsf.taglib.ajax.AjaxRepeat
JSP
Ajax-enabled repeater
var
false
A request-scope attribute under which the data object for the
current row is exposed when iterating
varState
false
varState
value
false
value
rows
false
A number of rows to display, or zero for all remaining
rows in the table
first
false
A zero-relative row number of the first row to display
componentState
false
componentState
rendered
false
rendered
id
false
id
ajaxKeys
false
ajaxKeys
rowKey
false
rowKey
binding
false
binding
status
org.ajax4jsf.taglib.ajax.AjaxStatus
JSP
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.
startStyleClass
false
CSS style class for the element displayed on the start
of a request.
stopStyle
false
CSS style for element displayed on request completion.
stopStyleClass
false
CSS style class for element displayed on request
layout
false
Define visual layout of panel, can be "block" or
"inline".
title
false
Advisory title information about markup elements generated for this component
onstart
false
JavaScript code, called on the start
of a request.
rendered
false
If "false", this component is rendered.
id
false
Every component may have a unique id that is automatically created if
omitted
dir
false
Alternate textual description of the element rendered by this component
styleClass
false
Corresponds to the HTML class attribute
startStyle
false
CSS style class for the element displayed on the start
of a request.
onkeypress
false
HTML: a script expression; a key is pressed and released
ondblclick
false
HTML: a script expression; a pointer button is double-clicked
style
false
CSS style(s) is/are to be applied when this component is rendered
onmouseover
false
HTML: a script expression; a pointer is moved onto
for
false
ID of the AjaxContainer component whose status is
indicated (in the format of a
javax.faces.UIComopnent.findComponent() call).
onkeyup
false
HTML: a script expression; a key is released
lang
false
Code describing the language used in the generated markup for this component
onclick
false
HTML: a script expression; a pointer button is clicked
onmouseout
false
HTML: a script expression; a pointer is moved away
startText
false
Text for display on starting request.
onkeydown
false
HTML: a script expression; a key is pressed down
onmousedown
false
HTML: script expression; a pointer button is pressed down
forceId
false
If true, render the ID of the component in HTML code
without JSF modifications.
stopText
false
Text for display on request complete.
onstop
false
JavaScript code, called on the stop
of a request.
onmouseup
false
HTML: script expression; a pointer button is released
binding
false
The attribute takes a value-binding expression for a component property of
a backing bean
onmousemove
false
HTML: a script expression; a pointer is moved within
support
org.ajax4jsf.taglib.ajax.AjaxSupport
JSP
Ajax Support
Adds the AJAX functionality for those UIComponent-based
componenent 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.
actionListener
false
MethodBinding pointing at method accepting an ActionEvent with return type void
oncomplete
false
JavaScript code for call after request completed on client side
rendered
false
If "false", this component is rendered.
reRender
false
Id['s] (in format of call UIComopnent.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
id
false
Every component may have a unique id that is automatically created if
omitted
disableDefault
false
Disable default action for target event ( append "return false;" to javascript )
bypassUpdates
false
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
limitToList
false
If "true", updates on client side ONLY elements from this 'reRender' property. If "false" (default) updates all rendered by ajax region components.
ajaxSingle
false
if true , submits ONLY one field/link, instead of all form controls.
onsubmit
false
JavaScript code for call before submission of ajax
event
parentProperties
false
parentProperties
action
false
MethodBinding pointing at the application action to be invoked,
if this UIComponent is activated by the user, during the Apply
Request Values or Invoke Application phase of the request
processing lifecycle, depending on the value of the immediate
property
timeout
false
Timeout (in ms) for request
status
false
ID (in format of call UIComopnent.findComponent()) of Request status component.
requestDelay
false
Delay (in ms.) for send ajax request on JavaScript event. In conjunction with events queue can reduce number of requests on keyboard or mouse move events.
eventsQueue
false
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.).
immediate
false
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
data
false
Serialized (on default with JSON) data passed on the client by a developer on AJAX request. It's accessible via this.data
event
false
Name of JavaScript event property ( onclick, onchange,
etc.) of parent component, for which we will build AJAX
submission code
binding
false
The attribute takes a value-binding expression for a component property of
a backing bean
ignoreDupResponses
false
If true, unfinished request will be aborted on new event