org.rcfaces.core.component
Class SpinnerComponent

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.TextEntryComponent
                              org.rcfaces.core.component.SpinnerComponent

All Implemented Interfaces:

EditableValueHolder, StateHolder, ValueHolder, IAccessKeyCapability, IAlternateTextCapability, IAutoTabCapability, IClientDataCapability, IClientValidationCapability, IDisabledCapability, IEmptyMessageCapability, IErrorEventCapability, IFocusBlurEventCapability, IFocusStyleClassCapability, IFontCapability, IForegroundBackgroundColorCapability, IHeightCapability, IHelpCapability, IHiddenModeCapability, IImmediateCapability, IInitEventCapability, IKeyDownEventCapability, IKeyEventCapability, IKeyPressEventCapability, IKeyUpEventCapability, ILayoutPositionCapability, ILookAndFeelCapability, IMarginCapability, IMaxTextLengthCapability, IMenuCapability, IMouseEventCapability, IPartialRenderingCapability, IPositionCapability, IPropertyChangeEventCapability, IReadOnlyCapability, IRequiredCapability, ISelectionEventCapability, IServerDataCapability, ISeverityStyleClassCapability, ISizeCapability, IStyleClassCapability, ITabIndexCapability, ITextAlignmentCapability, ITextCapability, ITextDirectionCapability, IToolTipCapability, IUnlockedClientAttributesCapability, IUserEventCapability, IValidationEventCapability, IValueChangeEventCapability, 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, org.rcfaces.core.internal.manager.IValidationParameters

public class SpinnerComponent
extends TextEntryComponent

The spinner Component is a textEntry Component that accepts numbers and whose value can be incremented or decremented (by a parametrable step) with buttons or the keyboard arrows.

The spinner Component has the following capabilities :

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

The default spinner renderer is linked to the f_spinner javascript class. f_spinner extends f_textEntry, fa_spinner

Table of component style classes:

Style Name	Description
f_spinner	Defines styles for the wrapper element
f_spinner_input	Defines styles for the INPUT element
f_spinner_up	Defines styles for the IMG element of the up button
f_spinner_down	Defines styles for the IMG elemen of the down button

Field Summary

protected static Set	CAMELIA_ATTRIBUTES
static String	COMPONENT_TYPE

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

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

DEFAULT_TEXT_DIRECTION, LEFT_TO_RIGHT_TEXT_DIRECTION, RIGHT_LEFT_TEXT_DIRECTION

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

SpinnerComponent()

SpinnerComponent(String componentId)

Method Summary

protected Set	getCameliaFields()
double	getMaximum() Returns an int value specifying the upper limit for the value of the component.
double	getMaximum(FacesContext facesContext) Returns an int value specifying the upper limit for the value of the component.
double	getMinimum()
double	getMinimum(FacesContext facesContext)
String	getStep()
String	getStep(FacesContext facesContext)
boolean	isCycleValue() Returns a boolean value indicating wether to start from the beginning when reaching the end or not.
boolean	isCycleValue(FacesContext facesContext) Returns a boolean value indicating wether to start from the beginning when reaching the end or not.
boolean	isCycleValueSetted() Returns true if the attribute "cycleValue" is set.
boolean	isMaximumSetted() Returns true if the attribute "maximum" is set.
boolean	isMinimumSetted() Returns true if the attribute "minimum" is set.
boolean	isStepSetted() Returns true if the attribute "step" is set.
void	setCycleValue(boolean cycleValue) Sets a boolean value indicating wether to start from the beginning when reaching the end or not.
void	setMaximum(double maximum) Sets an int value specifying the upper limit for the value of the component.
void	setMinimum(double minimum)
void	setStep(String step)

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

addSelectionListener, addValueChangeListener, getAlternateText, getAlternateText, getCameliaValueAlias, getClientValidationParametersMap, getClientValidationParametersMap, getClientValidator, getClientValidator, getColumnNumber, getColumnNumber, getEmptyMessage, getEmptyMessage, getErrorStyleClass, getErrorStyleClass, getFatalStyleClass, getFatalStyleClass, getFocusStyleClass, getFocusStyleClass, getInfoStyleClass, getInfoStyleClass, getMaxTextLength, getMaxTextLength, getMenu, getMenu, getText, getText, getTextDirection, getTextDirection, getValidationParameter, getValidationParameter, getValidationParametersCount, getValidationParametersCount, getValidationParametersMap, getValidationParametersMap, getWarnStyleClass, getWarnStyleClass, isAlternateTextSetted, isAutoCompletion, isAutoCompletion, isAutoCompletionSetted, isAutoTab, isAutoTab, isAutoTabSetted, isClientSideValidationParameter, isClientSideValidationParameter, isClientValidatorSetted, isColumnNumberSetted, isEmptyMessageSetted, isErrorStyleClassSetted, isFatalStyleClassSetted, isFocusStyleClassSetted, isInfoStyleClassSetted, isMaxTextLengthSetted, isReadOnly, isReadOnly, isReadOnlySetted, isTextDirectionSetted, isTextSetted, isWarnStyleClassSetted, listMenus, listSelectionListeners, listValueChangeListeners, removeSelectionListener, removeValidationParameter, removeValueChangeListener, setAlternateText, setAutoCompletion, setAutoTab, setClientValidator, setColumnNumber, setEmptyMessage, setErrorStyleClass, setFatalStyleClass, setFocusStyleClass, setInfoStyleClass, setMaxTextLength, setReadOnly, setText, setTextDirection, setValidationParameter, setValidationParameter, 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, compareValues, decode, getConverterMessage, getRequiredMessage, getSubmittedValue, getValidator, getValidatorMessage, getValidators, getValueChangeListener, getValueChangeListeners, isImmediate, isLocalValueSet, isRequired, isValid, removeValidator, 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

SpinnerComponent

public SpinnerComponent()

SpinnerComponent

public SpinnerComponent(String componentId)

Method Detail

getMinimum

public double getMinimum()

getMinimum

public double getMinimum(FacesContext facesContext)

setMinimum

public void setMinimum(double minimum)

isMinimumSetted

public boolean isMinimumSetted()

Returns true if the attribute "minimum" is set.

Returns:

true if the attribute is set.

getMaximum

public double getMaximum()

Returns an int value specifying the upper limit for the value of the component.

Returns:

maximum

getMaximum

public double getMaximum(FacesContext facesContext)

Returns an int value specifying the upper limit for the value of the component.

Returns:

maximum

setMaximum

public void setMaximum(double maximum)

Sets an int value specifying the upper limit for the value of the component.

Parameters:

maximum - maximum

isMaximumSetted

public boolean isMaximumSetted()

Returns true if the attribute "maximum" is set.

Returns:

true if the attribute is set.

isCycleValue

public boolean isCycleValue()

Returns a boolean value indicating wether to start from the beginning when reaching the end or not. And vice versa.

Returns:

true if the component should cycle

isCycleValue

public boolean isCycleValue(FacesContext facesContext)

Returns a boolean value indicating wether to start from the beginning when reaching the end or not. And vice versa.

Returns:

true if the component should cycle

setCycleValue

public void setCycleValue(boolean cycleValue)

Sets a boolean value indicating wether to start from the beginning when reaching the end or not. And vice versa.

Parameters:

cycleValue - true if the component should cycle

isCycleValueSetted

public boolean isCycleValueSetted()

Returns true if the attribute "cycleValue" is set.

Returns:

true if the attribute is set.

getStep

public String getStep()

getStep

public String getStep(FacesContext facesContext)

setStep

public void setStep(String step)

isStepSetted

public boolean isStepSetted()

Returns true if the attribute "step" is set.

Returns:

true if the attribute is set.

getCameliaFields

protected Set getCameliaFields()

Overrides:

getCameliaFields in class TextEntryComponent