| Info | Value |
|---|---|
| Component Type | org.primefaces.component.CommandLink |
| Handler Class | None |
| Renderer Type | org.primefaces.component.CommandLinkRenderer |
| Description | None |
| Name | Required | Type | Description |
|---|---|---|---|
accesskey | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Access key that when pressed transfers focus to the link. |
action | false | jakarta.el.ValueExpression
(must evaluate to javax.el.MethodExpression)
| A method expression or a string outcome to process when command is executed. |
actionListener | false | jakarta.el.ValueExpression
(must evaluate to javax.faces.event.ActionListener)
| An actionlistener to process when command is executed. |
ajax | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Specifies the submit mode, when set to true (default), submit would be made with Ajax. |
ariaLabel | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| The aria-label attribute is used to define a string that labels the current element for accessibility. |
async | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| When set to true, ajax requests are not queued. |
binding | false | jakarta.el.ValueExpression
(must evaluate to javax.faces.component.UIComponent)
| An el expression referring to a server side UIComponent instance in a backing bean. |
charset | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Character encoding of the resource designated by this hyperlink. |
coords | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Position and shape of the hot spot on the screen for client use in image maps. |
delay | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| If less than delay milliseconds elapses between calls to request() only the most recent one is sent and all other requests are discarded. The default value of this option is null. If the value of delay is the literal string 'none' without the quotes or the default, no delay is used. |
dir | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Direction indication for text that does not inherit directionality. Valid values are LTR and RTL. |
disabled | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Disables the link. |
disableOnAjax | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| If true, the link will be disabled during Ajax requests triggered by the link. Default is 'true'. |
form | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Form to serialize for an ajax request. Default is the enclosing form. |
global | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Defines whether to trigger ajaxStatus or not. |
hreflang | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Language code of the resource designated by the link. |
id | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Unique identifier of the component in a namingContainer. |
ignoreAutoUpdate | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| If true, components which autoUpdate="true" will not be updated for this request. If not specified, or the value is false, no such indication is made. |
ignoreComponentNotFound | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| If true, unresolvable components referenced in the update/process attribute are ignored. Default is 'false' and therefore a ComponentNotFoundException will be thrown. |
immediate | false | jakarta.el.ValueExpression
(must evaluate to boolean)
| Boolean value that determines the phaseId of the action event, when true actions are processed at "Apply Request Values", when false at "Invoke Application" phase. |
onblur | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Client side callback to execute when link loses focus. |
onclick | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Client side callback to execute when link is clicked. |
oncomplete | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Client side callback to execute when ajax request is completed. |
ondblclick | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Client side callback to execute when link is double clicked. |
onerror | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Client side callback to execute when ajax request fails. |
onfocus | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Client side callback to execute when link receives focus. |
onkeydown | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Client side callback to execute when a key is pressed down over link. |
onkeypress | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Client side callback to execute when a key is pressed and released over link. |
onkeyup | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Client side callback to execute when a key is released over link. |
onmousedown | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Client side callback to execute when a pointer button is pressed down over link. |
onmousemove | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Client side callback to execute when a pointer button is moved within link. |
onmouseout | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Client side callback to execute when a pointer button is moved away from link. |
onmouseover | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Client side callback to execute when a pointer button is moved onto link. |
onmouseup | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Client side callback to execute when a pointer button is released over link. |
onstart | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Client side callback to execute before ajax request begins. |
onsuccess | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Client side callback to execute when ajax request succeeds. |
partialSubmit | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| When enabled, only values related to partially processed components would be serialized for ajax instead of whole form. |
partialSubmitFilter | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Selector to use when partial submit is on, default is ":input" to select all descendant inputs of a partially processed components. |
process | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Component(s) to process partially instead of whole view. |
rel | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Relationship from the current document to the anchor specified by the link, values are provided by a space-separated list of link types. |
rendered | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Boolean value to specify the rendering of the component, when set to false component will not be rendered. |
resetValues | false | jakarta.el.ValueExpression
(must evaluate to java.lang.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. |
rev | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| A reverse link from the anchor specified by this link to the current document, values are provided by a space-separated list of link types. |
shape | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Shape of hot spot on the screen, valid values are default, rect, circle and poly. |
style | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Style to be applied on the anchor element. |
styleClass | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| StyleClass to be applied on the anchor element |
tabindex | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Position of the button element in the tabbing order. |
target | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Name of a frame where the resource targeted by this link will be displayed. |
timeout | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Integer)
| Defines the timeout for the ajax request. |
title | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Advisory tooltip information. |
type | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Type of resource referenced by the link. |
update | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Component(s) to be updated with ajax. |
validateClient | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| When set to true client side validation is enabled, global setting is required to be enabled as a prerequisite. |
value | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Object)
| Label of the component. |
widgetVar | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Name of the client side widget. |
Output generated by Vdldoc View Declaration Language Documentation Generator.