org.rcfaces.core.component
Class ListComponent

java.lang.Object
  javax.faces.component.UIComponent
      javax.faces.component.UIComponentBase
          javax.faces.component.UIOutput
              javax.faces.component.UIInput
                  org.rcfaces.core.internal.component.CameliaInputComponent
                      org.rcfaces.core.component.AbstractInputComponent
                          org.rcfaces.core.component.ComboComponent
                              org.rcfaces.core.component.ListComponent

All Implemented Interfaces:

EditableValueHolder, StateHolder, ValueHolder, IAccessKeyCapability, IClientDataCapability, IDisabledCapability, IDoubleClickEventCapability, IErrorEventCapability, IFilterCapability, IFocusBlurEventCapability, IFocusStyleClassCapability, IFontCapability, IForegroundBackgroundColorCapability, IHeightCapability, IHelpCapability, IHiddenModeCapability, IImmediateCapability, IInitEventCapability, IKeyDownEventCapability, IKeyEventCapability, IKeyPressEventCapability, IKeyUpEventCapability, ILayoutPositionCapability, ILookAndFeelCapability, IMarginCapability, IMouseEventCapability, IMultipleSelectCapability, 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

public class ListComponent
extends ComboComponent
implements IMultipleSelectCapability, IDoubleClickEventCapability

The list Component is based on the standard HTML tag <SELECT>.

The list Component has the following capabilities :

• IMultipleSelectCapability
• IDoubleClickEventCapability

The default list renderer is linked to the f_list javascript class. f_list extends f_abstractList, fa_selectionProvider

Table of component style classes:

Style Name	Description
f_list	Defines styles for the wrapper SELECT element

Field Summary

protected static Set	CAMELIA_ATTRIBUTES
static String	COMPONENT_TYPE

Fields inherited from class org.rcfaces.core.component.ComboComponent

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.IHiddenModeCapability

CLIENT_HIDDEN_MODE, DEFAULT_HIDDEN_MODE, IGNORE_HIDDEN_MODE, PHANTOM_HIDDEN_MODE, SERVER_HIDDEN_MODE

Constructor Summary

ListComponent()

ListComponent(String componentId)

Method Summary

void	addDoubleClickListener(IDoubleClickListener listener) Adds a listener to the component for the doubleClick event
protected Set	getCameliaFields()
int	getRowNumber() Returns an int value specifying the number of rows to be displayed.
int	getRowNumber(FacesContext facesContext) Returns an int value specifying the number of rows to be displayed.
boolean	isMultipleSelect() Returns a boolean value indicating wether multiple selection is permitted.
boolean	isMultipleSelect(FacesContext facesContext) See isMultipleSelect() for more details
boolean	isMultipleSelectSetted() Returns true if the attribute "multipleSelect" is set.
boolean	isRowNumberSetted() Returns true if the attribute "rowNumber" is set.
FacesListener[]	listDoubleClickListeners() Returns a list of doubleClick listener for the component
void	removeDoubleClickListener(IDoubleClickListener listener) Removes a listener from the component for the doubleClick event
void	setMultipleSelect(boolean multipleSelect) Sets a boolean value indicating wether multiple selection is permitted.
void	setRowNumber(int rowNumber) Sets an int value specifying the number of rows to be displayed.

Methods inherited from class org.rcfaces.core.component.ComboComponent

addSelectionListener, getCameliaValueAlias, getErrorStyleClass, getErrorStyleClass, getFatalStyleClass, getFatalStyleClass, getFilterProperties, getFilterProperties, getFocusStyleClass, getFocusStyleClass, getInfoStyleClass, getInfoStyleClass, getWarnStyleClass, getWarnStyleClass, isErrorStyleClassSetted, isFatalStyleClassSetted, isFilterPropertiesSetted, isFocusStyleClassSetted, isInfoStyleClassSetted, isWarnStyleClassSetted, listSelectionListeners, removeSelectionListener, setErrorStyleClass, setFatalStyleClass, setFilterProperties, setFilterProperties, setFocusStyleClass, setInfoStyleClass, setWarnStyleClass

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

Constructor Detail

ListComponent

public ListComponent()

ListComponent

public ListComponent(String componentId)

Method Detail

isMultipleSelect

public boolean isMultipleSelect()

Description copied from interface: IMultipleSelectCapability

Returns a boolean value indicating wether multiple selection is permitted.

Specified by:

isMultipleSelect in interface IMultipleSelectCapability

Returns:

boolean

isMultipleSelect

public boolean isMultipleSelect(FacesContext facesContext)

See isMultipleSelect() for more details

isMultipleSelectSetted

public final boolean isMultipleSelectSetted()

Returns true if the attribute "multipleSelect" is set.

Returns:

true if the attribute is set.

setMultipleSelect

public void setMultipleSelect(boolean multipleSelect)

Description copied from interface: IMultipleSelectCapability

Sets a boolean value indicating wether multiple selection is permitted.

Specified by:

setMultipleSelect in interface IMultipleSelectCapability

Parameters:

multipleSelect - boolean

addDoubleClickListener

public final void addDoubleClickListener(IDoubleClickListener listener)

Description copied from interface: IDoubleClickEventCapability

Adds a listener to the component for the doubleClick event

Specified by:

addDoubleClickListener in interface IDoubleClickEventCapability

Parameters:

listener - the doubleClick listener to add

removeDoubleClickListener

public final void removeDoubleClickListener(IDoubleClickListener listener)

Description copied from interface: IDoubleClickEventCapability

Removes a listener from the component for the doubleClick event

Specified by:

removeDoubleClickListener in interface IDoubleClickEventCapability

Parameters:

listener - the doubleClick listener to remove

listDoubleClickListeners

public final FacesListener[] listDoubleClickListeners()

Description copied from interface: IDoubleClickEventCapability

Returns a list of doubleClick listener for the component

Specified by:

listDoubleClickListeners in interface IDoubleClickEventCapability

Returns:

doubleClick listeners' list

getRowNumber

public int getRowNumber()

Returns an int value specifying the number of rows to be displayed.

Returns:

number of rows

getRowNumber

public int getRowNumber(FacesContext facesContext)

Returns an int value specifying the number of rows to be displayed.

Returns:

number of rows

setRowNumber

public void setRowNumber(int rowNumber)

Sets an int value specifying the number of rows to be displayed.

Parameters:

rowNumber - number of rows

isRowNumberSetted

public boolean isRowNumberSetted()

Returns true if the attribute "rowNumber" is set.

Returns:

true if the attribute is set.

getCameliaFields

protected Set getCameliaFields()

Overrides:

getCameliaFields in class ComboComponent