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
@Generated("component.stg") public class UITabGroup extends AbstractUITabGroup
Renders a tab group which contains tab panels. UIComponent class, generated from templatecomponent.stg
with classTabGroupTagDeclaration
.
-
-
Field Summary
Fields Modifier and Type Field Description static String
COMPONENT_FAMILY
static String
COMPONENT_TYPE
-
Constructor Summary
Constructors Constructor Description UITabGroup()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description jakarta.el.MethodExpression
getActionExpression()
jakarta.el.MethodExpression
getActionListenerExpression()
Boolean
getAutoSpacing()
Automatically add spacing (margins/paddings) to the component for better positioning.CustomClass
getCustomClass()
Sets a CSS class in its parent, if the parent supports it.String
getDefaultEventName()
Collection<String>
getEventNames()
String
getFamily()
Markup
getMarkup()
Integer
getRenderedIndex()
For internal use.Integer
getSelectedIndex()
ValueBindingExpression pointing to a Integer to save the component's selected Tab.SwitchType
getSwitchType()
Indicating how tab switching should be done.jakarta.el.MethodExpression
getTabChangeListenerExpression()
String
getTip()
Text value to display as tooltip.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.boolean
isShowNavigationBar()
Flag indicating that the tab navigation bar is rendered.void
restoreState(jakarta.faces.context.FacesContext context, Object state)
void
setActionExpression(jakarta.el.MethodExpression action)
void
setActionListenerExpression(jakarta.el.MethodExpression actionListener)
void
setAutoSpacing(Boolean autoSpacing)
void
setCustomClass(CustomClass customClass)
void
setImmediate(boolean immediate)
void
setMarkup(Markup markup)
void
setRenderedIndex(Integer renderedIndex)
void
setSelectedIndex(Integer selectedIndex)
void
setShowNavigationBar(boolean showNavigationBar)
void
setSwitchType(SwitchType switchType)
void
setTabChangeListenerExpression(jakarta.el.MethodExpression tabChangeListener)
void
setTip(String tip)
-
Methods 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, removeTabChangeListener
-
Methods 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, visitTree
-
Methods 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, unsubscribeFromEvent
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface jakarta.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 Detail
-
COMPONENT_TYPE
public static final String COMPONENT_TYPE
-
COMPONENT_FAMILY
public static final String COMPONENT_FAMILY
- See Also:
- Constant Field Values
-
-
Method Detail
-
getEventNames
public Collection<String> getEventNames()
- Specified by:
getEventNames
in interfacejakarta.faces.component.behavior.ClientBehaviorHolder
- Overrides:
getEventNames
in classjakarta.faces.component.UIComponentBase
-
getDefaultEventName
public String getDefaultEventName()
- Specified by:
getDefaultEventName
in interfacejakarta.faces.component.behavior.ClientBehaviorHolder
- Overrides:
getDefaultEventName
in classjakarta.faces.component.UIComponentBase
-
getFamily
public String getFamily()
- Overrides:
getFamily
in classjakarta.faces.component.UIPanel
-
getRenderedIndex
public Integer getRenderedIndex()
For internal use. TBD: Check if this is needed any longer.
Default:0
- Specified by:
getRenderedIndex
in classAbstractUITabGroup
-
setRenderedIndex
public void setRenderedIndex(Integer renderedIndex)
- Specified by:
setRenderedIndex
in classAbstractUITabGroup
-
getActionListenerExpression
public jakarta.el.MethodExpression getActionListenerExpression()
-
setActionListenerExpression
public void setActionListenerExpression(jakarta.el.MethodExpression actionListener)
-
getAutoSpacing
public Boolean 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
public void setAutoSpacing(Boolean autoSpacing)
-
getSwitchType
public SwitchType 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:
getSwitchType
in classAbstractUITabGroup
-
setSwitchType
public void setSwitchType(SwitchType switchType)
-
getTabChangeListenerExpression
public jakarta.el.MethodExpression getTabChangeListenerExpression()
-
setTabChangeListenerExpression
public void setTabChangeListenerExpression(jakarta.el.MethodExpression tabChangeListener)
-
getMarkup
public Markup getMarkup()
-
setMarkup
public void setMarkup(Markup markup)
-
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
public CustomClass 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
public void setCustomClass(CustomClass customClass)
-
isShowNavigationBar
public boolean isShowNavigationBar()
Flag indicating that the tab navigation bar is rendered.
Default:true
- Specified by:
isShowNavigationBar
in classAbstractUITabGroup
-
setShowNavigationBar
public void setShowNavigationBar(boolean showNavigationBar)
-
getTip
public String getTip()
Text value to display as tooltip.- Specified by:
getTip
in classAbstractUIPanelBase
-
setTip
public void setTip(String tip)
-
getSelectedIndex
public Integer getSelectedIndex()
ValueBindingExpression pointing to a Integer to save the component's selected Tab.
Default:0
- Specified by:
getSelectedIndex
in classAbstractUITabGroup
-
setSelectedIndex
public void setSelectedIndex(Integer selectedIndex)
- Specified by:
setSelectedIndex
in classAbstractUITabGroup
-
restoreState
public void restoreState(jakarta.faces.context.FacesContext context, Object state)
- Specified by:
restoreState
in interfacejakarta.faces.component.StateHolder
- Overrides:
restoreState
in classjakarta.faces.component.UIComponentBase
-
-