com.ibm.xsp.component.xp
Class XspOutputLink

java.lang.Object
  javax.faces.component.UIComponent
      javax.faces.component.UIComponentBase
          javax.faces.component.UIOutput
              com.ibm.xsp.component.UIOutputEx
                  com.ibm.xsp.component.UIOutputLink
                      com.ibm.xsp.component.xp.XspOutputLink

All Implemented Interfaces:

FacesAttrsObject, FacesComponent, FacesOutputFiltering, ThemeControl, javax.faces.component.StateHolder, javax.faces.component.ValueHolder

public class XspOutputLink
extends UIOutputLink

A control that links to a different page, to another control on the same page, or to an external resource using a URL.

XPages Core Controls - Link

Represents an HTML anchor element

Nested Class Summary

Nested classes/interfaces inherited from class javax.faces.component.UIComponentBase

javax.faces.component.UIComponentBase.AggregatedIterator, javax.faces.component.UIComponentBase.UnmodifiableIterator

Nested classes/interfaces inherited from class javax.faces.component.UIComponent

javax.faces.component.UIComponent.StateMap, javax.faces.component.UIComponent.StateMapEntry

Field Summary

static java.lang.String	COMPONENT_TYPE
static java.lang.String	RENDERER_TYPE

Fields inherited from class javax.faces.component.UIOutput

COMPONENT_FAMILY

Fields inherited from class javax.faces.component.UIComponentBase

EMPTY_ITERATOR

Fields inherited from class javax.faces.component.UIComponent

_xspStateId

Constructor Summary

XspOutputLink()

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	getContentType() Return the value of the contentType 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	getHtmlFilter() Return the value of the htmlFilter 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	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	getOuterStyleClass() Return the value of the outerStyleClass 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	getRole() Return the value of the role 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	isEscape() Return the value of the escape property.
void	restoreState(javax.faces.context.FacesContext _context, java.lang.Object _state)
java.lang.Object	saveState(javax.faces.context.FacesContext _context)
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	setContentType(java.lang.String contentType) Set the value of the contentType 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	setEscape(boolean escape) Set the value of the escape property.
void	setHreflang(java.lang.String hreflang) Set the value of the hreflang property.
void	setHtmlFilter(java.lang.String htmlFilter) Set the value of the htmlFilter 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	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	setOuterStyleClass(java.lang.String outerStyleClass) Set the value of the outerStyleClass 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	setRole(java.lang.String role) Set the value of the role 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 com.ibm.xsp.component.UIOutputLink

addAttr, addParameter, getAttrs, getParameters, getStyleKitFamily, getText, setAttrs, setText

Methods inherited from class com.ibm.xsp.component.UIOutputEx

buildContents, getDefaultHtmlFilter, getHtmlFilterName, initAfterContents, initBeforeContents

Methods inherited from class javax.faces.component.UIOutput

getConverter, getFamily, getLocalValue, getValue, setConverter, setValue

Methods inherited from class javax.faces.component.UIComponentBase

_xspCleanTransientData, _xspGetReadOnlyObj, _xspGetRendererData, _xspRemoveReadOnlyObj, _xspRemoveRendererData, _xspSetIdUnchecked, _xspSetReadOnlyObj, _xspSetRendererData, addFacesListener, broadcast, decode, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientId, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getParent, getRenderer, getRendererType, getRendersChildren, getValueBinding, 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

_xspGetStateId, _xspGetStateMap, _xspRestoreAttribute, _xspRestoreState, _xspSaveState, invokeOnComponent, isVisitable, markInitialState, setControlState, visitTree

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

See Also:

Constant Field Values

RENDERER_TYPE

public static final java.lang.String RENDERER_TYPE

See Also:

Constant Field Values

Constructor Detail

XspOutputLink

public XspOutputLink()

Method Detail

getAccesskey

public java.lang.String getAccesskey()

Return the value of the accesskey property. Contents:

Transfers focus to the control when pressed

getCharset

public java.lang.String getCharset()

Return the value of the charset property. Contents:

Specifies the character encoding of the resource referenced by the hyperlink.

getContentType

public java.lang.String getContentType()

Return the value of the contentType property. Contents:

Specifies the type of content to expect. HTML and Text are supported. Text is the default.

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

getDir

public java.lang.String getDir()

Return the value of the dir property. Contents:

Specifies the direction for text that does not inherit a direction. Valid values are 'LTR' (left to right) and 'RTL' (right to left).

getHreflang

public java.lang.String getHreflang()

Return the value of the hreflang property. Contents:

Specifies the language code of the resource referenced by the hyperlink.

getHtmlFilter

public java.lang.String getHtmlFilter()

Return the value of the htmlFilter property. Contents:

Indicates which Active Content Filtering processor to use.

Overrides:

getHtmlFilter in class UIOutputEx

getLang

public java.lang.String getLang()

Return the value of the lang property. Contents:

Describes the language used in the generated markup of the control.

getOnblur

public java.lang.String getOnblur()

Return the value of the onblur property. Contents:

JavaScript code executed when this control loses focus

getOnclick

public java.lang.String getOnclick()

Return the value of the onclick property. Contents:

JavaScript code executed when a pointer control is clicked over this control

getOnfocus

public java.lang.String getOnfocus()

Return the value of the onfocus property. Contents:

JavaScript code executed when this control receives focus

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 control

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

getOnkeyup

public java.lang.String getOnkeyup()

Return the value of the onkeyup property. Contents:

JavaScript code executed when a key is released over this control

getOnmousedown

public java.lang.String getOnmousedown()

Return the value of the onmousedown property. Contents:

JavaScript code executed when a pointer control is pressed down over this control

getOnmousemove

public java.lang.String getOnmousemove()

Return the value of the onmousemove property. Contents:

JavaScript code executed when a pointer control is moved within this control

getOnmouseout

public java.lang.String getOnmouseout()

Return the value of the onmouseout property. Contents:

JavaScript code executed when a pointer control is moved away from this control

getOnmouseover

public java.lang.String getOnmouseover()

Return the value of the onmouseover property. Contents:

JavaScript code executed when a pointer control is moved onto this control

getOnmouseup

public java.lang.String getOnmouseup()

Return the value of the onmouseup property. Contents:

JavaScript code executed when a pointer control is released over this control

getOuterStyleClass

public java.lang.String getOuterStyleClass()

Return the value of the outerStyleClass property. Contents:

Space-separated list of CSS style class(es) to be applied when this control is rendered. When this value is set, the renderer generates an enclosing span using this style as the "class" attribute on generated markup.

getRel

public java.lang.String getRel()

Return the value of the rel property. Contents:

Specifies the relationship between the current document and the anchor referenced by the control. The value is a list of link types separated by spaces.

getRev

public java.lang.String getRev()

Return the value of the rev property. Contents:

Specifies a reverse link from the anchor referenced by the control to the current document. Value is list of link types separated by spaces.

getRole

public java.lang.String getRole()

Return the value of the role property. Contents:

Describes the role of the current UI element/area. It can be used by assistive technologies to determine its purpose.

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

getStyle

public java.lang.String getStyle()

Return the value of the style property. Contents:

Specifies CSS style(s) to be applied when this control is rendered.

XPages Styling Category - style

getStyleClass

public java.lang.String getStyleClass()

Return the value of the styleClass property. Contents:

Specifies the space-separated list of CSS style class(es) to be applied when this control is rendered. This value must be passed through as the "class" attribute on generated markup.

getTabindex

public java.lang.String getTabindex()

Return the value of the tabindex property. Contents:

Indicates where this control is located in the tab order of the page. Value must be an integer between 0 and 32,767. If the value is left blank, the tab order will inherit the browser's default order.

getTarget

public java.lang.String getTarget()

Return the value of the target property. Contents:

Indicates the name of the frame where the resource retrieved by the control is to be displayed.

getTitle

public java.lang.String getTitle()

Return the value of the title property. Contents:

Provides title information for controls.

getType

public java.lang.String getType()

Return the value of the type property. Contents:

Specifies the type of content referenced by the control.

isEscape

public boolean isEscape()

Return the value of the escape property. Contents:

Flag indicating that characters that are sensitive in HTML and XML markup must be escaped. This flag is set to "true" by default.

restoreState

public void restoreState(javax.faces.context.FacesContext _context,
                         java.lang.Object _state)

Specified by:

restoreState in interface javax.faces.component.StateHolder

Overrides:

restoreState in class UIOutputLink

saveState

public java.lang.Object saveState(javax.faces.context.FacesContext _context)

Specified by:

saveState in interface javax.faces.component.StateHolder

Overrides:

saveState in class UIOutputLink

setAccesskey

public void setAccesskey(java.lang.String accesskey)

Set the value of the accesskey property.

setCharset

public void setCharset(java.lang.String charset)

Set the value of the charset property.

setContentType

public void setContentType(java.lang.String contentType)

Set the value of the contentType property.

setCoords

public void setCoords(java.lang.String coords)

Set the value of the coords property.

setDir

public void setDir(java.lang.String dir)

Set the value of the dir property.

setEscape

public void setEscape(boolean escape)

Set the value of the escape property.

setHreflang

public void setHreflang(java.lang.String hreflang)

Set the value of the hreflang property.

setHtmlFilter

public void setHtmlFilter(java.lang.String htmlFilter)

Set the value of the htmlFilter property.

setLang

public void setLang(java.lang.String lang)

Set the value of the lang property.

setOnblur

public void setOnblur(java.lang.String onblur)

Set the value of the onblur property.

setOnclick

public void setOnclick(java.lang.String onclick)

Set the value of the onclick property.

setOnfocus

public void setOnfocus(java.lang.String onfocus)

Set the value of the onfocus property.

setOnkeydown

public void setOnkeydown(java.lang.String onkeydown)

Set the value of the onkeydown property.

setOnkeypress

public void setOnkeypress(java.lang.String onkeypress)

Set the value of the onkeypress property.

setOnkeyup

public void setOnkeyup(java.lang.String onkeyup)

Set the value of the onkeyup property.

setOnmousedown

public void setOnmousedown(java.lang.String onmousedown)

Set the value of the onmousedown property.

setOnmousemove

public void setOnmousemove(java.lang.String onmousemove)

Set the value of the onmousemove property.

setOnmouseout

public void setOnmouseout(java.lang.String onmouseout)

Set the value of the onmouseout property.

setOnmouseover

public void setOnmouseover(java.lang.String onmouseover)

Set the value of the onmouseover property.

setOnmouseup

public void setOnmouseup(java.lang.String onmouseup)

Set the value of the onmouseup property.

setOuterStyleClass

public void setOuterStyleClass(java.lang.String outerStyleClass)

Set the value of the outerStyleClass property.

setRel

public void setRel(java.lang.String rel)

Set the value of the rel property.

setRev

public void setRev(java.lang.String rev)

Set the value of the rev property.

setRole

public void setRole(java.lang.String role)

Set the value of the role property.

setShape

public void setShape(java.lang.String shape)

Set the value of the shape property.

setStyle

public void setStyle(java.lang.String style)

Set the value of the style property.

setStyleClass

public void setStyleClass(java.lang.String styleClass)

Set the value of the styleClass property.

setTabindex

public void setTabindex(java.lang.String tabindex)

Set the value of the tabindex property.

setTarget

public void setTarget(java.lang.String target)

Set the value of the target property.

setTitle

public void setTitle(java.lang.String title)

Set the value of the title property.

setType

public void setType(java.lang.String type)

Set the value of the type property.