org.rcfaces.core.component
Class AbstractMenuComponent

java.lang.Object
  javax.faces.component.UIComponent
      javax.faces.component.UIComponentBase
          javax.faces.component.UICommand
              org.rcfaces.core.internal.component.CameliaCommandComponent
                  org.rcfaces.core.component.AbstractCommandComponent
                      org.rcfaces.core.component.AbstractConverterCommandComponent
                          org.rcfaces.core.component.AbstractMenuComponent

All Implemented Interfaces:

ActionSource, ActionSource2, StateHolder, ValueHolder, IAccessKeyCapability, ICheckedValuesCapability, ICheckEventCapability, IClientDataCapability, IDisabledCapability, IErrorEventCapability, IFocusBlurEventCapability, IFontCapability, IForegroundBackgroundColorCapability, IHeightCapability, IHelpCapability, IHiddenModeCapability, IImmediateCapability, IInitEventCapability, ILayoutPositionCapability, ILookAndFeelCapability, IMarginCapability, IMouseEventCapability, IPartialRenderingCapability, IPositionCapability, IPropertyChangeEventCapability, IReadOnlyCapability, ISelectionEventCapability, IServerDataCapability, ISizeCapability, IStyleClassCapability, ITabIndexCapability, ITextAlignmentCapability, IToolTipCapability, IUnlockedClientAttributesCapability, IUserEventCapability, IValidationEventCapability, IVisibilityCapability, IWAIRoleCapability, IWidthCapability, IMenuComponent, org.rcfaces.core.internal.capability.ICheckComponent, org.rcfaces.core.internal.capability.IComponentLifeCycle, org.rcfaces.core.internal.capability.IConvertValueHolder, org.rcfaces.core.internal.capability.IRCFacesComponent, org.rcfaces.core.internal.manager.IClientDataManager, org.rcfaces.core.internal.manager.IContainerManager, org.rcfaces.core.internal.manager.IServerDataManager, org.rcfaces.core.internal.manager.ITransientAttributesManager, org.rcfaces.core.internal.tools.CollectionTools.IComponentValueTypeCapability, ICheckProvider

Direct Known Subclasses:

ImageComboComponent, MenuBarComponent

public abstract class AbstractMenuComponent
extends AbstractConverterCommandComponent
implements IUnlockedClientAttributesCapability, ISelectionEventCapability, ICheckEventCapability, ICheckedValuesCapability, IReadOnlyCapability, org.rcfaces.core.internal.capability.ICheckComponent, IMenuComponent, org.rcfaces.core.internal.tools.CollectionTools.IComponentValueTypeCapability

Technical component, used as a basis for building new RCFaces components.

Field Summary

protected static Set

CAMELIA_ATTRIBUTES

Fields inherited from class org.rcfaces.core.internal.component.CameliaCommandComponent

engine

Fields inherited from class javax.faces.component.UICommand

COMPONENT_FAMILY, COMPONENT_TYPE

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

AbstractMenuComponent()

Method Summary

void	addCheckListener(ICheckListener listener) Adds a listener to the component for the checked event
void	addSelectionListener(ISelectionListener listener) Adds a listener to the component for the selection event
void	check(Object value)
void	checkAll()
protected Set	getCameliaFields()
Object	getCheckedValues()
Object	getCheckedValues(FacesContext facesContext) See getCheckedValues() for more details
int	getCheckedValuesCount()
Class	getCheckedValuesType(FacesContext facesContext) Return the type of the property represented by the ValueExpression, relative to the specified FacesContext.
org.rcfaces.core.internal.tools.CollectionTools.IComponentValueType	getComponentValueType()
Object	getFirstCheckedValue()
boolean	isCheckedValuesSetted() Returns true if the attribute "checkedValues" is set.
boolean	isReadOnly() Returns a boolean value indicating that this component will prohibit changes by the user.
boolean	isReadOnly(FacesContext facesContext) See isReadOnly() for more details
boolean	isReadOnlySetted() Returns true if the attribute "readOnly" is set.
boolean	isRemoveAllWhenShown() Returns a boolean value specifying wether the content of the component must be remove before the listener is called and the component displayed.
boolean	isRemoveAllWhenShown(FacesContext facesContext) Returns a boolean value specifying wether the content of the component must be remove before the listener is called and the component displayed.
boolean	isRemoveAllWhenShownSetted() Returns true if the attribute "removeAllWhenShown" is set.
Object[]	listCheckedValues()
FacesListener[]	listCheckListeners() Returns the list of check listener for the component
IMenuItemIterator	listMenuItems()
FacesListener[]	listSelectionListeners() Returns a list of selection listener for the component
void	removeCheckListener(ICheckListener listener) Removes a listener from the list of listeners
void	removeSelectionListener(ISelectionListener listener) Removes a listener from the component for the selection event
void	setCheckedValues(Object checkedValues)
void	setReadOnly(boolean readOnly) Sets a boolean value indicating that this component will prohibit changes by the user.
void	setRemoveAllWhenShown(boolean removeAllWhenShown) Sets a boolean value specifying wether the content of the component must be remove before the listener is called and the component displayed.
void	uncheck(Object value)
void	uncheckAll()

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

getConverter, getConverter, getLocalValue, setConverter, setConverter, setConverter

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

addBlurListener, addErrorListener, addFocusListener, addInitListener, 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, isVisible, isVisible, isVisibleSetted, isWaiRoleSetted, isWidthSetted, isXSetted, isYSetted, listBlurListeners, listClientDataKeys, listClientDataKeys, listErrorListeners, listFocusListeners, listInitListeners, listMouseOutListeners, listMouseOverListeners, listPropertyChangeListeners, listServerDataKeys, listServerDataKeys, listUserEventListeners, listValidationListeners, removeBlurListener, removeClientData, removeErrorListener, removeFocusListener, removeInitListener, 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, setVisible, setWaiRole, setWidth, setX, setY

Methods inherited from class org.rcfaces.core.internal.component.CameliaCommandComponent

broadcast, clearListeners, confirmListenerAppend, constructPhase, constructTemplate, decodePhase, encodeBegin, encodeChildren, encodeEnd, getAsyncRenderer, getCameliaValueAlias, getChildren, getChildrenListState, getFamily, getRendererType, getTransientAttribute, getValueExpression, hasDefaultProperties, initializeComponent, initializePhase, isClientRendered, isRendered, isTemplateComponent, processDecodes, processEngineUpdates, processEngineValidators, processUpdates, processValidators, queueEvent, renderPhase, restoreState, saveState, setDefaultProperties, setRendered, setTransientAttribute, setValueExpression, toString, updatePhase, validationPhase, verifyAsyncDecode

Methods inherited from class javax.faces.component.UICommand

addActionListener, getAction, getActionExpression, getActionListener, getActionListeners, getValue, isImmediate, removeActionListener, setAction, setActionExpression, setActionListener, setImmediate, setValue

Methods inherited from class javax.faces.component.UIComponentBase

addFacesListener, decode, 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.IUnlockedClientAttributesCapability

getUnlockedClientAttributeNames, setUnlockedClientAttributeNames

Methods inherited from interface javax.faces.component.ValueHolder

getValue, setValue

Methods inherited from interface org.rcfaces.core.component.capability.IImmediateCapability

isImmediate, setImmediate

Methods inherited from interface org.rcfaces.core.internal.manager.IContainerManager

getChildCount

Field Detail

CAMELIA_ATTRIBUTES

protected static final Set CAMELIA_ATTRIBUTES

Constructor Detail

AbstractMenuComponent

public AbstractMenuComponent()

Method Detail

getComponentValueType

public org.rcfaces.core.internal.tools.CollectionTools.IComponentValueType getComponentValueType()

Specified by:

getComponentValueType in interface org.rcfaces.core.internal.tools.CollectionTools.IComponentValueTypeCapability

check

public void check(Object value)

Specified by:

check in interface org.rcfaces.core.internal.capability.ICheckComponent

checkAll

public void checkAll()

Specified by:

checkAll in interface org.rcfaces.core.internal.capability.ICheckComponent

uncheck

public void uncheck(Object value)

Specified by:

uncheck in interface org.rcfaces.core.internal.capability.ICheckComponent

uncheckAll

public void uncheckAll()

Specified by:

uncheckAll in interface org.rcfaces.core.internal.capability.ICheckComponent

listMenuItems

public IMenuItemIterator listMenuItems()

Specified by:

listMenuItems in interface IMenuComponent

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

addCheckListener

public final void addCheckListener(ICheckListener listener)

Description copied from interface: ICheckEventCapability

Adds a listener to the component for the checked event

Specified by:

addCheckListener in interface ICheckEventCapability

Parameters:

listener - the listener to add

removeCheckListener

public final void removeCheckListener(ICheckListener listener)

Description copied from interface: ICheckEventCapability

Removes a listener from the list of listeners

Specified by:

removeCheckListener in interface ICheckEventCapability

Parameters:

listener - the listener to remove

listCheckListeners

public final FacesListener[] listCheckListeners()

Description copied from interface: ICheckEventCapability

Returns the list of check listener for the component

Specified by:

listCheckListeners in interface ICheckEventCapability

Returns:

check listeners' list

getCheckedValues

public Object getCheckedValues()

Specified by:

getCheckedValues in interface ICheckProvider

getCheckedValues

public Object getCheckedValues(FacesContext facesContext)

See getCheckedValues() for more details

isCheckedValuesSetted

public final boolean isCheckedValuesSetted()

Returns true if the attribute "checkedValues" is set.

Returns:

true if the attribute is set.

setCheckedValues

public void setCheckedValues(Object checkedValues)

Specified by:

setCheckedValues in interface ICheckProvider

getCheckedValuesType

public Class getCheckedValuesType(FacesContext facesContext)

Return the type of the property represented by the ValueExpression, relative to the specified FacesContext.

Specified by:

getCheckedValuesType in interface ICheckedValuesCapability

getFirstCheckedValue

public Object getFirstCheckedValue()

Specified by:

getFirstCheckedValue in interface ICheckProvider

getCheckedValuesCount

public int getCheckedValuesCount()

Specified by:

getCheckedValuesCount in interface ICheckProvider

listCheckedValues

public Object[] listCheckedValues()

Specified by:

listCheckedValues in interface ICheckProvider

isReadOnly

public boolean isReadOnly()

Description copied from interface: IReadOnlyCapability

Returns a boolean value indicating that this component will prohibit changes by the user. The element may receive focus unless it has also been disabled.

Specified by:

isReadOnly in interface IReadOnlyCapability

Returns:

readOnly boolean property

isReadOnly

public boolean isReadOnly(FacesContext facesContext)

See isReadOnly() for more details

isReadOnlySetted

public final boolean isReadOnlySetted()

Returns true if the attribute "readOnly" is set.

Returns:

true if the attribute is set.

setReadOnly

public void setReadOnly(boolean readOnly)

Description copied from interface: IReadOnlyCapability

Sets a boolean value indicating that this component will prohibit changes by the user. The element may receive focus unless it has also been disabled.

Specified by:

setReadOnly in interface IReadOnlyCapability

Parameters:

readOnly - readOnly boolean property

isRemoveAllWhenShown

public boolean isRemoveAllWhenShown()

Returns a boolean value specifying wether the content of the component must be remove before the listener is called and the component displayed.

Specified by:

isRemoveAllWhenShown in interface IMenuComponent

Returns:

true if content is removed when shown

isRemoveAllWhenShown

public boolean isRemoveAllWhenShown(FacesContext facesContext)

Returns a boolean value specifying wether the content of the component must be remove before the listener is called and the component displayed.

Returns:

true if content is removed when shown

setRemoveAllWhenShown

public void setRemoveAllWhenShown(boolean removeAllWhenShown)

Sets a boolean value specifying wether the content of the component must be remove before the listener is called and the component displayed.

Specified by:

setRemoveAllWhenShown in interface IMenuComponent

Parameters:

removeAllWhenShown - true if content is to be removed when shown

isRemoveAllWhenShownSetted

public boolean isRemoveAllWhenShownSetted()

Returns true if the attribute "removeAllWhenShown" is set.

Returns:

true if the attribute is set.

getCameliaFields

protected Set getCameliaFields()

Overrides:

getCameliaFields in class AbstractConverterCommandComponent