javax.faces.component.html
Class HtmlOutputLink

java.lang.Object
  extended by javax.faces.component.UIComponent
      extended by javax.faces.component.UIComponentBase
          extended by javax.faces.component.UIOutput
              extended by javax.faces.component.html.HtmlOutputLink
All Implemented Interfaces:
StateHolder, ValueHolder

public class HtmlOutputLink
extends UIOutput

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 "javax.faces.Link". This value can be changed by calling the setRendererType() method.


Field Summary
static java.lang.String COMPONENT_TYPE
          The standard component type for this component.
 
Fields inherited from class javax.faces.component.UIOutput
COMPONENT_FAMILY
 
Fields inherited from class javax.faces.component.UIComponent
bindings
 
Constructor Summary
HtmlOutputLink()
           
 
Method Summary
 java.lang.String getAccesskey()
          Return the value of the accesskey property.
 java.lang.String getCharset()
          Return the value of the charset property.
 java.lang.String getCoords()
          Return the value of the coords property.
 java.lang.String getDir()
          Return the value of the dir property.
 java.lang.String getHreflang()
          Return the value of the hreflang property.
 java.lang.String getLang()
          Return the value of the lang property.
 java.lang.String getOnblur()
          Return the value of the onblur property.
 java.lang.String getOnclick()
          Return the value of the onclick property.
 java.lang.String getOndblclick()
          Return the value of the ondblclick property.
 java.lang.String getOnfocus()
          Return the value of the onfocus property.
 java.lang.String getOnkeydown()
          Return the value of the onkeydown property.
 java.lang.String getOnkeypress()
          Return the value of the onkeypress property.
 java.lang.String getOnkeyup()
          Return the value of the onkeyup property.
 java.lang.String getOnmousedown()
          Return the value of the onmousedown property.
 java.lang.String getOnmousemove()
          Return the value of the onmousemove property.
 java.lang.String getOnmouseout()
          Return the value of the onmouseout property.
 java.lang.String getOnmouseover()
          Return the value of the onmouseover property.
 java.lang.String getOnmouseup()
          Return the value of the onmouseup property.
 java.lang.String getRel()
          Return the value of the rel property.
 java.lang.String getRev()
          Return the value of the rev property.
 java.lang.String getShape()
          Return the value of the shape property.
 java.lang.String getStyle()
          Return the value of the style property.
 java.lang.String getStyleClass()
          Return the value of the styleClass property.
 java.lang.String getTabindex()
          Return the value of the tabindex property.
 java.lang.String getTarget()
          Return the value of the target property.
 java.lang.String getTitle()
          Return the value of the title property.
 java.lang.String getType()
          Return the value of the type property.
 boolean isDisabled()
          Return the value of the disabled property.
 void restoreState(FacesContext _context, java.lang.Object _state)
           Perform any processing required to restore the state from the entries in the state Object.
 java.lang.Object saveState(FacesContext _context)
           Gets the state of the instance as a Serializable Object.
 void setAccesskey(java.lang.String accesskey)
          Set the value of the accesskey property.
 void setCharset(java.lang.String charset)
          Set the value of the charset property.
 void setCoords(java.lang.String coords)
          Set the value of the coords property.
 void setDir(java.lang.String dir)
          Set the value of the dir property.
 void setDisabled(boolean disabled)
          Set the value of the disabled property.
 void setHreflang(java.lang.String hreflang)
          Set the value of the hreflang property.
 void setLang(java.lang.String lang)
          Set the value of the lang property.
 void setOnblur(java.lang.String onblur)
          Set the value of the onblur property.
 void setOnclick(java.lang.String onclick)
          Set the value of the onclick property.
 void setOndblclick(java.lang.String ondblclick)
          Set the value of the ondblclick property.
 void setOnfocus(java.lang.String onfocus)
          Set the value of the onfocus property.
 void setOnkeydown(java.lang.String onkeydown)
          Set the value of the onkeydown property.
 void setOnkeypress(java.lang.String onkeypress)
          Set the value of the onkeypress property.
 void setOnkeyup(java.lang.String onkeyup)
          Set the value of the onkeyup property.
 void setOnmousedown(java.lang.String onmousedown)
          Set the value of the onmousedown property.
 void setOnmousemove(java.lang.String onmousemove)
          Set the value of the onmousemove property.
 void setOnmouseout(java.lang.String onmouseout)
          Set the value of the onmouseout property.
 void setOnmouseover(java.lang.String onmouseover)
          Set the value of the onmouseover property.
 void setOnmouseup(java.lang.String onmouseup)
          Set the value of the onmouseup property.
 void setRel(java.lang.String rel)
          Set the value of the rel property.
 void setRev(java.lang.String rev)
          Set the value of the rev property.
 void setShape(java.lang.String shape)
          Set the value of the shape property.
 void setStyle(java.lang.String style)
          Set the value of the style property.
 void setStyleClass(java.lang.String styleClass)
          Set the value of the styleClass property.
 void setTabindex(java.lang.String tabindex)
          Set the value of the tabindex property.
 void setTarget(java.lang.String target)
          Set the value of the target property.
 void setTitle(java.lang.String title)
          Set the value of the title property.
 void setType(java.lang.String type)
          Set the value of the type property.
 
Methods inherited from class javax.faces.component.UIOutput
getConverter, getFamily, getLocalValue, getValue, setConverter, setValue
 
Methods inherited from class javax.faces.component.UIComponentBase
addFacesListener, broadcast, decode, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientId, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getParent, getRenderer, getRendererType, getRendersChildren, getValueBinding, invokeOnComponent, isRendered, isTransient, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding
 
Methods inherited from class javax.faces.component.UIComponent
encodeAll, getContainerClientId, getValueExpression, setValueExpression
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

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.

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.


getCharset

public java.lang.String getCharset()

Return the value of the charset property.

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.


getCoords

public java.lang.String getCoords()

Return the value of the coords property.

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.


getDir

public java.lang.String getDir()

Return the value of the dir property.

Contents: Direction indication for text that does not inherit directionality. Valid values are "LTR" (left-to-right) and "RTL" (right-to-left).


setDir

public void setDir(java.lang.String dir)

Set the value of the dir property.


isDisabled

public boolean isDisabled()

Return the value of the disabled property.

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.


getHreflang

public java.lang.String getHreflang()

Return the value of the hreflang property.

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.


getLang

public java.lang.String getLang()

Return the value of the lang property.

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.


getOnblur

public java.lang.String getOnblur()

Return the value of the onblur property.

Contents: Javascript code executed when this element loses focus.


setOnblur

public void setOnblur(java.lang.String onblur)

Set the value of the onblur property.


getOnclick

public java.lang.String getOnclick()

Return the value of the onclick property.

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.


getOndblclick

public java.lang.String getOndblclick()

Return the value of the ondblclick property.

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.


getOnfocus

public java.lang.String getOnfocus()

Return the value of the onfocus property.

Contents: Javascript code executed when this element receives focus.


setOnfocus

public void setOnfocus(java.lang.String onfocus)

Set the value of the onfocus property.


getOnkeydown

public java.lang.String getOnkeydown()

Return the value of the onkeydown property.

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.


getOnkeypress

public java.lang.String getOnkeypress()

Return the value of the onkeypress property.

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.


getOnkeyup

public java.lang.String getOnkeyup()

Return the value of the onkeyup property.

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.


getOnmousedown

public java.lang.String getOnmousedown()

Return the value of the onmousedown property.

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.


getOnmousemove

public java.lang.String getOnmousemove()

Return the value of the onmousemove property.

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.


getOnmouseout

public java.lang.String getOnmouseout()

Return the value of the onmouseout property.

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.


getOnmouseover

public java.lang.String getOnmouseover()

Return the value of the onmouseover property.

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.


getOnmouseup

public java.lang.String getOnmouseup()

Return the value of the onmouseup property.

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.


getRel

public java.lang.String getRel()

Return the value of the rel property.

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.


getRev

public java.lang.String getRev()

Return the value of the rev property.

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.


getShape

public java.lang.String getShape()

Return the value of the shape property.

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.


getStyle

public java.lang.String getStyle()

Return the value of the style property.

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.


getStyleClass

public java.lang.String getStyleClass()

Return the value of the styleClass property.

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.


getTabindex

public java.lang.String getTabindex()

Return the value of the tabindex property.

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.


getTarget

public java.lang.String getTarget()

Return the value of the target property.

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.


getTitle

public java.lang.String getTitle()

Return the value of the title property.

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.


getType

public java.lang.String getType()

Return the value of the type property.

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.


saveState

public java.lang.Object saveState(FacesContext _context)
Description copied from interface: StateHolder

Gets the state of the instance as a Serializable Object.

If the class that implements this interface has references to instances that implement StateHolder (such as a UIComponent with event handlers, validators, etc.) this method must call the StateHolder.saveState(javax.faces.context.FacesContext) method on all those instances as well. This method must not save the state of children and facets. That is done via the StateManager

This method must not alter the state of the implementing object. In other words, after executing this code:

 Object state = component.saveState(facesContext);
 

component should be the same as before executing it.

The return from this method must be Serializable

Specified by:
saveState in interface StateHolder
Overrides:
saveState in class UIOutput

restoreState

public void restoreState(FacesContext _context,
                         java.lang.Object _state)
Description copied from interface: StateHolder

Perform any processing required to restore the state from the entries in the state Object.

If the class that implements this interface has references to instances that also implement StateHolder (such as a UIComponent with event handlers, validators, etc.) this method must call the StateHolder.restoreState(javax.faces.context.FacesContext, java.lang.Object) method on all those instances as well.

Specified by:
restoreState in interface StateHolder
Overrides:
restoreState in class UIOutput


Copyright 2002-2006 Sun Microsystems, Inc. All Rights Reserved.