org.apache.myfaces.tobago.component
Class UITabGroup

java.lang.Object
  extended by javax.faces.component.UIComponent
      extended by javax.faces.component.UIComponentBase
          extended by javax.faces.component.UIPanel
              extended by org.apache.myfaces.tobago.internal.component.AbstractUIPanelBase
                  extended by org.apache.myfaces.tobago.internal.component.AbstractUITabGroup
                      extended by org.apache.myfaces.tobago.component.UITabGroup
All Implemented Interfaces:
javax.faces.component.ActionSource, javax.faces.component.ActionSource2, javax.faces.component.StateHolder, OnComponentPopulated, SupportsMarkup, SupportsRenderedPartially, Configurable, TabChangeSource, LayoutBase, LayoutBox, LayoutComponent, LayoutContainer

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

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


Field Summary
static String COMPONENT_TYPE
           
 
Fields inherited from class org.apache.myfaces.tobago.internal.component.AbstractUITabGroup
SWITCH_TYPE_CLIENT, SWITCH_TYPE_RELOAD_PAGE, SWITCH_TYPE_RELOAD_TAB
 
Fields inherited from class javax.faces.component.UIPanel
COMPONENT_FAMILY
 
Fields inherited from class javax.faces.component.UIComponent
bindings
 
Fields inherited from interface org.apache.myfaces.tobago.component.OnComponentPopulated
MARKER
 
Constructor Summary
UITabGroup()
           
 
Method Summary
 javax.faces.el.MethodBinding getAction()
           
 javax.el.MethodExpression getActionExpression()
           
 javax.faces.el.MethodBinding getActionListener()
           
 Measure getBorderBottom()
          This attribute is for internal use only.
 Measure getBorderLeft()
          This attribute is for internal use only.
 Measure getBorderRight()
          This attribute is for internal use only.
 Measure getBorderTop()
          This attribute is for internal use only.
 Integer getColumnSpan()
           
 Measure getCurrentHeight()
          This value will usually be set by the layout manager.
 Markup getCurrentMarkup()
           
 Measure getCurrentWidth()
          This value will usually be set by the layout manager.
 Display getDisplay()
          This attribute is for internal use only.
 Measure getHeight()
          This value will usually be set by the layout manager.
 Integer getHorizontalIndex()
          This attribute is for internal use only.
 Measure getLeft()
          This value will usually be set by the layout manager.
 Measure getMarginBottom()
           
 Measure getMarginLeft()
           
 Measure getMarginRight()
           
 Measure getMarginTop()
           
 Markup getMarkup()
           
 Measure getMaximumHeight()
           
 Measure getMaximumWidth()
           
 Measure getMinimumHeight()
           
 Measure getMinimumWidth()
           
 Measure getPaddingBottom()
          This attribute is for internal use only.
 Measure getPaddingLeft()
          This attribute is for internal use only.
 Measure getPaddingRight()
          This attribute is for internal use only.
 Measure getPaddingTop()
          This attribute is for internal use only.
 Measure getPreferredHeight()
           
 Measure getPreferredWidth()
           
 Integer getRenderedIndex()
          For internal use.
 String[] getRenderedPartially()
          Indicate the partially rendered Components in a case of a submit.
 Integer getRowSpan()
           
 Integer getSelectedIndex()
          ValueBindingExpression pointing to a Integer to save the component's selected Tab.
 String getSwitchType()
          Indicating how tab switching should be done.
 javax.faces.el.MethodBinding getTabChangeListener()
           
 Measure getTop()
          This value will usually be set by the layout manager.
 Integer getVerticalIndex()
          This attribute is for internal use only.
 Measure getWidth()
          This value will usually be set by the layout manager.
 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 isOverflowX()
          This attribute is for internal use only.
 boolean isOverflowY()
          This attribute is for internal use only.
 boolean isShowNavigationBar()
          Flag indicating that the tab navigation bar is rendered.
 void restoreState(javax.faces.context.FacesContext context, Object componentState)
           
 Object saveState(javax.faces.context.FacesContext context)
           
 void setAction(javax.faces.el.MethodBinding action)
           
 void setActionExpression(javax.el.MethodExpression actionExpression)
           
 void setActionListener(javax.faces.el.MethodBinding actionListener)
           
 void setBorderBottom(Measure borderBottom)
           
 void setBorderLeft(Measure borderLeft)
           
 void setBorderRight(Measure borderRight)
           
 void setBorderTop(Measure borderTop)
           
 void setColumnSpan(Integer columnSpan)
           
 void setCurrentHeight(Measure currentHeight)
           
 void setCurrentMarkup(Markup currentMarkup)
           
 void setCurrentWidth(Measure currentWidth)
           
 void setDisplay(Display display)
           
 void setHeight(Measure height)
           
 void setHorizontalIndex(Integer horizontalIndex)
           
 void setImmediate(boolean immediate)
           
 void setLeft(Measure left)
           
 void setMarginBottom(Measure marginBottom)
           
 void setMarginLeft(Measure marginLeft)
           
 void setMarginRight(Measure marginRight)
           
 void setMarginTop(Measure marginTop)
           
 void setMarkup(Markup markup)
           
 void setMaximumHeight(Measure maximumHeight)
           
 void setMaximumWidth(Measure maximumWidth)
           
 void setMinimumHeight(Measure minimumHeight)
           
 void setMinimumWidth(Measure minimumWidth)
           
 void setOverflowX(boolean overflowX)
           
 void setOverflowY(boolean overflowY)
           
 void setPaddingBottom(Measure paddingBottom)
           
 void setPaddingLeft(Measure paddingLeft)
           
 void setPaddingRight(Measure paddingRight)
           
 void setPaddingTop(Measure paddingTop)
           
 void setPreferredHeight(Measure preferredHeight)
           
 void setPreferredWidth(Measure preferredWidth)
           
 void setRenderedIndex(Integer renderedIndex)
           
 void setRenderedPartially(String[] renderedPartially)
           
 void setRowSpan(Integer rowSpan)
           
 void setSelectedIndex(Integer selectedIndex)
           
 void setShowNavigationBar(boolean showNavigationBar)
           
 void setSwitchType(String switchType)
           
 void setTabChangeListener(javax.faces.el.MethodBinding tabChangeListener)
           
 void setTop(Measure top)
           
 void setVerticalIndex(Integer verticalIndex)
           
 void setWidth(Measure width)
           
 
Methods inherited from class org.apache.myfaces.tobago.internal.component.AbstractUITabGroup
addActionListener, addTabChangeListener, broadcast, encodeBegin, encodeChildren, encodeEnd, getActionListeners, getActiveTab, getComponents, getLayoutManager, getRendersChildren, getTabChangeListeners, getTabs, isLayoutChildren, isSwitchTypeClient, onComponentPopulated, processDecodes, processUpdates, processValidators, queueEvent, removeActionListener, removeTabChangeListener, setLayoutManager
 
Methods inherited from class javax.faces.component.UIPanel
getFamily
 
Methods inherited from class javax.faces.component.UIComponentBase
addFacesListener, decode, findComponent, getAttributes, getChildCount, getChildren, getClientId, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getParent, getRenderer, getRendererType, getValueBinding, invokeOnComponent, isRendered, isTransient, processRestoreState, processSaveState, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding
 
Methods inherited from class javax.faces.component.UIComponent
encodeAll, getContainerClientId, getValueExpression, setValueExpression
 
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.layout.LayoutComponent
isRendered
 
Methods inherited from interface org.apache.myfaces.tobago.config.Configurable
getRendererType
 

Field Detail

COMPONENT_TYPE

public static final String COMPONENT_TYPE
See Also:
Constant Field Values
Constructor Detail

UITabGroup

public UITabGroup()
Method Detail

getActionListener

public javax.faces.el.MethodBinding getActionListener()
Specified by:
getActionListener in interface javax.faces.component.ActionSource

setActionListener

public void setActionListener(javax.faces.el.MethodBinding actionListener)
Specified by:
setActionListener in interface javax.faces.component.ActionSource

getMarkup

public Markup getMarkup()
Specified by:
getMarkup in interface SupportsMarkup

setMarkup

public void setMarkup(Markup markup)
Specified by:
setMarkup in interface SupportsMarkup

getRenderedIndex

public Integer getRenderedIndex()
For internal use. TODO: Check if this long needed
Default: 0

Specified by:
getRenderedIndex in class AbstractUITabGroup

setRenderedIndex

public void setRenderedIndex(Integer renderedIndex)
Specified by:
setRenderedIndex in class AbstractUITabGroup

getMarginLeft

public Measure getMarginLeft()
Specified by:
getMarginLeft in interface LayoutBase

setMarginLeft

public void setMarginLeft(Measure marginLeft)
Specified by:
setMarginLeft in interface LayoutBase

getMinimumHeight

public Measure getMinimumHeight()
Specified by:
getMinimumHeight in interface LayoutBase

setMinimumHeight

public void setMinimumHeight(Measure minimumHeight)
Specified by:
setMinimumHeight in interface LayoutBase

getBorderLeft

public Measure getBorderLeft()
This attribute is for internal use only.

Specified by:
getBorderLeft in interface LayoutBox

setBorderLeft

public void setBorderLeft(Measure borderLeft)
Specified by:
setBorderLeft in interface LayoutBox

getHeight

public Measure getHeight()
This value will usually be set by the layout manager.

Specified by:
getHeight in interface LayoutBase

setHeight

public void setHeight(Measure height)
Specified by:
setHeight in interface LayoutBase

getMinimumWidth

public Measure getMinimumWidth()
Specified by:
getMinimumWidth in interface LayoutBase

setMinimumWidth

public void setMinimumWidth(Measure minimumWidth)
Specified by:
setMinimumWidth in interface LayoutBase

isOverflowX

public boolean isOverflowX()
This attribute is for internal use only.

Specified by:
isOverflowX in interface LayoutContainer

setOverflowX

public void setOverflowX(boolean overflowX)
Specified by:
setOverflowX in interface LayoutContainer

getAction

public javax.faces.el.MethodBinding getAction()
Specified by:
getAction in interface javax.faces.component.ActionSource

setAction

public void setAction(javax.faces.el.MethodBinding action)
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 actionExpression)
Specified by:
setActionExpression in interface javax.faces.component.ActionSource2

getRowSpan

public Integer getRowSpan()
Specified by:
getRowSpan in interface LayoutComponent

setRowSpan

public void setRowSpan(Integer rowSpan)
Specified by:
setRowSpan in interface LayoutComponent

isOverflowY

public boolean isOverflowY()
This attribute is for internal use only.

Specified by:
isOverflowY in interface LayoutContainer

setOverflowY

public void setOverflowY(boolean overflowY)
Specified by:
setOverflowY in interface LayoutContainer

getLeft

public Measure getLeft()
This value will usually be set by the layout manager.

Specified by:
getLeft in interface LayoutBase

setLeft

public void setLeft(Measure left)
Specified by:
setLeft in interface LayoutBase

getColumnSpan

public Integer getColumnSpan()
Specified by:
getColumnSpan in interface LayoutComponent

setColumnSpan

public void setColumnSpan(Integer columnSpan)
Specified by:
setColumnSpan in interface LayoutComponent

getBorderRight

public Measure getBorderRight()
This attribute is for internal use only.

Specified by:
getBorderRight in interface LayoutBox

setBorderRight

public void setBorderRight(Measure borderRight)
Specified by:
setBorderRight in interface LayoutBox

isShowNavigationBar

public boolean isShowNavigationBar()
Flag indicating that the tab navigation bar is rendered.
Default: true


setShowNavigationBar

public void setShowNavigationBar(boolean showNavigationBar)

getPaddingBottom

public Measure getPaddingBottom()
This attribute is for internal use only.

Specified by:
getPaddingBottom in interface LayoutBox

setPaddingBottom

public void setPaddingBottom(Measure paddingBottom)
Specified by:
setPaddingBottom in interface LayoutBox

getTabChangeListener

public javax.faces.el.MethodBinding getTabChangeListener()
Specified by:
getTabChangeListener in interface TabChangeSource

setTabChangeListener

public void setTabChangeListener(javax.faces.el.MethodBinding tabChangeListener)
Specified by:
setTabChangeListener in interface TabChangeSource

getMaximumHeight

public Measure getMaximumHeight()
Specified by:
getMaximumHeight in interface LayoutBase

setMaximumHeight

public void setMaximumHeight(Measure maximumHeight)
Specified by:
setMaximumHeight in interface LayoutBase

getTop

public Measure getTop()
This value will usually be set by the layout manager.

Specified by:
getTop in interface LayoutBase

setTop

public void setTop(Measure top)
Specified by:
setTop in interface LayoutBase

getCurrentWidth

public Measure getCurrentWidth()
This value will usually be set by the layout manager. It holds the current width computed by the layout manager.

Specified by:
getCurrentWidth in interface LayoutBase

setCurrentWidth

public void setCurrentWidth(Measure currentWidth)
Specified by:
setCurrentWidth in interface LayoutBase

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

getPaddingTop

public Measure getPaddingTop()
This attribute is for internal use only.

Specified by:
getPaddingTop in interface LayoutBox

setPaddingTop

public void setPaddingTop(Measure paddingTop)
Specified by:
setPaddingTop in interface LayoutBox

getMarginTop

public Measure getMarginTop()
Specified by:
getMarginTop in interface LayoutBase

setMarginTop

public void setMarginTop(Measure marginTop)
Specified by:
setMarginTop in interface LayoutBase

getWidth

public Measure getWidth()
This value will usually be set by the layout manager.

Specified by:
getWidth in interface LayoutBase

setWidth

public void setWidth(Measure width)
Specified by:
setWidth in interface LayoutBase

getMarginRight

public Measure getMarginRight()
Specified by:
getMarginRight in interface LayoutBase

setMarginRight

public void setMarginRight(Measure marginRight)
Specified by:
setMarginRight in interface LayoutBase

getCurrentHeight

public Measure getCurrentHeight()
This value will usually be set by the layout manager. It holds the current height computed by the layout manager.

Specified by:
getCurrentHeight in interface LayoutBase

setCurrentHeight

public void setCurrentHeight(Measure currentHeight)
Specified by:
setCurrentHeight in interface LayoutBase

getPreferredHeight

public Measure getPreferredHeight()
Specified by:
getPreferredHeight in interface LayoutBase

setPreferredHeight

public void setPreferredHeight(Measure preferredHeight)
Specified by:
setPreferredHeight in interface LayoutBase

getBorderBottom

public Measure getBorderBottom()
This attribute is for internal use only.

Specified by:
getBorderBottom in interface LayoutBox

setBorderBottom

public void setBorderBottom(Measure borderBottom)
Specified by:
setBorderBottom in interface LayoutBox

getDisplay

public Display getDisplay()
This attribute is for internal use only.

Specified by:
getDisplay in interface LayoutComponent

setDisplay

public void setDisplay(Display display)
Specified by:
setDisplay in interface LayoutComponent

getMaximumWidth

public Measure getMaximumWidth()
Specified by:
getMaximumWidth in interface LayoutBase

setMaximumWidth

public void setMaximumWidth(Measure maximumWidth)
Specified by:
setMaximumWidth in interface LayoutBase

getPaddingLeft

public Measure getPaddingLeft()
This attribute is for internal use only.

Specified by:
getPaddingLeft in interface LayoutBox

setPaddingLeft

public void setPaddingLeft(Measure paddingLeft)
Specified by:
setPaddingLeft in interface LayoutBox

getPaddingRight

public Measure getPaddingRight()
This attribute is for internal use only.

Specified by:
getPaddingRight in interface LayoutBox

setPaddingRight

public void setPaddingRight(Measure paddingRight)
Specified by:
setPaddingRight in interface LayoutBox

getPreferredWidth

public Measure getPreferredWidth()
Specified by:
getPreferredWidth in interface LayoutBase

setPreferredWidth

public void setPreferredWidth(Measure preferredWidth)
Specified by:
setPreferredWidth in interface LayoutBase

getSwitchType

public String 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(String switchType)

getMarginBottom

public Measure getMarginBottom()
Specified by:
getMarginBottom in interface LayoutBase

setMarginBottom

public void setMarginBottom(Measure marginBottom)
Specified by:
setMarginBottom in interface LayoutBase

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

getBorderTop

public Measure getBorderTop()
This attribute is for internal use only.

Specified by:
getBorderTop in interface LayoutBox

setBorderTop

public void setBorderTop(Measure borderTop)
Specified by:
setBorderTop in interface LayoutBox

getVerticalIndex

public Integer getVerticalIndex()
This attribute is for internal use only.

Specified by:
getVerticalIndex in interface LayoutComponent

setVerticalIndex

public void setVerticalIndex(Integer verticalIndex)
Specified by:
setVerticalIndex in interface LayoutComponent

getRenderedPartially

public String[] getRenderedPartially()
Indicate the partially rendered Components in a case of a submit.

Specified by:
getRenderedPartially in interface SupportsRenderedPartially

setRenderedPartially

public void setRenderedPartially(String[] renderedPartially)
Specified by:
setRenderedPartially in interface SupportsRenderedPartially

getCurrentMarkup

public Markup getCurrentMarkup()
Specified by:
getCurrentMarkup in interface SupportsMarkup
Specified by:
getCurrentMarkup in interface Configurable

setCurrentMarkup

public void setCurrentMarkup(Markup currentMarkup)
Specified by:
setCurrentMarkup in interface SupportsMarkup

getHorizontalIndex

public Integer getHorizontalIndex()
This attribute is for internal use only.

Specified by:
getHorizontalIndex in interface LayoutComponent

setHorizontalIndex

public void setHorizontalIndex(Integer horizontalIndex)
Specified by:
setHorizontalIndex in interface LayoutComponent

restoreState

public void restoreState(javax.faces.context.FacesContext context,
                         Object componentState)
Specified by:
restoreState in interface javax.faces.component.StateHolder
Overrides:
restoreState in class javax.faces.component.UIComponentBase

saveState

public Object saveState(javax.faces.context.FacesContext context)
Specified by:
saveState in interface javax.faces.component.StateHolder
Overrides:
saveState in class javax.faces.component.UIComponentBase


Copyright © 2002-2014 The Apache Software Foundation. All Rights Reserved.