Class UITabGroup
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.AbstractUITabGroup
org.apache.myfaces.tobago.component.UITabGroup
- 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,SupportsAutoSpacing,Visual,TabChangeSource
Renders a tab group which contains tab panels.
UIComponent class, generated from template
component.stg with class
TabGroupTagDeclaration.-
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 TypeMethodDescriptionjakarta.el.MethodExpressionjakarta.el.MethodExpressionAutomatically add spacing (margins/paddings) to the component for better positioning.Sets a CSS class in its parent, if the parent supports it.For internal use.ValueBindingExpression pointing to a Integer to save the component's selected Tab.Indicating how tab switching should be done.jakarta.el.MethodExpressiongetTip()Text value to display as tooltip.booleanFlag indicating that, if this component is activated by the user, notifications should be delivered to interested listeners and actions immediately (that is, during Apply Request Values phase) rather than waiting until Invoke Application phase.booleanFlag indicating that the tab navigation bar is rendered.voidrestoreState(jakarta.faces.context.FacesContext context, Object state) voidsetActionExpression(jakarta.el.MethodExpression action) voidsetActionListenerExpression(jakarta.el.MethodExpression actionListener) voidsetAutoSpacing(Boolean autoSpacing) voidsetCustomClass(CustomClass customClass) voidsetImmediate(boolean immediate) voidvoidsetRenderedIndex(Integer renderedIndex) voidsetSelectedIndex(Integer selectedIndex) voidsetShowNavigationBar(boolean showNavigationBar) voidsetSwitchType(SwitchType switchType) voidsetTabChangeListenerExpression(jakarta.el.MethodExpression tabChangeListener) voidMethods inherited from class org.apache.myfaces.tobago.internal.component.AbstractUITabGroup
addActionListener, addTabChangeListener, broadcast, encodeChildren, encodeEnd, getActionListeners, getActiveTab, getRendersChildren, getTabChangeListeners, getTabs, processDecodes, processUpdates, processValidators, queueEvent, removeActionListener, removeTabChangeListenerMethods inherited from class jakarta.faces.component.UIComponentBase
addClientBehavior, addFacesListener, clearInitialState, decode, encodeAll, encodeBegin, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getClientId, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getParent, getPassThroughAttributes, getRenderer, getRendererType, invokeOnComponent, isRendered, isTransient, markInitialState, processRestoreState, processSaveState, 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, getClientBehaviorsMethods 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
-
UITabGroup
public UITabGroup()
-
-
Method Details
-
getEventNames
- Specified by:
getEventNamesin interfacejakarta.faces.component.behavior.ClientBehaviorHolder- Overrides:
getEventNamesin classjakarta.faces.component.UIComponentBase
-
getDefaultEventName
- Specified by:
getDefaultEventNamein interfacejakarta.faces.component.behavior.ClientBehaviorHolder- Overrides:
getDefaultEventNamein classjakarta.faces.component.UIComponentBase
-
getFamily
- Overrides:
getFamilyin classjakarta.faces.component.UIPanel
-
getRenderedIndex
For internal use. TBD: Check if this is needed any longer.
Default:0- Specified by:
getRenderedIndexin classAbstractUITabGroup
-
setRenderedIndex
- Specified by:
setRenderedIndexin classAbstractUITabGroup
-
getActionListenerExpression
public jakarta.el.MethodExpression getActionListenerExpression() -
setActionListenerExpression
public void setActionListenerExpression(jakarta.el.MethodExpression actionListener) -
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 -
setAutoSpacing
-
getSwitchType
Indicating how tab switching should be done.
Possible values are:
- client
- Tab switching is done on client, no server Request.
- reloadPage
- Tab switching is done by server request. Full page is reloaded.
- reloadTab
- Tab switching is done by server request. Only the Tab is reloaded.
Default:client
Allowed Values:client,reloadPage,reloadTab- Specified by:
getSwitchTypein classAbstractUITabGroup
-
setSwitchType
-
getTabChangeListenerExpression
public jakarta.el.MethodExpression getTabChangeListenerExpression() -
setTabChangeListenerExpression
public void setTabChangeListenerExpression(jakarta.el.MethodExpression tabChangeListener) -
getMarkup
-
setMarkup
-
isImmediate
public boolean isImmediate()Flag indicating that, if this component is activated by the user, notifications should be delivered to interested listeners and actions immediately (that is, during Apply Request Values phase) rather than waiting until Invoke Application phase.
Default:false -
setImmediate
public void setImmediate(boolean immediate) -
getActionExpression
public jakarta.el.MethodExpression getActionExpression() -
setActionExpression
public void setActionExpression(jakarta.el.MethodExpression action) -
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. -
setCustomClass
-
getTip
Text value to display as tooltip.- Specified by:
getTipin classAbstractUIPanelBase
-
setTip
-
getSelectedIndex
ValueBindingExpression pointing to a Integer to save the component's selected Tab.
Default:0- Specified by:
getSelectedIndexin classAbstractUITabGroup
-
setSelectedIndex
- Specified by:
setSelectedIndexin classAbstractUITabGroup
-
restoreState
- Specified by:
restoreStatein interfacejakarta.faces.component.StateHolder- Overrides:
restoreStatein classjakarta.faces.component.UIComponentBase
-