org.rcfaces.core.component
Class CardBoxComponent

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
All Implemented Interfaces:
EditableValueHolder, StateHolder, ValueHolder, IAccessKeyCapability, IAsyncDecodeModeCapability, IAsyncRenderModeCapability, IClientDataCapability, IDisabledCapability, IErrorEventCapability, IFocusBlurEventCapability, IFontCapability, IForegroundBackgroundColorCapability, IHeightCapability, IHelpCapability, IHiddenModeCapability, IImmediateCapability, IInitEventCapability, IKeyDownEventCapability, IKeyEventCapability, IKeyPressEventCapability, IKeyUpEventCapability, ILayoutPositionCapability, ILookAndFeelCapability, IMarginCapability, IMouseEventCapability, IPartialRenderingCapability, IPositionCapability, IPreferencesCapability, IPropertyChangeEventCapability, ISelectionEventCapability, IServerDataCapability, 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
Direct Known Subclasses:
TabbedPaneComponent

public class CardBoxComponent
extends AbstractInputComponent
implements ISelectionEventCapability, IAsyncRenderModeCapability, org.rcfaces.core.internal.capability.IPreferencesSettings, org.rcfaces.core.internal.capability.IVariableScopeCapability, IAsyncDecodeModeCapability

The cardBox Component is similar to the tabbedPane Component without title and borders. It is usefull for showing alternatively different contents on the same page.

The cardBox Component has the following capabilities :

The default cardBox renderer is linked to the f_cardBox javascript class. f_cardBox extends f_component, fa_immediateu

Table of component style classes:

Style Name Description
f_cardBox Defines styles for the wrapper DIV element
f_cardBox_card Defines styles for the wrapper DIV element for each card


Field Summary
protected static Set CAMELIA_ATTRIBUTES
           
protected static String CAMELIA_VALUE_ALIAS
           
static String COMPONENT_TYPE
           
 
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
CardBoxComponent()
           
CardBoxComponent(String componentId)
           
 
Method Summary
 void addSelectionListener(ISelectionListener listener)
          Adds a listener to the component for the selection event
 int getAsyncDecodeMode()
          Returns a int value that indicates the decoding mode for asynchronous capable component.
 int getAsyncDecodeMode(FacesContext facesContext)
          See getAsyncDecodeMode() for more details
 int getAsyncRenderMode()
          Returns a int value that indicates the rendering mode for asynchronous capable component.
 int getAsyncRenderMode(FacesContext facesContext)
          See getAsyncRenderMode() for more details
protected  Set getCameliaFields()
           
protected  String getCameliaValueAlias()
           
 IComponentPreferences getPreferences()
          Returns an object that holds the preferences for the component.
 IComponentPreferences getPreferences(FacesContext facesContext)
          See getPreferences() for more details
 Object getScopeValue()
           
 Object getScopeValue(FacesContext facesContext)
          See getScopeValue() for more details
 String getScopeVar()
           
 String getScopeVar(FacesContext facesContext)
          See getScopeVar() for more details
 CardComponent getSelectedCard()
           
 CardComponent getSelectedCard(FacesContext facesContext)
           
 boolean isAsyncDecodeModeSetted()
          Returns true if the attribute "asyncDecodeMode" is set.
 boolean isAsyncRenderModeSetted()
          Returns true if the attribute "asyncRenderMode" is set.
 boolean isPreferencesSetted()
          Returns true if the attribute "preferences" is set.
 boolean isScopeSaveValue()
           
 boolean isScopeSaveValue(FacesContext facesContext)
          See isScopeSaveValue() for more details
 boolean isScopeSaveValueSetted()
          Returns true if the attribute "scopeSaveValue" is set.
 boolean isScopeValueSetted()
          Returns true if the attribute "scopeValue" is set.
 boolean isScopeVarSetted()
          Returns true if the attribute "scopeVar" is set.
 ICardIterator listCards()
           
 FacesListener[] listSelectionListeners()
          Returns a list of selection listener for the component
 void removeSelectionListener(ISelectionListener listener)
          Removes a listener from the component for the selection event
 void select(CardComponent card)
           
 void setAsyncDecodeMode(int asyncDecodeMode)
          Sets a int value that indicates the decoding mode for asynchronous capable component.
 void setAsyncDecodeMode(String asyncDecodeMode)
           
 void setAsyncRenderMode(int asyncRenderMode)
          Sets a int value that indicates the rendering mode for asynchronous capable component.
 void setAsyncRenderMode(String asyncRenderMode)
           
 void setPreferences(IComponentPreferences preferences)
          Sets an object that holds the preferences for the component.
 void setScopeSaveValue(boolean scopeSaveValue)
           
 void setScopeValue(Object scopeValue)
           
 void setScopeVar(String scopeVar)
           
protected  boolean verifyAsyncDecode(FacesContext facesContext, PhaseId phaseId)
           
 
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

CAMELIA_VALUE_ALIAS

protected static final String CAMELIA_VALUE_ALIAS
See Also:
Constant Field Values
Constructor Detail

CardBoxComponent

public CardBoxComponent()

CardBoxComponent

public CardBoxComponent(String componentId)
Method Detail

listCards

public ICardIterator listCards()

getSelectedCard

public CardComponent getSelectedCard()

getSelectedCard

public CardComponent getSelectedCard(FacesContext facesContext)

select

public void select(CardComponent card)

setAsyncRenderMode

public void setAsyncRenderMode(String asyncRenderMode)

setAsyncDecodeMode

public void setAsyncDecodeMode(String asyncDecodeMode)

verifyAsyncDecode

protected boolean verifyAsyncDecode(FacesContext facesContext,
                                    PhaseId phaseId)
Overrides:
verifyAsyncDecode in class org.rcfaces.core.internal.component.CameliaInputComponent

addSelectionListener

public final void addSelectionListener(ISelectionListener listener)
Description copied from interface: ISelectionEventCapability
Adds a listener to the component for the selection event

Specified by:
addSelectionListener in interface ISelectionEventCapability
Parameters:
listener - the selection listener to add

removeSelectionListener

public final void removeSelectionListener(ISelectionListener listener)
Description copied from interface: ISelectionEventCapability
Removes a listener from the component for the selection event

Specified by:
removeSelectionListener in interface ISelectionEventCapability
Parameters:
listener - the selection listener to remove

listSelectionListeners

public final FacesListener[] listSelectionListeners()
Description copied from interface: ISelectionEventCapability
Returns a list of selection listener for the component

Specified by:
listSelectionListeners in interface ISelectionEventCapability
Returns:
selection listeners' list

getAsyncRenderMode

public int getAsyncRenderMode()
Description copied from interface: IAsyncRenderModeCapability
Returns a int value that indicates the rendering mode for asynchronous capable component.

Specified by:
getAsyncRenderMode in interface IAsyncRenderModeCapability
Returns:
0:none|1:buffer|2:tree

getAsyncRenderMode

public int getAsyncRenderMode(FacesContext facesContext)
See getAsyncRenderMode() for more details


isAsyncRenderModeSetted

public final boolean isAsyncRenderModeSetted()
Returns true if the attribute "asyncRenderMode" is set.

Returns:
true if the attribute is set.

setAsyncRenderMode

public void setAsyncRenderMode(int asyncRenderMode)
Description copied from interface: IAsyncRenderModeCapability
Sets a int value that indicates the rendering mode for asynchronous capable component.

Specified by:
setAsyncRenderMode in interface IAsyncRenderModeCapability
Parameters:
asyncRenderMode - 0:none|1:buffer|2:tree

getPreferences

public IComponentPreferences getPreferences()
Description copied from interface: IPreferencesCapability
Returns an object that holds the preferences for the component.

Specified by:
getPreferences in interface IPreferencesCapability
Returns:
ComponentPreference object

getPreferences

public IComponentPreferences getPreferences(FacesContext facesContext)
See getPreferences() for more details


isPreferencesSetted

public final boolean isPreferencesSetted()
Returns true if the attribute "preferences" is set.

Specified by:
isPreferencesSetted in interface org.rcfaces.core.internal.capability.IPreferencesSettings
Returns:
true if the attribute is set.

setPreferences

public void setPreferences(IComponentPreferences preferences)
Description copied from interface: IPreferencesCapability
Sets an object that holds the preferences for the component.

Specified by:
setPreferences in interface IPreferencesCapability
Parameters:
preferences - ComponentPreference object

isScopeSaveValue

public boolean isScopeSaveValue()
Specified by:
isScopeSaveValue in interface org.rcfaces.core.internal.capability.IVariableScopeCapability

isScopeSaveValue

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


isScopeSaveValueSetted

public final boolean isScopeSaveValueSetted()
Returns true if the attribute "scopeSaveValue" is set.

Returns:
true if the attribute is set.

setScopeSaveValue

public void setScopeSaveValue(boolean scopeSaveValue)
Specified by:
setScopeSaveValue in interface org.rcfaces.core.internal.capability.IVariableScopeCapability

getScopeValue

public Object getScopeValue()
Specified by:
getScopeValue in interface org.rcfaces.core.internal.capability.IVariableScopeCapability

getScopeValue

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


isScopeValueSetted

public final boolean isScopeValueSetted()
Returns true if the attribute "scopeValue" is set.

Returns:
true if the attribute is set.

setScopeValue

public void setScopeValue(Object scopeValue)
Specified by:
setScopeValue in interface org.rcfaces.core.internal.capability.IVariableScopeCapability

getScopeVar

public String getScopeVar()
Specified by:
getScopeVar in interface org.rcfaces.core.internal.capability.IVariableScopeCapability

getScopeVar

public String getScopeVar(FacesContext facesContext)
See getScopeVar() for more details


isScopeVarSetted

public final boolean isScopeVarSetted()
Returns true if the attribute "scopeVar" is set.

Returns:
true if the attribute is set.

setScopeVar

public void setScopeVar(String scopeVar)
Specified by:
setScopeVar in interface org.rcfaces.core.internal.capability.IVariableScopeCapability

getAsyncDecodeMode

public int getAsyncDecodeMode()
Description copied from interface: IAsyncDecodeModeCapability
Returns a int value that indicates the decoding mode for asynchronous capable component.

Specified by:
getAsyncDecodeMode in interface IAsyncDecodeModeCapability
Returns:
0:complete|1:partial

getAsyncDecodeMode

public int getAsyncDecodeMode(FacesContext facesContext)
See getAsyncDecodeMode() for more details


isAsyncDecodeModeSetted

public final boolean isAsyncDecodeModeSetted()
Returns true if the attribute "asyncDecodeMode" is set.

Returns:
true if the attribute is set.

setAsyncDecodeMode

public void setAsyncDecodeMode(int asyncDecodeMode)
Description copied from interface: IAsyncDecodeModeCapability
Sets a int value that indicates the decoding mode for asynchronous capable component.

Specified by:
setAsyncDecodeMode in interface IAsyncDecodeModeCapability
Parameters:
asyncDecodeMode - 0:complete|1:partial

getCameliaFields

protected Set getCameliaFields()
Overrides:
getCameliaFields in class AbstractInputComponent

getCameliaValueAlias

protected String getCameliaValueAlias()
Overrides:
getCameliaValueAlias in class org.rcfaces.core.internal.component.CameliaInputComponent


Copyright © 2006-2011 Vedana. All Rights Reserved.