Top Description Inners Fields Constructors Methods
jakarta.faces.component.html

public Class HtmlOutputLink

extends UIOutput
implements ClientBehaviorHolder
Class Inheritance
All Implemented Interfaces
jakarta.faces.component.behavior.ClientBehaviorHolder
Imports
java.util.ArrayList, .Arrays, .Collection, .Collections, .List, jakarta.el.ValueExpression, jakarta.faces.component.UIOutput, jakarta.faces.component.behavior.ClientBehaviorHolder

Represents an HTML a (hyperlink) element that may be used to link to an arbitrary URL defined by the value property.

By default, the rendererType property must be set to "jakarta.faces.Link". This value can be changed by calling the setRendererType() method.

Nested and Inner Type Summary

Modifier and TypeClass and Description
protected static enum
HtmlOutputLink.PropertyKeys

The property keys.

Field Summary

Modifier and TypeField and Description
public static final String
COMPONENT_TYPE

Hides jakarta.faces.component.UIOutput.COMPONENT_TYPE.

The standard component type for this component.

private static final Collection<String>
EVENT_NAMES

private static final String
OPTIMIZED_PACKAGE

Inherited from jakarta.faces.component.UIOutput:
COMPONENT_FAMILY

Constructor Summary

AccessConstructor and Description

Method Summary

Modifier and TypeMethod and Description
public String

Returns:

the property value

Contents: Access key that, when pressed, transfers focus to this element.

getAccesskey()

Return the value of the accesskey property.

public String

Returns:

the property value

Contents: The character encoding of the resource designated by this hyperlink.

getCharset()

Return the value of the charset property.

public String

Returns:

the property value

Contents: The position and shape of the hot spot on the screen (for use in client-side image maps).

getCoords()

Return the value of the coords property.

public String
getDefaultEventName()

Overrides jakarta.faces.component.UIComponentBase.getDefaultEventName.

Implements jakarta.faces.component.behavior.ClientBehaviorHolder.getDefaultEventName.

Returns the default event name for this ClientBehaviorHolder implementation.

public String

Returns:

the property value

Contents: 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.

getDir()

Return the value of the dir property.

public Collection<String>
getEventNames()

Overrides jakarta.faces.component.UIComponentBase.getEventNames.

Implements jakarta.faces.component.behavior.ClientBehaviorHolder.getEventNames.

Returns a non-null, unmodifiable Collection containing the names of the logical events supported by the component implementing this interface.

public String

Returns:

the property value

Contents: The identifier of the page fragment which should be brought into focus when the target page is rendered. The value of this attribute is appended to the end of target URL following a hash (#) mark. This notation is part of the standard URL syntax.

getFragment()

Return the value of the fragment property.

public String

Returns:

the property value

Contents: The language code of the resource designated by this hyperlink.

getHreflang()

Return the value of the hreflang property.

public String

Returns:

the property value

Contents: Code describing the language used in the generated markup for this component.

getLang()

Return the value of the lang property.

public String

Returns:

the property value

Contents: Javascript code executed when this element loses focus.

getOnblur()

Return the value of the onblur property.

public String

Returns:

the property value

Contents: Javascript code executed when a pointer button is clicked over this element.

getOnclick()

Return the value of the onclick property.

public String

Returns:

the property value

Contents: Javascript code executed when a pointer button is double clicked over this element.

getOndblclick()

Return the value of the ondblclick property.

public String

Returns:

the property value

Contents: Javascript code executed when this element receives focus.

getOnfocus()

Return the value of the onfocus property.

public String

Returns:

the property value

Contents: Javascript code executed when a key is pressed down over this element.

getOnkeydown()

Return the value of the onkeydown property.

public String

Returns:

the property value

Contents: Javascript code executed when a key is pressed and released over this element.

getOnkeypress()

Return the value of the onkeypress property.

public String

Returns:

the property value

Contents: Javascript code executed when a key is released over this element.

getOnkeyup()

Return the value of the onkeyup property.

public String

Returns:

the property value

Contents: Javascript code executed when a pointer button is pressed down over this element.

getOnmousedown()

Return the value of the onmousedown property.

public String

Returns:

the property value

Contents: Javascript code executed when a pointer button is moved within this element.

getOnmousemove()

Return the value of the onmousemove property.

public String

Returns:

the property value

Contents: Javascript code executed when a pointer button is moved away from this element.

getOnmouseout()

Return the value of the onmouseout property.

public String

Returns:

the property value

Contents: Javascript code executed when a pointer button is moved onto this element.

getOnmouseover()

Return the value of the onmouseover property.

public String

Returns:

the property value

Contents: Javascript code executed when a pointer button is released over this element.

getOnmouseup()

Return the value of the onmouseup property.

public String

Returns:

the property value

Contents: 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.

getRel()

Return the value of the rel property.

public String

Returns:

the property value

Contents: 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.

getRev()

Return the value of the rev property.

public String

Returns:

the property value

Contents:

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.

getRole()

Return the value of the role property.

public String

Returns:

the property value

Contents: 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).

getShape()

Return the value of the shape property.

public String

Returns:

the property value

Contents: CSS style(s) to be applied when this component is rendered.

getStyle()

Return the value of the style property.

public String

Returns:

the property value

Contents: 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.

getStyleClass()

Return the value of the styleClass property.

public String

Returns:

the property value

Contents: Position of this element in the tabbing order for the current document. This value must be an integer between 0 and 32767.

getTabindex()

Return the value of the tabindex property.

public String

Returns:

the property value

Contents: Name of a frame where the resource retrieved via this hyperlink is to be displayed.

getTarget()

Return the value of the target property.

public String

Returns:

the property value

Contents: Advisory title information about markup elements generated for this component.

getTitle()

Return the value of the title property.

public String

Returns:

the property value

Contents: The content type of the resource designated by this hyperlink.

getType()

Return the value of the type property.

private void
handleAttribute(String name, Object value)

public boolean

Returns:

the property value

Contents: Flag indicating that this element must never receive focus or be included in a subsequent submit.

isDisabled()

Return the value of the disabled property.

public void
setAccesskey(String
the new property value
accesskey)

Set the value of the accesskey property.

public void
setCharset(String
the new property value
charset)

Set the value of the charset property.

public void
setCoords(String
the new property value
coords)

Set the value of the coords property.

public void
setDir(String
the new property value
dir)

Set the value of the dir property.

public void
setDisabled(boolean
the new property value
disabled)

Set the value of the disabled property.

public void
setFragment(String
the new property value
fragment)

Set the value of the fragment property.

public void
setHreflang(String
the new property value
hreflang)

Set the value of the hreflang property.

public void
setLang(String
the new property value
lang)

Set the value of the lang property.

public void
setOnblur(String
the new property value
onblur)

Set the value of the onblur property.

public void
setOnclick(String
the new property value
onclick)

Set the value of the onclick property.

public void
setOndblclick(String
the new property value
ondblclick)

Set the value of the ondblclick property.

public void
setOnfocus(String
the new property value
onfocus)

Set the value of the onfocus property.

public void
setOnkeydown(String
the new property value
onkeydown)

Set the value of the onkeydown property.

public void
setOnkeypress(String
the new property value
onkeypress)

Set the value of the onkeypress property.

public void
setOnkeyup(String
the new property value
onkeyup)

Set the value of the onkeyup property.

public void
setOnmousedown(String
the new property value
onmousedown)

Set the value of the onmousedown property.

public void
setOnmousemove(String
the new property value
onmousemove)

Set the value of the onmousemove property.

public void
setOnmouseout(String
the new property value
onmouseout)

Set the value of the onmouseout property.

public void
setOnmouseover(String
the new property value
onmouseover)

Set the value of the onmouseover property.

public void
setOnmouseup(String
the new property value
onmouseup)

Set the value of the onmouseup property.

public void
setRel(String
the new property value
rel)

Set the value of the rel property.

public void
setRev(String
the new property value
rev)

Set the value of the rev property.

public void
setRole(String
the new property value
role)

Set the value of the role property.

public void
setShape(String
the new property value
shape)

Set the value of the shape property.

public void
setStyle(String
the new property value
style)

Set the value of the style property.

public void
setStyleClass(String
the new property value
styleClass)

Set the value of the styleClass property.

public void
setTabindex(String
the new property value
tabindex)

Set the value of the tabindex property.

public void
setTarget(String
the new property value
target)

Set the value of the target property.

public void
setTitle(String
the new property value
title)

Set the value of the title property.

public void
setType(String
the new property value
type)

Set the value of the type property.

Inherited from jakarta.faces.component.UIOutput:
clearInitialStategetConvertergetFamilygetLocalValuegetValuemarkInitialStateresetValuerestoreStatesaveStatesetConvertersetValue