com.sencha.gxt.widget.core.client.form

Class SpinnerField<N extends Number & Comparable<N>>

java.lang.Object

Widget

com.sencha.gxt.widget.core.client.Component

com.sencha.gxt.widget.core.client.cell.CellComponent<T>

com.sencha.gxt.widget.core.client.form.Field<T>

com.sencha.gxt.widget.core.client.form.ValueBaseField<T>

com.sencha.gxt.widget.core.client.form.TriggerField<T>

com.sencha.gxt.widget.core.client.form.TwinTriggerField<N>

com.sencha.gxt.widget.core.client.form.SpinnerField<N>

Type Parameters:

N - the numeric field type

All Implemented Interfaces:

HasGestureRecognizers, BeforeHideEvent.HasBeforeHideHandlers, BeforeShowContextMenuEvent.HasBeforeShowContextMenuHandler, BeforeShowEvent.HasBeforeShowHandlers, BlurEvent.HasBlurHandlers, DisableEvent.HasDisableHandlers, EnableEvent.HasEnableHandlers, FocusEvent.HasFocusHandlers, HideEvent.HasHideHandlers, InvalidEvent.HasInvalidHandlers, MoveEvent.HasMoveHandlers, ParseErrorEvent.HasParseErrorHandlers, ShowContextMenuEvent.HasShowContextMenuHandler, ShowEvent.HasShowHandlers, TriggerClickEvent.HasTriggerClickHandlers, TwinTriggerClickEvent.HasTwinTriggerClickHandlers, ValidEvent.HasValidHandlers, HasErrorHandler, IsField<N>, HasFocusSupport, HasItemId

Direct Known Subclasses:

BigDecimalSpinnerField, BigIntegerSpinnerField, DoubleSpinnerField, FloatSpinnerField, IntegerSpinnerField, LongSpinnerField, ShortSpinnerField

public class SpinnerField<N extends Number & Comparable<N>>
extends TwinTriggerField<N>

A single line input field with up / down arrows that enable incrementing / decrementing a numeric value. A spinner field uses a number property editor to increment, decrement and format the value. See the nested classes at NumberPropertyEditor for number property editors you can use with spinner field.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	SpinnerField.DefaultSpinnerMessages
static interface	SpinnerField.SpinnerMessages The locale-sensitive messages used by this class.

Nested classes/interfaces inherited from class com.sencha.gxt.widget.core.client.form.Field

Field.FieldStyles

Field Summary

Fields

Modifier and Type	Field and Description
protected SpinnerField.SpinnerMessages	messages

Fields inherited from class com.sencha.gxt.widget.core.client.form.ValueBaseField

impl

Fields inherited from class com.sencha.gxt.widget.core.client.form.Field

forceInvalidText, hasFocus, name, originalValue, parseError, preventMark, validationTask

Fields inherited from class com.sencha.gxt.widget.core.client.cell.CellComponent

valueUpdater

Fields inherited from class com.sencha.gxt.widget.core.client.Component

adjustSize, allowTextSelection, cacheSizes, disableContextMenu, disabled, disabledStyle, ensureVisibilityOnSizing, height, hidden, lastSize, layer, left, mask, maskMessage, monitorWindowResize, pageX, pageY, resizeHandler, shim, tabIndex, toolTip, toolTipConfig, top, width, windowResizeDelay, windowResizeTask

Constructor Summary

Constructors

Constructor and Description
SpinnerField(NumberPropertyEditor<N> editor) Creates a spinner field with the specified property editor.
SpinnerField(SpinnerFieldCell<N> cell) Creates a spinner field with the specified cell.

Method Summary

Modifier and Type	Method and Description
HandlerRegistration	addBeforeSelectionHandler(<any> handler)
HandlerRegistration	addSelectionHandler(<any> handler)
SpinnerFieldCell<N>	getCell() Get the Cell wrapped by this widget.
Number	getIncrement(Context context) Sets the increment value.
Number	getMaxValue() Returns the fields max value.
SpinnerField.SpinnerMessages	getMessages() Returns the locale-sensitive messages used by this class.
Number	getMinValue() Returns the field's minimum value.
NumberPropertyEditor<N>	getPropertyEditor() Returns the field's property editor.
boolean	isAllowDecimals() Returns true of decimal values are allowed.
boolean	isAllowNegative() Returns true if negative values are allowed.
void	setAllowDecimals(boolean allowDecimals) Sets whether decimal value are allowed (defaults to true).
void	setAllowNegative(boolean allowNegative) Sets whether negative value are allowed.
void	setIncrement(N increment) Sets the increment that should be used (defaults to 1d).
void	setMaxValue(N maxValue) Sets the field's max allowable value.
void	setMessages(SpinnerField.SpinnerMessages messages) Sets the spinner field messages.
void	setMinValue(Number minValue) Sets the field's minimum allowed value.
void	setValue(N value, boolean fireEvents, boolean redraw) Sets this object's value and optionally redraw the widget.
protected boolean	validateValue(N value)

Methods inherited from class com.sencha.gxt.widget.core.client.form.TwinTriggerField

addTwinTriggerClickHandler

Methods inherited from class com.sencha.gxt.widget.core.client.form.TriggerField

addTriggerClickHandler, isEditable, isFinishEditOnEnter, isMonitorTab, onBlur, onDetach, setEditable, setFinishEditOnEnter, setHideTrigger, setMonitorTab

Methods inherited from class com.sencha.gxt.widget.core.client.form.ValueBaseField

addChangeHandler, addKeyDownHandler, addKeyPressHandler, addKeyUpHandler, addParseErrorHandler, clear, doAutoValidate, getCurrentValue, getCursorPos, getDirection, getDirectionEstimator, getEmptyText, getFocusEl, getImpl, getInputEl, getSelectedText, getSelectionLength, getText, getValueOrThrow, isAllowBlank, isClearValueOnParseError, isCurrentValid, isCurrentValid, isReadOnly, isSelectOnFocus, onCellParseError, onRedraw, select, selectAll, setAllowBlank, setClearValueOnParseError, setCursorPos, setDirection, setDirectionEstimator, setDirectionEstimator, setEmptyText, setId, setPropertyEditor, setReadOnly, setSelectionRange, setSelectOnFocus, setTabIndex, setText, setValue, validateCurrent

Methods inherited from class com.sencha.gxt.widget.core.client.form.Field

addInvalidHandler, addValidator, addValidHandler, addValueChangeHandler, clearInvalid, finishEditing, flush, forceInvalid, getErrors, getErrorSupport, getName, getOriginalValue, getValidateOnBlur, getValidationDelay, getValidators, isAutoValidate, isEditing, isValid, isValid, markInvalid, markInvalid, onBrowserEvent, onDisable, onEnable, onFocus, onKeyDown, onKeyPress, onKeyUp, onLogicalBlur, onLogicalFocus, onNavigationKey, onPropertyChange, removeValidator, reset, setAutoValidate, setDelegate, setErrors, setErrorSupport, setName, setOriginalValue, setValidateOnBlur, setValidationDelay, showErrors, validate, validate

Methods inherited from class com.sencha.gxt.widget.core.client.cell.CellComponent

createContext, getElement, getKey, getKeyProvider, getValue, onResize, redraw, redraw, setKeyProvider, setValue

Methods inherited from class com.sencha.gxt.widget.core.client.Component

addBeforeHideHandler, addBeforeShowContextMenuHandler, addBeforeShowHandler, addBlurHandler, addDisableHandler, addEnableHandler, addFocusHandler, addGestureRecognizer, addHideHandler, addMoveHandler, addResizeHandler, addShowContextMenuHandler, addShowHandler, addStyleDependentName, addStyleOnOver, adjustPosition, adjustSize, applyState, assertAfterRender, assertPreRender, blur, clearSizeCache, disable, disableContextMenu, disableEvents, enable, enableEvents, fireCancellableEvent, fireEvent, focus, getData, getFocusSupport, getGestureRecognizer, getGestureRecognizerCount, getHideMode, getId, getItemId, getOffsetHeight, getOffsetWidth, getPositionEl, getShadow, getShadowPosition, getStateId, getTabIndex, getToolTip, hide, hideShadow, hideToolTip, isAllowTextSelection, isAutoHeight, isAutoWidth, isDeferHeight, isEnabled, isMonitorWindowResize, isRendered, isStateful, isVisible, isVisible, mask, mask, notifyHide, notifyShow, onAfterFirstAttach, onAttach, onHide, onHideContextMenu, onLoad, onPosition, onRightClick, onShow, onShowContextMenu, onTouch, onUnload, onWindowResize, removeStyleDependentName, removeStyleOnOver, removeToolTip, setAllowTextSelection, setBorders, setBounds, setBounds, setContextMenu, setData, setDeferHeight, setEnabled, setHeight, setHeight, setHideMode, setItemId, setMonitorWindowResize, setPagePosition, setPixelSize, setPosition, setShadow, setShadowPosition, setSize, setStateful, setStateId, setStyleDependentName, setToolTip, setToolTipConfig, setVisible, setWidth, setWidth, show, sync, syncSize, unmask

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.sencha.gxt.widget.core.client.event.BlurEvent.HasBlurHandlers

addBlurHandler

Field Detail

messages

protected SpinnerField.SpinnerMessages messages

Constructor Detail

SpinnerField

public SpinnerField(NumberPropertyEditor<N> editor)

Creates a spinner field with the specified property editor.

Parameters:

editor - the property editor that increments, decrements and formats the value.

SpinnerField

public SpinnerField(SpinnerFieldCell<N> cell)

Creates a spinner field with the specified cell.

Parameters:

cell - a numeric cell with up / down arrows that increment / decrement the value

Method Detail

addBeforeSelectionHandler

public HandlerRegistration addBeforeSelectionHandler(<any> handler)

addSelectionHandler

public HandlerRegistration addSelectionHandler(<any> handler)

getCell

public SpinnerFieldCell<N> getCell()

Description copied from class: CellComponent

Get the Cell wrapped by this widget.

Overrides:

getCell in class TriggerField<N extends Number & Comparable<N>>

Returns:

the Cell being wrapped

getIncrement

public Number getIncrement(Context context)

Sets the increment value.

Parameters:

context - the cell context

Returns:

the increment

getMaxValue

public Number getMaxValue()

Returns the fields max value.

Returns:

the max value

getMessages

public SpinnerField.SpinnerMessages getMessages()

Returns the locale-sensitive messages used by this class.

Returns:

the local-sensitive messages used by this class.

getMinValue

public Number getMinValue()

Returns the field's minimum value.

Returns:

the min value

getPropertyEditor

public NumberPropertyEditor<N> getPropertyEditor()

Description copied from class: ValueBaseField

Returns the field's property editor.

Overrides:

getPropertyEditor in class ValueBaseField<N extends Number & Comparable<N>>

Returns:

the property editor

isAllowDecimals

public boolean isAllowDecimals()

Returns true of decimal values are allowed.

Returns:

the allow decimal state

isAllowNegative

public boolean isAllowNegative()

Returns true if negative values are allowed.

Returns:

the allow negative value state

setAllowDecimals

public void setAllowDecimals(boolean allowDecimals)

Sets whether decimal value are allowed (defaults to true).

Parameters:

allowDecimals - true to allow negative values

setAllowNegative

public void setAllowNegative(boolean allowNegative)

Sets whether negative value are allowed.

Parameters:

allowNegative - true to allow negative values

setIncrement

public void setIncrement(N increment)

Sets the increment that should be used (defaults to 1d).

Parameters:

increment - the increment to set.

setMaxValue

public void setMaxValue(N maxValue)

Sets the field's max allowable value.

Parameters:

maxValue - the max value

setMessages

public void setMessages(SpinnerField.SpinnerMessages messages)

Sets the spinner field messages.

Parameters:

messages - the messages

setMinValue

public void setMinValue(Number minValue)

Sets the field's minimum allowed value.

Parameters:

minValue - the minimum value

setValue

public void setValue(N value,
                     boolean fireEvents,
                     boolean redraw)

Description copied from class: CellComponent

Sets this object's value and optionally redraw the widget. Fires ValueChangeEvent when fireEvents is true and the new value does not equal the existing value. Redraws the widget when redraw is true and the new value does not equal the existing value.

Overrides:

setValue in class Field<N extends Number & Comparable<N>>

Parameters:

value - the object's new value

fireEvents - fire events if true and value is new

redraw - redraw the widget if true and value is new

validateValue

protected boolean validateValue(N value)

Overrides:

validateValue in class Field<N extends Number & Comparable<N>>