HTML_BASIC render-kit
component-family: javax.faces.Command renderer-type: javax.faces.Link


Render an HTML "a" anchor element that acts like a form submit button when clicked.

General Behaviour

Both the encode and decode behavior require the ability to get the id/name for a hidden field, which may be rendered in markup or which may be programmatically added via client DOM manipulation, whose value is set by the JavaScript form submit. This name must be constructed as follows:

In the following text, this String is called hiddenFieldName.

Decode Behavior

Encode Behavior

To support entering flows that are defined by both a defining document id and a flow id, add a component attribute to this component whose name is given by the value of the symbolic constant javax.faces.event.ActionListener.TO_FLOW_DOCUMENT_ID_ATTR_NAME, and whose value is the defining document id. For example, when using this component in a facelet page, the following markup would cause such an attribute to be added.

<h:commandLink id="start_a" value="enter flow-a" action="flow-a">
  <f:attribute name="to-flow-document-id" value="unique"/>
</h:commandLink>

This renderer is responsible for rendering its children.


Note:

Attributes with a ignored-by-renderer value of true are not interpreted by the renderer and are conveyed straight to the rendered markup, without checking for validity. Attributes with a ignored-by-renderer value of false are interpreted by the renderer, and may or may not be checked for validity by the renderer.

Attributes
attribute-name ignored-by-renderer attribute-class description default-value
 accesskey true java.lang.String Access key that, when pressed, transfers focus to this element. undefined
 charset true java.lang.String The character encoding of the resource designated by this hyperlink. undefined
 coords true java.lang.String The position and shape of the hot spot on the screen (for use in client-side image maps). undefined
 dir true java.lang.String Direction indication for text that does not inherit directionality. Valid values are "LTR" (left-to-right) and "RTL" (right-to-left). These attributes are case sensitive when rendering to XHTML, so care must be taken to have the correct case. undefined
 disabled false boolean Flag indicating that this element must never receive focus or be included in a subsequent submit. undefined
 hreflang true java.lang.String The language code of the resource designated by this hyperlink. undefined
 lang true java.lang.String Code describing the language used in the generated markup for this component. undefined
 onblur true java.lang.String Javascript code executed when this element loses focus. undefined
 onclick false java.lang.String Javascript code executed when a pointer button is clicked over this element. undefined
 ondblclick true java.lang.String Javascript code executed when a pointer button is double clicked over this element. undefined
 onfocus true java.lang.String Javascript code executed when this element receives focus. undefined
 onkeydown true java.lang.String Javascript code executed when a key is pressed down over this element. undefined
 onkeypress true java.lang.String Javascript code executed when a key is pressed and released over this element. undefined
 onkeyup true java.lang.String Javascript code executed when a key is released over this element. undefined
 onmousedown true java.lang.String Javascript code executed when a pointer button is pressed down over this element. undefined
 onmousemove true java.lang.String Javascript code executed when a pointer button is moved within this element. undefined
 onmouseout true java.lang.String Javascript code executed when a pointer button is moved away from this element. undefined
 onmouseover true java.lang.String Javascript code executed when a pointer button is moved onto this element. undefined
 onmouseup true java.lang.String Javascript code executed when a pointer button is released over this element. undefined
 rel true 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. undefined
 rev true 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. undefined
 role true 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.

undefined
 shape true 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). undefined
 style true java.lang.String CSS style(s) to be applied when this component is rendered. undefined
 styleClass false 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. undefined
 tabindex true 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. undefined
 target false java.lang.String Name of a frame where the resource retrieved via this hyperlink is to be displayed. undefined
 title true java.lang.String Advisory title information about markup elements generated for this component. undefined
 type true java.lang.String The content type of the resource designated by this hyperlink. undefined

Copyright (c) 2003-2017 Oracle America, Inc. All Rights Reserved.