commandLink (Liferay Faces Alloy View Description Language Documentation (VDLDoc))

Description:

CommandLink is a UICommand component that renders an HTML <a> element. Since it extends HtmlCommandLink, it supports all the features of h:commandLink. The component must be a child of h:form in order to trigger the action or actionListener.

Since:

2.0.0

Example usage of this component can be found at:

http://www.liferayfaces.org/web/guest/alloy-showcase/-/alloy-tag/alloy/commandlink/general

Component Information
Info	Value
Component Type	`com.liferay.faces.alloy.component.commandlink.CommandLink`
Handler Class	None
Renderer Type	`com.liferay.faces.alloy.component.commandlink.CommandLinkRenderer`
Description	None

Attributes
Name	Required	Type	Description
`accesskey`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	HTML passthrough attribute specifying a hot key character for the element.
`action`	`false`	`javax.el.MethodExpression` (signature must match `java.lang.Object action()`)	A method that is executed when this component is clicked. The method must be `public`, return an `Object`, and take no arguments. The `toString()` method of the returned object is used to determine where to navigate (if at all) after the action has been performed.
`actionListener`	`false`	`javax.el.MethodExpression` (signature must match `void actionListener(javax.faces.event.ActionEvent)`)	A method that is executed when this component is clicked. The method must be `public`, return `void`, and take either no arguments or one `ActionEvent` argument.
`ajax`	`false`	`javax.el.ValueExpression` (must evaluate to `boolean`)	When this flag is true, clicking on the button will cause the form to be submitted via XmlHttpRequest. The default value is `true`.
`binding`	`false`	`javax.el.ValueExpression` (must evaluate to `javax.faces.component.UIComponent`)	An EL expression that binds the Java reference to this component in the component tree to a bean property.
`charset`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	The character encoding of the resource linked to by this component.
`coords`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	The position and shape of the component's area on the page. Used in image maps.
`dir`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	HTML passthrough attribute specifying the reading direction for the element For example, right to left (RTL), or left to right (LTR).
`disabled`	`false`	`javax.el.ValueExpression` (must evaluate to `boolean`)	When this flag is true, the component will be disabled, and the user will be unable to interact with the component. The default value is `false`.
`execute`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	Space-delimited list of component ids that are to participate in the APPLY_REQUEST_VALUES, PROCESS_VALIDATIONS, UPDATE_MODEL_VALUES, and INVOKE_APPLICATION phases of the JSF lifecycle. The following keywords may also appear in the list: `@this`, `@form`, `@all`, `@none`. The default value is `"@all"`.
`hreflang`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	The language code of the resource linked to by this component.
`id`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	A unique identifier for this component.
`immediate`	`false`	`javax.el.ValueExpression` (must evaluate to `boolean`)	When this flag is true, this component's value must be converted and validated (immediately) during the Apply Request Values phase, instead of (later) during the PROCESS_VALIDATIONS phase.
`lang`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	HTML passthrough attribute specifying the language code used in the element.
`onblur`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	Javascript to execute after this component loses focus.
`onclick`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	Javascript to execute when this component is clicked.
`ondblclick`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	Javascript to execute when a double click event occurs.
`onfocus`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	Javascript to execute when this component gets focus.
`onkeydown`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	Javascript to execute when a keydown event occurs.
`onkeypress`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	Javascript to execute when a keypress event occurs.
`onkeyup`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	Javascript to execute when a keyup event occurs.
`onmousedown`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	Javascript to execute when a mousedown event occurs.
`onmousemove`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	Javascript to execute when a mousemove event occurs.
`onmouseout`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	Javascript to execute when a mouseout event occurs.
`onmouseover`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	Javascript to execute when a mouseover event occurs.
`onmouseup`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	Javascript to execute when a mouseup event occurs.
`process`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	Synonym for the `execute` attribute. The default value is `"@all"`.
`rel`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	The relationship between the current document and the one linked to by this component. This is a space-separated list of link types. Used by bots, not browsers.
`render`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	Space-delimited list of component ids that are to participate in the RENDER_RESPONSE phase of the JSF lifecycle and be re-rendered in the DOM after the response is received from the XmlHttpRequest. The following keywords may also appear in the list: `@this`, `@form`, `@all`, `@none`. The default value is `"@none"`.
`rendered`	`false`	`javax.el.ValueExpression` (must evaluate to `boolean`)	When this flag is true, this component will be rendered to there response. When false, it will not be rendered to the response. The default value is `true`.
`rev`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	The reverse of the rel attribute. The relationship between the document linked to by this component and the current document.
`role`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	HTML passthrough attribute specifying the various WAI-ARIA roles that the element is used for. Since: JSF 2.2
`shape`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	Used by some browsers with the coords to specify the size, shape, and placement of the link.
`style`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	HTML passthrough attribute specifying the css style of the element.
`styleClass`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	List of CSS class names (separated by spaces) that are to be rendered within the class attribute.
`tabindex`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	HTML passthrough attribute specifying where the element is located in the tabbing progression.
`target`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	Specifies which window, tab, or frame to open the link in.
`title`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	HTML passthrough attribute specifying the title of the element.
`type`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	HTML passthrough attribute specifying the content type of resource located by the URL in the rendered href attribute.
`update`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	Synonym for the `render` attribute. The default value is `"@none"`.
`value`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.Object`)	The value of this component, which is typically bound via EL to a model bean property.

alloy

Tag commandLink