org.rcfaces.core.component
Class CheckButton3StatesComponent

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

All Implemented Interfaces:

EditableValueHolder, StateHolder, ValueHolder, IAccessKeyCapability, IAlternateTextCapability, IClientDataCapability, IDisabledCapability, IErrorEventCapability, IFocusBlurEventCapability, IFocusStyleClassCapability, IFontCapability, IForegroundBackgroundColorCapability, IHeightCapability, IHelpCapability, IHiddenModeCapability, IHorizontalTextPositionCapability, IImmediateCapability, IInitEventCapability, IKeyDownEventCapability, IKeyEventCapability, IKeyPressEventCapability, IKeyUpEventCapability, ILookAndFeelCapability, IMarginCapability, IMouseEventCapability, IPositionCapability, IPropertyChangeEventCapability, IReadOnlyCapability, ISelected3StatesCapability, ISelectionEventCapability, IServerDataCapability, ISizeCapability, IStyleClassCapability, ITabIndexCapability, ITextAlignmentCapability, ITextCapability, ITextDirectionCapability, IToolTipCapability, IUnlockedClientAttributesCapability, IUserEventCapability, IValidationEventCapability, IValueLockedCapability, IVisibilityCapability, IWAIRoleCapability, IWidthCapability, 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 CheckButton3StatesComponent
extends AbstractInputComponent
implements ITextCapability, ITextDirectionCapability, IHorizontalTextPositionCapability, ISelectionEventCapability, IReadOnlyCapability, IAlternateTextCapability, IFocusStyleClassCapability, ISelected3StatesCapability

The checkButton3States Component is a CheckButton with 3 states : Check, unchecked and undefined. It is often used to show the state of a group of checkButtons

This component is experimental.

The checkButton3States Component has the following capabilities :

• Position & Size
• Foreground & Background Color
• Text & font
• Help
• Visibility, Read-Only, Disabled
• Events Handling

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

DEFAULT_TEXT_DIRECTION, LEFT_TO_RIGHT_TEXT_DIRECTION, RIGHT_LEFT_TEXT_DIRECTION

Fields inherited from interface org.rcfaces.core.component.capability.IHorizontalTextPositionCapability

DEFAULT_POSITION, LEFT_POSITION, RIGHT_POSITION

Fields inherited from interface org.rcfaces.core.component.capability.ISelected3StatesCapability

NOT_SELECTED_STATE, SELECTED_STATE, UNDETERMINATED_STATE

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

CheckButton3StatesComponent()

CheckButton3StatesComponent(String componentId)

Method Summary

void	addSelectionListener(ISelectionListener listener) Adds a listener to the component for the selection event
String	getAlternateText()
String	getAlternateText(FacesContext facesContext) See getAlternateText() for more details
protected Set	getCameliaFields()
protected String	getCameliaValueAlias()
String	getFocusStyleClass() Returns the style class of the component.
String	getFocusStyleClass(FacesContext facesContext) See getFocusStyleClass() for more details
String	getSelectedState() Returns a string value indicating wether the component is selected.
String	getSelectedState(FacesContext facesContext) See getSelectedState() for more details
String	getText() Returns a string value specifying the text shown.
String	getText(FacesContext facesContext) See getText() for more details
int	getTextDirection()
int	getTextDirection(FacesContext facesContext) See getTextDirection() for more details
int	getTextPosition() Returns an int value specifying the position of the text in the component.
int	getTextPosition(FacesContext facesContext) See getTextPosition() for more details
protected Converter	getTextPositionConverter()
boolean	isAlternateTextSetted() Returns true if the attribute "alternateText" is set.
boolean	isFocusStyleClassSetted() Returns true if the attribute "focusStyleClass" 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	isSelected() Returns a boolean value indicating wether the component is selected.
boolean	isSelectedStateSetted() Returns true if the attribute "selectedState" is set.
boolean	isTextDirectionSetted() Returns true if the attribute "textDirection" is set.
boolean	isTextPositionSetted() Returns true if the attribute "textPosition" is set.
boolean	isTextSetted() Returns true if the attribute "text" is set.
boolean	isUndeterminated() Sets a boolean value indicating wether the component is in a undeterminated select state.
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	setAlternateText(String alternateText)
void	setFocusStyleClass(String focusStyleClass) Specify the style class of the component.
void	setReadOnly(boolean readOnly) Sets a boolean value indicating that this component will prohibit changes by the user.
void	setSelectedState(String selectedState) Sets a string value indicating wether the component is selected.
void	setText(String text) Sets a string value specifying the text to be shown.
void	setTextDirection(int textDirection)
void	setTextPosition(int textPosition) Sets an int value specifying the position of the text in the component.
void	setTextPosition(String textPosition)

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

addBlurListener, addErrorListener, addFocusListener, addInitListener, addKeyDownListener, addKeyPressListener, addKeyUpListener, addMouseOutListener, addMouseOverListener, addPropertyChangeListener, addUserEventListener, addValidationListener, getAccessKey, getAccessKey, getBackgroundColor, getBackgroundColor, 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, getLookId, getLookId, getMarginBottom, getMarginBottom, getMarginLeft, getMarginLeft, getMarginRight, getMarginRight, getMarginTop, getMarginTop, getServerData, getServerData, getServerDataCount, getServerDataMap, getServerDataMap, getStyleClass, getStyleClass, getTabIndex, getTabIndex, getTextAlignment, getTextAlignment, getToolTipText, getToolTipText, getUnlockedClientAttributeNames, getUnlockedClientAttributeNames, getVisibleState, getVisibleState, getWaiRole, getWaiRole, getWidth, getWidth, getX, getX, getY, getY, isAccessKeySetted, isBackgroundColorSetted, isDisabled, isDisabled, isDisabledSetted, isFontBoldSetted, isFontItalicSetted, isFontNameSetted, isFontSizeSetted, isFontUnderlineSetted, isForegroundColorSetted, isHeightSetted, isHelpMessageSetted, isHelpURLSetted, isHiddenModeSetted, isLookIdSetted, isMarginBottomSetted, isMarginLeftSetted, isMarginRightSetted, isMarginTopSetted, isStyleClassSetted, isTabIndexSetted, isTextAlignmentSetted, isToolTipTextSetted, 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, setBackgroundColor, setClientData, setClientData, setDisabled, setFontBold, setFontItalic, setFontName, setFontSize, setFontUnderline, setForegroundColor, setHeight, setHelpMessage, setHelpURL, setHiddenMode, setHiddenMode, setLookId, setMarginBottom, setMarginLeft, setMarginRight, setMargins, setMarginTop, setServerData, setServerData, setStyleClass, setTabIndex, setTextAlignment, setToolTipText, setUnlockedClientAttributeNames, setValueLocked, setVisible, setWaiRole, setWidth, setX, setY

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

broadcast, clearListeners, constructTemplate, encodeBegin, encodeChildren, encodeEnd, getAsyncRenderer, getChildren, getChildrenListState, getConvertedValue, getFamily, getLocalValue, getRendererType, getSubmittedExternalValue, getTransientAttribute, getValue, getValueExpression, hasDefaultProperties, initializeComponent, isClientRendered, isRendered, isSubmittedValueSetted, isTemplateComponent, processDecodes, processEngineUpdates, processUpdates, processValidators, queueEvent, restoreState, saveState, setConverter, setConverter, setDefaultProperties, setRendered, setSubmittedExternalValue, setTransientAttribute, setValueExpression, toString, 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.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

CheckButton3StatesComponent

public CheckButton3StatesComponent()

CheckButton3StatesComponent

public CheckButton3StatesComponent(String componentId)

Method Detail

getTextPositionConverter

protected Converter getTextPositionConverter()

isSelected

public boolean isSelected()

Description copied from interface: ISelected3StatesCapability

Returns a boolean value indicating wether the component is selected.

Specified by:

isSelected in interface ISelected3StatesCapability

Returns:

true if selected, false otherwise

isUndeterminated

public boolean isUndeterminated()

Description copied from interface: ISelected3StatesCapability

Sets a boolean value indicating wether the component is in a undeterminated select state.

Specified by:

isUndeterminated in interface ISelected3StatesCapability

Returns:

true if undeterminate select state, false otherwise

setTextPosition

public void setTextPosition(String textPosition)

getText

public String getText()

Description copied from interface: ITextCapability

Returns a string value specifying the text shown.

Specified by:

getText in interface ITextCapability

Returns:

text

getText

public String getText(FacesContext facesContext)

See getText() for more details

isTextSetted

public final boolean isTextSetted()

Returns true if the attribute "text" is set.

Returns:

true if the attribute is set.

setText

public void setText(String text)

Description copied from interface: ITextCapability

Sets a string value specifying the text to be shown.

Specified by:

setText in interface ITextCapability

Parameters:

text - text

getTextDirection

public int getTextDirection()

Specified by:

getTextDirection in interface ITextDirectionCapability

getTextDirection

public int getTextDirection(FacesContext facesContext)

See getTextDirection() for more details

isTextDirectionSetted

public final boolean isTextDirectionSetted()

Returns true if the attribute "textDirection" is set.

Returns:

true if the attribute is set.

setTextDirection

public void setTextDirection(int textDirection)

Specified by:

setTextDirection in interface ITextDirectionCapability

getTextPosition

public int getTextPosition()

Description copied from interface: IHorizontalTextPositionCapability

Returns an int value specifying the position of the text in the component.

Specified by:

getTextPosition in interface IHorizontalTextPositionCapability

Returns:

0x08:right|0x10:left

getTextPosition

public int getTextPosition(FacesContext facesContext)

See getTextPosition() for more details

isTextPositionSetted

public final boolean isTextPositionSetted()

Returns true if the attribute "textPosition" is set.

Returns:

true if the attribute is set.

setTextPosition

public void setTextPosition(int textPosition)

Description copied from interface: IHorizontalTextPositionCapability

Sets an int value specifying the position of the text in the component.

Specified by:

setTextPosition in interface IHorizontalTextPositionCapability

Parameters:

textPosition - 0x00:right|0x10:left

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

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

getAlternateText

public String getAlternateText()

Specified by:

getAlternateText in interface IAlternateTextCapability

getAlternateText

public String getAlternateText(FacesContext facesContext)

See getAlternateText() for more details

isAlternateTextSetted

public final boolean isAlternateTextSetted()

Returns true if the attribute "alternateText" is set.

Returns:

true if the attribute is set.

setAlternateText

public void setAlternateText(String alternateText)

Specified by:

setAlternateText in interface IAlternateTextCapability

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

getSelectedState

public String getSelectedState()

Description copied from interface: ISelected3StatesCapability

Returns a string value indicating wether the component is selected.

Specified by:

getSelectedState in interface ISelected3StatesCapability

Returns:

NOT_SELECTED_STATE:notSelected|SELECTED_STATE:selected|UNDETERMINATED_STATE:undeterminated

getSelectedState

public String getSelectedState(FacesContext facesContext)

See getSelectedState() for more details

isSelectedStateSetted

public final boolean isSelectedStateSetted()

Returns true if the attribute "selectedState" is set.

Returns:

true if the attribute is set.

setSelectedState

public void setSelectedState(String selectedState)

Description copied from interface: ISelected3StatesCapability

Sets a string value indicating wether the component is selected.

Specified by:

setSelectedState in interface ISelected3StatesCapability

Parameters:

selectedState - NOT_SELECTED_STATE:notSelected|SELECTED_STATE:selected|UNDETERMINATED_STATE:undeterminated

getCameliaFields

protected Set getCameliaFields()

Overrides:

getCameliaFields in class AbstractInputComponent

getCameliaValueAlias

protected String getCameliaValueAlias()

Overrides:

getCameliaValueAlias in class org.rcfaces.core.internal.component.CameliaInputComponent