Package org.apache.myfaces.tobago.component

Class UILink

java.lang.Object

javax.faces.component.UIComponent

javax.faces.component.UIComponentBase

javax.faces.component.UICommand

org.apache.myfaces.tobago.internal.component.AbstractUICommandBase

org.apache.myfaces.tobago.internal.component.AbstractUICommand

org.apache.myfaces.tobago.internal.component.AbstractUILink

org.apache.myfaces.tobago.component.UILink

All Implemented Interfaces:

SupportFieldId, SupportsAccessKey, Visual

@Generated("component.stg")
public class UILink
extends AbstractUILink
implements SupportsAccessKey, Visual

Renders a link element. UIComponent class, generated from template component.stg with class LinkTagDeclaration.

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	COMPONENT_FAMILY
static java.lang.String	COMPONENT_TYPE

Fields inherited from class javax.faces.component.UIComponent

BEANINFO_KEY, bindings, COMPOSITE_COMPONENT_TYPE_KEY, COMPOSITE_FACET_NAME, CURRENT_COMPONENT, CURRENT_COMPOSITE_COMPONENT, FACETS_KEY, VIEW_LOCATION_KEY

Constructor Summary

Constructors

Constructor	Description
UILink()

Method Summary

Modifier and Type	Method	Description
java.lang.Character	getAccessKey()	The access key of this control.
java.lang.String	getConfirmation()	Text to use as confirmation message.
CustomClass	getCustomClass()	Sets a CSS class in its parent, if the parent supports it.
java.lang.String	getDefaultEventName()
java.util.Collection<java.lang.String>	getEventNames()
java.lang.String	getFamily()
java.lang.String	getFragment()	The identifier of the page fragment which should be brought into focus when the target page is rendered.
java.lang.String	getImage()	Url to an image to display.
java.lang.String	getLabel()	A localized user presentable label for this component.
java.lang.String	getLink()	Link to an arbitrary URL, either an internal link or an external link.
Markup	getMarkup()
java.lang.String	getOutcome()	Link to an internal facelet page, like the outcome of an action.
java.lang.Integer	getTabIndex()	Controls the navigation of the focus through the input controls on a page with the Tab-Key.
java.lang.String	getTarget()	Name of a frame where the resource retrieved via this hyperlink is to be displayed.
java.lang.String	getTip()	Text value to display as tooltip.
boolean	isOmit()	Flag indicating that the action of this element, will not be executed from client side (e. g. when the user clicks a button.
boolean	isTransition()	Specify, if the command calls an JSF-Action.
void	restoreState(javax.faces.context.FacesContext context, java.lang.Object state)
void	setAccessKey(java.lang.Character accessKey)
void	setConfirmation(java.lang.String confirmation)
void	setCustomClass(CustomClass customClass)
void	setFragment(java.lang.String fragment)
void	setImage(java.lang.String image)
void	setLabel(java.lang.String label)
void	setLink(java.lang.String link)
void	setMarkup(Markup markup)
void	setOmit(boolean omit)
void	setOutcome(java.lang.String outcome)
void	setTabIndex(java.lang.Integer tabIndex)
void	setTarget(java.lang.String target)
void	setTip(java.lang.String tip)
void	setTransition(boolean transition)

Methods inherited from class org.apache.myfaces.tobago.internal.component.AbstractUICommand

getFieldId, isParentOfCommands

Methods inherited from class org.apache.myfaces.tobago.internal.component.AbstractUICommandBase

isDisabled, isRendered, processDecodes, processEvent, queueEvent, setDisabled

Methods inherited from interface javax.faces.component.behavior.ClientBehaviorHolder

addClientBehavior, getClientBehaviors

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from class javax.faces.component.UICommand

addActionListener, broadcast, getAction, getActionExpression, getActionListener, getActionListeners, getValue, isImmediate, removeActionListener, setAction, setActionExpression, setActionListener, setImmediate, setValue

Methods inherited from class javax.faces.component.UIComponent

getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getListenersForEventClass, getNamingContainer, getResourceBundleMap, getStateHelper, getStateHelper, getValueExpression, isCompositeComponent, isInView, isVisitable, popComponentFromEL, pushComponentToEL, setInView, setValueExpression, subscribeToEvent, unsubscribeFromEvent

Methods inherited from class javax.faces.component.UIComponentBase

addClientBehavior, addFacesListener, clearInitialState, decode, encodeAll, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getClientId, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getParent, getRenderer, getRendererType, getRendersChildren, getValueBinding, initialStateMarked, invokeOnComponent, isTransient, markInitialState, processRestoreState, processSaveState, processUpdates, processValidators, removeFacesListener, restoreAttachedState, saveAttachedState, saveState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding, visitTree

Methods inherited from interface org.apache.myfaces.tobago.component.Visual

getRendererType

Field Detail

COMPONENT_TYPE

public static final java.lang.String COMPONENT_TYPE

See Also:

Constant Field Values

COMPONENT_FAMILY

public static final java.lang.String COMPONENT_FAMILY

See Also:

Constant Field Values

Constructor Detail

UILink

public UILink()

Method Detail

getEventNames

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

Overrides:

getEventNames in class javax.faces.component.UIComponentBase

getDefaultEventName

public java.lang.String getDefaultEventName()

Overrides:

getDefaultEventName in class javax.faces.component.UIComponentBase

getFamily

public java.lang.String getFamily()

Overrides:

getFamily in class javax.faces.component.UICommand

getImage

public java.lang.String getImage()

Url to an image to display.

Specified by:

getImage in class AbstractUILink

setImage

public void setImage(java.lang.String image)

getMarkup

public Markup getMarkup()

Specified by:

getMarkup in interface Visual

setMarkup

public void setMarkup(Markup markup)

Specified by:

setMarkup in interface Visual

getLink

public java.lang.String getLink()

Link to an arbitrary URL, either an internal link or an external link.

internal absolute link

Starts with a slash '/' character. The context path will be added. A session id will be added, if needed.

external link

Starts with protocol followed by a colon ':' character. The link will not be modified.

internal relative link

Any other strings. A session id will be added, if needed.

Specified by:

getLink in class AbstractUICommandBase

setLink

public void setLink(java.lang.String link)

getTabIndex

public java.lang.Integer getTabIndex()

Controls the navigation of the focus through the input controls on a page with the Tab-Key. The navigation starts from the element with the lowest tabIndex value to the element with the highest value. Elements that have identical tabIndex values should be navigated in the order they appear in the character stream Elements that are disabled or with a negative tabIndex do not participate in the tabbing order.

Specified by:

getTabIndex in class AbstractUILink

setTabIndex

public void setTabIndex(java.lang.Integer tabIndex)

getConfirmation

public java.lang.String getConfirmation()

Text to use as confirmation message.

Specified by:

getConfirmation in class AbstractUICommandBase

setConfirmation

public void setConfirmation(java.lang.String confirmation)

getLabel

public java.lang.String getLabel()

A localized user presentable label for this component.

Specified by:

getLabel in interface SupportsAccessKey

Specified by:

getLabel in class AbstractUICommand

setLabel

public void setLabel(java.lang.String label)

isTransition

public boolean isTransition()

Specify, if the command calls an JSF-Action. Useful to switch off the Double-Submit-Check and Waiting-Behavior.
Default: true

Specified by:

isTransition in class AbstractUICommandBase

setTransition

public void setTransition(boolean transition)

getTarget

public java.lang.String getTarget()

Name of a frame where the resource retrieved via this hyperlink is to be displayed. The target attribute is not reliable in combination with DeltaSpike and its

Specified by:

getTarget in class AbstractUICommandBase

setTarget

public void setTarget(java.lang.String target)

getFragment

public java.lang.String getFragment()

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.

Specified by:

getFragment in class AbstractUICommandBase

setFragment

public void setFragment(java.lang.String fragment)

getAccessKey

public java.lang.Character getAccessKey()

The access key of this control.

Specified by:

getAccessKey in interface SupportsAccessKey

setAccessKey

public void setAccessKey(java.lang.Character accessKey)

getCustomClass

public CustomClass getCustomClass()

Sets a CSS class in its parent, if the parent supports it. Which this feature it is possible to put a CSS class name into a component with the <tc:style> tag. Example:

   <tc:in>
     <tc:style customClass="my-emphasized"/>
   </tc:in>
   

One capability is, to used external CSS libs.
This feature should not be used imprudent. Because it might be unstable against changes in the renderered HTML code.

Specified by:

getCustomClass in interface Visual

setCustomClass

public void setCustomClass(CustomClass customClass)

Specified by:

setCustomClass in interface Visual

getTip

public java.lang.String getTip()

Text value to display as tooltip.

setTip

public void setTip(java.lang.String tip)

isOmit

public boolean isOmit()

Flag indicating that the action of this element, will not be executed from client side (e. g. when the user clicks a button. When setting this value to true, the action will not be executed by the Tobago, but it can executed by JavaScript. This attribute is useful, when you want to add JavaScript event handlers to commands manually. In this case you usually don't want a submit with a full reload of the page.
Default: false

Specified by:

isOmit in class AbstractUICommandBase

setOmit

public void setOmit(boolean omit)

Specified by:

setOmit in class AbstractUICommandBase

getOutcome

public java.lang.String getOutcome()

Link to an internal facelet page, like the outcome of an action. The context path will be added. A session id will be added, if needed.

Specified by:

getOutcome in class AbstractUICommandBase

setOutcome

public void setOutcome(java.lang.String outcome)

restoreState

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

Overrides:

restoreState in class javax.faces.component.UIComponentBase