Tobago Components
Tag link

Renders a link element.

UIComponentClass: org.apache.myfaces.tobago.component.UILinkCommand

RendererType: Link

Supported facets:

Contains a UIOutput instance with the confirmation message.
Contains a UIPopup instance.

Tag Information
Tag Classorg.apache.myfaces.tobago.taglib.component.LinkTag
TagExtraInfo Classorg.apache.myfaces.tobago.taglib.component.CommandTagExtraInfo
Body ContentJSP
Display NameNone

actionfalsetruejava.lang.StringAction to invoke when clicked. This must be a MethodBinding or a String representing the application action to invoke when this component is activated by the user. The MethodBinding must evaluate to a public method that takes no parameters, and returns a String (the logical outcome) which is passed to the NavigationHandler for this application. The String is directly passed to the Navigationhandler.
Type: javax.faces.el.MethodBinding
actionListenerfalsetruejava.lang.StringMethodBinding representing an action listener method that will be notified when this component is activated by the user. The expression must evaluate to a public method that takes an ActionEvent parameter, with a return type of void.
Type: javax.faces.el.MethodBinding
immediatefalsetruejava.lang.StringFlag indicating that, if this component is activated by the user, notifications should be delivered to interested listeners and actions immediately (that is, during Apply Request Values phase) rather than waiting until Invoke Application phase.
Type: java.lang.Boolean
Default: false
onclickfalsetruejava.lang.StringScript to be invoked when clicked
Type: java.lang.String
linkfalsetruejava.lang.StringLink to an arbitrary URL, either an internal link or an external link.
internal absolute link
Starts with a slash '/' character. The context path will be added. A session id will be added, if needed.
external link
Contains a colon ':' character. The link will not be modified.
internal relative link
Any other strings. A session id will be added, if needed.

Type: java.lang.String
jsfResourcefalsetruejava.lang.StringFlag indicating that the resource referenced by the resource attribute is a jsf resource. That means that the url has to be processed to change the prefix or suffix (e. g. *.jsf or /faces/*). Default is false.
Type: java.lang.Boolean
resourcefalsetruejava.lang.StringLink to an internal resource. Resources will be processed by the resource management. E. g. define help.html and it will be served help_es.html or help_de.html if available. For JSF-Pages you have to set the jsfResource attribute.
Type: java.lang.String
transitionfalsetruejava.lang.StringSpecify, if the command calls an JSF-Action. Useful to switch off the Double-Submit-Check and Waiting-Behavior.
Type: java.lang.Boolean
Default: true
idfalsetruejava.lang.StringThe component identifier for this component. This value must be unique within the closest parent component that is a naming container.
Type: java.lang.String
bindingfalsetruejava.lang.StringThe value binding expression linking this component to a property in a backing bean.

Warning: For the tobago extension library tx the binding differs from JSP and Facelets:

  • JSP: The component is the inner main control (e. g. UIInput).
  • Facelets: The component is the outer UIPanel.
renderedfalsetruejava.lang.StringFlag indicating whether or not this component should be rendered (during Render Response Phase), or processed on any subsequent form submit.
Type: java.lang.Boolean
Default: true
labelfalsetruejava.lang.StringText value to display as label. If text contains an underscore the next character is used as accesskey.
Type: java.lang.String

**** @deprecated. Will be removed in a future version ****

Deprecated! Has not longer any function. See label attribute.
Type: [java.lang.String, java.lang.Character]

**** @deprecated. Will be removed in a future version ****

Deprecated! Use 'label' instead. Text value to display as label. If text contains an underscore the next character overwrites 'accesskey'.
Type: java.lang.String
disabledfalsetruejava.lang.StringFlag indicating that this element is disabled.
Type: java.lang.Boolean
inlinefalsetruejava.lang.StringFlag indicating this component should rendered as an inline element.
Type: java.lang.Boolean

**** @deprecated. Will be removed in a future version ****

Type of command component to create. Valid values are 'navigate', 'reset', 'script' or 'submit'. If not specified, or not a valid value, the default value is 'submit' is used.

Deprecation info:

  • Instead of 'navigate' please use the link attribute.
  • Instead of 'script' please use the onclick attribute.
  • 'submit' is the default, so you can omit it.
  • 'reset' should not be used, but can emulated by the application (e.g. cancel button).

Type: java.lang.String
Default: submit
targetfalsetruejava.lang.StringName of a frame where the resource retrieved via this hyperlink is to be displayed.
Type: java.lang.String
tipfalsetruejava.lang.StringText value to display as tooltip.
Type: java.lang.String
imagefalsetruejava.lang.StringUrl to an image to display.
Type: java.lang.String
markupfalsetruejava.lang.StringIndicate markup of this component. Possible value is 'none'. But this can be overridden in the theme.
Type: java.lang.String
Default: none
tabIndexfalsetruejava.lang.StringControls the navigation of the focus through the input controls on a page with the Tab-Key. The navigation starts from the element with the lowest tabIndex value to the element with the highest value. Elements that have identical tabIndex values should be navigated in the order they appear in the character stream Elements that are disabled or with a negative tabIndex do not participate in the tabbing order.
Type: java.lang.String

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.