Documentation

Search 

Contents

  1. Introduction
  2. Getting Started
  3. ICEfaces Concepts
  4. Code View Support
  5. Design View Support
  6. Tag Object Toolbars
  7. Server Behaviors
  8. Property Inspectors
Selected 9. ICEfaces Tag Reference

10. ICEfaces Tag Reference

Contents > ICEfaces Tag Reference > ice:commandLink

ice:commandLink

The ice:commandLink tag displays a link that can be linked to an application action or action listener method in a backing bean by specifying the bean and action method in the action and actionListener attributes.

Example

<ice:commandLink value="Log Out"></ice:commandLink>

Rendered Output

Rendered ice:commandLink tag

Tag Attributes

accesskey Text
 
The accesskey attribute is a standard HTML attribute that sets the access key that transfers focus to this element when pressed.
action Text
 
The action attribute accepts a method-binding expression for a backing bean action method to invoke when this component is activated by the user. An action method must be a public method with no parameters that returns a String. The returned string represents the logical outcome of the action (eg. "success", "failure", etc.) and is used by the JavaServer Faces MVC framework to determine which view to display next.
actionListener Text
 
The actionListener attribute accepts a method-binding expression for a backing bean action listener method that will be notified when this component is activated by the user. An action listener method must be a public method with an javax.faces.event.ActionEvent parameter and a void return type.
binding Expression
 
The value-binding expression linking this component tag to a backing bean property.
charset Text
 
The charset attribute identifies the character encoding of the resource linked to by this hyperlink.
coords Text
 
The coords attribute sets the position and shape of the hotspot on the screen when using this link with a client-side image map.
dir Enumerated
 
The dir attribute is a standard HTML attribute that overrides the default text directionality for this component. The values accepted for this component are "LTR" (left-to-right) and "RTL" (right-to-left).
disabled Boolean
 
The disabled attribute is a boolean flag that when set to true indicates that this component should not receive focus or be included in a form submit.
effect Text
 
The effect attribute sets the JavaScript effect.
enabledOnUserRole Text
 
The enabledOnUserRole attribute is a boolean flag that when set to "true" and if a role has been configured for the user, then the component will be displayed and will function. If the user does not have a role, then the component will be disabled (will not function) and will be grayed out.
hreflang Text
 
The hreflang attribute identifies the language code of the resource linked to by this hyperlink.
id Text
 
The unique identifier value for this component. The value must be unique within the closest naming container.
immediate Boolean
 
The immediate attribute is a boolean flag indicating that component events should be sent to registered event listeners immediately rather than after the validation phase of the JSF request processing lifecycle. The immediate flag allows you bypass JSF validation for a particular component.
lang Text
 
The lang attribute is a standard HTML attribute that sets the code describing the language to be used in the markup generated by this component.
onblur Text
 
The onblur attribute sets the JavaScript code to execute when this element loses focus.
onclick Text
 
The onclick attribute sets the JavaScript code to execute when the mouse pointer is clicked over this element.
onclickeffect Text
 
The onclickeffect attribute sets the effect to invoke when when the mouse pointer is clicked over this element.
ondblclick Text
 
The ondblclick attribute sets the JavaScript code to execute when the mouse pointer is double-clicked over this element.
ondblclickeffect Text
 
The ondblclickeffect attribute sets the effect to invoke when the mouse pointer is double-clicked over this element.
onfocus Text
 
The onfocus attribute sets the JavaScript code to execute when the element receives focus.
onkeydown Text
 
The onkeydown attribute sets the JavaScript code to execute when a key is pressed down over this element.
onkeydowneffect Text
 
The onkeydowneffect attribute sets the effect to invoke when a key is pressed down over this element.
onkeypress Text
 
The onkeypress attribute sets the JavaScript code to execute when a key is pressed and released over this element.
onkeypresseffect Text
 
The onkeypresseffect attribute sets the effect to invoke when a key is pressed and released over this element.
onkeyup Text
 
The onkeyup attribute sets the JavaScript code to execute when a key is released over this element.
onkeyupeffect Text
 
The onkeyupeffect attribute sets the effect to invoke when a key is released over this element.
onmousedown Text
 
The onmousedown attribute sets the JavaScript code to execute when the mouse pointer is pressed down over this element.
onmousedowneffect Text
 
The onmousedowneffect attribute sets the effect to invoke when the mouse pointer is pressed down over this element.
onmousemove Text
 
The onmousemove attribute sets the JavaScript code to execute when the mouse pointer is moved within this element.
onmousemoveeffect Text
 
The onmousemoveeffect attribute sets the effect to invoke when the mouse pointer is moved within this element.
onmouseout Text
 
The onmouseout attribute sets the JavaScript code to execute when the mouse pointer is moved away from this element.
onmouseouteffect Text
 
The onmouseouteffect attribute sets the effect to invoke when the mouse pointer is moved away from this element.
onmouseover Text
 
The onmouseover attribute sets the JavaScript code to execute when the mouse pointer is moved onto this element.
onmouseovereffect Text
 
The onmouseovereffect attribute sets the effect to invoke when the mouse pointer is moved onto this element.
onmouseup Text
 
The onmouseup attribute sets the JavaScript code to execute when the mouse button is released over this element.
onmouseupeffect Text
 
The onmouseupeffect attribute sets the effect to invoke when the mouse button is released over this element.
partialSubmit Boolean
 
The partialSubmit attribute is a boolean flag that when set to "true" will allow the component to activate a partial submit of the form.
rel Text
 
The rel attribute identifies 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.
rendered Boolean
 
A value-binding expression that evaluates to a Boolean condition indicating if this component should be rendered.
renderedOnUserRole Text
 
The renderedOnUserRole attribute is a boolean flag that when set to "true" and if a role has been configured for the user, then the component will be displayed. If the user does not have a role, then the component will not be displayed.
rev Text
 
The rev attribute identifies 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.
shape Enumerated
 
The shape attribute sets the shape of the hotspot on the screen when using this link with a client-side image map. The valid values for this attribute are: default (entire region), rect (rectangular region), circle (circular region), and poly (polygonal region).
style CSS Style
 
The style attribute sets the CSS style definition to be applied to this component when it is rendered.
styleClass CSS Class
 
The styleClass attribute sets the CSS class to apply to this component when it is rendered. Default value is iceCmdLnk if enabled and iceCmdLnk-dis if disabled.
tabindex Text
 
The tabindex attribute is a standard HTML attribute that sets the order in which this element receives focus when the user cycles through the elements using the TAB key. The value for this attribute must be an integer between 0 and 32767.
target Text
 
The target attribute identifies the name of a frame into which the resource retrieved by this hyperlink should be displayed.
title Text
 
The title attribute is a standard HTML attribute that sets the tooltip text to display for the rendered component.
type Text
 
The type attribute sets the content type of the resource designated by this hyperlink.
value Text
 
The value attribute sets the current value for this component.
visible Boolean
 
The visible attribute is a boolean flag that when set to "true", displays the component. If this attribute is set to "false", then the CSS style is display:none.