UITab (RichFaces rich components 4.5.2.Final-redhat-1 API)

java.lang.Object
- javax.faces.component.UIComponent
- - javax.faces.component.UIComponentBase
  - - javax.faces.component.UICommand
    - - org.richfaces.component.AbstractActionComponent
      - org.richfaces.component.AbstractTab
        
        org.richfaces.component.UITab

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.component.TransientStateHolder, javax.faces.event.ComponentSystemEventListener, javax.faces.event.FacesListener, javax.faces.event.SystemEventListenerHolder, AbstractDivPanel, AbstractTogglePanelItemInterface, AbstractTogglePanelTitledItem, org.richfaces.component.attribute.AjaxActivatorProps, org.richfaces.component.attribute.AjaxProps, org.richfaces.component.attribute.BypassProps, org.richfaces.component.attribute.CoreProps, org.richfaces.component.attribute.DisabledProps, org.richfaces.component.attribute.EventsMouseProps, org.richfaces.component.attribute.I18nProps, org.richfaces.component.VisitChildrenRejectable
```
@Generated(value={"RichFaces CDK","4.3.1.Final-redhat-1"})
public class UITab
extends AbstractTab
implements javax.faces.component.behavior.ClientBehaviorHolder, AbstractTogglePanelTitledItem, org.richfaces.component.attribute.AjaxProps, org.richfaces.component.attribute.BypassProps, org.richfaces.component.attribute.CoreProps, org.richfaces.component.attribute.EventsMouseProps, org.richfaces.component.attribute.I18nProps
```
The <rich:tab> component represents an individual tab inside a <rich:tabPanel> component, including the tab's content. Clicking on the tab header will bring its corresponding content to the front of other tabs.

Author:

akolonitsky

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

protected static class UITab.Properties
- Nested classes/interfaces inherited from interface org.richfaces.component.AbstractTogglePanelTitledItem
  AbstractTogglePanelTitledItem.HeaderStates

Nested Classes
Modifier and Type	Class and Description
`protected static class`	`UITab.Properties`

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
  ATTRS_WITH_DECLARED_DEFAULT_VALUES, BEANINFO_KEY, bindings, COMPOSITE_COMPONENT_TYPE_KEY, COMPOSITE_FACET_NAME, CURRENT_COMPONENT, CURRENT_COMPOSITE_COMPONENT, FACETS_KEY, HONOR_CURRENT_COMPONENT_ATTRIBUTES_PARAM_NAME, VIEW_LOCATION_KEY

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

Constructor Summary

Constructors
Constructor and Description

UITab()

Constructors
Constructor and Description
`UITab()`

Method Summary

Methods
Modifier and Type	Method and Description
`Object`	`getData()`
`String`	`getDefaultEventName()`
`String`	`getDir()`
`Collection<String>`	`getEventNames()`
`String`	`getFamily()`
`String`	`getHeaderStyle()` The CSS style applied to the header
`String`	`getLang()`
`String`	`getOnbeforedomupdate()`
`String`	`getOnbegin()`
`String`	`getOnclick()`
`String`	`getOncomplete()`
`String`	`getOndblclick()`
`String`	`getOnenter()` The function to perform when the mouse enters the panel
`String`	`getOnheaderclick()` Javascript code executed when a pointer button is clicked over the header of this element.
`String`	`getOnheaderdblclick()` Javascript code executed when a pointer button is double clicked over the header of this element.
`String`	`getOnheadermousedown()` Javascript code executed when a pointer button is pressed down over the header of this element.
`String`	`getOnheadermousemove()` Javascript code executed when a pointer button is moved within the header of this element.
`String`	`getOnheadermouseup()` Javascript code executed when a pointer button is released over the header of this element.
`String`	`getOnleave()` The function to perform when the mouse leaves the panel.
`String`	`getOnmousedown()`
`String`	`getOnmousemove()`
`String`	`getOnmouseout()`
`String`	`getOnmouseover()`
`String`	`getOnmouseup()`
`Object`	`getRender()`
`String`	`getStatus()`
`String`	`getStyle()`
`String`	`getStyleClass()`
`String`	`getTitle()`
`Object`	`getValue()` Suppress the inherited value attribute from the taglib.
`boolean`	`isBypassUpdates()`
`boolean`	`isDisabled()`
`boolean`	`isLimitRender()`
`boolean`	`isResetValues()`
`void`	`setBypassUpdates(boolean bypassUpdates)`
`void`	`setData(Object data)`
`void`	`setDir(String dir)`
`void`	`setDisabled(boolean disabled)`
`void`	`setHeaderStyle(String headerStyle)`
`void`	`setLang(String lang)`
`void`	`setLimitRender(boolean limitRender)`
`void`	`setOnbeforedomupdate(String onbeforedomupdate)`
`void`	`setOnbegin(String onbegin)`
`void`	`setOnclick(String onclick)`
`void`	`setOncomplete(String oncomplete)`
`void`	`setOndblclick(String ondblclick)`
`void`	`setOnenter(String onenter)`
`void`	`setOnheaderclick(String onheaderclick)`
`void`	`setOnheaderdblclick(String onheaderdblclick)`
`void`	`setOnheadermousedown(String onheadermousedown)`
`void`	`setOnheadermousemove(String onheadermousemove)`
`void`	`setOnheadermouseup(String onheadermouseup)`
`void`	`setOnleave(String onleave)`
`void`	`setOnmousedown(String onmousedown)`
`void`	`setOnmousemove(String onmousemove)`
`void`	`setOnmouseout(String onmouseout)`
`void`	`setOnmouseover(String onmouseover)`
`void`	`setOnmouseup(String onmouseup)`
`void`	`setRender(Object render)`
`void`	`setResetValues(boolean resetValues)`
`void`	`setStatus(String status)`
`void`	`setStyle(String style)`
`void`	`setStyleClass(String styleClass)`
`void`	`setTitle(String title)`
`void`	`setValue(Object value)`

Methods inherited from class org.richfaces.component.AbstractTab
getContentClass, getExecute, getHeader, getHeaderActiveClass, getHeaderClass, getHeaderDisabledClass, getHeaderFacet, getHeaderFacet, getHeaderInactiveClass, getName, getParentPanel, getRenderer, getSwitchType, getTabPanel, getVisitableChildren, isActive, isDynamicPanelItem, setContentClass, setExecute, setHeader, setHeaderActiveClass, setHeaderClass, setHeaderDisabledClass, setHeaderInactiveClass, setName, setSwitchType, shouldVisitChildren, toString, visitTree

Methods inherited from class org.richfaces.component.AbstractActionComponent
queueEvent

Methods inherited from class javax.faces.component.UICommand
addActionListener, broadcast, getAction, getActionExpression, getActionListener, getActionListeners, isImmediate, removeActionListener, setAction, setActionExpression, setActionListener, setImmediate

Methods inherited from class javax.faces.component.UIComponentBase
addClientBehavior, addFacesListener, clearInitialState, decode, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getClientId, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getListenersForEventClass, getParent, getRendererType, getRendersChildren, getValueBinding, invokeOnComponent, isRendered, isTransient, markInitialState, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, removeFacesListener, restoreAttachedState, restoreState, saveAttachedState, saveState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding, subscribeToEvent, unsubscribeFromEvent

Methods inherited from class javax.faces.component.UIComponent
encodeAll, getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getNamingContainer, getResourceBundleMap, getStateHelper, getStateHelper, getTransientStateHelper, getTransientStateHelper, getValueExpression, initialStateMarked, isCompositeComponent, isInView, isVisitable, popComponentFromEL, processEvent, pushComponentToEL, restoreTransientState, saveTransientState, setInView, setValueExpression

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface javax.faces.component.behavior.ClientBehaviorHolder
addClientBehavior, getClientBehaviors

Methods inherited from interface org.richfaces.component.AbstractTogglePanelTitledItem
getContentClass, getHeader, getHeaderActiveClass, getHeaderClass, getHeaderDisabledClass, getHeaderInactiveClass

Methods inherited from interface org.richfaces.component.AbstractTogglePanelItemInterface
getClientId, getName, getParentPanel, getSwitchType, isActive, isDynamicPanelItem, isRendered

Methods inherited from interface org.richfaces.component.VisitChildrenRejectable
shouldVisitChildren

Methods inherited from interface org.richfaces.component.attribute.AjaxProps
getExecute

- 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
  - UITab
```
public UITab()
```
- Method Detail
  - getFamily
```
public String getFamily()
```
    Overrides:
    
    getFamily in class javax.faces.component.UICommand
  - 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
  - isBypassUpdates
```
public boolean isBypassUpdates()
```
    Specified by:
    
    isBypassUpdates in interface org.richfaces.component.attribute.BypassProps
  - setBypassUpdates
```
public void setBypassUpdates(boolean bypassUpdates)
```
  - getData
```
public Object getData()
```
    Specified by:
    
    getData in interface org.richfaces.component.attribute.AjaxActivatorProps
  - setData
```
public void setData(Object data)
```
  - getDir
```
public String getDir()
```
    Specified by:
    
    getDir in interface org.richfaces.component.attribute.I18nProps
  - setDir
```
public void setDir(String dir)
```
  - isDisabled
```
public boolean isDisabled()
```
    Specified by:
    
    isDisabled in interface org.richfaces.component.attribute.DisabledProps
  - setDisabled
```
public void setDisabled(boolean disabled)
```
  - getHeaderStyle
```
public String getHeaderStyle()
```
    Description copied from interface: AbstractTogglePanelTitledItem
    
    The CSS style applied to the header
    
    Specified by:
    
    getHeaderStyle in interface AbstractTogglePanelTitledItem
  - setHeaderStyle
```
public void setHeaderStyle(String headerStyle)
```
  - getLang
```
public String getLang()
```
    Specified by:
    
    getLang in interface org.richfaces.component.attribute.I18nProps
  - setLang
```
public void setLang(String lang)
```
  - isLimitRender
```
public boolean isLimitRender()
```
    Specified by:
    
    isLimitRender in interface org.richfaces.component.attribute.AjaxActivatorProps
  - setLimitRender
```
public void setLimitRender(boolean limitRender)
```
  - getOnbeforedomupdate
```
public String getOnbeforedomupdate()
```
    Specified by:
    
    getOnbeforedomupdate in interface org.richfaces.component.attribute.AjaxActivatorProps
  - setOnbeforedomupdate
```
public void setOnbeforedomupdate(String onbeforedomupdate)
```
  - getOnbegin
```
public String getOnbegin()
```
    Specified by:
    
    getOnbegin in interface org.richfaces.component.attribute.AjaxProps
  - setOnbegin
```
public void setOnbegin(String onbegin)
```
  - getOnclick
```
public String getOnclick()
```
    Specified by:
    
    getOnclick in interface org.richfaces.component.attribute.EventsMouseProps
  - setOnclick
```
public void setOnclick(String onclick)
```
  - getOncomplete
```
public String getOncomplete()
```
    Specified by:
    
    getOncomplete in interface org.richfaces.component.attribute.AjaxActivatorProps
  - setOncomplete
```
public void setOncomplete(String oncomplete)
```
  - getOndblclick
```
public String getOndblclick()
```
    Specified by:
    
    getOndblclick in interface org.richfaces.component.attribute.EventsMouseProps
  - setOndblclick
```
public void setOndblclick(String ondblclick)
```
  - getOnenter
```
public String getOnenter()
```
    Description copied from interface: AbstractTogglePanelItemInterface
    
    The function to perform when the mouse enters the panel
    
    Specified by:
    
    getOnenter in interface AbstractTogglePanelItemInterface
  - setOnenter
```
public void setOnenter(String onenter)
```
  - getOnheaderclick
```
public String getOnheaderclick()
```
    Description copied from interface: AbstractTogglePanelTitledItem
    
    Javascript code executed when a pointer button is clicked over the header of this element.
    
    Specified by:
    
    getOnheaderclick in interface AbstractTogglePanelTitledItem
  - setOnheaderclick
```
public void setOnheaderclick(String onheaderclick)
```
  - getOnheaderdblclick
```
public String getOnheaderdblclick()
```
    Description copied from interface: AbstractTogglePanelTitledItem
    
    Javascript code executed when a pointer button is double clicked over the header of this element.
    
    Specified by:
    
    getOnheaderdblclick in interface AbstractTogglePanelTitledItem
  - setOnheaderdblclick
```
public void setOnheaderdblclick(String onheaderdblclick)
```
  - getOnheadermousedown
```
public String getOnheadermousedown()
```
    Description copied from interface: AbstractTogglePanelTitledItem
    
    Javascript code executed when a pointer button is pressed down over the header of this element.
    
    Specified by:
    
    getOnheadermousedown in interface AbstractTogglePanelTitledItem
  - setOnheadermousedown
```
public void setOnheadermousedown(String onheadermousedown)
```
  - getOnheadermousemove
```
public String getOnheadermousemove()
```
    Description copied from interface: AbstractTogglePanelTitledItem
    
    Javascript code executed when a pointer button is moved within the header of this element.
    
    Specified by:
    
    getOnheadermousemove in interface AbstractTogglePanelTitledItem
  - setOnheadermousemove
```
public void setOnheadermousemove(String onheadermousemove)
```
  - getOnheadermouseup
```
public String getOnheadermouseup()
```
    Description copied from interface: AbstractTogglePanelTitledItem
    
    Javascript code executed when a pointer button is released over the header of this element.
    
    Specified by:
    
    getOnheadermouseup in interface AbstractTogglePanelTitledItem
  - setOnheadermouseup
```
public void setOnheadermouseup(String onheadermouseup)
```
  - getOnleave
```
public String getOnleave()
```
    Description copied from interface: AbstractTogglePanelItemInterface
    
    The function to perform when the mouse leaves the panel.
    
    Specified by:
    
    getOnleave in interface AbstractTogglePanelItemInterface
  - setOnleave
```
public void setOnleave(String onleave)
```
  - getOnmousedown
```
public String getOnmousedown()
```
    Specified by:
    
    getOnmousedown in interface org.richfaces.component.attribute.EventsMouseProps
  - setOnmousedown
```
public void setOnmousedown(String onmousedown)
```
  - getOnmousemove
```
public String getOnmousemove()
```
    Specified by:
    
    getOnmousemove in interface org.richfaces.component.attribute.EventsMouseProps
  - setOnmousemove
```
public void setOnmousemove(String onmousemove)
```
  - getOnmouseout
```
public String getOnmouseout()
```
    Specified by:
    
    getOnmouseout in interface org.richfaces.component.attribute.EventsMouseProps
  - setOnmouseout
```
public void setOnmouseout(String onmouseout)
```
  - getOnmouseover
```
public String getOnmouseover()
```
    Specified by:
    
    getOnmouseover in interface org.richfaces.component.attribute.EventsMouseProps
  - setOnmouseover
```
public void setOnmouseover(String onmouseover)
```
  - getOnmouseup
```
public String getOnmouseup()
```
    Specified by:
    
    getOnmouseup in interface org.richfaces.component.attribute.EventsMouseProps
  - setOnmouseup
```
public void setOnmouseup(String onmouseup)
```
  - getRender
```
public Object getRender()
```
    Specified by:
    
    getRender in interface org.richfaces.component.attribute.AjaxActivatorProps
  - setRender
```
public void setRender(Object render)
```
  - isResetValues
```
public boolean isResetValues()
```
    Specified by:
    
    isResetValues in interface org.richfaces.component.attribute.AjaxActivatorProps
  - setResetValues
```
public void setResetValues(boolean resetValues)
```
  - getStatus
```
public String getStatus()
```
    Specified by:
    
    getStatus in interface org.richfaces.component.attribute.AjaxProps
  - setStatus
```
public void setStatus(String status)
```
  - getStyle
```
public String getStyle()
```
    Specified by:
    
    getStyle in interface org.richfaces.component.attribute.CoreProps
  - setStyle
```
public void setStyle(String style)
```
  - getStyleClass
```
public String getStyleClass()
```
    Specified by:
    
    getStyleClass in interface org.richfaces.component.attribute.CoreProps
  - setStyleClass
```
public void setStyleClass(String styleClass)
```
  - getTitle
```
public String getTitle()
```
    Specified by:
    
    getTitle in interface org.richfaces.component.attribute.CoreProps
  - setTitle
```
public void setTitle(String title)
```
  - getValue
```
public Object getValue()
```
    Description copied from class: AbstractTab
    
    Suppress the inherited value attribute from the taglib.
    
    Specified by:
    
    getValue in class AbstractTab
  - setValue
```
public void setValue(Object value)
```
    Overrides:
    
    setValue in class javax.faces.component.UICommand

Class UITab

Nested Class Summary

Nested classes/interfaces inherited from interface org.richfaces.component.AbstractTogglePanelTitledItem

Field Summary

Fields inherited from class javax.faces.component.UIComponent

Constructor Summary

Method Summary

Methods inherited from class org.richfaces.component.AbstractTab

Methods inherited from class org.richfaces.component.AbstractActionComponent

Methods inherited from class javax.faces.component.UICommand

Methods inherited from class javax.faces.component.UIComponentBase

Methods inherited from class javax.faces.component.UIComponent

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.richfaces.component.AbstractTogglePanelTitledItem

Methods inherited from interface org.richfaces.component.AbstractTogglePanelItemInterface

Methods inherited from interface org.richfaces.component.VisitChildrenRejectable

Methods inherited from interface org.richfaces.component.attribute.AjaxProps

Field Detail

COMPONENT_TYPE

COMPONENT_FAMILY

Constructor Detail

UITab

Method Detail

getFamily

getEventNames

getDefaultEventName

isBypassUpdates

setBypassUpdates

getData

setData

getDir

setDir

isDisabled

setDisabled

getHeaderStyle

setHeaderStyle

getLang

setLang

isLimitRender

setLimitRender

getOnbeforedomupdate

setOnbeforedomupdate

getOnbegin

setOnbegin

getOnclick

setOnclick

getOncomplete

setOncomplete

getOndblclick

setOndblclick

getOnenter

setOnenter

getOnheaderclick

setOnheaderclick

getOnheaderdblclick

setOnheaderdblclick

getOnheadermousedown

setOnheadermousedown

getOnheadermousemove

setOnheadermousemove

getOnheadermouseup

setOnheadermouseup

getOnleave

setOnleave

getOnmousedown

setOnmousedown

getOnmousemove

setOnmousemove

getOnmouseout

setOnmouseout

getOnmouseover

setOnmouseover

getOnmouseup

setOnmouseup

getRender

setRender

isResetValues

setResetValues

getStatus