Ajax4Jsf
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
focusfalsefalsejava.lang.Stringid of element to set focus after request completed on client side
dirfalsefalsejava.lang.StringDirection indication for text that does not inherit directionality. Valid values are "LTR" (left-to-right) and "RTL" (right-to-left)
idfalsefalsejava.lang.StringEvery component may have a unique id that is automatically created if omitted
revfalsefalsejava.lang.StringA 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
bypassUpdatesfalsefalsejava.lang.StringIf "true", after process validations phase it skips updates of model beans on a force render response. It can be used for validating components input
limitToListfalsefalsejava.lang.StringIf "true", updates on client side ONLY elements from this 'reRender' property. If "false" (default) updates all rendered by ajax region components
stylefalsefalsejava.lang.StringCSS style(s) is/are to be applied when this component is rendered
onmouseoverfalsefalsejava.lang.StringHTML: a script expression; a pointer is moved onto
onkeyupfalsefalsejava.lang.StringHTML: a script expression; a key is released
tabindexfalsefalsejava.lang.StringThis 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
timeoutfalsefalsejava.lang.StringTimeout ( in ms ) for request.
langfalsefalsejava.lang.StringCode describing the language used in the generated markup for this component
actionExpressionfalsefalsejava.lang.StringThe action method binding expression.
onmouseoutfalsefalsejava.lang.StringHTML: a script expression; a pointer is moved away
relfalsefalsejava.lang.StringThe 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
onmouseupfalsefalsejava.lang.StringHTML: script expression; a pointer button is released
bindingfalsefalsejava.lang.StringThe attribute takes a value-binding expression for a component property of a backing bean
onmousemovefalsefalsejava.lang.StringHTML: a script expression; a pointer is moved within
coordsfalsefalsejava.lang.StringThis 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
actionListenerfalsefalsejava.lang.StringMethodBinding pointing at method accepting an ActionEvent with return type void
titlefalsefalsejava.lang.StringAdvisory title information about markup elements generated for this component
shapefalsefalsejava.lang.Stringdefault|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.
oncompletefalsefalsejava.lang.StringJavaScript code for call after request completed on client side
targetfalsefalsejava.lang.StringThis 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
charsetfalsefalsejava.lang.StringThe character encoding of a resource designated by this hyperlink
renderedfalsefalsejava.lang.StringIf "false", this component is not rendered
reRenderfalsefalsejava.lang.StringId['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
styleClassfalsefalsejava.lang.StringCorresponds to the HTML class attribute
accesskeyfalsefalsejava.lang.StringThis 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
onkeypressfalsefalsejava.lang.StringHTML: a script expression; a key is pressed and released
ondblclickfalsefalsejava.lang.StringHTML: a script expression; a pointer button is double-clicked
ajaxSinglefalsefalsejava.lang.Stringif "true", submits ONLY one field/link, instead of all form controls
onblurfalsefalsejava.lang.StringJavaScript 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
actionfalsefalsejava.lang.StringMethodBinding 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
valuefalsefalsejava.lang.StringThe current value for this component
hreflangfalsefalsejava.lang.StringBase language of a resource specified with the href attribute; hreflang may only be used with href
typefalsefalsejava.lang.StringThe content type of the resource designated by this hyperlink
onclickfalsefalsejava.lang.StringHTML: a script expression; a pointer button is clicked
statusfalsefalsejava.lang.StringID (in format of call UIComponent.findComponent()) of Request status component
onkeydownfalsefalsejava.lang.StringHTML: a script expression; a key is pressed down
onmousedownfalsefalsejava.lang.StringHTML: script expression; a pointer button is pressed down
requestDelayfalsefalsejava.lang.StringAttribute 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
eventsQueuefalsefalsejava.lang.StringName 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.)
immediatefalsefalsejava.lang.StringTrue 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
datafalsefalsejava.lang.StringSerialized (on default with JSON) data passed on the client by a developer on AJAX request. It's accessible via "data.foo" syntax
onfocusfalsefalsejava.lang.StringJavaScript code. The onfocus event occurs when an element gets focus
onbeforedomupdatefalsefalsejava.lang.StringJavaScript code for call before DOM has been updated on client side
ignoreDupResponsesfalsefalsejava.lang.StringAttribute 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

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.