META-INF.a4j.taglib.xml Maven / Gradle / Ivy
http://richfaces.org/a4j
commandButton
<p> The <a4j:commandButton> component is similar to the JavaServer Faces (JSF) <h:commandButton> component, but additionally includes Ajax support. </p> @author Nick Belaevski
org.richfaces.CommandButton
org.richfaces.CommandButtonRenderer
<p> The <a4j:commandButton> component is similar to the JavaServer Faces (JSF) <h:commandButton> component, but additionally includes Ajax support. </p> @author Nick Belaevski
Access key that, when pressed, transfers focus to this element.
accesskey
java.lang.String
MethodExpression representing the application action to invoke when this component is activated by the user. The expression must evaluate to a public method that takes no parameters, and returns an Object (the toString() of which is called to derive the logical outcome) which is passed to the NavigationHandler for this application.
Application Action
action
javax.faces.el.MethodBinding
<p> MethodExpression representing an action listener method that will be notified when this component is activated by the user. The expression must evaluate to a public method that takes an ActionEvent parameter, with a return type of void, <span class="changed_added_2_0">or to a public method that takes no arguments with a return type of void. In the latter case, the method has no way of easily knowing where the event came from, but this can be useful in cases where a notification is needed that "some action happened".</span> </p>
Action Listener
actionListener
javax.faces.el.MethodBinding
The value binding expression used to wire up this component to a component property of a JavaBean class
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 to the client by a developer on an AJAX request. It's accessible via "event.data" syntax. Both primitive types and complex types such as arrays and collections can be serialized and used with data
data
java.lang.Object
Flag indicating that this element must never receive focus or be included in a subsequent submit. Default value - "false"
Disabled Flag
disabled
boolean
Ids of components that will participate in the "execute" portion of the Request Processing Lifecycle. Can be a single id, a space or comma separated list of Id's, or an EL Expression evaluating to an array or Collection. Any of the keywords "@this", "@form", "@all", "@none", "@region" may be specified in the identifier list. Some components make use of additional keywords
execute
java.lang.Object
The component identifier for this component. This value must be unique within the closest parent component that is a naming container.
Component Identifier
id
java.lang.String
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
Flag indicating that, if this component is activated by the user, notifications should be delivered to interested listeners and actions immediately (that is, during Apply Request Values phase) rather than waiting until Invoke Application phase.
Immediate Action
immediate
boolean
If "true", render only those ids specified in the "render" attribute, forgoing the render of the auto-rendered panels
limitRender
boolean
The client-side script method to be called after the ajax response comes back, but before the DOM is updated
onbeforedomupdate
java.lang.String
The client-side script method to be called before an ajax request.
onbegin
java.lang.String
Javascript code executed when a pointer button is clicked over this element.
Button Click Script
onclick
java.lang.String
The client-side script method to be called after the DOM is updated
oncomplete
java.lang.String
Javascript code executed when a pointer button is double clicked over this element.
Double Click Script
ondblclick
java.lang.String
Javascript code executed when a key is pressed down over this element.
Key Down Script
onkeydown
java.lang.String
Javascript code executed when a key is pressed and released over this element.
Key Press Script
onkeypress
java.lang.String
Javascript code executed when a key is released over this element.
Key Up Script
onkeyup
java.lang.String
Javascript code executed when a pointer button is pressed down over this element.
Mouse Down Script
onmousedown
java.lang.String
Javascript code executed when a pointer button is moved within this element.
Mouse Move Script
onmousemove
java.lang.String
Javascript code executed when a pointer button is moved away from this element.
Mouse Out Script
onmouseout
java.lang.String
Javascript code executed when a pointer button is moved onto this element.
Mouse Over Script
onmouseover
java.lang.String
Javascript code executed when a pointer button is released over this element.
Mouse Up Script
onmouseup
java.lang.String
Ids of components that will participate in the "render" portion of the Request Processing Lifecycle. Can be a single id, a space or comma separated list of Id's, or an EL Expression evaluating to an array or Collection. Any of the keywords "@this", "@form", "@all", "@none", "@region" may be specified in the identifier list. Some components make use of additional keywords
render
java.lang.Object
Flag indicating whether or not this component should be rendered (during Render Response Phase), or processed on any subsequent form submit. The default value for this property is true.
Rendered Flag
rendered
boolean
If true, indicate that this particular Ajax transaction is a value reset transaction. This will cause resetValue() to be called on any EditableValueHolder instances encountered as a result of this ajax transaction. If not specified, or the value is false, no such indication is made.
resetValues
boolean
Name of the request status component that will indicate the status of the Ajax request
status
java.lang.String
CSS style(s) to be applied when this component is rendered.
CSS Styles
style
java.lang.String
Space-separated list of CSS style class(es) to be applied when this element is rendered. This value must be passed through as the "class" attribute on generated markup.
CSS Style Classes
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
Advisory title information about markup elements generated for this component.
Advisory Title
title
java.lang.String
Type of button to create. Can be one of "submit", "button", "image" and "reset". If not specified, the default value is "submit".
Button Type
type
java.lang.String
The current value of this component.
Value
value
java.lang.Object
attachQueue
<p> The <a4j:attachQueue> behavior is used together with a <a4j:queue> component to further customize queuing for particular components and behaviors. The <a4j:attachQueue> behavior can override the scope-wide queue settings for an individual component, or attach specific requests to a queue. </p> @author Nick Belaevski
org.richfaces.AttachQueue
org.richfaces.AttachQueueRenderer
org.richfaces.view.facelets.html.AttachQueueHandler
<p> The <a4j:attachQueue> behavior is used together with a <a4j:queue> component to further customize queuing for particular components and behaviors. The <a4j:attachQueue> behavior can override the scope-wide queue settings for an individual component, or attach specific requests to a queue. </p> @author Nick Belaevski
The value binding expression used to wire up this component to a component property of a JavaBean class
binding
javax.faces.component.UIComponent
The component identifier for this component. This value must be unique within the closest parent component that is a naming container.
Component Identifier
id
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
Identify the name of the destination queue
name
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
Flag indicating whether or not this component should be rendered (during Render Response Phase), or processed on any subsequent form submit. The default value for this property is true.
Rendered Flag
rendered
boolean
Attribute defines the time (in ms) the request will be waiting in the queue before it is ready to be sent.
requestDelay
int
Specify the groupingId to process multiple requests together. Requests from multiple <a4j:attachQueue> behaviors can use the same identifier to group requests together
requestGroupingId
java.lang.String
mediaOutput
<p> The <a4j:mediaOutput> component is used for generating images, video, sounds, and other resources defined on the fly. </p> @author shura
org.richfaces.MediaOutput
org.richfaces.MediaOutputRenderer
org.richfaces.view.facelets.html.MediaOutputHandler
<p> The <a4j:mediaOutput> component is used for generating images, video, sounds, and other resources defined on the fly. </p> @author shura
Access key that, when pressed, transfers focus to this element.
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 value binding expression used to wire up this component to a component property of a JavaBean class
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 the resource designated by this hyperlink.
Character Set
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
Converter instance registered with this component.
Converter
converter
javax.faces.convert.Converter
<p> 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". </p> <p> Notes: <ol> <li>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;</li> <li>the radius value should be smaller than center-x and center-y values;</li> <li>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).</li> </ol> Coordinates are relative to the top left corner of an object. All values are lengths. All values are comma separated. </p>
Coordinates
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
javax.el.MethodExpression
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).
Direction
dir
java.lang.String
Flag indicating that this element must never receive focus or be included in a subsequent submit. Default value - "false"
Disabled Flag
disabled
boolean
Get the Element name for rendering ( img , a , object, applet ).
element
java.lang.String
The attribute allows to manage caching and defines the period after which a resource is reloaded.
expires
java.util.Date
Filename of the resource to be served
fileName
java.lang.String
The language code of the resource designated by this hyperlink.
Language
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
The component identifier for this component. This value must be unique within the closest parent component that is a naming container.
Component Identifier
id
java.lang.String
Use server-side image map
ismap
boolean
Code describing the language used in the generated markup for this component.
Language Code
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
Javascript code executed when this element loses focus.
Focus Off Script
onblur
java.lang.String
Javascript code executed when a pointer button is clicked over this element.
Button Click Script
onclick
java.lang.String
Javascript code executed when a pointer button is double clicked over this element.
Double Click Script
ondblclick
java.lang.String
Javascript code executed when this element receives focus.
Focus On Script
onfocus
java.lang.String
Javascript code executed when a key is pressed down over this element.
Key Down Script
onkeydown
java.lang.String
Javascript code executed when a key is pressed and released over this element.
Key Press Script
onkeypress
java.lang.String
Javascript code executed when a key is released over this element.
Key Up Script
onkeyup
java.lang.String
Javascript code executed when a pointer button is pressed down over this element.
Mouse Down Script
onmousedown
java.lang.String
Javascript code executed when a pointer button is moved within this element.
Mouse Move Script
onmousemove
java.lang.String
Javascript code executed when a pointer button is moved away from this element.
Mouse Out Script
onmouseout
java.lang.String
Javascript code executed when a pointer button is moved onto this element.
Mouse Over Script
onmouseover
java.lang.String
Javascript code executed when a pointer button is released over this element.
Mouse Up Script
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.
Relationship
rel
java.lang.String
Flag indicating whether or not this component should be rendered (during Render Response Phase), or processed on any subsequent form submit. The default value for this property is true.
Rendered Flag
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.
Reverse Link
rev
java.lang.String
The shape of the hot spot on the screen (for use in client-side image maps). Valid values are: default (entire region); rect (rectangular region); circle (circular region); and poly (polygonal region).
Shape
shape
java.lang.String
Message to show while loading
standby
java.lang.String
CSS style(s) to be applied when this component is rendered.
CSS Styles
style
java.lang.String
Space-separated list of CSS style class(es) to be applied when this element is rendered. This value must be passed through as the "class" attribute on generated markup.
CSS Style Classes
styleClass
java.lang.String
Position of this element in the tabbing order for the current document. This value must be an integer between 0 and 32767.
Tab Index
tabindex
java.lang.String
Name of a frame where the resource retrieved via this hyperlink is to be displayed.
Target Frame
target
java.lang.String
Advisory title information about markup elements generated for this component.
Advisory Title
title
java.lang.String
The content type of the resource designated by this hyperlink.
Content Type
type
java.lang.String
Get URI attribute for resource ( src for images, href for links etc ).
uriAttribute
java.lang.String
Specifies an image as a client-side image-map
usemap
java.lang.String
<p> 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). </p> <p> IMPORTANT: Since serialized data stored in URI, avoid using big objects. </p>
Value
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
param
<p> The <a4j:param> behavior combines the functionality of the JavaServer Faces (JSF) components <f:param> and <f:actionListener>. </p> @author shura, alexsmirnov
org.richfaces.Parameter
org.richfaces.view.facelets.html.ParameterHandler
<p> The <a4j:param> behavior combines the functionality of the JavaServer Faces (JSF) components <f:param> and <f:actionListener>. </p> @author shura, alexsmirnov
EL expression for updatable bean property. This property will be updated if the parent command component performs an actionEvent.
assignTo
java.lang.Object
The value binding expression used to wire up this component to a component property of a JavaBean class
binding
javax.faces.component.UIComponent
The converter attribute can be used to specify how to convert the value before it is submitted to the data model.
converter
javax.faces.convert.Converter
The component identifier for this component. This value must be unique within the closest parent component that is a naming container.
Component Identifier
id
java.lang.String
Name of the parameter associated with this component.
Property Name
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
Flag indicating whether or not this component should be rendered (during Render Response Phase), or processed on any subsequent form submit. The default value for this property is true.
Rendered Flag
rendered
boolean
Value of the parameter associated with this component.
Property Value
value
java.lang.Object
status
<p> The <a4j:status> component displays the status of current Ajax requests. The status can be either in progress, complete, or an error is shown after a failed request. </p> @author Nick Belaevski
org.richfaces.Status
org.richfaces.StatusRenderer
<p> The <a4j:status> component displays the status of current Ajax requests. The status can be either in progress, complete, or an error is shown after a failed request. </p> @author Nick Belaevski
The value binding expression used to wire up this component to a component property of a JavaBean class
binding
javax.faces.component.UIComponent
The css style attribute for the error text
errorStyle
java.lang.String
The css class attribute used to style the error text
errorStyleClass
java.lang.String
The text shown when an error has occurred
errorText
java.lang.String
The component identifier for this component. This value must be unique within the closest parent component that is a naming container.
Component Identifier
id
java.lang.String
The name of the status component
name
java.lang.String
The client-side script method to be called when the request results in an error
onerror
java.lang.String
The client-side script method to be called when the request starts
onstart
java.lang.String
The client-side script method to be called when the request stops
onstop
java.lang.String
The client-side script method to be called when the request completes successfully
onsuccess
java.lang.String
Flag indicating whether or not this component should be rendered (during Render Response Phase), or processed on any subsequent form submit. The default value for this property is true.
Rendered Flag
rendered
boolean
The css style attribute for the start text
startStyle
java.lang.String
The css class attribute used to style the start text
startStyleClass
java.lang.String
The text shown after the request has been started and is currently in progress
startText
java.lang.String
The css style attribute for the stop text
stopStyle
java.lang.String
The css class attribute used to style the stop text
stopStyleClass
java.lang.String
The text shown once the request is complete
stopText
java.lang.String
repeat
<p> The non-visual <a4j:repeat> component is used to iterate through a data model. The component renders child content for every iteration according to the current object data. </p> @author Nick Belaevski
org.richfaces.Repeat
org.richfaces.RepeatRenderer
org.richfaces.view.facelets.html.RepeatHandler
<p> The non-visual <a4j:repeat> component is used to iterate through a data model. The component renders child content for every iteration according to the current object data. </p> @author Nick Belaevski
The value binding expression used to wire up this component to a component property of a JavaBean class
binding
javax.faces.component.UIComponent
A zero-relative row number of the first row to display
first
int
The component identifier for this component. This value must be unique within the closest parent component that is a naming container.
Component Identifier
id
java.lang.String
Provides access to the iteration status in a Request scope
iterationStatusVar
java.lang.String
Boolean attribute that defines whether this iteration component will reset saved children's state before rendering. By default state is reset if there are no faces messages with severity error or higher.
keepSaved
boolean
Flag indicating whether or not this component should be rendered (during Render Response Phase), or processed on any subsequent form submit. The default value for this property is true.
Rendered Flag
rendered
boolean
Converter for a row key object
rowKeyConverter
javax.faces.convert.Converter
Provides access to the row key in a Request scope
rowKeyVar
java.lang.String
The 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
java.lang.String
Points to the data model
value
java.lang.Object
A request-scope attribute via which the data object for the current row will be used when iterating
var
java.lang.String
push
<p> The <a4j:push> component performs real-time updates on the client side from events triggered at the server side. The events are pushed out to the client through the RichFaces messaging queue (which is bound to Java Messaging Service - JMS). When the <a4j:push> component is triggered by a server event, it can in turn cause Ajax updates and changes. </p> @author Nick Belaevski @author Lukas Fryc
org.richfaces.Push
org.richfaces.PushRenderer
<p> The <a4j:push> component performs real-time updates on the client side from events triggered at the server side. The events are pushed out to the client through the RichFaces messaging queue (which is bound to Java Messaging Service - JMS). When the <a4j:push> component is triggered by a server event, it can in turn cause Ajax updates and changes. </p> @author Nick Belaevski @author Lukas Fryc
References the topic on the JMS server that contains the pushed messages
address
true
java.lang.String
The value binding expression used to wire up this component to a component property of a JavaBean class
binding
javax.faces.component.UIComponent
The component identifier for this component. This value must be unique within the closest parent component that is a naming container.
Component Identifier
id
java.lang.String
The client-side script method to be called when a push notification is received
ondataavailable
java.lang.String
The client-side script method to be called when an error has occurred with the push notifications
onerror
java.lang.String
The client-side script method to be called when push is subscribed successfully to the topic.
onsubscribed
java.lang.String
Flag indicating whether or not this component should be rendered (during Render Response Phase), or processed on any subsequent form submit. The default value for this property is true.
Rendered Flag
rendered
boolean
region
<p> The <a4j:region> component specifies a part of the JSF component tree to be processed on the server. The region causes all the a4j and rich Ajax controls to execute: decoding, validating, and updating the model. The region causes these components to execute even if not explicitly declared. As such, processing areas can more easily be marked using a declarative approach. </p> <p> Regions can be nested, in which case only the parent region of the component initiating the request will be processed. </p> @author Nick Belaevski
org.richfaces.Region
<p> The <a4j:region> component specifies a part of the JSF component tree to be processed on the server. The region causes all the a4j and rich Ajax controls to execute: decoding, validating, and updating the model. The region causes these components to execute even if not explicitly declared. As such, processing areas can more easily be marked using a declarative approach. </p> <p> Regions can be nested, in which case only the parent region of the component initiating the request will be processed. </p> @author Nick Belaevski
The value binding expression used to wire up this component to a component property of a JavaBean class
binding
javax.faces.component.UIComponent
The component identifier for this component. This value must be unique within the closest parent component that is a naming container.
Component Identifier
id
java.lang.String
Flag indicating whether or not this component should be rendered (during Render Response Phase), or processed on any subsequent form submit. The default value for this property is true.
Rendered Flag
rendered
boolean
queue
<p> The <a4j:queue> component manages the JSF queue of Ajax requests. It provides additional options for a finer control of request processing. </p> @author Nick Belaevski
org.richfaces.Queue
org.richfaces.QueueRenderer
<p> The <a4j:queue> component manages the JSF queue of Ajax requests. It provides additional options for a finer control of request processing. </p> @author Nick Belaevski
The value binding expression used to wire up this component to a component property of a JavaBean class
binding
javax.faces.component.UIComponent
The component identifier for this component. This value must be unique within the closest parent component that is a naming container.
Component Identifier
id
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 the name for the queue, allowing it to be referenced via the name attribute of the attachQueue component
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 when an error has occurred during Ajax communications
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 before an ajax request is submitted
onsubmit
java.lang.String
Flag indicating whether or not this component should be rendered (during Render Response Phase), or processed on any subsequent form submit. The default value for this property is true.
Rendered Flag
rendered
boolean
Attribute defines the time (in ms) the request will be waiting in the queue before it is ready to be sent.
requestDelay
int
outputPanel
<p> The <a4j:outputPanel> component is used to group together components in to update them as a whole, rather than having to specify the components individually. <p> @author [email protected]
org.richfaces.OutputPanel
org.richfaces.OutputPanelRenderer
<p> The <a4j:outputPanel> component is used to group together components in to update them as a whole, rather than having to specify the components individually. <p> @author [email protected]
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 - "true"
ajaxRendered
boolean
The value binding expression used to wire up this component to a component property of a JavaBean class
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).
Direction
dir
java.lang.String
The component identifier for this component. This value must be unique within the closest parent component that is a naming container.
Component Identifier
id
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 ).
keepTransient
boolean
Code describing the language used in the generated markup for this component.
Language Code
lang
java.lang.String
HTML layout for generated markup. Possible values: "block" for generating an HTML <div> element and "inline" for generating an HTML <span> element. Default value is "inline"
layout
org.richfaces.component.OutputPanelLayout
Javascript code executed when a pointer button is clicked over this element.
Button Click Script
onclick
java.lang.String
Javascript code executed when a pointer button is double clicked over this element.
Double Click Script
ondblclick
java.lang.String
Javascript code executed when a key is pressed down over this element.
Key Down Script
onkeydown
java.lang.String
Javascript code executed when a key is pressed and released over this element.
Key Press Script
onkeypress
java.lang.String
Javascript code executed when a key is released over this element.
Key Up Script
onkeyup
java.lang.String
Javascript code executed when a pointer button is pressed down over this element.
Mouse Down Script
onmousedown
java.lang.String
Javascript code executed when a pointer button is moved within this element.
Mouse Move Script
onmousemove
java.lang.String
Javascript code executed when a pointer button is moved away from this element.
Mouse Out Script
onmouseout
java.lang.String
Javascript code executed when a pointer button is moved onto this element.
Mouse Over Script
onmouseover
java.lang.String
Javascript code executed when a pointer button is released over this element.
Mouse Up Script
onmouseup
java.lang.String
Flag indicating whether or not this component should be rendered (during Render Response Phase), or processed on any subsequent form submit. The default value for this property is true.
Rendered Flag
rendered
boolean
CSS style(s) to be applied when this component is rendered.
CSS Styles
style
java.lang.String
Space-separated list of CSS style class(es) to be applied when this element is rendered. This value must be passed through as the "class" attribute on generated markup.
CSS Style Classes
styleClass
java.lang.String
Advisory title information about markup elements generated for this component.
Advisory Title
title
java.lang.String
jsFunction
<p> The <a4j:jsFunction> component performs Ajax requests directly from JavaScript code and retrieves server-side data. The server-side data is returned in JavaScript Object Notation (JSON) format prior to the execution of any JavaScript code defined using the "oncomplete" attribute. </p> @author [email protected]
org.richfaces.Function
org.richfaces.FunctionRenderer
<p> The <a4j:jsFunction> component performs Ajax requests directly from JavaScript code and retrieves server-side data. The server-side data is returned in JavaScript Object Notation (JSON) format prior to the execution of any JavaScript code defined using the "oncomplete" attribute. </p> @author [email protected]
MethodExpression representing the application action to invoke when this component is activated by the user. The expression must evaluate to a public method that takes no parameters, and returns an Object (the toString() of which is called to derive the logical outcome) which is passed to the NavigationHandler for this application.
Application Action
action
javax.faces.el.MethodBinding
<p> MethodExpression representing an action listener method that will be notified when this component is activated by the user. The expression must evaluate to a public method that takes an ActionEvent parameter, with a return type of void, <span class="changed_added_2_0">or to a public method that takes no arguments with a return type of void. In the latter case, the method has no way of easily knowing where the event came from, but this can be useful in cases where a notification is needed that "some action happened".</span> </p>
Action Listener
actionListener
javax.faces.el.MethodBinding
The value binding expression used to wire up this component to a component property of a JavaBean class
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 to the client by a developer on an AJAX request. It's accessible via "event.data" syntax. Both primitive types and complex types such as arrays and collections can be serialized and used with data
data
java.lang.Object
Ids of components that will participate in the "execute" portion of the Request Processing Lifecycle. Can be a single id, a space or comma separated list of Id's, or an EL Expression evaluating to an array or Collection. Any of the keywords "@this", "@form", "@all", "@none", "@region" may be specified in the identifier list. Some components make use of additional keywords
execute
java.lang.Object
The component identifier for this component. This value must be unique within the closest parent component that is a naming container.
Component Identifier
id
java.lang.String
Flag indicating that, if this component is activated by the user, notifications should be delivered to interested listeners and actions immediately (that is, during Apply Request Values phase) rather than waiting until Invoke Application phase.
Immediate Action
immediate
boolean
If "true", render only those ids specified in the "render" attribute, forgoing the render of the auto-rendered panels
limitRender
boolean
The name of the generated javascript function
name
true
java.lang.String
The client-side script method to be called after the ajax response comes back, but before the DOM is updated
onbeforedomupdate
java.lang.String
The client-side script method to be called before an ajax request.
onbegin
java.lang.String
The client-side script method to be called after the DOM is updated
oncomplete
java.lang.String
Ids of components that will participate in the "render" portion of the Request Processing Lifecycle. Can be a single id, a space or comma separated list of Id's, or an EL Expression evaluating to an array or Collection. Any of the keywords "@this", "@form", "@all", "@none", "@region" may be specified in the identifier list. Some components make use of additional keywords
render
java.lang.Object
Flag indicating whether or not this component should be rendered (during Render Response Phase), or processed on any subsequent form submit. The default value for this property is true.
Rendered Flag
rendered
boolean
If true, indicate that this particular Ajax transaction is a value reset transaction. This will cause resetValue() to be called on any EditableValueHolder instances encountered as a result of this ajax transaction. If not specified, or the value is false, no such indication is made.
resetValues
boolean
Name of the request status component that will indicate the status of the Ajax request
status
java.lang.String
The current value of this component.
Value
value
java.lang.Object
log
<p> The <a4j:log> component generates JavaScript that opens a debug window, logging application information such as requests, responses, and DOM changes. </p> @author Nick Belaevski
org.richfaces.AjaxLog
org.richfaces.AjaxLogRenderer
<p> The <a4j:log> component generates JavaScript that opens a debug window, logging application information such as requests, responses, and DOM changes. </p> @author Nick Belaevski
The value binding expression used to wire up this component to a component property of a JavaBean class
binding
javax.faces.component.UIComponent
Key to open (in combination with Ctrl+Shift) the popup window. Default value is "L"
hotkey
java.lang.String
The component identifier for this component. This value must be unique within the closest parent component that is a naming container.
Component Identifier
id
java.lang.String
Sets the logging level, can be one of 'debug', 'info', 'warn', 'error'.
level
java.lang.String
Determines how the log appears on the page, can be one of: "inline", "popup". When set to "popup", the popup window is opened by pressing the key combination Ctrl + Shift + L
mode
org.richfaces.component.LogMode
Flag indicating whether or not this component should be rendered (during Render Response Phase), or processed on any subsequent form submit. The default value for this property is true.
Rendered Flag
rendered
boolean
CSS style(s) to be applied when this component is rendered.
CSS Styles
style
java.lang.String
Space-separated list of CSS style class(es) to be applied when this element is rendered. This value must be passed through as the "class" attribute on generated markup.
CSS Style Classes
styleClass
java.lang.String
poll
<p> The <a4j:poll> component allows periodical sending of Ajax requests to the server. It is used for repeatedly updating a page at specific time intervals. </p> @author shura
org.richfaces.Poll
org.richfaces.PollRenderer
org.richfaces.view.facelets.html.AjaxPollHandler
<p> The <a4j:poll> component allows periodical sending of Ajax requests to the server. It is used for repeatedly updating a page at specific time intervals. </p> @author shura
MethodExpression representing the application action to invoke when this component is activated by the user. The expression must evaluate to a public method that takes no parameters, and returns an Object (the toString() of which is called to derive the logical outcome) which is passed to the NavigationHandler for this application.
Application Action
action
javax.faces.el.MethodBinding
<p> MethodExpression representing an action listener method that will be notified when this component is activated by the user. The expression must evaluate to a public method that takes an ActionEvent parameter, with a return type of void, <span class="changed_added_2_0">or to a public method that takes no arguments with a return type of void. In the latter case, the method has no way of easily knowing where the event came from, but this can be useful in cases where a notification is needed that "some action happened".</span> </p>
Action Listener
actionListener
javax.faces.el.MethodBinding
The value binding expression used to wire up this component to a component property of a JavaBean class
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 to the client by a developer on an AJAX request. It's accessible via "event.data" syntax. Both primitive types and complex types such as arrays and collections can be serialized and used with data
data
java.lang.Object
Enables/disables polling to the server. Using Expression Language (EL), the enabled attribute can point to a bean property to apply a particular attribute value
enabled
boolean
Ids of components that will participate in the "execute" portion of the Request Processing Lifecycle. Can be a single id, a space or comma separated list of Id's, or an EL Expression evaluating to an array or Collection. Any of the keywords "@this", "@form", "@all", "@none", "@region" may be specified in the identifier list. Some components make use of additional keywords
execute
java.lang.Object
The component identifier for this component. This value must be unique within the closest parent component that is a naming container.
Component Identifier
id
java.lang.String
Flag indicating that, if this component is activated by the user, notifications should be delivered to interested listeners and actions immediately (that is, during Apply Request Values phase) rather than waiting until Invoke Application phase.
Immediate Action
immediate
boolean
Specifies the time in milliseconds between requests. The default for this value is 1000 ms (1 second)
interval
int
If "true", render only those ids specified in the "render" attribute, forgoing the render of the auto-rendered panels
limitRender
boolean
The client-side script method to be called after the ajax response comes back, but before the DOM is updated
onbeforedomupdate
java.lang.String
The client-side script method to be called before an ajax request.
onbegin
java.lang.String
The client-side script method to be called after the DOM is updated
oncomplete
java.lang.String
The client-side script method to be called after the timer counts down, but before the Ajax request is initiated
ontimer
java.lang.String
Ids of components that will participate in the "render" portion of the Request Processing Lifecycle. Can be a single id, a space or comma separated list of Id's, or an EL Expression evaluating to an array or Collection. Any of the keywords "@this", "@form", "@all", "@none", "@region" may be specified in the identifier list. Some components make use of additional keywords
render
java.lang.Object
Flag indicating whether or not this component should be rendered (during Render Response Phase), or processed on any subsequent form submit. The default value for this property is true.
Rendered Flag
rendered
boolean
If true, indicate that this particular Ajax transaction is a value reset transaction. This will cause resetValue() to be called on any EditableValueHolder instances encountered as a result of this ajax transaction. If not specified, or the value is false, no such indication is made.
resetValues
boolean
Name of the request status component that will indicate the status of the Ajax request
status
java.lang.String
The current value of this component.
Value
value
java.lang.Object
commandLink
<p> The <a4j:commandLink> component is similar to the JavaServer Faces (JSF) <h:commandLink> component, except that it includes plugged-in Ajax behavior. </p> @author Nick Belaevski
org.richfaces.CommandLink
org.richfaces.CommandLinkRenderer
<p> The <a4j:commandLink> component is similar to the JavaServer Faces (JSF) <h:commandLink> component, except that it includes plugged-in Ajax behavior. </p> @author Nick Belaevski
Access key that, when pressed, transfers focus to this element.
accesskey
java.lang.String
MethodExpression representing the application action to invoke when this component is activated by the user. The expression must evaluate to a public method that takes no parameters, and returns an Object (the toString() of which is called to derive the logical outcome) which is passed to the NavigationHandler for this application.
Application Action
action
javax.faces.el.MethodBinding
<p> MethodExpression representing an action listener method that will be notified when this component is activated by the user. The expression must evaluate to a public method that takes an ActionEvent parameter, with a return type of void, <span class="changed_added_2_0">or to a public method that takes no arguments with a return type of void. In the latter case, the method has no way of easily knowing where the event came from, but this can be useful in cases where a notification is needed that "some action happened".</span> </p>
Action Listener
actionListener
javax.faces.el.MethodBinding
The value binding expression used to wire up this component to a component property of a JavaBean class
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 the resource designated by this hyperlink.
Character Set
charset
java.lang.String
The position and shape of the hot spot on the screen (for use in client-side image maps).
Coordinates
coords
java.lang.String
Serialized (on default with JSON) data passed to the client by a developer on an AJAX request. It's accessible via "event.data" syntax. Both primitive types and complex types such as arrays and collections can be serialized and used with data
data
java.lang.Object
Flag indicating that this element must never receive focus or be included in a subsequent submit. Default value - "false"
Disabled Flag
disabled
boolean
Ids of components that will participate in the "execute" portion of the Request Processing Lifecycle. Can be a single id, a space or comma separated list of Id's, or an EL Expression evaluating to an array or Collection. Any of the keywords "@this", "@form", "@all", "@none", "@region" may be specified in the identifier list. Some components make use of additional keywords
execute
java.lang.Object
The language code of the resource designated by this hyperlink.
Language
hreflang
java.lang.String
The component identifier for this component. This value must be unique within the closest parent component that is a naming container.
Component Identifier
id
java.lang.String
Flag indicating that, if this component is activated by the user, notifications should be delivered to interested listeners and actions immediately (that is, during Apply Request Values phase) rather than waiting until Invoke Application phase.
Immediate Action
immediate
boolean
If "true", render only those ids specified in the "render" attribute, forgoing the render of the auto-rendered panels
limitRender
boolean
The client-side script method to be called after the ajax response comes back, but before the DOM is updated
onbeforedomupdate
java.lang.String
The client-side script method to be called before an ajax request.
onbegin
java.lang.String
Javascript code executed when a pointer button is clicked over this element.
Button Click Script
onclick
java.lang.String
The client-side script method to be called after the DOM is updated
oncomplete
java.lang.String
Javascript code executed when a pointer button is double clicked over this element.
Double Click Script
ondblclick
java.lang.String
Javascript code executed when a key is pressed down over this element.
Key Down Script
onkeydown
java.lang.String
Javascript code executed when a key is pressed and released over this element.
Key Press Script
onkeypress
java.lang.String
Javascript code executed when a key is released over this element.
Key Up Script
onkeyup
java.lang.String
Javascript code executed when a pointer button is pressed down over this element.
Mouse Down Script
onmousedown
java.lang.String
Javascript code executed when a pointer button is moved within this element.
Mouse Move Script
onmousemove
java.lang.String
Javascript code executed when a pointer button is moved away from this element.
Mouse Out Script
onmouseout
java.lang.String
Javascript code executed when a pointer button is moved onto this element.
Mouse Over Script
onmouseover
java.lang.String
Javascript code executed when a pointer button is released over this element.
Mouse Up Script
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.
Relationship
rel
java.lang.String
Ids of components that will participate in the "render" portion of the Request Processing Lifecycle. Can be a single id, a space or comma separated list of Id's, or an EL Expression evaluating to an array or Collection. Any of the keywords "@this", "@form", "@all", "@none", "@region" may be specified in the identifier list. Some components make use of additional keywords
render
java.lang.Object
Flag indicating whether or not this component should be rendered (during Render Response Phase), or processed on any subsequent form submit. The default value for this property is true.
Rendered Flag
rendered
boolean
If true, indicate that this particular Ajax transaction is a value reset transaction. This will cause resetValue() to be called on any EditableValueHolder instances encountered as a result of this ajax transaction. If not specified, or the value is false, no such indication is made.
resetValues
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.
Reverse Link
rev
java.lang.String
The shape of the hot spot on the screen (for use in client-side image maps). Valid values are: default (entire region); rect (rectangular region); circle (circular region); and poly (polygonal region).
Shape
shape
java.lang.String
Name of the request status component that will indicate the status of the Ajax request
status
java.lang.String
CSS style(s) to be applied when this component is rendered.
CSS Styles
style
java.lang.String
Space-separated list of CSS style class(es) to be applied when this element is rendered. This value must be passed through as the "class" attribute on generated markup.
CSS Style Classes
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
Advisory title information about markup elements generated for this component.
Advisory Title
title
java.lang.String
The content type of the resource designated by this hyperlink.
Content Type
type
java.lang.String
The current value of this component.
Value
value
java.lang.Object
actionListener
org.richfaces.view.facelets.html.ActionListenerHandler
If present, this attribute refers to the value of one of the exposed attached objects within the composite component inside of which this tag is nested.
for
java.lang.String
Value binding expression that evaluates to an object that implements ActionListener.
binding
javax.el.ValueExpression
MethodExpression representing an action listener method that will be notified when this component is activated by the user. The expression must evaluate to a public method that takes an LazyActionListener parameter, with a return type of void, or to a public method that takes no arguments with a return type of void
listener
javax.el.ValueExpression
Fully qualified Java class name of an ActionListener to be created and registered.
type
javax.el.ValueExpression
ajax
<p> The <a4j:ajax> behavior allows Ajax capability to be added to a non-Ajax component. The non-Ajax component must implement the ClientBehaviorHolder interface for all the event attributes that support behavior rendering. </p> @author Anton Belevich
org.ajax4jsf.behavior.Ajax
org.richfaces.view.facelets.html.AjaxHandler
<p> The <a4j:ajax> behavior allows Ajax capability to be added to a non-Ajax component. The non-Ajax component must implement the ClientBehaviorHolder interface for all the event attributes that support behavior rendering. </p> @author Anton Belevich
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 to the client by a developer on an AJAX request. It's accessible via "event.data" syntax. Both primitive types and complex types such as arrays and collections can be serialized and used with data
data
java.lang.Object
If "true", do not initiate an ajax request when the associated event is observed
disabled
boolean
Name of JavaScript event property (click, change, etc.) of parent component that triggers the behavior. If the event attribute is not defined, the behavior is triggered on the event that normally provides interaction behavior for the parent component
event
java.lang.String
Ids of components that will participate in the "execute" portion of the Request Processing Lifecycle. Can be a single id, a space or comma separated list of Id's, or an EL Expression evaluating to an array or Collection. Any of the keywords "@this", "@form", "@all", "@none", "@region" may be specified in the identifier list. Some components make use of additional keywords
execute
java.lang.Object
Flag indicating that, if this component is activated by the user, notifications should be delivered to interested listeners and actions immediately (that is, during Apply Request Values phase) rather than waiting until Invoke Application phase.
immediate
boolean
If "true", render only those ids specified in the "render" attribute, forgoing the render of the auto-rendered panels
limitRender
boolean
Method expression referencing a method that will be called when an AjaxBehaviorEvent has been broadcast for the listener.
listener
javax.el.MethodExpression
The client-side script method to be called after the ajax response comes back, but before the DOM is updated
onbeforedomupdate
java.lang.String
The client-side script method to be called before the AJAX request is submitted
onbeforesubmit
java.lang.String
The client-side script method to be called before an ajax request.
onbegin
java.lang.String
The client-side script method to be called after the DOM is updated
oncomplete
java.lang.String
The client-side script method to be called when an error has occurred during Ajax communications
onerror
java.lang.String
Identify the name of the destination queue
queueId
java.lang.String
Ids of components that will participate in the "render" portion of the Request Processing Lifecycle. Can be a single id, a space or comma separated list of Id's, or an EL Expression evaluating to an array or Collection. Any of the keywords "@this", "@form", "@all", "@none", "@region" may be specified in the identifier list. Some components make use of additional keywords
render
java.lang.Object
If true, indicate that this particular Ajax transaction is a value reset transaction. This will cause resetValue() to be called on any EditableValueHolder instances encountered as a result of this ajax transaction. If not specified, or the value is false, no such indication is made.
resetValues
boolean
Name of the request status component that will indicate the status of the Ajax request
status
java.lang.String
© 2015 - 2025 Weber Informatics LLC | Privacy Policy