Class UITabGroup
java.lang.Object
org.apache.myfaces.tobago.internal.component.AbstractUIPanelBase
org.apache.myfaces.tobago.internal.component.AbstractUITabGroup
org.apache.myfaces.tobago.component.UITabGroup
- All Implemented Interfaces:
EventListener, SupportsAutoSpacing, Visual, TabChangeSource
Renders a tab group which contains tab panels.
UIComponent class, generated from template
component.stg with class
TabGroupTagDeclaration.-
Field Summary
Fields -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoidaddClientBehavior(String arg0, jakarta.faces.component.behavior.ClientBehavior arg1) voidaddClientBehavior(String arg0, jakarta.faces.component.behavior.ClientBehavior arg1) protected voidaddFacesListener(jakarta.faces.event.FacesListener arg0) voidvoiddecode(jakarta.faces.context.FacesContext arg0) voidencodeAll(jakarta.faces.context.FacesContext arg0) voidencodeBegin(jakarta.faces.context.FacesContext arg0) jakarta.faces.component.UIComponentfindComponent(String arg0) jakarta.el.MethodExpressionjakarta.el.MethodExpressionAutomatically add spacing (margins/paddings) to the component for better positioning.intList<jakarta.faces.component.UIComponent> getClientId(jakarta.faces.context.FacesContext arg0) static jakarta.faces.component.UIComponentgetCompositeComponentParent(jakarta.faces.component.UIComponent arg0) getContainerClientId(jakarta.faces.context.FacesContext arg0) static jakarta.faces.component.UIComponentgetCurrentComponent(jakarta.faces.context.FacesContext arg0) static jakarta.faces.component.UIComponentgetCurrentCompositeComponent(jakarta.faces.context.FacesContext arg0) Sets a CSS class in its parent, if the parent supports it.protected jakarta.faces.context.FacesContextprotected jakarta.faces.event.FacesListener[]getFacesListeners(Class arg0) jakarta.faces.component.UIComponentintIterator<jakarta.faces.component.UIComponent> getId()List<jakarta.faces.event.SystemEventListener> getListenersForEventClass(Class<? extends jakarta.faces.event.SystemEvent> arg0) jakarta.faces.component.UIComponentjakarta.faces.component.UIComponentgetPassThroughAttributes(boolean arg0) For internal use.protected jakarta.faces.render.RenderergetRenderer(jakarta.faces.context.FacesContext arg0) ValueBindingExpression pointing to a Integer to save the component's selected Tab.protected jakarta.faces.component.StateHelperprotected jakarta.faces.component.StateHelpergetStateHelper(boolean arg0) Indicating how tab switching should be done.jakarta.el.MethodExpressiongetTip()Text value to display as tooltip.jakarta.faces.component.TransientStateHelperjakarta.faces.component.TransientStateHelpergetTransientStateHelper(boolean arg0) jakarta.el.ValueExpressiongetValueExpression(String arg0) booleanbooleaninvokeOnComponent(jakarta.faces.context.FacesContext arg0, String arg1, jakarta.faces.component.ContextCallback arg2) static booleanisCompositeComponent(jakarta.faces.component.UIComponent arg0) 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.booleanisInView()booleanbooleanFlag indicating that the tab navigation bar is rendered.booleanprotected booleanisVisitable(jakarta.faces.component.visit.VisitContext arg0) voidvoidpopComponentFromEL(jakarta.faces.context.FacesContext arg0) voidprocessEvent(jakarta.faces.event.ComponentSystemEvent arg0) voidprocessRestoreState(jakarta.faces.context.FacesContext arg0, Object arg1) processSaveState(jakarta.faces.context.FacesContext arg0) voidpushComponentToEL(jakarta.faces.context.FacesContext arg0, jakarta.faces.component.UIComponent arg1) protected voidremoveFacesListener(jakarta.faces.event.FacesListener arg0) static ObjectrestoreAttachedState(jakarta.faces.context.FacesContext arg0, Object arg1) voidrestoreState(jakarta.faces.context.FacesContext context, Object state) voidrestoreTransientState(jakarta.faces.context.FacesContext arg0, Object arg1) static ObjectsaveAttachedState(jakarta.faces.context.FacesContext arg0, Object arg1) saveState(jakarta.faces.context.FacesContext arg0) saveTransientState(jakarta.faces.context.FacesContext arg0) voidsetActionExpression(jakarta.el.MethodExpression action) voidsetActionListenerExpression(jakarta.el.MethodExpression actionListener) voidsetAutoSpacing(Boolean autoSpacing) voidsetCustomClass(CustomClass customClass) voidvoidsetImmediate(boolean immediate) voidsetInView(boolean arg0) voidvoidsetParent(jakarta.faces.component.UIComponent arg0) voidsetRendered(boolean arg0) voidsetRenderedIndex(Integer renderedIndex) voidsetRendererType(String arg0) voidsetSelectedIndex(Integer selectedIndex) voidsetShowNavigationBar(boolean showNavigationBar) voidsetSwitchType(SwitchType switchType) voidsetTabChangeListenerExpression(jakarta.el.MethodExpression tabChangeListener) voidvoidsetTransient(boolean arg0) voidsetValueExpression(String arg0, jakarta.el.ValueExpression arg1) voidsubscribeToEvent(Class<? extends jakarta.faces.event.SystemEvent> arg0, jakarta.faces.event.ComponentSystemEventListener arg1) voidunsubscribeFromEvent(Class<? extends jakarta.faces.event.SystemEvent> arg0, jakarta.faces.event.ComponentSystemEventListener arg1) booleanvisitTree(jakarta.faces.component.visit.VisitContext arg0, jakarta.faces.component.visit.VisitCallback arg1) Methods inherited from class AbstractUITabGroup
addActionListener, addTabChangeListener, broadcast, encodeChildren, encodeEnd, getActionListeners, getActiveTab, getRendersChildren, getTabChangeListeners, getTabs, processDecodes, processUpdates, processValidators, queueEvent, removeActionListener, removeTabChangeListenerMethods inherited from class Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface SupportsAutoSpacing
getAutoSpacingMethods inherited from interface Visual
getRendererType, isPlain
-
Field Details
-
COMPONENT_TYPE
-
COMPONENT_FAMILY
- See Also:
-
BEANINFO_KEY
- See Also:
-
COMPOSITE_COMPONENT_TYPE_KEY
- See Also:
-
COMPOSITE_FACET_NAME
- See Also:
-
FACETS_KEY
- See Also:
-
VIEW_LOCATION_KEY
- See Also:
-
ATTRS_WITH_DECLARED_DEFAULT_VALUES
- See Also:
-
bindings
Deprecated.
-
-
Constructor Details
-
UITabGroup
public UITabGroup()
-
-
Method Details
-
getEventNames
-
getDefaultEventName
-
getFamily
-
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 - popover - 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
-
addClientBehavior
-
getClientBehaviors
-
setId
-
setParent
public void setParent(jakarta.faces.component.UIComponent arg0) -
addClientBehavior
-
clearInitialState
public void clearInitialState() -
decode
public void decode(jakarta.faces.context.FacesContext arg0) -
encodeAll
- Throws:
IOException
-
encodeBegin
- Throws:
IOException
-
findComponent
-
getAttributes
-
getPassThroughAttributes
-
getChildCount
public int getChildCount() -
getChildren
-
getClientBehaviors
-
getClientId
-
getFacet
-
getFacetCount
public int getFacetCount() -
getFacets
-
getFacetsAndChildren
-
getId
-
getParent
public jakarta.faces.component.UIComponent getParent() -
getRendererType
-
invokeOnComponent
public boolean invokeOnComponent(jakarta.faces.context.FacesContext arg0, String arg1, jakarta.faces.component.ContextCallback arg2) throws jakarta.faces.FacesException - Throws:
jakarta.faces.FacesException
-
visitTree
public boolean visitTree(jakarta.faces.component.visit.VisitContext arg0, jakarta.faces.component.visit.VisitCallback arg1) -
isRendered
public boolean isRendered() -
isTransient
public boolean isTransient() -
markInitialState
public void markInitialState() -
addFacesListener
protected void addFacesListener(jakarta.faces.event.FacesListener arg0) -
getFacesContext
protected jakarta.faces.context.FacesContext getFacesContext() -
getFacesListeners
-
getRenderer
protected jakarta.faces.render.Renderer getRenderer(jakarta.faces.context.FacesContext arg0) -
removeFacesListener
protected void removeFacesListener(jakarta.faces.event.FacesListener arg0) -
processSaveState
-
processRestoreState
-
setTransient
public void setTransient(boolean arg0) -
saveAttachedState
-
restoreAttachedState
public static Object restoreAttachedState(jakarta.faces.context.FacesContext arg0, Object arg1) throws IllegalStateException - Throws:
IllegalStateException
-
saveState
-
setRendered
public void setRendered(boolean arg0) -
setRendererType
-
getPassThroughAttributes
-
initialStateMarked
public boolean initialStateMarked() -
isCompositeComponent
public static boolean isCompositeComponent(jakarta.faces.component.UIComponent arg0) -
isInView
public boolean isInView() -
isVisitable
protected boolean isVisitable(jakarta.faces.component.visit.VisitContext arg0) -
setValueExpression
-
getClientId
-
getCompositeComponentParent
public static jakarta.faces.component.UIComponent getCompositeComponentParent(jakarta.faces.component.UIComponent arg0) -
getContainerClientId
-
getCurrentComponent
public static jakarta.faces.component.UIComponent getCurrentComponent(jakarta.faces.context.FacesContext arg0) -
getCurrentCompositeComponent
public static jakarta.faces.component.UIComponent getCurrentCompositeComponent(jakarta.faces.context.FacesContext arg0) -
getListenersForEventClass
-
getNamingContainer
public jakarta.faces.component.UIComponent getNamingContainer() -
setInView
public void setInView(boolean arg0) -
getResourceBundleMap
-
getValueExpression
-
processEvent
public void processEvent(jakarta.faces.event.ComponentSystemEvent arg0) throws jakarta.faces.event.AbortProcessingException - Throws:
jakarta.faces.event.AbortProcessingException
-
subscribeToEvent
public void subscribeToEvent(Class<? extends jakarta.faces.event.SystemEvent> arg0, jakarta.faces.event.ComponentSystemEventListener arg1) -
unsubscribeFromEvent
public void unsubscribeFromEvent(Class<? extends jakarta.faces.event.SystemEvent> arg0, jakarta.faces.event.ComponentSystemEventListener arg1) -
getStateHelper
protected jakarta.faces.component.StateHelper getStateHelper() -
getStateHelper
protected jakarta.faces.component.StateHelper getStateHelper(boolean arg0) -
getTransientStateHelper
public jakarta.faces.component.TransientStateHelper getTransientStateHelper() -
getTransientStateHelper
public jakarta.faces.component.TransientStateHelper getTransientStateHelper(boolean arg0) -
restoreTransientState
-
saveTransientState
-
popComponentFromEL
public void popComponentFromEL(jakarta.faces.context.FacesContext arg0) -
pushComponentToEL
public void pushComponentToEL(jakarta.faces.context.FacesContext arg0, jakarta.faces.component.UIComponent arg1)
-