org.apache.myfaces.tobago.component

Class UITabGroup

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.AbstractUITabGroup

org.apache.myfaces.tobago.component.UITabGroup

All Implemented Interfaces:

EventListener, javax.faces.component.ActionSource, javax.faces.component.ActionSource2, javax.faces.component.behavior.ClientBehaviorHolder, javax.faces.component.PartialStateHolder, javax.faces.component.StateHolder, javax.faces.event.ComponentSystemEventListener, javax.faces.event.FacesListener, javax.faces.event.SystemEventListenerHolder, Visual, TabChangeSource, TabChangeSource2

public class UITabGroup
extends AbstractUITabGroup
implements javax.faces.component.ActionSource2, Visual

Renders a tab group which contains tab panels. UIComponent class, generated from template component.stg with class TabGroupTagDeclaration.

Field Summary

Fields

Modifier and Type	Field and Description
static String	COMPONENT_FAMILY
static String	COMPONENT_TYPE

Fields inherited from class javax.faces.component.UIComponent

BEANINFO_KEY, bindings, COMPOSITE_COMPONENT_TYPE_KEY, COMPOSITE_FACET_NAME, CURRENT_COMPONENT, CURRENT_COMPOSITE_COMPONENT, FACETS_KEY, VIEW_LOCATION_KEY

Constructor Summary

Constructors

Constructor and Description
UITabGroup()

Method Summary

Modifier and Type	Method and Description
javax.faces.el.MethodBinding	getAction() Deprecated. since 2.0.0
javax.el.MethodExpression	getActionExpression()
javax.faces.el.MethodBinding	getActionListener() Deprecated. since 2.0.0
javax.el.MethodExpression	getActionListenerExpression()
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.
Style	getStyle() For internal use.
SwitchType	getSwitchType() Indicating how tab switching should be done.
javax.faces.el.MethodBinding	getTabChangeListener() Deprecated. since 2.0.0
javax.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	setAction(javax.faces.el.MethodBinding action) Deprecated. since 2.0.0
void	setActionExpression(javax.el.MethodExpression action)
void	setActionListener(javax.faces.el.MethodBinding actionListener) Deprecated. since 2.0.0
void	setActionListenerExpression(javax.el.MethodExpression actionListener)
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	setStyle(Style style)
void	setSwitchType(SwitchType switchType)
void	setTabChangeListener(javax.faces.el.MethodBinding tabChangeListener) Deprecated. since 2.0.0
void	setTabChangeListenerExpression(javax.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 org.apache.myfaces.tobago.internal.component.AbstractUIPanelBase

encodeBegin

Methods inherited from class javax.faces.component.UIComponentBase

addClientBehavior, addFacesListener, clearInitialState, decode, encodeAll, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getClientId, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getParent, getRenderer, getRendererType, getValueBinding, initialStateMarked, invokeOnComponent, isRendered, isTransient, markInitialState, processRestoreState, processSaveState, removeFacesListener, restoreAttachedState, restoreState, saveAttachedState, saveState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding, visitTree

Methods inherited from class javax.faces.component.UIComponent

getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getListenersForEventClass, getNamingContainer, getResourceBundleMap, getStateHelper, getStateHelper, getValueExpression, isCompositeComponent, isInView, isVisitable, popComponentFromEL, processEvent, pushComponentToEL, 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.ActionSource

addActionListener, getActionListeners, removeActionListener

Methods inherited from interface org.apache.myfaces.tobago.component.Visual

getRendererType

Methods inherited from interface javax.faces.component.behavior.ClientBehaviorHolder

addClientBehavior, getClientBehaviors

Field Detail

COMPONENT_TYPE

public static final String COMPONENT_TYPE

See Also:

Constant Field Values

COMPONENT_FAMILY

public static final String COMPONENT_FAMILY

See Also:

Constant Field Values

Constructor Detail

UITabGroup

public UITabGroup()

Method Detail

getEventNames

public Collection<String> getEventNames()

Specified by:

getEventNames in interface javax.faces.component.behavior.ClientBehaviorHolder

Overrides:

getEventNames in class javax.faces.component.UIComponentBase

getDefaultEventName

public String getDefaultEventName()

Specified by:

getDefaultEventName in interface javax.faces.component.behavior.ClientBehaviorHolder

Overrides:

getDefaultEventName in class javax.faces.component.UIComponentBase

getFamily

public String getFamily()

Overrides:

getFamily in class javax.faces.component.UIPanel

getRenderedIndex

public Integer getRenderedIndex()

For internal use. TBD: Check if this is needed any longer.
Default: 0

Specified by:

getRenderedIndex in class AbstractUITabGroup

setRenderedIndex

public void setRenderedIndex(Integer renderedIndex)

Specified by:

setRenderedIndex in class AbstractUITabGroup

getActionListener

@Deprecated
public javax.faces.el.MethodBinding getActionListener()

Deprecated. since 2.0.0

Specified by:

getActionListener in interface javax.faces.component.ActionSource

setActionListener

@Deprecated
public void setActionListener(javax.faces.el.MethodBinding actionListener)

Deprecated. since 2.0.0

Specified by:

setActionListener in interface javax.faces.component.ActionSource

getActionListenerExpression

public javax.el.MethodExpression getActionListenerExpression()

setActionListenerExpression

public void setActionListenerExpression(javax.el.MethodExpression actionListener)

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 class AbstractUITabGroup

setSwitchType

public void setSwitchType(SwitchType switchType)

getTabChangeListener

@Deprecated
public javax.faces.el.MethodBinding getTabChangeListener()

Deprecated. since 2.0.0

Specified by:

getTabChangeListener in interface TabChangeSource

setTabChangeListener

@Deprecated
public void setTabChangeListener(javax.faces.el.MethodBinding tabChangeListener)

Deprecated. since 2.0.0

Specified by:

setTabChangeListener in interface TabChangeSource

getTabChangeListenerExpression

public javax.el.MethodExpression getTabChangeListenerExpression()

Specified by:

getTabChangeListenerExpression in interface TabChangeSource2

setTabChangeListenerExpression

public void setTabChangeListenerExpression(javax.el.MethodExpression tabChangeListener)

Specified by:

setTabChangeListenerExpression in interface TabChangeSource2

getMarkup

public Markup getMarkup()

Specified by:

getMarkup in interface Visual

setMarkup

public void setMarkup(Markup markup)

Specified by:

setMarkup in interface Visual

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

Specified by:

isImmediate in interface javax.faces.component.ActionSource

setImmediate

public void setImmediate(boolean immediate)

Specified by:

setImmediate in interface javax.faces.component.ActionSource

getAction

@Deprecated
public javax.faces.el.MethodBinding getAction()

Deprecated. since 2.0.0

Specified by:

getAction in interface javax.faces.component.ActionSource

setAction

@Deprecated
public void setAction(javax.faces.el.MethodBinding action)

Deprecated. since 2.0.0

Specified by:

setAction in interface javax.faces.component.ActionSource

getActionExpression

public javax.el.MethodExpression getActionExpression()

Specified by:

getActionExpression in interface javax.faces.component.ActionSource2

setActionExpression

public void setActionExpression(javax.el.MethodExpression action)

Specified by:

setActionExpression in interface javax.faces.component.ActionSource2

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.

Specified by:

getCustomClass in interface Visual

setCustomClass

public void setCustomClass(CustomClass customClass)

Specified by:

setCustomClass in interface Visual

isShowNavigationBar

public boolean isShowNavigationBar()

Flag indicating that the tab navigation bar is rendered.
Default: true

setShowNavigationBar

public void setShowNavigationBar(boolean showNavigationBar)

getStyle

public Style getStyle()

For internal use. Used for rendering, if there is a child tag <tc:style>

Specified by:

getStyle in interface Visual

setStyle

public void setStyle(Style style)

Specified by:

setStyle in interface Visual

getTip

public String getTip()

Text value to display as tooltip.

Specified by:

getTip in class AbstractUIPanelBase

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 class AbstractUITabGroup

setSelectedIndex

public void setSelectedIndex(Integer selectedIndex)

Specified by:

setSelectedIndex in class AbstractUITabGroup