java.lang.Object
jakarta.faces.component.UIComponent
jakarta.faces.component.UIComponentBase
jakarta.faces.component.UIPanel
org.apache.myfaces.tobago.internal.component.AbstractUIPanelBase
org.apache.myfaces.tobago.internal.component.AbstractUILinks
org.apache.myfaces.tobago.component.UILinks
- All Implemented Interfaces:
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,SupportsAutoSpacing,SupportsDisabled,Visual
@Generated("component.stg")
public class UILinks
extends AbstractUILinks
implements jakarta.faces.component.behavior.ClientBehaviorHolder
Defines a navigation element, which contains a menu-like structure
UIComponent class, generated from template
component.stg with class
LinksTagDeclaration.-
Field Summary
FieldsFields inherited from class jakarta.faces.component.UIComponent
ATTRS_WITH_DECLARED_DEFAULT_VALUES, BEANINFO_KEY, bindings, COMPOSITE_COMPONENT_TYPE_KEY, COMPOSITE_FACET_NAME, FACETS_KEY, VIEW_LOCATION_KEY -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionAutomatically add spacing (margins/paddings) to the component for better positioning.Sets a CSS class in its parent, if the parent supports it.Set the orientation of the component.getTip()Text value to display as tooltip.booleanFlag indicating that this element and all children are disabled.voidrestoreState(jakarta.faces.context.FacesContext context, Object state) voidsetAutoSpacing(Boolean autoSpacing) voidsetCustomClass(CustomClass customClass) voidsetDisabled(boolean disabled) voidvoidsetOrientation(Orientation orientation) voidMethods inherited from class jakarta.faces.component.UIComponentBase
addClientBehavior, addFacesListener, broadcast, clearInitialState, decode, encodeAll, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getClientId, getDefaultEventName, getEventNames, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getParent, getPassThroughAttributes, getRenderer, getRendererType, getRendersChildren, invokeOnComponent, isRendered, isTransient, markInitialState, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, removeFacesListener, restoreAttachedState, saveAttachedState, saveState, setId, setParent, setRendered, setRendererType, setTransient, visitTreeMethods inherited from class jakarta.faces.component.UIComponent
getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getListenersForEventClass, getNamingContainer, getPassThroughAttributes, getResourceBundleMap, getStateHelper, getStateHelper, getTransientStateHelper, getTransientStateHelper, getValueExpression, initialStateMarked, isCompositeComponent, isInView, isVisitable, popComponentFromEL, processEvent, pushComponentToEL, restoreTransientState, saveTransientState, setInView, setValueExpression, subscribeToEvent, unsubscribeFromEventMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface jakarta.faces.component.behavior.ClientBehaviorHolder
addClientBehavior, getClientBehaviors, getDefaultEventName, getEventNamesMethods inherited from interface org.apache.myfaces.tobago.component.SupportsAutoSpacing
getAutoSpacingMethods inherited from interface org.apache.myfaces.tobago.component.Visual
getRendererType, isPlain
-
Field Details
-
COMPONENT_TYPE
-
COMPONENT_FAMILY
- See Also:
-
-
Constructor Details
-
UILinks
public UILinks()
-
-
Method Details
-
getFamily
- Overrides:
getFamilyin classjakarta.faces.component.UIPanel
-
getOrientation
Set the orientation of the component. Allowed values: horizontal, vertical
Allowed Values:horizontal,vertical- Specified by:
getOrientationin classAbstractUILinks
-
setOrientation
-
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:
getAutoSpacingin interfaceSupportsAutoSpacing
-
setAutoSpacing
-
getMarkup
-
setMarkup
-
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:
getCustomClassin interfaceVisual
-
setCustomClass
- Specified by:
setCustomClassin interfaceVisual
-
getTip
Text value to display as tooltip.- Specified by:
getTipin classAbstractUIPanelBase
-
setTip
-
isDisabled
public boolean isDisabled()Flag indicating that this element and all children are disabled.- Specified by:
isDisabledin interfaceSupportsDisabled
-
setDisabled
public void setDisabled(boolean disabled) - Specified by:
setDisabledin interfaceSupportsDisabled
-
restoreState
- Specified by:
restoreStatein interfacejakarta.faces.component.StateHolder- Overrides:
restoreStatein classjakarta.faces.component.UIComponentBase
-