Send your remarks, comments or wishes to doc team
Subject:
Message:
Your name:
Your email:

JBoss.org Community Documentation

- Prev
- Next

## 6.5. < a4j:commandLink >

### 6.5.1. Description

The <a4j:commandLink> component is very similar to the <h:commandLink> component, the only difference is that an Ajax form submit is generated on a click and it allows dynamic rerendering after a response comes back. It's not necessary to plug any support into the component, as Ajax support is already built in.

Table 6.9. a4j : commandLink attributes

Attribute Name | Description
--- | ---
accesskey | 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
action | MethodBinding pointing at the application action to be invoked, if this UIComponent is activated by you, during the Apply Request Values or Invoke Application phase of the request processing lifecycle, depending on the value of the immediate property
actionListener | MethodBinding pointing at method accepting an ActionEvent with return type void
ajaxSingle | boolean attribute which provides possibility to limit JSF tree processing(decoding, conversion/validation, value applying) to the component which send the request only
binding | The attribute takes a value-binding expression for a component property of a backing bean
bypassUpdates | 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
charset | The character encoding of a resource designated by this hyperlink
coords | 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
data | Serialized (on default with JSON) data passed on the client by a developer on AJAX request. It's accessible via "data.foo" syntax
dir | Direction indication for text that does not inherit directionality. Valid values are "LTR" (left-to-right) and "RTL" (right-to-left)
disabled | If true, disable this component on page.
eventsQueue | 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.)
focus | id of element to set focus after request completed on client side
hreflang | Base language of a resource specified with the href attribute; hreflang may only be used with href
id | Every component may have a unique id that is automatically created if omitted
ignoreDupResponses | Attribute allows to ignore an Ajax Response produced by a request if the newest 'similar' request is in a queue already. ignoreDupResponses="true" does not cancel the request while it is processed on the server, but just allows to avoid unnecessary updates on the client side if the response isn't actual now
immediate | 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
lang | Code describing the language used in the generated markup for this component
limitToList | If "true", then of all AJAX-rendered on the page components only those will be updated, which ID's are passed to the "reRender" attribute of the describable component. "false"-the default value-means that all components with ajaxRendered="true" will be updated.
onbeforedomupdate | JavaScript code for call before DOM has been updated on client side
onblur | 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
onclick | HTML: a script expression; a pointer button is clicked
oncomplete | JavaScript code for call after request completed on client side
ondblclick | HTML: a script expression; a pointer button is double-clicked
onfocus | JavaScript code. The onfocus event occurs when an element gets focus
onkeydown | HTML: a script expression; a key is pressed down
onkeypress | HTML: a script expression; a key is pressed and released
onkeyup | HTML: a script expression; a key is released
onmousedown | HTML: script expression; a pointer button is pressed down
onmousemove | HTML: a script expression; a pointer is moved within
onmouseout | HTML: a script expression; a pointer is moved away
onmouseover | HTML: a script expression; a pointer is moved onto
onmouseup | HTML: script expression; a pointer button is released
process | Id['s] (in format of call UIComponent.findComponent()) of components, processed at the phases 2-5 in case of AjaxRequest caused by this component. Can be single id, comma-separated list of Id's, or EL Expression with array or Collection
rel | 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
rendered | If "false", this component is not rendered
requestDelay | Attribute defines the time (in ms.) that the request will be wait in the queue before it is ready to send. When the delay time is over, the request will be sent to the server or removed if the newest 'similar' request is in a queue already
reRender | Id['s] (in format of call UIComponent.findComponent()) of components, rendered in case of AjaxRequest caused by this component. Can be single id, comma-separated list of Id's, or EL Expression with array or Collection
rev | 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
shape | This attribute specifies the shape of a region. The possible values are "default", "rect", "circle" and "poly".
similarityGroupingId | If there are any component requests with identical IDs then these requests will be grouped.
status | ID (in format of call UIComponent.findComponent()) of Request status component
style | CSS style(s) is/are to be applied when this component is rendered
styleClass | Corresponds to the HTML class attribute
tabindex | 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
target | 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
timeout | Timeout ( in ms ) for request.
title | Advisory title information about markup elements generated for this component
type | The content type of the resource designated by this hyperlink
value | The current value for this component

Table 6.10. Component identification parameters

Name | Value
--- | ---
component-type | org.ajax4jsf.CommandLink
component-family | javax.faces.Command
component-class | org.ajax4jsf.component.html.HtmlAjaxCommandLink
renderer-type | org.ajax4jsf.components.AjaxCommandLinkRenderer

### 6.5.2. Creating on a page

To create the simplest variant on a page use the following syntax:

Example:

    ...

       <a4j:commandLink reRender="someData" action="#{bean.action1}" value="Link"/>

    ...

### 6.5.3. Creating the Component Dynamically Using Java

Example:

    import org.ajax4jsf.component.html.HtmlAjaxCommandLink;

    ...

    HtmlAjaxCommandLink myLink = new HtmlAjaxCommandLink();

    ...

### 6.5.4. Key attributes and ways of usage

The <a4j:commandLink> component is used in the same way as the <h:commandLink> component, but with definition of the area that is updated after the response comes back from the server.

This definition of the component provides a link, and a click on the link causes an Ajax form submit on the server, `"action1"` method performance, and rendering of the component with `"someData"` id after the response comes back from the server.

## Tip:

The example in the "Creation on a page" section generates the following HTML code:

    ...

    <a href="#" onclick="A4J.AJAX.Submit(?"request parameters"); return false;">

          <span>Link</span>

    </a>

    ...

If you click on the generated anchor the utility method `A4J.AJAX.Submit()` is fired. The method performs an Ajax request as the Ajax support is built-in. It's not necessary to add nested <a4j:support /> to the <a4j:commandLink /> component.

Common JSF navigation could be performed after Ajax submit and partial rendering, but Navigation Case must be defined as <redirect/> in order to avoid problems with some browsers.

As any Core Ajax component sending Ajax requests and processing server responses <a4j:commandLink> has all attributes described above (see <a4j:support> chapter) that provide the required behavior of requests sending (delay, limitation of submit area and rendering, etc.)

Information about the "process" attribute usage you can find here.

### 6.5.5. Relevant resources links

Vizit CommandLink demo page at RichFaces live demo for examples of component usage and their sources.

Useful articles:

- How to use "window.confirm" JavaScript with <rich:commandLink> "onclick" attribute in RichFaces cookbook at JBoss portal.

- Prev6.4. < a4j:commandButton >
- Top of page
- Front page
- Next6.6. < a4j:form >