Class UILinks
java.lang.Object
javax.faces.component.UIComponent
javax.faces.component.UIComponentBase
javax.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:
EventListener
,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
,SupportsAutoSpacing
,SupportsDisabled
,Visual
@Generated("component.stg")
public class UILinks
extends AbstractUILinks
implements javax.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 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 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.boolean
Flag indicating that this element and all children are disabled.void
restoreState
(javax.faces.context.FacesContext context, Object state) void
setAutoSpacing
(Boolean autoSpacing) void
setCustomClass
(CustomClass customClass) void
setDisabled
(boolean disabled) void
void
setOrientation
(Orientation orientation) void
Methods inherited from class javax.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, getValueBinding, invokeOnComponent, isRendered, isTransient, markInitialState, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, 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, processEvent, 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, getDefaultEventName, getEventNames
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
-
UILinks
public UILinks()
-
-
Method Details
-
getFamily
- Overrides:
getFamily
in classjavax.faces.component.UIPanel
-
getOrientation
Set the orientation of the component. Allowed values: horizontal, vertical
Allowed Values:horizontal,vertical
- Specified by:
getOrientation
in 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:
getAutoSpacing
in 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:
getCustomClass
in interfaceVisual
-
setCustomClass
- Specified by:
setCustomClass
in interfaceVisual
-
getTip
Text value to display as tooltip.- Specified by:
getTip
in classAbstractUIPanelBase
-
setTip
-
isDisabled
public boolean isDisabled()Flag indicating that this element and all children are disabled.- Specified by:
isDisabled
in interfaceSupportsDisabled
-
setDisabled
public void setDisabled(boolean disabled) - Specified by:
setDisabled
in interfaceSupportsDisabled
-
restoreState
- Specified by:
restoreState
in interfacejavax.faces.component.StateHolder
- Overrides:
restoreState
in classjavax.faces.component.UIComponentBase
-