outputLink (Jakarta Server Faces 2.3.2 VDL Documentation)

Description:

Render an HTML "a" anchor element. The value of the component is rendered as the value of the "href" attribute. Any child UIParameter components are appended to the String to be output as the value of the "href" attribute as query parameters before rendering. The entire "href" string must be passed through a call to the encodeResourceURL() method of the ExternalContext. The name of the UIParameter goes on the left hand side, and the value of the UIParameter on the right hand side. The name and the value must be URLEncoded. Each UIParameter instance is separeted by an ampersand, as dictated in the URL spec. If the "styleClass" attribute is specified, render its value as the value of the "class" attribute. If the "id" attribute is specified, follow the same steps as mentioned in the "General Notes on Encoding" regarding the "id" attribute for UIInput components. If the "disabled" attribute is specified, do not render the HTML "a" anchor element or the "href" element. Instead, render a "span" element. If the "styleClass" attribute is specified, render its value as the value of the "class" attribute on the "span". Render any pass-through attributes on the "span".

Component Information
Info	Value
Component Type	`javax.faces.HtmlOutputLink`
Handler Class	None
Renderer Type	`javax.faces.Link`
Description	None

Attributes
Name	Required	Type	Description
`converter`	`false`	`javax.el.ValueExpression` (must evaluate to `javax.faces.convert.Converter`)	Converter instance registered with this component.
`id`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	The component identifier for this component. This value must be unique within the closest parent component that is a naming container.
`rendered`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.Boolean`)	Flag indicating whether or not this component should be rendered (during Render Response Phase), or processed on any subsequent form submit. The default value for this property is true.
`value`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.Object`)	The current value of this component.
`accesskey`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	Access key that, when pressed, transfers focus to this element.
`charset`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	The character encoding of the resource designated by this hyperlink.
`coords`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	The position and shape of the hot spot on the screen (for use in client-side 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" (left-to-right) and "RTL" (right-to-left).
`disabled`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.Boolean`)	Flag indicating that this element must never receive focus or be included in a subsequent submit.
`hreflang`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	The language code of the resource designated by this hyperlink.
`lang`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	Code describing the language used in the generated markup for this component.
`onblur`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	Javascript code executed when this element loses focus.
`onclick`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	Javascript code executed when a pointer button is clicked over this element.
`ondblclick`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	Javascript code executed when a pointer button is double clicked over this element.
`onfocus`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	Javascript code executed when this element receives focus.
`onkeydown`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	Javascript code executed when a key is pressed down over this element.
`onkeypress`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	Javascript code executed when a key is pressed and released over this element.
`onkeyup`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	Javascript code executed when a key is released over this element.
`onmousedown`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	Javascript code executed when a pointer button is pressed down over this element.
`onmousemove`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	Javascript code executed when a pointer button is moved within this element.
`onmouseout`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	Javascript code executed when a pointer button is moved away from this element.
`onmouseover`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	Javascript code executed when a pointer button is moved onto this element.
`onmouseup`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	Javascript code executed when a pointer button is released over this element.
`rel`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	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.
`rev`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	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`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	The shape of the hot spot on the screen (for use in client-side image maps). Valid values are: default (entire region); rect (rectangular region); circle (circular region); and poly (polygonal region).
`style`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	CSS style(s) to be applied when this component is rendered.
`styleClass`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	Space-separated list of CSS style class(es) to be applied when this element is rendered. This value must be passed through as the "class" attribute on generated markup.
`tabindex`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	Position of this element in the tabbing order for the current document. This value must be an integer between 0 and 32767.
`target`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	Name of a frame where the resource retrieved via this hyperlink is to be displayed.
`title`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	Advisory title information about markup elements generated for this component.
`type`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	The content type of the resource designated by this hyperlink.
`binding`	`false`	`javax.el.ValueExpression` (must evaluate to `javax.faces.component.UIComponent`)	The ValueExpression linking this component to a property in a backing bean
`role`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	Per the WAI-ARIA spec and its relationship to HTML5 (Section title ARIA Role Attriubute), every HTML element may have a "role" attribute whose value must be passed through unmodified on the element on which it is declared in the final rendered markup. The attribute, if specified, must have a value that is a string literal that is, or an EL Expression that evaluates to, a set of space-separated tokens representing the various WAI-ARIA roles that the element belongs to. It is the page author's responsibility to ensure that the user agent is capable of correctly interpreting the value of this attribute.

html_basic

Tag outputLink