commandLink (VDL Documentation Generator - Generated Documentation)

Description:

CommandLink extends standard JSF commandLink with Ajax capabilities.

Component Information
Info	Value
Component Type	`org.primefaces.component.CommandLink`
Handler Class	None
Renderer Type	`org.primefaces.component.CommandLinkRenderer`
Description	None

Attributes
Name	Required	Type	Description
`id`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	Unique identifier of the component in a namingContainer.
`rendered`	`false`	`javax.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.
`binding`	`false`	`javax.el.ValueExpression` (must evaluate to `javax.faces.component.UIComponent`)	An el expression referring to a server side UIComponent instance in a backing bean.
`value`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.Object`)	Label of the component.
`actionListener`	`false`	`javax.el.ValueExpression` (must evaluate to `javax.faces.event.ActionListener`)	An actionlistener to process when command is executed.
`action`	`false`	`javax.el.ValueExpression` (must evaluate to `javax.el.MethodExpression`)	A method expression or a string outcome to process when command is executed.
`immediate`	`false`	`javax.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.
`ajax`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.Boolean`)	Specifies the submit mode, when set to true (default), submit would be made with Ajax.
`async`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.Boolean`)	When set to true, ajax requests are not queued.
`process`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	Component(s) to process partially instead of whole view.
`update`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	Component(s) to be updated with ajax.
`onstart`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	Client side callback to execute before ajax request is begins.
`oncomplete`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	Client side callback to execute when ajax request is completed.
`onerror`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	Client side callback to execute when ajax request fails.
`onsuccess`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	Client side callback to execute when ajax request succeeds.
`global`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.Boolean`)	Defines whether to trigger ajaxStatus or not.
`delay`	`false`	`javax.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.
`timeout`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.Integer`)	Defines the timeout for the ajax request.
`partialSubmit`	`false`	`javax.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.
`resetValues`	`false`	`javax.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.
`ignoreAutoUpdate`	`false`	`javax.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.
`accesskey`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	Access key that when pressed transfers focus to the link.
`charset`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	Character encoding of the resource designated by this hyperlink.
`coords`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	Position and shape of the hot spot on the screen for client use in image maps.
`dir`	`false`	`javax.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`	`javax.el.ValueExpression` (must evaluate to `java.lang.Boolean`)	Disables the link.
`hreflang`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	Languae code of the resource designated by the link.
`rel`	`false`	`javax.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.
`rev`	`false`	`javax.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`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	Shape of hot spot on the screen, valid values are default, rect, circle and poly.
`tabindex`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	Position of the button element in the tabbing order.
`target`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	Name of a frame where the resource targeted by this link will be displayed.
`title`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	Advisory tooltip informaton.
`type`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	Type of resource referenced by the link.
`style`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	Style to be applied on the anchor element.
`styleClass`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	StyleClass to be applied on the anchor element
`onblur`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	Client side callback to execute when link loses focus.
`onclick`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	Client side callback to execute when link is clicked.
`ondblclick`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	Client side callback to execute when link is double clicked.
`onfocus`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	Client side callback to execute when link receives focus.
`onkeydown`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	Client side callback to execute when a key is pressed down over link.
`onkeypress`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	Client side callback to execute when a key is pressed and released over link.
`onkeyup`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	Client side callback to execute when a key is released over link.
`onmousedown`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	Client side callback to execute when a pointer button is pressed down over link.
`onmousemove`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	Client side callback to execute when a pointer button is moved within link.
`onmouseout`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	Client side callback to execute when a pointer button is moved away from link.
`onmouseover`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	Client side callback to execute when a pointer button is moved onto link.
`onmouseup`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	Client side callback to execute when a pointer button is released over link.
`validateClient`	`false`	`javax.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.
`partialSubmitFilter`	`false`	`javax.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.
`form`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	Form to serialize for an ajax request. Default is the enclosing form.
`ariaLabel`	`false`	`javax.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.

primefaces-p

Tag commandLink