com.ibm.xsp.component
Class UITabbedPanel

java.lang.Object
  javax.faces.component.UIComponent
      javax.faces.component.UIComponentBase
          javax.faces.component.UIPanel
              com.ibm.xsp.component.UITabbedPanel

All Implemented Interfaces:

FacesAttrsObject, ThemeControl, javax.faces.component.StateHolder

Direct Known Subclasses:

XspTabbedPanel

public class UITabbedPanel
extends javax.faces.component.UIPanel
implements ThemeControl, FacesAttrsObject

Not intended to be subclassed.

Nested Class Summary

static class

UITabbedPanel.TabChangeEvent

Nested classes/interfaces inherited from class javax.faces.component.UIComponentBase

javax.faces.component.UIComponentBase.AggregatedIterator, javax.faces.component.UIComponentBase.UnmodifiableIterator

Nested classes/interfaces inherited from class javax.faces.component.UIComponent

javax.faces.component.UIComponent.StateMap, javax.faces.component.UIComponent.StateMapEntry

Field Summary

static java.lang.String	COMPONENT_FAMILY
static java.lang.String	COMPONENT_TYPE
static java.lang.String	RENDERER_TYPE

Fields inherited from class javax.faces.component.UIComponentBase

EMPTY_ITERATOR

Fields inherited from class javax.faces.component.UIComponent

_xspStateId

Constructor Summary

UITabbedPanel()
Default constructor for a tabbed panel

Method Summary

void	addAttr(Attr attr) Add an Attr, to appear as an attribute in the HTML output of this control or object tag.
void	broadcast(javax.faces.event.FacesEvent event)
java.util.List<Attr>	getAttrs() The extra attributes to be output on the base element at the root of this control or object tag.
java.lang.String	getFamily()
java.lang.String	getRefreshId()
java.lang.String	getSelectedTab()
XspTabPanel	getSelectedTabPanel()
java.lang.String	getStyleKitFamily() The styleKitFamily is basically the default themeId, to use if the "themeId" property is not set on this control instance in the XPage source.
boolean	isPartialExecute()
boolean	isPartialRefresh()
void	queueEvent(javax.faces.event.FacesEvent e)
void	restoreState(javax.faces.context.FacesContext context, java.lang.Object state)
java.lang.Object	saveState(javax.faces.context.FacesContext context)
void	setAttrs(java.util.List<Attr> attrs) This method is not used by the XPage generated .java file - instead the addAttr(Attr) method is used to add attributes to the list.
void	setPartialExecute(boolean partialExecute)
void	setPartialRefresh(boolean partialRefresh)
void	setRefreshId(java.lang.String partialRefreshId)
void	setSelectedTab(java.lang.String selectedTab)

Methods inherited from class javax.faces.component.UIComponentBase

_xspCleanTransientData, _xspGetReadOnlyObj, _xspGetRendererData, _xspRemoveReadOnlyObj, _xspRemoveRendererData, _xspSetIdUnchecked, _xspSetReadOnlyObj, _xspSetRendererData, addFacesListener, decode, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientId, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getParent, getRenderer, getRendererType, getRendersChildren, getValueBinding, isRendered, isTransient, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding

Methods inherited from class javax.faces.component.UIComponent

_xspGetStateId, _xspGetStateMap, _xspRestoreAttribute, _xspRestoreState, _xspSaveState, invokeOnComponent, isVisitable, markInitialState, setControlState, visitTree

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

COMPONENT_TYPE

public static final java.lang.String COMPONENT_TYPE

See Also:

Constant Field Values

COMPONENT_FAMILY

public static final java.lang.String COMPONENT_FAMILY

See Also:

Constant Field Values

RENDERER_TYPE

public static final java.lang.String RENDERER_TYPE

See Also:

Constant Field Values

Constructor Detail

UITabbedPanel

public UITabbedPanel()

Default constructor for a tabbed panel

Method Detail

getStyleKitFamily

public java.lang.String getStyleKitFamily()

Description copied from interface: ThemeControl

The styleKitFamily is basically the default themeId, to use if the "themeId" property is not set on this control instance in the XPage source. For example, "InputField.EditBox" is used for most Edit Box controls. See Domino/xsp/nsf/themes/webstandard.theme for more examples.

The implementation may return different values depending on the configuration of the current control, for example the Button control returns a different value and looks different when it is configured as a cancel button.

Specified by:

getStyleKitFamily in interface ThemeControl

Returns:

a non-null themeId corresponding to the configuration for this type of control in a theme file.

getFamily

public java.lang.String getFamily()

Overrides:

getFamily in class javax.faces.component.UIPanel

isPartialExecute

public boolean isPartialExecute()

setPartialExecute

public void setPartialExecute(boolean partialExecute)

isPartialRefresh

public boolean isPartialRefresh()

setPartialRefresh

public void setPartialRefresh(boolean partialRefresh)

getRefreshId

public java.lang.String getRefreshId()

setRefreshId

public void setRefreshId(java.lang.String partialRefreshId)

getSelectedTab

public java.lang.String getSelectedTab()

Returns:

the selectedTab

setSelectedTab

public void setSelectedTab(java.lang.String selectedTab)

Parameters:

selectedTab - the selectedTab to set

getSelectedTabPanel

public XspTabPanel getSelectedTabPanel()

getAttrs

public java.util.List<Attr> getAttrs()

The extra attributes to be output on the base element at the root of this control or object tag. This should only be used when none of the properties in the All Properties pane correspond to the desired attribute. This may return null. The addAttr(Attr) method should be used to add an Attr.

Specified by:

getAttrs in interface FacesAttrsObject

addAttr

public void addAttr(Attr attr)

Add an Attr, to appear as an attribute in the HTML output of this control or object tag.

Specified by:

addAttr in interface FacesAttrsObject

Parameters:

action -

setAttrs

public void setAttrs(java.util.List<Attr> attrs)

This method is not used by the XPage generated .java file - instead the addAttr(Attr) method is used to add attributes to the list.

broadcast

public void broadcast(javax.faces.event.FacesEvent event)
               throws javax.faces.event.AbortProcessingException

Overrides:

broadcast in class javax.faces.component.UIComponentBase

Throws:

javax.faces.event.AbortProcessingException

queueEvent

public void queueEvent(javax.faces.event.FacesEvent e)

Overrides:

queueEvent in class javax.faces.component.UIComponentBase

saveState

public java.lang.Object saveState(javax.faces.context.FacesContext context)

Specified by:

saveState in interface javax.faces.component.StateHolder

Overrides:

saveState in class javax.faces.component.UIComponentBase

restoreState

public void restoreState(javax.faces.context.FacesContext context,
                         java.lang.Object state)

Specified by:

restoreState in interface javax.faces.component.StateHolder

Overrides:

restoreState in class javax.faces.component.UIComponentBase