org.rcfaces.core.component
Class ComboComponent

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.ComboComponent
All Implemented Interfaces:
EditableValueHolder, StateHolder, ValueHolder, IAccessKeyCapability, IClientDataCapability, IDisabledCapability, IErrorEventCapability, IFilterCapability, IFocusBlurEventCapability, IFocusStyleClassCapability, IFontCapability, IForegroundBackgroundColorCapability, IHeightCapability, IHelpCapability, IHiddenModeCapability, IImmediateCapability, IInitEventCapability, IKeyDownEventCapability, IKeyEventCapability, IKeyPressEventCapability, IKeyUpEventCapability, ILayoutPositionCapability, ILookAndFeelCapability, IMarginCapability, IMouseEventCapability, IPartialRenderingCapability, IPositionCapability, IPropertyChangeEventCapability, IRequiredCapability, ISelectionEventCapability, IServerDataCapability, ISeverityStyleClassCapability, 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.IRCFacesComponent, org.rcfaces.core.internal.capability.ISubmittedExternalValue, 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:
ListComponent, TextEditorComboComponent

public class ComboComponent
extends AbstractInputComponent
implements ISelectionEventCapability, IRequiredCapability, IFocusStyleClassCapability, ISeverityStyleClassCapability, IFilterCapability

The combo Component is equivalent to the standard HTML tag <SELECT SIZE=1>.

The combo Component has the following capabilities :

The default comboComponent renderer is linked to the f_combo javascript class. f_combo extends f_abstractList, fa_selectionProvider

Table of component style classes:

Style Name Description
f_combo Defines styles for the wrapper Select element


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.IHiddenModeCapability
CLIENT_HIDDEN_MODE, DEFAULT_HIDDEN_MODE, IGNORE_HIDDEN_MODE, PHANTOM_HIDDEN_MODE, SERVER_HIDDEN_MODE
 
Constructor Summary
ComboComponent()
           
ComboComponent(String componentId)
           
 
Method Summary
 void addSelectionListener(ISelectionListener listener)
          Adds a listener to the component for the selection event
protected  Set getCameliaFields()
           
protected  String getCameliaValueAlias()
           
 String getErrorStyleClass()
          Returns a space-separated list of CSS style class(es) to be applied for error messages.
 String getErrorStyleClass(FacesContext facesContext)
          See getErrorStyleClass() for more details
 String getFatalStyleClass()
          Returns a space-separated list of CSS style class(es) to be applied for fatal messages.
 String getFatalStyleClass(FacesContext facesContext)
          See getFatalStyleClass() for more details
 IFilterProperties getFilterProperties()
          Return an object that represent the filter to use on the server side.
 IFilterProperties getFilterProperties(FacesContext facesContext)
          See getFilterProperties() for more details
 String getFocusStyleClass()
          Returns the style class of the component.
 String getFocusStyleClass(FacesContext facesContext)
          See getFocusStyleClass() for more details
 String getInfoStyleClass()
          Returns a space-separated list of CSS style class(es) to be applied for info messages.
 String getInfoStyleClass(FacesContext facesContext)
          See getInfoStyleClass() for more details
 String getWarnStyleClass()
          Returns a space-separated list of CSS style class(es) to be applied for warning messages.
 String getWarnStyleClass(FacesContext facesContext)
          See getWarnStyleClass() for more details
 boolean isErrorStyleClassSetted()
          Returns true if the attribute "errorStyleClass" is set.
 boolean isFatalStyleClassSetted()
          Returns true if the attribute "fatalStyleClass" is set.
 boolean isFilterPropertiesSetted()
          Returns true if the attribute "filterProperties" is set.
 boolean isFocusStyleClassSetted()
          Returns true if the attribute "focusStyleClass" is set.
 boolean isInfoStyleClassSetted()
          Returns true if the attribute "infoStyleClass" is set.
 boolean isWarnStyleClassSetted()
          Returns true if the attribute "warnStyleClass" is set.
 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 setErrorStyleClass(String errorStyleClass)
          Sets a space-separated list of CSS style class(es) to be applied for error messages.
 void setFatalStyleClass(String fatalStyleClass)
          Sets a space-separated list of CSS style class(es) to be applied for fatal messages.
 void setFilterProperties(IFilterProperties filterProperties)
          Sets an object that represent the filter to use on the server side.
 void setFilterProperties(String properties)
           
 void setFocusStyleClass(String focusStyleClass)
          Specify the style class of the component.
 void setInfoStyleClass(String infoStyleClass)
          Sets a space-separated list of CSS style class(es) to be applied for info messages.
 void setWarnStyleClass(String warnStyleClass)
          Sets a space-separated list of CSS style class(es) to be applied for warning messages.
 
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, verifyAsyncDecode
 
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.IRequiredCapability
isRequired, setRequired
 
Methods inherited from interface org.rcfaces.core.component.capability.IStyleClassCapability
getStyleClass, setStyleClass
 
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

ComboComponent

public ComboComponent()

ComboComponent

public ComboComponent(String componentId)
Method Detail

setFilterProperties

public void setFilterProperties(String properties)

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

getFocusStyleClass

public String getFocusStyleClass()
Description copied from interface: IFocusStyleClassCapability
Returns the style class of the component.

Specified by:
getFocusStyleClass in interface IFocusStyleClassCapability
Returns:
style class

getFocusStyleClass

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


isFocusStyleClassSetted

public final boolean isFocusStyleClassSetted()
Returns true if the attribute "focusStyleClass" is set.

Returns:
true if the attribute is set.

setFocusStyleClass

public void setFocusStyleClass(String focusStyleClass)
Description copied from interface: IFocusStyleClassCapability
Specify the style class of the component.

Specified by:
setFocusStyleClass in interface IFocusStyleClassCapability
Parameters:
focusStyleClass - style class

getErrorStyleClass

public String getErrorStyleClass()
Description copied from interface: ISeverityStyleClassCapability
Returns a space-separated list of CSS style class(es) to be applied for error messages. This value will be passed through as the "class" attribute on generated markup.

Specified by:
getErrorStyleClass in interface ISeverityStyleClassCapability
Returns:
list of CSS style classes

getErrorStyleClass

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


isErrorStyleClassSetted

public final boolean isErrorStyleClassSetted()
Returns true if the attribute "errorStyleClass" is set.

Returns:
true if the attribute is set.

setErrorStyleClass

public void setErrorStyleClass(String errorStyleClass)
Description copied from interface: ISeverityStyleClassCapability
Sets a space-separated list of CSS style class(es) to be applied for error messages. This value will be passed through as the "class" attribute on generated markup.

Specified by:
setErrorStyleClass in interface ISeverityStyleClassCapability
Parameters:
errorStyleClass - list of CSS style classes

getFatalStyleClass

public String getFatalStyleClass()
Description copied from interface: ISeverityStyleClassCapability
Returns a space-separated list of CSS style class(es) to be applied for fatal messages. This value will be passed through as the "class" attribute on generated markup.

Specified by:
getFatalStyleClass in interface ISeverityStyleClassCapability
Returns:
list of CSS style classes

getFatalStyleClass

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


isFatalStyleClassSetted

public final boolean isFatalStyleClassSetted()
Returns true if the attribute "fatalStyleClass" is set.

Returns:
true if the attribute is set.

setFatalStyleClass

public void setFatalStyleClass(String fatalStyleClass)
Description copied from interface: ISeverityStyleClassCapability
Sets a space-separated list of CSS style class(es) to be applied for fatal messages. This value will be passed through as the "class" attribute on generated markup.

Specified by:
setFatalStyleClass in interface ISeverityStyleClassCapability
Parameters:
fatalStyleClass - list of CSS style classes

getInfoStyleClass

public String getInfoStyleClass()
Description copied from interface: ISeverityStyleClassCapability
Returns a space-separated list of CSS style class(es) to be applied for info messages. This value will be passed through as the "class" attribute on generated markup.

Specified by:
getInfoStyleClass in interface ISeverityStyleClassCapability
Returns:
list of CSS style classes

getInfoStyleClass

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


isInfoStyleClassSetted

public final boolean isInfoStyleClassSetted()
Returns true if the attribute "infoStyleClass" is set.

Returns:
true if the attribute is set.

setInfoStyleClass

public void setInfoStyleClass(String infoStyleClass)
Description copied from interface: ISeverityStyleClassCapability
Sets a space-separated list of CSS style class(es) to be applied for info messages. This value will be passed through as the "class" attribute on generated markup.

Specified by:
setInfoStyleClass in interface ISeverityStyleClassCapability
Parameters:
infoStyleClass - list of CSS style classes

getWarnStyleClass

public String getWarnStyleClass()
Description copied from interface: ISeverityStyleClassCapability
Returns a space-separated list of CSS style class(es) to be applied for warning messages. This value will be passed through as the "class" attribute on generated markup.

Specified by:
getWarnStyleClass in interface ISeverityStyleClassCapability
Returns:
list of CSS style classes

getWarnStyleClass

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


isWarnStyleClassSetted

public final boolean isWarnStyleClassSetted()
Returns true if the attribute "warnStyleClass" is set.

Returns:
true if the attribute is set.

setWarnStyleClass

public void setWarnStyleClass(String warnStyleClass)
Description copied from interface: ISeverityStyleClassCapability
Sets a space-separated list of CSS style class(es) to be applied for warning messages. This value will be passed through as the "class" attribute on generated markup.

Specified by:
setWarnStyleClass in interface ISeverityStyleClassCapability
Parameters:
warnStyleClass - list of CSS style classes

getFilterProperties

public IFilterProperties getFilterProperties()
Description copied from interface: IFilterCapability
Return an object that represent the filter to use on the server side.

Specified by:
getFilterProperties in interface IFilterCapability
Returns:
filter

getFilterProperties

public IFilterProperties getFilterProperties(FacesContext facesContext)
See getFilterProperties() for more details


isFilterPropertiesSetted

public final boolean isFilterPropertiesSetted()
Returns true if the attribute "filterProperties" is set.

Returns:
true if the attribute is set.

setFilterProperties

public void setFilterProperties(IFilterProperties filterProperties)
Description copied from interface: IFilterCapability
Sets an object that represent the filter to use on the server side.

Specified by:
setFilterProperties in interface IFilterCapability
Parameters:
filterProperties - filter

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.