Class UILink
java.lang.Object
javax.faces.component.UIComponent
javax.faces.component.UIComponentBase
javax.faces.component.UICommand
- All Implemented Interfaces:
EventListener
,javax.faces.component.ActionSource
,javax.faces.component.ActionSource2
,javax.faces.component.behavior.ClientBehaviorHolder
,javax.faces.component.PartialStateHolder
,javax.faces.component.StateHolder
,javax.faces.component.TransientStateHolder
,javax.faces.event.ComponentSystemEventListener
,javax.faces.event.FacesListener
,javax.faces.event.SystemEventListenerHolder
,SupportFieldId
,SupportsAccessKey
,SupportsAutoSpacing
,Visual
Renders a link element, i. e. an anchor <a> tag.
For a <link> tag, please use <tc:metaLink> tag.
UIComponent class, generated from template
component.stg
with class
LinkTagDeclaration
.-
Field Summary
FieldsFields 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 TypeMethodDescriptionThe access key of this control.Automatically add spacing (margins/paddings) to the component for better positioning.Text to use as confirmation message.Sets a CSS class in its parent, if the parent supports it.The identifier of the page fragment which should be brought into focus when the target page is rendered.getImage()
Url to an image to display.getLabel()
A localized user presentable label for this component.getLink()
Link to an arbitrary URL, either an internal link or an external link.Link to an internal facelet page, like the outcome of an action.Controls the navigation of the focus through the input controls on a page with the Tab-Key.Name of a frame where the resource retrieved via this hyperlink is to be displayed.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
Specify, if the command calls an JSF-Action.void
restoreState
(javax.faces.context.FacesContext context, Object state) void
setAccessKey
(Character accessKey) void
setAutoSpacing
(Boolean autoSpacing) void
setConfirmation
(String confirmation) void
setCustomClass
(CustomClass customClass) void
setFragment
(String fragment) void
void
void
void
void
setOmit
(boolean omit) void
setOutcome
(String outcome) void
setTabIndex
(Integer tabIndex) void
void
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 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.UIComponentBase
addClientBehavior, addFacesListener, clearInitialState, decode, encodeAll, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getClientId, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getParent, getPassThroughAttributes, getRenderer, getRendererType, getRendersChildren, getValueBinding, invokeOnComponent, isTransient, markInitialState, processRestoreState, processSaveState, processUpdates, processValidators, removeFacesListener, restoreAttachedState, saveAttachedState, saveState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding, visitTree
Methods inherited from class javax.faces.component.UIComponent
getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getListenersForEventClass, getNamingContainer, getPassThroughAttributes, getResourceBundleMap, getStateHelper, getStateHelper, getTransientStateHelper, getTransientStateHelper, getValueExpression, initialStateMarked, isCompositeComponent, isInView, isVisitable, popComponentFromEL, pushComponentToEL, restoreTransientState, saveTransientState, setInView, setValueExpression, subscribeToEvent, unsubscribeFromEvent
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface javax.faces.component.behavior.ClientBehaviorHolder
addClientBehavior, getClientBehaviors
Methods inherited from interface org.apache.myfaces.tobago.component.SupportsAutoSpacing
getAutoSpacing
Methods inherited from interface org.apache.myfaces.tobago.component.Visual
getRendererType, isPlain
-
Field Details
-
COMPONENT_TYPE
-
COMPONENT_FAMILY
- See Also:
-
-
Constructor Details
-
UILink
public UILink()
-
-
Method Details
-
getEventNames
- Specified by:
getEventNames
in interfacejavax.faces.component.behavior.ClientBehaviorHolder
- Overrides:
getEventNames
in classjavax.faces.component.UIComponentBase
-
getDefaultEventName
- Specified by:
getDefaultEventName
in interfacejavax.faces.component.behavior.ClientBehaviorHolder
- Overrides:
getDefaultEventName
in classjavax.faces.component.UIComponentBase
-
getFamily
- Overrides:
getFamily
in classjavax.faces.component.UICommand
-
getImage
Url to an image to display.- Specified by:
getImage
in classAbstractUICommand
-
setImage
-
getMarkup
-
setMarkup
-
getLink
Link to an arbitrary URL, either an internal link or an external link. For internal URLs, a session id will be added, if needed (when cookies disabled). The context path needs to be added manually e.g. #{request.contextPath}. For JSF navigation to a viewId use the outcome attribute!
The semantic of this attributes has been changed from Tobago 3 to 4!
- Specified by:
getLink
in classAbstractUICommandBase
-
setLink
-
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 classAbstractUILink
-
setTabIndex
-
getConfirmation
Text to use as confirmation message.- Specified by:
getConfirmation
in classAbstractUICommandBase
-
setConfirmation
-
getLabel
A localized user presentable label for this component.- Specified by:
getLabel
in interfaceSupportsAccessKey
- Specified by:
getLabel
in classAbstractUICommand
-
setLabel
-
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 classAbstractUICommandBase
-
setTransition
public void setTransition(boolean transition) -
getTarget
Name of a frame where the resource retrieved via this hyperlink is to be displayed.- Specified by:
getTarget
in classAbstractUICommandBase
-
setTarget
-
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 classAbstractUICommandBase
-
setFragment
-
getAutoSpacing
Automatically add spacing (margins/paddings) to the component for better positioning. Default is 'true' except the component is inside a: - header - footer - bar - sheet - tree - link group - button group - before facet - after facet - label facet - bar facet- Specified by:
getAutoSpacing
in interfaceSupportsAutoSpacing
-
setAutoSpacing
-
getAccessKey
The access key of this control.- Specified by:
getAccessKey
in interfaceSupportsAccessKey
-
setAccessKey
-
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 interfaceVisual
-
setCustomClass
- Specified by:
setCustomClass
in interfaceVisual
-
getTip
Text value to display as tooltip. -
setTip
-
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 classAbstractUICommandBase
-
setOmit
public void setOmit(boolean omit) - Specified by:
setOmit
in classAbstractUICommandBase
-
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 classAbstractUICommandBase
-
setOutcome
-
restoreState
- Specified by:
restoreState
in interfacejavax.faces.component.StateHolder
- Overrides:
restoreState
in classjavax.faces.component.UIComponentBase
-