JBoss.org Community Documentation

- Prev
- Next

## 6.7. < a4j:htmlCommandLink >

### 6.7.1. Description

The <a4j:htmlCommandLink> component is very similar to the same component from the JSF HTML library, the only slight difference is in links generation and problem solving that occurs when an original component is used.

Table 6.13. a4j : htmlCommandLink 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
binding | The attribute takes a value-binding expression for a component property of a backing bean
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
dir | Direction indication for text that does not inherit directionality. Valid values are "LTR" (left-to-right) and "RTL" (right-to-left)
disabled | When set for a form control, this boolean attribute disables the control for your input.
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
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
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
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
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
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".
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
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.14. Component identification parameters

Name | Value
--- | ---
component-type | javax.faces.HtmlCommandLink
component-family | javax.faces.Command
component-class | javax.faces.component.html.HtmlCommandLink
renderer-type | org.ajax4jsf.HtmlCommandLinkRenderer

### 6.7.2. Creating the Component with a Page Tag

Component definition on a page is the same as for the original component from the JSF HTML library.

Example:

    <a4j:htmlCommandLink value="value" action="action"/>

### 6.7.3. Creating the Component Dynamically Using Java

Example:

    import javax.faces.component.html.HtmlCommandLink;

    ...

    HtmlCommandLink myCommandLink = new HtmlCommandLink();

    ...

### 6.7.4. Key attributes and ways of usage

The difference with the original component is that all hidden fields required for command links with the child <f:param> elements are always rendered and it doesn't depend on links rendering on the initial page. It solves the problem with invalid links that weren't rendered on a page immediately, but after some Ajax request.

Example:

    <a4j:form>

        ...

        <a4j:htmlComandLink action="action" value="link" rendered="#{bean.rendered}">

            <f:param .../>

        <a4j:htmlComandLink>

        ...

    </a4j:form>

In this example <a4j:htmlCommandLink> works as standard <h:commandLink> , but here hidden fields required for correct functionality are rendered before the first downloading of a page, though it doesn't happen if its attribute isn't set to "false".

### 6.7.5. Relevant resources links

Here you can found some additional information for <a4j:htmlCommandLinks> component usage.

Here you can found some additional information about <f:param> component.

- Prev6.6. < a4j:form >
- Top of page
- Front page
- Next6.8. < a4j:jsFunction >