Ajax4jsf ( Legacy URL )
Tag 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.


Tag Information
Tag Classorg.ajax4jsf.taglib.html.jsp.AjaxCommandLink
TagExtraInfo ClassNone
Body ContentJSP
Display NameAjax commandLink

Attributes
NameRequiredRequest-timeTypeDescription
accesskeyfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
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
actionfalsefalsejavax.el.MethodExpression
(signature must match java.lang.Object 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
actionListenerfalsefalsejavax.el.MethodExpression
(signature must match void actionListener(javax.faces.event.ActionEvent))
MethodBinding pointing at method accepting an ActionEvent with return type void
ajaxSinglefalsefalsejavax.el.ValueExpression
(must evaluate to boolean)
Limits JSF tree processing (decoding, conversion, validation and model updating) only to a component that sends the request. Boolean. Default value is "false".
bindingfalsefalsejavax.el.ValueExpression
(must evaluate to javax.faces.component.UIComponent)
The attribute takes a value-binding expression for a component property of a backing bean
bypassUpdatesfalsefalsejavax.el.ValueExpression
(must evaluate to boolean)
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
charsetfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
The character encoding of a resource designated by this hyperlink
coordsfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
The attribute specifies shape and it position on the screen. Possible values: "rect: left-x, top-y, right-x, bottom-y", "circle: center-x, center-y, radius", "poly: x1, y1, x2, y2, ..., xN, yN". Notes: a) when giving the radius value in percents, user agents should calculate the final radius value in pixels based on the associated object's width and height; b) the radius value should be smaller than center-x and center-y values; c) for a polygon, the first and last coordinate pairs should have same x and y to close the shape (x1=xN; y1=yN) (when these coordinates are different, user agents should infer an additional pair to close a polygon). Coordinates are relative to the top left corner of an object. All values are lengths. All values are comma separated.
datafalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.Object)
Serialized (on default with JSON) data passed on the client by a developer on AJAX request. It's accessible via "data.foo" syntax
dirfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
Direction indication for text that does not inherit directionality. Valid values are "LTR" (left-to-right) and "RTL" (right-to-left)
disabledfalsefalsejavax.el.ValueExpression
(must evaluate to boolean)
Disables the component on page. Boolean.
eventsQueuefalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
Name of requests queue to avoid send next request before complete other from same event. Can be used to reduce number of requests of frequently events (key press, mouse move etc.)
focusfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
ID of an element to set focus after request is completed on client side
hreflangfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
Base language of a resource specified with the href attribute; hreflang may only be used with href
idfalsefalsejava.lang.StringEvery component may have a unique id that is automatically created if omitted
ignoreDupResponsesfalsefalsejavax.el.ValueExpression
(must evaluate to boolean)
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
immediatefalsefalsejavax.el.ValueExpression
(must evaluate to boolean)
True means, that the default ActionListener should be executed immediately (i.e. during Apply Request Values phase of the request processing lifecycle), rather than waiting until the Invoke Application phase
langfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
Code describing the language used in the generated markup for this component
limitToListfalsefalsejavax.el.ValueExpression
(must evaluate to boolean)
If "true", then of all AJAX-rendered on the page components only those will be updated, which ID's are passed to the "reRender" attribute of the describable component. "false"-the default value-means that all components with ajaxRendered="true" will be updated.
onbeforedomupdatefalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
The client-side script method to be called before DOM is updated
onblurfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
The client-side script method to be called when the element loses the focus either when pointing a device or tabbing navigation. The attribute may be used with the same elements as onfocus
onclickfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
The client-side script method to be called when the element is clicked
oncompletefalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
The client-side script method to be called after the request is completed
ondblclickfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
The client-side script method to be called when the element is double-clicked
onfocusfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
The client-side script method to be called when the element gets the focus
onkeydownfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
The client-side script method to be called when a key is pressed down over the element
onkeypressfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
The client-side script method to be called when a key is pressed over the element and released
onkeyupfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
The client-side script method to be called when a key is released
onmousedownfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
The client-side script method to be called when a mouse button is pressed down over the element
onmousemovefalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
The client-side script method to be called when a pointer is moved within the element
onmouseoutfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
The client-side script method to be called when a pointer is moved away from the element
onmouseoverfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
The client-side script method to be called when a pointer is moved onto the element
onmouseupfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
The client-side script method to be called when a mouse button is released
processfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.Object)
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
reRenderfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.Object)
Id['s] (in format of call UIComponent.findComponent()) of components, rendered in case of AjaxRequest caused by this component. Can be single id, comma-separated list of Id's, or EL Expression with array or Collection
relfalsefalsejavax.el.ValueExpression
(must evaluate to 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
renderedfalsefalsejavax.el.ValueExpression
(must evaluate to boolean)
If "false", this component is not rendered
requestDelayfalsefalsejavax.el.ValueExpression
(must evaluate to int)
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
revfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
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
shapefalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
This attribute specifies the shape of a region. The possible values are "default", "rect", "circle" and "poly".
similarityGroupingIdfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
If there are any component requests with identical IDs then these requests will be grouped.
statusfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
ID (in format of call UIComponent.findComponent()) of Request status component
stylefalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
CSS style rules to be applied to the component
styleClassfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
Assigns one or more CSS class names to the component. Corresponds to the HTML "class" attribute.
tabindexfalsefalsejavax.el.ValueExpression
(must evaluate to 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
targetfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
This attribute specifies the name of a frame where a document is to be opened. By assigning a name to a frame via the name attribute, authors can refer to it as the "target" of links defined by other elements
timeoutfalsefalsejavax.el.ValueExpression
(must evaluate to int)
Timeout ( in ms ) for request.
titlefalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
Advisory title information about markup elements generated for this component
typefalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
The content type of the resource designated by this hyperlink
valuefalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.Object)
The current value for this component

Variables
No Variables Defined.


Output Generated by Tag Library Documentation Generator. Java, JSP, and JavaServer Pages are trademarks or registered trademarks of Sun Microsystems, Inc. in the US and other countries. Copyright 2002-4 Sun Microsystems, Inc. 4150 Network Circle Santa Clara, CA 95054, U.S.A. All Rights Reserved.