Field Detail

• COMPONENT_TYPE

  public static final java.lang.String COMPONENT_TYPE

  The standard component type for this component.

  See Also:

  Constant Field Values

Constructor Detail

• HtmlOutputLink

  public HtmlOutputLink()

Method Detail

• getAccesskey

  public java.lang.String getAccesskey()

  Return the value of the accesskey property.

  Returns:

  the property value

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

• setAccesskey

  public void setAccesskey(java.lang.String accesskey)

  Set the value of the accesskey property.

  Parameters:

  accesskey - the new property value

• getCharset

  public java.lang.String getCharset()

  Return the value of the charset property.

  Returns:

  the property value

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

• setCharset

  public void setCharset(java.lang.String charset)

  Set the value of the charset property.

  Parameters:

  charset - the new property value

• getCoords

  public java.lang.String getCoords()

  Return the value of the coords property.

  Returns:

  the property value

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

• setCoords

  public void setCoords(java.lang.String coords)

  Set the value of the coords property.

  Parameters:

  coords - the new property value

• getDir

  public java.lang.String getDir()

  Return the value of the dir property.

  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.

• setDir

  public void setDir(java.lang.String dir)

  Set the value of the dir property.

  Parameters:

  dir - the new property value

• isDisabled

  public boolean isDisabled()

  Return the value of the disabled property.

  Returns:

  the property value

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

• setDisabled

  public void setDisabled(boolean disabled)

  Set the value of the disabled property.

  Parameters:

  disabled - the new property value

• getFragment

  public java.lang.String getFragment()

  Return the value of the fragment property.

  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.

• setFragment

  public void setFragment(java.lang.String fragment)

  Set the value of the fragment property.

  Parameters:

  fragment - the new property value

• getHreflang

  public java.lang.String getHreflang()

  Return the value of the hreflang property.

  Returns:

  the property value

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

• setHreflang

  public void setHreflang(java.lang.String hreflang)

  Set the value of the hreflang property.

  Parameters:

  hreflang - the new property value

• getLang

  public java.lang.String getLang()

  Return the value of the lang property.

  Returns:

  the property value

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

• setLang

  public void setLang(java.lang.String lang)

  Set the value of the lang property.

  Parameters:

  lang - the new property value

• getOnblur

  public java.lang.String getOnblur()

  Return the value of the onblur property.

  Returns:

  the property value

  Contents: Javascript code executed when this element loses focus.

• setOnblur

  public void setOnblur(java.lang.String onblur)

  Set the value of the onblur property.

  Parameters:

  onblur - the new property value

• getOnclick

  public java.lang.String getOnclick()

  Return the value of the onclick property.

  Returns:

  the property value

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

• setOnclick

  public void setOnclick(java.lang.String onclick)

  Set the value of the onclick property.

  Parameters:

  onclick - the new property value

• getOndblclick

  public java.lang.String getOndblclick()

  Return the value of the ondblclick property.

  Returns:

  the property value

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

• setOndblclick

  public void setOndblclick(java.lang.String ondblclick)

  Set the value of the ondblclick property.

  Parameters:

  ondblclick - the new property value

• getOnfocus

  public java.lang.String getOnfocus()

  Return the value of the onfocus property.

  Returns:

  the property value

  Contents: Javascript code executed when this element receives focus.

• setOnfocus

  public void setOnfocus(java.lang.String onfocus)

  Set the value of the onfocus property.

  Parameters:

  onfocus - the new property value

• getOnkeydown

  public java.lang.String getOnkeydown()

  Return the value of the onkeydown property.

  Returns:

  the property value

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

• setOnkeydown

  public void setOnkeydown(java.lang.String onkeydown)

  Set the value of the onkeydown property.

  Parameters:

  onkeydown - the new property value

• getOnkeypress

  public java.lang.String getOnkeypress()

  Return the value of the onkeypress property.

  Returns:

  the property value

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

• setOnkeypress

  public void setOnkeypress(java.lang.String onkeypress)

  Set the value of the onkeypress property.

  Parameters:

  onkeypress - the new property value

• getOnkeyup

  public java.lang.String getOnkeyup()

  Return the value of the onkeyup property.

  Returns:

  the property value

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

• setOnkeyup

  public void setOnkeyup(java.lang.String onkeyup)

  Set the value of the onkeyup property.

  Parameters:

  onkeyup - the new property value

• getOnmousedown

  public java.lang.String getOnmousedown()

  Return the value of the onmousedown property.

  Returns:

  the property value

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

• setOnmousedown

  public void setOnmousedown(java.lang.String onmousedown)

  Set the value of the onmousedown property.

  Parameters:

  onmousedown - the new property value

• getOnmousemove

  public java.lang.String getOnmousemove()

  Return the value of the onmousemove property.

  Returns:

  the property value

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

• setOnmousemove

  public void setOnmousemove(java.lang.String onmousemove)

  Set the value of the onmousemove property.

  Parameters:

  onmousemove - the new property value

• getOnmouseout

  public java.lang.String getOnmouseout()

  Return the value of the onmouseout property.

  Returns:

  the property value

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

• setOnmouseout

  public void setOnmouseout(java.lang.String onmouseout)

  Set the value of the onmouseout property.

  Parameters:

  onmouseout - the new property value

• getOnmouseover

  public java.lang.String getOnmouseover()

  Return the value of the onmouseover property.

  Returns:

  the property value

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

• setOnmouseover

  public void setOnmouseover(java.lang.String onmouseover)

  Set the value of the onmouseover property.

  Parameters:

  onmouseover - the new property value

• getOnmouseup

  public java.lang.String getOnmouseup()

  Return the value of the onmouseup property.

  Returns:

  the property value

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

• setOnmouseup

  public void setOnmouseup(java.lang.String onmouseup)

  Set the value of the onmouseup property.

  Parameters:

  onmouseup - the new property value

• getRel

  public java.lang.String getRel()

  Return the value of the rel property.

  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.

• setRel

  public void setRel(java.lang.String rel)

  Set the value of the rel property.

  Parameters:

  rel - the new property value

• getRev

  public java.lang.String getRev()

  Return the value of the rev property.

  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.

• setRev

  public void setRev(java.lang.String rev)

  Set the value of the rev property.

  Parameters:

  rev - the new property value

• getRole

  public java.lang.String getRole()

  Return the value of the role property.

  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.

• setRole

  public void setRole(java.lang.String role)

  Set the value of the role property.

  Parameters:

  role - the new property value

• getShape

  public java.lang.String getShape()

  Return the value of the shape property.

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

• setShape

  public void setShape(java.lang.String shape)

  Set the value of the shape property.

  Parameters:

  shape - the new property value

• getStyle

  public java.lang.String getStyle()

  Return the value of the style property.

  Returns:

  the property value

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

• setStyle

  public void setStyle(java.lang.String style)

  Set the value of the style property.

  Parameters:

  style - the new property value

• getStyleClass

  public java.lang.String getStyleClass()

  Return the value of the styleClass property.

  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.

• setStyleClass

  public void setStyleClass(java.lang.String styleClass)

  Set the value of the styleClass property.

  Parameters:

  styleClass - the new property value

• getTabindex

  public java.lang.String getTabindex()

  Return the value of the tabindex property.

  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.

• setTabindex

  public void setTabindex(java.lang.String tabindex)

  Set the value of the tabindex property.

  Parameters:

  tabindex - the new property value

• getTarget

  public java.lang.String getTarget()

  Return the value of the target property.

  Returns:

  the property value

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

• setTarget

  public void setTarget(java.lang.String target)

  Set the value of the target property.

  Parameters:

  target - the new property value

• getTitle

  public java.lang.String getTitle()

  Return the value of the title property.

  Returns:

  the property value

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

• setTitle

  public void setTitle(java.lang.String title)

  Set the value of the title property.

  Parameters:

  title - the new property value

• getType

  public java.lang.String getType()

  Return the value of the type property.

  Returns:

  the property value

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

• setType

  public void setType(java.lang.String type)

  Set the value of the type property.

  Parameters:

  type - the new property value

• getEventNames

  public java.util.Collection<java.lang.String> getEventNames()

  Description copied from class: UIComponentBase

  This is a default implementation of ClientBehaviorHolder.getEventNames(). UIComponent does not implement the ClientBehaviorHolder interface, but provides default implementations for the methods defined by ClientBehaviorHolder to simplify subclass implementations. Subclasses that wish to support the ClientBehaviorHolder contract must declare that the subclass implements ClientBehaviorHolder, and must override this method to return a non-Empty Collection of the client event names that the component supports.

  Specified by:

  getEventNames in interface ClientBehaviorHolder

  Overrides:

  getEventNames in class UIComponentBase

  Returns:

  the collection of event names.

• getDefaultEventName

  public java.lang.String getDefaultEventName()

  Description copied from class: UIComponentBase

  This is a default implementation of ClientBehaviorHolder.getDefaultEventName(). UIComponent does not implement the ClientBehaviorHolder interface, but provides default implementations for the methods defined by ClientBehaviorHolder to simplify subclass implementations. Subclasses that wish to support the ClientBehaviorHolder contract must declare that the subclass implements ClientBehaviorHolder, and must provide an implementation of ClientBehaviorHolder.getEventNames().

  Specified by:

  getDefaultEventName in interface ClientBehaviorHolder

  Overrides:

  getDefaultEventName in class UIComponentBase

  Returns:

  the default event name.