org.rcfaces.core.component
Class TabbedPaneComponent

java.lang.Object
  extended by javax.faces.component.UIComponent
      extended by javax.faces.component.UIComponentBase
          extended by javax.faces.component.UIOutput
              extended by javax.faces.component.UIInput
                  extended by org.rcfaces.core.internal.component.CameliaInputComponent
                      extended by org.rcfaces.core.component.AbstractInputComponent
                          extended by org.rcfaces.core.component.CardBoxComponent
                              extended by org.rcfaces.core.component.TabbedPaneComponent
All Implemented Interfaces:
EditableValueHolder, StateHolder, ValueHolder, IAccessKeyCapability, IAsyncDecodeModeCapability, IAsyncRenderModeCapability, IClientDataCapability, IClosableCapability, ICloseEventCapability, IDisabledCapability, IErrorEventCapability, IFocusBlurEventCapability, IFontCapability, IForegroundBackgroundColorCapability, IHeightCapability, IHelpCapability, IHiddenModeCapability, IImmediateCapability, IInitEventCapability, IKeyDownEventCapability, IKeyEventCapability, IKeyPressEventCapability, IKeyUpEventCapability, ILayoutPositionCapability, ILookAndFeelCapability, IMarginCapability, IMouseEventCapability, IPartialRenderingCapability, IPositionCapability, IPreferencesCapability, IPreSelectionEventCapability, IPropertyChangeEventCapability, ISelectionEventCapability, IServerDataCapability, IShowValueCapability, ISizeCapability, IStyleClassCapability, ITabIndexCapability, ITextAlignmentCapability, IToolTipCapability, IUnlockedClientAttributesCapability, IUserEventCapability, IValidationEventCapability, IValueLockedCapability, IVisibilityCapability, IWAIRoleCapability, IWidthCapability, org.rcfaces.core.internal.capability.IComponentLifeCycle, org.rcfaces.core.internal.capability.IConvertValueHolder, org.rcfaces.core.internal.capability.IPreferencesSettings, org.rcfaces.core.internal.capability.IRCFacesComponent, org.rcfaces.core.internal.capability.ISubmittedExternalValue, org.rcfaces.core.internal.capability.IVariableScopeCapability, org.rcfaces.core.internal.manager.IClientDataManager, org.rcfaces.core.internal.manager.IContainerManager, org.rcfaces.core.internal.manager.IServerDataManager, org.rcfaces.core.internal.manager.ITransientAttributesManager

public class TabbedPaneComponent
extends CardBoxComponent
implements ICloseEventCapability, IClosableCapability, IPreSelectionEventCapability, IShowValueCapability

The tabbedPane Component provides a way to show more information on a single page. It can download the data asynchronously via AJAX.

The tabbedPane Component has the following capabilities :

The default tabbedPane renderer is linked to the f_tabbedPane javascript class. f_tabbedPane extends f_cardBox

Table of component style classes:

Style Name Description
f_tabbedPane Defines styles for the wrapper element
f_tabbedPane_title Defines styles for the TABLE element
f_tabbedPane_content Defines styles for the DIV element
f_tabbedPane_tab Defines styles for the DIV element


Field Summary
protected static Set CAMELIA_ATTRIBUTES
           
static String COMPONENT_TYPE
           
 
Fields inherited from class org.rcfaces.core.component.CardBoxComponent
CAMELIA_VALUE_ALIAS
 
Fields inherited from class org.rcfaces.core.internal.component.CameliaInputComponent
engine
 
Fields inherited from class javax.faces.component.UIInput
COMPONENT_FAMILY, CONVERSION_MESSAGE_ID, REQUIRED_MESSAGE_ID, UPDATE_MESSAGE_ID
 
Fields inherited from class javax.faces.component.UIComponent
bindings
 
Fields inherited from interface org.rcfaces.core.component.capability.IAsyncRenderModeCapability
BUFFER_ASYNC_RENDER_MODE, DEFAULT_ASYNC_RENDER_MODE, NONE_ASYNC_RENDER_MODE, TREE_ASYNC_RENDER_MODE
 
Fields inherited from interface org.rcfaces.core.component.capability.IAsyncDecodeModeCapability
COMPLETE_ASYNC_DECODE_MODE, DEFAULT_ASYNC_DECODE_MODE, PARTIAL_ASYNC_DECODE_MODE
 
Fields inherited from interface org.rcfaces.core.component.capability.IHiddenModeCapability
CLIENT_HIDDEN_MODE, DEFAULT_HIDDEN_MODE, IGNORE_HIDDEN_MODE, PHANTOM_HIDDEN_MODE, SERVER_HIDDEN_MODE
 
Constructor Summary
TabbedPaneComponent()
           
TabbedPaneComponent(String componentId)
           
 
Method Summary
 void addCloseListener(ICloseListener listener)
          Adds a listener to the component for the close event
 void addPreSelectionListener(IPreSelectionListener listener)
          Adds a listener to the component for the preSelection event
protected  Set getCameliaFields()
           
 TabComponent getSelectedTab()
           
 TabComponent getSelectedTab(FacesContext facesContext)
           
 Object getShowValue()
           
 Object getShowValue(FacesContext facesContext)
          See getShowValue() for more details
 boolean isClosable()
          Experimental : Do not use !
 boolean isClosable(FacesContext facesContext)
          See isClosable() for more details
 boolean isClosableSetted()
          Returns true if the attribute "closable" is set.
 boolean isShowValueSetted()
          Returns true if the attribute "showValue" is set.
 FacesListener[] listCloseListeners()
          Returns a list of close listener for the component
 FacesListener[] listPreSelectionListeners()
          Returns a list of PreSelection listener for the component
 ITabIterator listTabs()
           
 void removeCloseListener(ICloseListener listener)
          Removes a listener from the component for the close event
 void removePreSelectionListener(IPreSelectionListener listener)
          Removes a listener from the component for the preSelection event
 void select(TabComponent tab)
           
 void setClosable(boolean closable)
          Experimental : Do not use !
 void setShowValue(Object showValue)
          Set the value of the item will be shown.
 
Methods inherited from class org.rcfaces.core.component.CardBoxComponent
addSelectionListener, getAsyncDecodeMode, getAsyncDecodeMode, getAsyncRenderMode, getAsyncRenderMode, getCameliaValueAlias, getPreferences, getPreferences, getScopeValue, getScopeValue, getScopeVar, getScopeVar, getSelectedCard, getSelectedCard, isAsyncDecodeModeSetted, isAsyncRenderModeSetted, isPreferencesSetted, isScopeSaveValue, isScopeSaveValue, isScopeSaveValueSetted, isScopeValueSetted, isScopeVarSetted, listCards, listSelectionListeners, removeSelectionListener, select, setAsyncDecodeMode, setAsyncDecodeMode, setAsyncRenderMode, setAsyncRenderMode, setPreferences, setScopeSaveValue, setScopeValue, setScopeVar, verifyAsyncDecode
 
Methods inherited from class org.rcfaces.core.component.AbstractInputComponent
addBlurListener, addErrorListener, addFocusListener, addInitListener, addKeyDownListener, addKeyPressListener, addKeyUpListener, addMouseOutListener, addMouseOverListener, addPropertyChangeListener, addUserEventListener, addValidationListener, getAccessKey, getAccessKey, getAriaLabel, getAriaLabel, getAriaLevel, getAriaLevel, getBackgroundColor, getBackgroundColor, getBottom, getBottom, getClientData, getClientData, getClientDataCount, getClientDataMap, getClientDataMap, getFontBold, getFontBold, getFontItalic, getFontItalic, getFontName, getFontName, getFontSize, getFontSize, getFontUnderline, getFontUnderline, getForegroundColor, getForegroundColor, getHeight, getHeight, getHelpMessage, getHelpMessage, getHelpURL, getHelpURL, getHiddenMode, getHiddenMode, getLeft, getLeft, getLookId, getLookId, getMarginBottom, getMarginBottom, getMarginLeft, getMarginLeft, getMarginRight, getMarginRight, getMarginTop, getMarginTop, getRight, getRight, getServerData, getServerData, getServerDataCount, getServerDataMap, getServerDataMap, getStyleClass, getStyleClass, getTabIndex, getTabIndex, getTextAlignment, getTextAlignment, getToolTipText, getToolTipText, getTop, getTop, getUnlockedClientAttributeNames, getUnlockedClientAttributeNames, getVisibleState, getVisibleState, getWaiRole, getWaiRole, getWidth, getWidth, getX, getX, getY, getY, isAccessKeySetted, isAriaLabelSetted, isAriaLevelSetted, isBackgroundColorSetted, isBottomSetted, isDisabled, isDisabled, isDisabledSetted, isFontBoldSetted, isFontItalicSetted, isFontNameSetted, isFontSizeSetted, isFontUnderlineSetted, isForegroundColorSetted, isHeightSetted, isHelpMessageSetted, isHelpURLSetted, isHiddenModeSetted, isLeftSetted, isLookIdSetted, isMarginBottomSetted, isMarginLeftSetted, isMarginRightSetted, isMarginTopSetted, isPartialRendering, isPartialRendering, isPartialRenderingSetted, isRightSetted, isStyleClassSetted, isTabIndexSetted, isTextAlignmentSetted, isToolTipTextSetted, isTopSetted, isUnlockedClientAttributeNamesSetted, isValueLocked, isValueLocked, isValueLockedSetted, isVisible, isVisible, isVisibleSetted, isWaiRoleSetted, isWidthSetted, isXSetted, isYSetted, listBlurListeners, listClientDataKeys, listClientDataKeys, listErrorListeners, listFocusListeners, listInitListeners, listKeyDownListeners, listKeyPressListeners, listKeyUpListeners, listMouseOutListeners, listMouseOverListeners, listPropertyChangeListeners, listServerDataKeys, listServerDataKeys, listUserEventListeners, listValidationListeners, removeBlurListener, removeClientData, removeErrorListener, removeFocusListener, removeInitListener, removeKeyDownListener, removeKeyPressListener, removeKeyUpListener, removeMouseOutListener, removeMouseOverListener, removePropertyChangeListener, removeServerData, removeUserEventListener, removeValidationListener, setAccessKey, setAriaLabel, setAriaLevel, setBackgroundColor, setBottom, setClientData, setClientData, setDisabled, setFontBold, setFontItalic, setFontName, setFontSize, setFontUnderline, setForegroundColor, setHeight, setHelpMessage, setHelpURL, setHiddenMode, setHiddenMode, setLeft, setLookId, setMarginBottom, setMarginLeft, setMarginRight, setMargins, setMarginTop, setPartialRendering, setRight, setServerData, setServerData, setStyleClass, setTabIndex, setTextAlignment, setToolTipText, setTop, setUnlockedClientAttributeNames, setValueLocked, setVisible, setWaiRole, setWidth, setX, setY
 
Methods inherited from class org.rcfaces.core.internal.component.CameliaInputComponent
broadcast, clearListeners, confirmListenerAppend, constructPhase, constructTemplate, decodePhase, encodeBegin, encodeChildren, encodeEnd, getAsyncRenderer, getChildren, getChildrenListState, getConvertedValue, getFamily, getLocalValue, getRendererType, getSubmittedExternalValue, getTransientAttribute, getValue, getValueExpression, hasDefaultProperties, initializeComponent, initializePhase, isClientRendered, isRendered, isSubmittedValueSetted, isTemplateComponent, processDecodes, processEngineUpdates, processEngineValidators, processUpdates, processValidators, queueEvent, renderPhase, restoreState, saveState, setConverter, setConverter, setDefaultProperties, setRendered, setSubmittedExternalValue, setTransientAttribute, setValueExpression, toString, updatePhase, validationPhase
 
Methods inherited from class javax.faces.component.UIInput
addValidator, addValueChangeListener, compareValues, decode, getConverterMessage, getRequiredMessage, getSubmittedValue, getValidator, getValidatorMessage, getValidators, getValueChangeListener, getValueChangeListeners, isImmediate, isLocalValueSet, isRequired, isValid, removeValidator, removeValueChangeListener, resetValue, setConverterMessage, setImmediate, setLocalValueSet, setRequired, setRequiredMessage, setSubmittedValue, setValid, setValidator, setValidatorMessage, setValue, setValueChangeListener, updateModel, validate, validateValue
 
Methods inherited from class javax.faces.component.UIOutput
getConverter, setConverter
 
Methods inherited from class javax.faces.component.UIComponentBase
addFacesListener, findComponent, getAttributes, getChildCount, getClientId, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getParent, getRenderer, getRendersChildren, getValueBinding, invokeOnComponent, isTransient, processRestoreState, processSaveState, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding
 
Methods inherited from class javax.faces.component.UIComponent
encodeAll, getContainerClientId
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface org.rcfaces.core.component.capability.IImmediateCapability
isImmediate, setImmediate
 
Methods inherited from interface org.rcfaces.core.internal.manager.IContainerManager
getChildCount
 
Methods inherited from interface javax.faces.component.ValueHolder
getConverter, setConverter, setValue
 

Field Detail

COMPONENT_TYPE

public static final String COMPONENT_TYPE
See Also:
Constant Field Values

CAMELIA_ATTRIBUTES

protected static final Set CAMELIA_ATTRIBUTES
Constructor Detail

TabbedPaneComponent

public TabbedPaneComponent()

TabbedPaneComponent

public TabbedPaneComponent(String componentId)
Method Detail

listTabs

public ITabIterator listTabs()

getSelectedTab

public TabComponent getSelectedTab()

getSelectedTab

public TabComponent getSelectedTab(FacesContext facesContext)

select

public void select(TabComponent tab)

addCloseListener

public final void addCloseListener(ICloseListener listener)
Description copied from interface: ICloseEventCapability
Adds a listener to the component for the close event

Specified by:
addCloseListener in interface ICloseEventCapability
Parameters:
listener - the close listener to add

removeCloseListener

public final void removeCloseListener(ICloseListener listener)
Description copied from interface: ICloseEventCapability
Removes a listener from the component for the close event

Specified by:
removeCloseListener in interface ICloseEventCapability
Parameters:
listener - the close listener to remove

listCloseListeners

public final FacesListener[] listCloseListeners()
Description copied from interface: ICloseEventCapability
Returns a list of close listener for the component

Specified by:
listCloseListeners in interface ICloseEventCapability
Returns:
close listeners' list

isClosable

public boolean isClosable()
Description copied from interface: IClosableCapability
Experimental : Do not use !

Specified by:
isClosable in interface IClosableCapability
Returns:
true is the component can be closed.

isClosable

public boolean isClosable(FacesContext facesContext)
See isClosable() for more details


isClosableSetted

public final boolean isClosableSetted()
Returns true if the attribute "closable" is set.

Returns:
true if the attribute is set.

setClosable

public void setClosable(boolean closable)
Description copied from interface: IClosableCapability
Experimental : Do not use !

Specified by:
setClosable in interface IClosableCapability

addPreSelectionListener

public final void addPreSelectionListener(IPreSelectionListener listener)
Description copied from interface: IPreSelectionEventCapability
Adds a listener to the component for the preSelection event

Specified by:
addPreSelectionListener in interface IPreSelectionEventCapability
Parameters:
listener - the preSelection listener to add

removePreSelectionListener

public final void removePreSelectionListener(IPreSelectionListener listener)
Description copied from interface: IPreSelectionEventCapability
Removes a listener from the component for the preSelection event

Specified by:
removePreSelectionListener in interface IPreSelectionEventCapability
Parameters:
listener - the PreSelection listener to remove

listPreSelectionListeners

public final FacesListener[] listPreSelectionListeners()
Description copied from interface: IPreSelectionEventCapability
Returns a list of PreSelection listener for the component

Specified by:
listPreSelectionListeners in interface IPreSelectionEventCapability
Returns:
preSelection listeners' list

getShowValue

public Object getShowValue()
Specified by:
getShowValue in interface IShowValueCapability
Returns:
The value of the item will be shown.

getShowValue

public Object getShowValue(FacesContext facesContext)
See getShowValue() for more details


isShowValueSetted

public final boolean isShowValueSetted()
Returns true if the attribute "showValue" is set.

Returns:
true if the attribute is set.

setShowValue

public void setShowValue(Object showValue)
Description copied from interface: IShowValueCapability
Set the value of the item will be shown.

Specified by:
setShowValue in interface IShowValueCapability
Parameters:
showValue - The value of the item

getCameliaFields

protected Set getCameliaFields()
Overrides:
getCameliaFields in class CardBoxComponent


Copyright © 2006-2011 Vedana. All Rights Reserved.