UITab (RichFaces Distribution Assembler 4.5.5.Final 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, AjaxActivatorProps, AjaxProps, BypassProps, CoreProps, DisabledProps, EventsMouseProps, I18nProps, VisitChildrenRejectable
```
@Generated(value={"RichFaces CDK","4.5.0-SNAPSHOT"})
public class UITab
extends AbstractTab
implements javax.faces.component.behavior.ClientBehaviorHolder, AbstractTogglePanelTitledItem, AjaxProps, BypassProps, CoreProps, EventsMouseProps, 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()` Serialized (on default with JSON) data passed to the client by a developer on an AJAX request.
`String`	`getDefaultEventName()`
`String`	`getDir()` Direction indication for text that does not inherit directionality.
`Collection<String>`	`getEventNames()`
`String`	`getFamily()`
`String`	`getHeaderStyle()` The CSS style applied to the header
`String`	`getLang()` Code describing the language used in the generated markup for this component.
`String`	`getOnbeforedomupdate()` The client-side script method to be called after the ajax response comes back, but before the DOM is updated
`String`	`getOnbegin()` The client-side script method to be called before an ajax request.
`String`	`getOnclick()` Javascript code executed when a pointer button is clicked over this element.
`String`	`getOncomplete()` The client-side script method to be called after the DOM is updated
`String`	`getOndblclick()` Javascript code executed when a pointer button is double clicked over this element.
`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()` Javascript code executed when a pointer button is pressed down over this element.
`String`	`getOnmousemove()` Javascript code executed when a pointer button is moved within this element.
`String`	`getOnmouseout()` Javascript code executed when a pointer button is moved away from this element.
`String`	`getOnmouseover()` Javascript code executed when a pointer button is moved onto this element.
`String`	`getOnmouseup()` Javascript code executed when a pointer button is released over this element.
`Object`	`getRender()` IDs of components that will participate in the "render" portion of the Request Processing Lifecycle.
`String`	`getStatus()` Name of the request status component that will indicate the status of the Ajax request
`String`	`getStyle()` CSS style(s) to be applied when this component is rendered.
`String`	`getStyleClass()` Space-separated list of CSS style class(es) to be applied when this element is rendered.
`String`	`getTitle()` Advisory title information about markup elements generated for this component.
`Object`	`getValue()` Suppress the inherited value attribute from the taglib.
`boolean`	`isBypassUpdates()` If "true", after process validations phase it skips updates of model beans on a force render response.
`boolean`	`isDisabled()` Flag indicating that this element must never receive focus or be included in a subsequent submit.
`boolean`	`isLimitRender()` If "true", render only those ids specified in the "render" attribute, forgoing the render of the auto-rendered panels
`boolean`	`isResetValues()` If true, indicate that this particular Ajax transaction is a value reset transaction.
`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, getPassThroughAttributes, 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, getPassThroughAttributes, 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()
```
    Description copied from interface: BypassProps
    
    If "true", after process validations phase it skips updates of model beans on a force render response. It can be used for validating components input.
    
    Specified by:
    
    isBypassUpdates in interface BypassProps
  - setBypassUpdates
```
public void setBypassUpdates(boolean bypassUpdates)
```
  - getData
```
public Object getData()
```
    Description copied from interface: AjaxActivatorProps
    
    Serialized (on default with JSON) data passed to the client by a developer on an AJAX request. It's accessible via "event.data" syntax. Both primitive types and complex types such as arrays and collections can be serialized and used with data
    
    Specified by:
    
    getData in interface AjaxActivatorProps
  - setData
```
public void setData(Object data)
```
  - getDir
```
public String getDir()
```
    Description copied from interface: I18nProps
    
    Direction indication for text that does not inherit directionality. Valid values are "LTR" (left-to-right) and "RTL" (right-to-left).
    
    Specified by:
    
    getDir in interface I18nProps
  - setDir
```
public void setDir(String dir)
```
  - isDisabled
```
public boolean isDisabled()
```
    Description copied from interface: DisabledProps
    
    Flag indicating that this element must never receive focus or be included in a subsequent submit.
    
    Specified by:
    
    isDisabled in interface 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()
```
    Description copied from interface: I18nProps
    
    Code describing the language used in the generated markup for this component.
    
    Specified by:
    
    getLang in interface I18nProps
  - setLang
```
public void setLang(String lang)
```
  - isLimitRender
```
public boolean isLimitRender()
```
    Description copied from interface: AjaxActivatorProps
    
    If "true", render only those ids specified in the "render" attribute, forgoing the render of the auto-rendered panels
    
    Specified by:
    
    isLimitRender in interface AjaxActivatorProps
  - setLimitRender
```
public void setLimitRender(boolean limitRender)
```
  - getOnbeforedomupdate
```
public String getOnbeforedomupdate()
```
    Description copied from interface: AjaxActivatorProps
    
    The client-side script method to be called after the ajax response comes back, but before the DOM is updated
    
    Specified by:
    
    getOnbeforedomupdate in interface AjaxActivatorProps
  - setOnbeforedomupdate
```
public void setOnbeforedomupdate(String onbeforedomupdate)
```
  - getOnbegin
```
public String getOnbegin()
```
    Description copied from interface: AjaxProps
    
    The client-side script method to be called before an ajax request.
    
    Specified by:
    
    getOnbegin in interface AjaxProps
  - setOnbegin
```
public void setOnbegin(String onbegin)
```
  - getOnclick
```
public String getOnclick()
```
    Description copied from interface: EventsMouseProps
    
    Javascript code executed when a pointer button is clicked over this element.
    
    Specified by:
    
    getOnclick in interface EventsMouseProps
  - setOnclick
```
public void setOnclick(String onclick)
```
  - getOncomplete
```
public String getOncomplete()
```
    Description copied from interface: AjaxActivatorProps
    
    The client-side script method to be called after the DOM is updated
    
    Specified by:
    
    getOncomplete in interface AjaxActivatorProps
  - setOncomplete
```
public void setOncomplete(String oncomplete)
```
  - getOndblclick
```
public String getOndblclick()
```
    Description copied from interface: EventsMouseProps
    
    Javascript code executed when a pointer button is double clicked over this element.
    
    Specified by:
    
    getOndblclick in interface 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()
```
    Description copied from interface: EventsMouseProps
    
    Javascript code executed when a pointer button is pressed down over this element.
    
    Specified by:
    
    getOnmousedown in interface EventsMouseProps
  - setOnmousedown
```
public void setOnmousedown(String onmousedown)
```
  - getOnmousemove
```
public String getOnmousemove()
```
    Description copied from interface: EventsMouseProps
    
    Javascript code executed when a pointer button is moved within this element.
    
    Specified by:
    
    getOnmousemove in interface EventsMouseProps
  - setOnmousemove
```
public void setOnmousemove(String onmousemove)
```
  - getOnmouseout
```
public String getOnmouseout()
```
    Description copied from interface: EventsMouseProps
    
    Javascript code executed when a pointer button is moved away from this element.
    
    Specified by:
    
    getOnmouseout in interface EventsMouseProps
  - setOnmouseout
```
public void setOnmouseout(String onmouseout)
```
  - getOnmouseover
```
public String getOnmouseover()
```
    Description copied from interface: EventsMouseProps
    
    Javascript code executed when a pointer button is moved onto this element.
    
    Specified by:
    
    getOnmouseover in interface EventsMouseProps
  - setOnmouseover
```
public void setOnmouseover(String onmouseover)
```
  - getOnmouseup
```
public String getOnmouseup()
```
    Description copied from interface: EventsMouseProps
    
    Javascript code executed when a pointer button is released over this element.
    
    Specified by:
    
    getOnmouseup in interface EventsMouseProps
  - setOnmouseup
```
public void setOnmouseup(String onmouseup)
```
  - getRender
```
public Object getRender()
```
    Description copied from interface: AjaxActivatorProps
    
    IDs of components that will participate in the "render" portion of the Request Processing Lifecycle. Can be a single ID, a space or comma separated list of Id's, or an EL Expression evaluating to an array or Collection. Any of the keywords "@this", "@form", "@all", "@none", "@region" may be specified in the identifier list. Some components make use of additional keywords
    
    Specified by:
    
    getRender in interface AjaxActivatorProps
  - setRender
```
public void setRender(Object render)
```
  - isResetValues
```
public boolean isResetValues()
```
    Description copied from interface: AjaxActivatorProps
    
    If true, indicate that this particular Ajax transaction is a value reset transaction. This will cause resetValue() to be called on any EditableValueHolder instances encountered as a result of this ajax transaction. If not specified, or the value is false, no such indication is made.
    
    Specified by:
    
    isResetValues in interface AjaxActivatorProps
  - setResetValues
```
public void setResetValues(boolean resetValues)
```
  - getStatus
```
public String getStatus()
```
    Description copied from interface: AjaxProps
    
    Name of the request status component that will indicate the status of the Ajax request
    
    Specified by:
    
    getStatus in interface AjaxProps
  - setStatus
```
public void setStatus(String status)
```
  - getStyle
```
public String getStyle()
```
    Description copied from interface: CoreProps
    
    CSS style(s) to be applied when this component is rendered.
    
    Specified by:
    
    getStyle in interface CoreProps
  - setStyle
```
public void setStyle(String style)
```
  - getStyleClass
```
public String getStyleClass()
```
    Description copied from interface: CoreProps
    
    Space-separated list of CSS style class(es) to be applied when this element is rendered. This value must be passed through as the "class" attribute on generated markup.
    
    Specified by:
    
    getStyleClass in interface CoreProps
  - setStyleClass
```
public void setStyleClass(String styleClass)
```
  - getTitle
```
public String getTitle()
```
    Description copied from interface: CoreProps
    
    Advisory title information about markup elements generated for this component.
    
    Specified by:
    
    getTitle in interface 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