Class HtmlOutputLink
- All Implemented Interfaces:
EventListener,ClientBehaviorHolder,PartialStateHolder,StateHolder,TransientStateHolder,ValueHolder,ComponentSystemEventListener,FacesListener,SystemEventListenerHolder
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.
-
Nested Class Summary
Nested Classes -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final StringThe standard component type for this component.Fields inherited from class javax.faces.component.UIOutput
COMPONENT_FAMILYFields inherited from class javax.faces.component.UIComponent
ATTRS_WITH_DECLARED_DEFAULT_VALUES, BEANINFO_KEY, bindings, COMPOSITE_COMPONENT_TYPE_KEY, COMPOSITE_FACET_NAME, CURRENT_COMPONENT, CURRENT_COMPOSITE_COMPONENT, FACETS_KEY, HONOR_CURRENT_COMPONENT_ATTRIBUTES_PARAM_NAME, VIEW_LOCATION_KEY -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionReturn the value of theaccesskeyproperty.Return the value of thecharsetproperty.Return the value of thecoordsproperty.This is a default implementation ofClientBehaviorHolder.getDefaultEventName().getDir()Return the value of thedirproperty.This is a default implementation ofClientBehaviorHolder.getEventNames().Return the value of thefragmentproperty.Return the value of thehreflangproperty.getLang()Return the value of thelangproperty.Return the value of theonblurproperty.Return the value of theonclickproperty.Return the value of theondblclickproperty.Return the value of theonfocusproperty.Return the value of theonkeydownproperty.Return the value of theonkeypressproperty.Return the value of theonkeyupproperty.Return the value of theonmousedownproperty.Return the value of theonmousemoveproperty.Return the value of theonmouseoutproperty.Return the value of theonmouseoverproperty.Return the value of theonmouseupproperty.getRel()Return the value of therelproperty.getRev()Return the value of therevproperty.getRole()Return the value of theroleproperty.getShape()Return the value of theshapeproperty.getStyle()Return the value of thestyleproperty.Return the value of thestyleClassproperty.Return the value of thetabindexproperty.Return the value of thetargetproperty.getTitle()Return the value of thetitleproperty.getType()Return the value of thetypeproperty.booleanReturn the value of thedisabledproperty.voidsetAccesskey(String accesskey) Set the value of theaccesskeyproperty.voidsetCharset(String charset) Set the value of thecharsetproperty.voidSet the value of thecoordsproperty.voidSet the value of thedirproperty.voidsetDisabled(boolean disabled) Set the value of thedisabledproperty.voidsetFragment(String fragment) Set the value of thefragmentproperty.voidsetHreflang(String hreflang) Set the value of thehreflangproperty.voidSet the value of thelangproperty.voidSet the value of theonblurproperty.voidsetOnclick(String onclick) Set the value of theonclickproperty.voidsetOndblclick(String ondblclick) Set the value of theondblclickproperty.voidsetOnfocus(String onfocus) Set the value of theonfocusproperty.voidsetOnkeydown(String onkeydown) Set the value of theonkeydownproperty.voidsetOnkeypress(String onkeypress) Set the value of theonkeypressproperty.voidsetOnkeyup(String onkeyup) Set the value of theonkeyupproperty.voidsetOnmousedown(String onmousedown) Set the value of theonmousedownproperty.voidsetOnmousemove(String onmousemove) Set the value of theonmousemoveproperty.voidsetOnmouseout(String onmouseout) Set the value of theonmouseoutproperty.voidsetOnmouseover(String onmouseover) Set the value of theonmouseoverproperty.voidsetOnmouseup(String onmouseup) Set the value of theonmouseupproperty.voidSet the value of therelproperty.voidSet the value of therevproperty.voidSet the value of theroleproperty.voidSet the value of theshapeproperty.voidSet the value of thestyleproperty.voidsetStyleClass(String styleClass) Set the value of thestyleClassproperty.voidsetTabindex(String tabindex) Set the value of thetabindexproperty.voidSet the value of thetargetproperty.voidSet the value of thetitleproperty.voidSet the value of thetypeproperty.Methods inherited from class javax.faces.component.UIOutput
clearInitialState, getConverter, getFamily, getLocalValue, getValue, markInitialState, resetValue, restoreState, saveState, setConverter, setValueMethods inherited from class javax.faces.component.UIComponentBase
addClientBehavior, addFacesListener, broadcast, decode, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getClientId, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getListenersForEventClass, getParent, getPassThroughAttributes, getRenderer, getRendererType, getRendersChildren, getValueBinding, invokeOnComponent, isRendered, isTransient, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding, subscribeToEvent, unsubscribeFromEventMethods inherited from class javax.faces.component.UIComponent
encodeAll, getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getNamingContainer, getPassThroughAttributes, getResourceBundleMap, getStateHelper, getStateHelper, getTransientStateHelper, getTransientStateHelper, getValueExpression, initialStateMarked, isCompositeComponent, isInView, isVisitable, popComponentFromEL, processEvent, pushComponentToEL, restoreTransientState, saveTransientState, setInView, setValueExpression, visitTreeMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface javax.faces.component.behavior.ClientBehaviorHolder
addClientBehavior, getClientBehaviors
-
Field Details
-
COMPONENT_TYPE
The standard component type for this component.
- See Also:
-
-
Constructor Details
-
HtmlOutputLink
public HtmlOutputLink()
-
-
Method Details
-
getAccesskey
Return the value of the
accesskeyproperty.Contents: Access key that, when pressed, transfers focus to this element.
-
setAccesskey
Set the value of the
accesskeyproperty. -
getCharset
Return the value of the
charsetproperty.Contents: The character encoding of the resource designated by this hyperlink.
-
setCharset
Set the value of the
charsetproperty. -
getCoords
Return the value of the
coordsproperty.Contents: The position and shape of the hot spot on the screen (for use in client-side image maps).
-
setCoords
Set the value of the
coordsproperty. -
getDir
Return the value of the
dirproperty.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
Set the value of the
dirproperty. -
isDisabled
public boolean isDisabled()Return the value of the
disabledproperty.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
disabledproperty. -
getFragment
Return the value of the
fragmentproperty.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
Set the value of the
fragmentproperty. -
getHreflang
Return the value of the
hreflangproperty.Contents: The language code of the resource designated by this hyperlink.
-
setHreflang
Set the value of the
hreflangproperty. -
getLang
Return the value of the
langproperty.Contents: Code describing the language used in the generated markup for this component.
-
setLang
Set the value of the
langproperty. -
getOnblur
Return the value of the
onblurproperty.Contents: Javascript code executed when this element loses focus.
-
setOnblur
Set the value of the
onblurproperty. -
getOnclick
Return the value of the
onclickproperty.Contents: Javascript code executed when a pointer button is clicked over this element.
-
setOnclick
Set the value of the
onclickproperty. -
getOndblclick
Return the value of the
ondblclickproperty.Contents: Javascript code executed when a pointer button is double clicked over this element.
-
setOndblclick
Set the value of the
ondblclickproperty. -
getOnfocus
Return the value of the
onfocusproperty.Contents: Javascript code executed when this element receives focus.
-
setOnfocus
Set the value of the
onfocusproperty. -
getOnkeydown
Return the value of the
onkeydownproperty.Contents: Javascript code executed when a key is pressed down over this element.
-
setOnkeydown
Set the value of the
onkeydownproperty. -
getOnkeypress
Return the value of the
onkeypressproperty.Contents: Javascript code executed when a key is pressed and released over this element.
-
setOnkeypress
Set the value of the
onkeypressproperty. -
getOnkeyup
Return the value of the
onkeyupproperty.Contents: Javascript code executed when a key is released over this element.
-
setOnkeyup
Set the value of the
onkeyupproperty. -
getOnmousedown
Return the value of the
onmousedownproperty.Contents: Javascript code executed when a pointer button is pressed down over this element.
-
setOnmousedown
Set the value of the
onmousedownproperty. -
getOnmousemove
Return the value of the
onmousemoveproperty.Contents: Javascript code executed when a pointer button is moved within this element.
-
setOnmousemove
Set the value of the
onmousemoveproperty. -
getOnmouseout
Return the value of the
onmouseoutproperty.Contents: Javascript code executed when a pointer button is moved away from this element.
-
setOnmouseout
Set the value of the
onmouseoutproperty. -
getOnmouseover
Return the value of the
onmouseoverproperty.Contents: Javascript code executed when a pointer button is moved onto this element.
-
setOnmouseover
Set the value of the
onmouseoverproperty. -
getOnmouseup
Return the value of the
onmouseupproperty.Contents: Javascript code executed when a pointer button is released over this element.
-
setOnmouseup
Set the value of the
onmouseupproperty. -
getRel
Return the value of the
relproperty.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
Set the value of the
relproperty. -
getRev
Return the value of the
revproperty.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
Set the value of the
revproperty. -
getRole
Return the value of the
roleproperty.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
Set the value of the
roleproperty. -
getShape
Return the value of the
shapeproperty.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
Set the value of the
shapeproperty. -
getStyle
Return the value of the
styleproperty.Contents: CSS style(s) to be applied when this component is rendered.
-
setStyle
Set the value of the
styleproperty. -
getStyleClass
Return the value of the
styleClassproperty.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
Set the value of the
styleClassproperty. -
getTabindex
Return the value of the
tabindexproperty.Contents: Position of this element in the tabbing order for the current document. This value must be an integer between 0 and 32767.
-
setTabindex
Set the value of the
tabindexproperty. -
getTarget
Return the value of the
targetproperty.Contents: Name of a frame where the resource retrieved via this hyperlink is to be displayed.
-
setTarget
Set the value of the
targetproperty. -
getTitle
Return the value of the
titleproperty.Contents: Advisory title information about markup elements generated for this component.
-
setTitle
Set the value of the
titleproperty. -
getType
Return the value of the
typeproperty.Contents: The content type of the resource designated by this hyperlink.
-
setType
Set the value of the
typeproperty. -
getEventNames
Description copied from class:UIComponentBaseThis is a default implementation of
ClientBehaviorHolder.getEventNames().UIComponentdoes not implement theClientBehaviorHolderinterface, but provides default implementations for the methods defined byClientBehaviorHolderto simplify subclass implementations. Subclasses that wish to support theClientBehaviorHoldercontract must declare that the subclass implementsClientBehaviorHolder, and must override this method to return a non-EmptyCollectionof the client event names that the component supports.- Specified by:
getEventNamesin interfaceClientBehaviorHolder- Overrides:
getEventNamesin classUIComponentBase
-
getDefaultEventName
Description copied from class:UIComponentBaseThis is a default implementation of
ClientBehaviorHolder.getDefaultEventName().UIComponentdoes not implement theClientBehaviorHolderinterface, but provides default implementations for the methods defined byClientBehaviorHolderto simplify subclass implementations. Subclasses that wish to support theClientBehaviorHoldercontract must declare that the subclass implementsClientBehaviorHolder, and must provide an implementation ofClientBehaviorHolder.getEventNames().- Specified by:
getDefaultEventNamein interfaceClientBehaviorHolder- Overrides:
getDefaultEventNamein classUIComponentBase
-