Class UILink
java.lang.Object
jakarta.faces.component.UIComponent
jakarta.faces.component.UIComponentBase
jakarta.faces.component.UICommand
- All Implemented Interfaces:
- jakarta.faces.component.ActionSource,- jakarta.faces.component.ActionSource2,- jakarta.faces.component.behavior.ClientBehaviorHolder,- jakarta.faces.component.PartialStateHolder,- jakarta.faces.component.StateHolder,- jakarta.faces.component.TransientStateHolder,- jakarta.faces.event.ComponentSystemEventListener,- jakarta.faces.event.FacesListener,- jakarta.faces.event.SystemEventListenerHolder,- EventListener,- 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 SummaryFieldsFields inherited from class jakarta.faces.component.UIComponentATTRS_WITH_DECLARED_DEFAULT_VALUES, BEANINFO_KEY, bindings, COMPOSITE_COMPONENT_TYPE_KEY, COMPOSITE_FACET_NAME, FACETS_KEY, VIEW_LOCATION_KEY
- 
Constructor SummaryConstructors
- 
Method SummaryModifier 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.booleanisOmit()Flag indicating that the action of this element, will not be executed from client side (e. g. when the user clicks a button.booleanSpecify, if the command calls an JSF-Action.voidrestoreState(jakarta.faces.context.FacesContext context, Object state) voidsetAccessKey(Character accessKey) voidsetAutoSpacing(Boolean autoSpacing) voidsetConfirmation(String confirmation) voidsetCustomClass(CustomClass customClass) voidsetFragment(String fragment) voidvoidvoidvoidvoidsetOmit(boolean omit) voidsetOutcome(String outcome) voidsetTabIndex(Integer tabIndex) voidvoidvoidsetTransition(boolean transition) Methods inherited from class org.apache.myfaces.tobago.internal.component.AbstractUICommandgetFieldId, isParentOfCommandsMethods inherited from class org.apache.myfaces.tobago.internal.component.AbstractUICommandBaseisDisabled, isRendered, processDecodes, processEvent, queueEvent, setDisabledMethods inherited from class jakarta.faces.component.UICommandaddActionListener, broadcast, getActionExpression, getActionListeners, getValue, isImmediate, removeActionListener, setActionExpression, setImmediate, setValueMethods inherited from class jakarta.faces.component.UIComponentBaseaddClientBehavior, 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, invokeOnComponent, isTransient, markInitialState, processRestoreState, processSaveState, processUpdates, processValidators, removeFacesListener, restoreAttachedState, saveAttachedState, saveState, setId, setParent, setRendered, setRendererType, setTransient, visitTreeMethods inherited from class jakarta.faces.component.UIComponentgetClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getListenersForEventClass, getNamingContainer, getPassThroughAttributes, getResourceBundleMap, getStateHelper, getStateHelper, getTransientStateHelper, getTransientStateHelper, getValueExpression, initialStateMarked, isCompositeComponent, isInView, isVisitable, popComponentFromEL, pushComponentToEL, restoreTransientState, saveTransientState, setInView, setValueExpression, subscribeToEvent, unsubscribeFromEventMethods inherited from class java.lang.Objectclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface jakarta.faces.component.behavior.ClientBehaviorHolderaddClientBehavior, getClientBehaviorsMethods inherited from interface org.apache.myfaces.tobago.component.SupportsAutoSpacinggetAutoSpacingMethods inherited from interface org.apache.myfaces.tobago.component.VisualgetRendererType, isPlain
- 
Field Details- 
COMPONENT_TYPE
- 
COMPONENT_FAMILY- See Also:
 
 
- 
- 
Constructor Details- 
UILinkpublic UILink()
 
- 
- 
Method Details- 
getEventNames- Specified by:
- getEventNamesin interface- jakarta.faces.component.behavior.ClientBehaviorHolder
- Overrides:
- getEventNamesin class- jakarta.faces.component.UIComponentBase
 
- 
getDefaultEventName- Specified by:
- getDefaultEventNamein interface- jakarta.faces.component.behavior.ClientBehaviorHolder
- Overrides:
- getDefaultEventNamein class- jakarta.faces.component.UIComponentBase
 
- 
getFamily- Overrides:
- getFamilyin class- jakarta.faces.component.UICommand
 
- 
getImageUrl to an image to display.- Specified by:
- getImagein class- AbstractUICommand
 
- 
setImage
- 
getMarkup
- 
setMarkup
- 
getLinkLink 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:
- getLinkin class- AbstractUICommandBase
 
- 
setLink
- 
getTabIndexControls 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:
- getTabIndexin class- AbstractUILink
 
- 
setTabIndex
- 
getConfirmationText to use as confirmation message.- Specified by:
- getConfirmationin class- AbstractUICommandBase
 
- 
setConfirmation
- 
getLabelA localized user presentable label for this component.- Specified by:
- getLabelin interface- SupportsAccessKey
- Specified by:
- getLabelin class- AbstractUICommand
 
- 
setLabel
- 
isTransitionpublic 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:
- isTransitionin class- AbstractUICommandBase
 
- 
setTransitionpublic void setTransition(boolean transition) 
- 
getTargetName of a frame where the resource retrieved via this hyperlink is to be displayed.- Specified by:
- getTargetin class- AbstractUICommandBase
 
- 
setTarget
- 
getFragmentThe 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:
- getFragmentin class- AbstractUICommandBase
 
- 
setFragment
- 
getAutoSpacingAutomatically 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:
- getAutoSpacingin interface- SupportsAutoSpacing
 
- 
setAutoSpacing
- 
getAccessKeyThe access key of this control.- Specified by:
- getAccessKeyin interface- SupportsAccessKey
 
- 
setAccessKey
- 
getCustomClassSets 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:
- getCustomClassin interface- Visual
 
- 
setCustomClass- Specified by:
- setCustomClassin interface- Visual
 
- 
getTipText value to display as tooltip.
- 
setTip
- 
isOmitpublic 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:
- isOmitin class- AbstractUICommandBase
 
- 
setOmitpublic void setOmit(boolean omit) - Specified by:
- setOmitin class- AbstractUICommandBase
 
- 
getOutcomeLink 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:
- getOutcomein class- AbstractUICommandBase
 
- 
setOutcome
- 
restoreState- Specified by:
- restoreStatein interface- jakarta.faces.component.StateHolder
- Overrides:
- restoreStatein class- jakarta.faces.component.UIComponentBase
 
 
-