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

Class NumberField<N extends Number>

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.NumberField<N>

Type Parameters:

N - the number type

All Implemented Interfaces:

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:

BigDecimalField, BigIntegerField, DoubleField, FloatField, IntegerField, LongField, ShortField

public class NumberField<N extends Number>
extends TwinTriggerField<N>

A numeric text field that provides automatic keystroke filtering to disallow non-numeric characters, and numeric validation to limit the value to a range of valid numbers.

A NumberPropertyEditor must be passed at construction which is used to convert strings to typed number and from typed numbers to strings.

Nested Class Summary

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

Field.FieldStyles

Field Summary

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
NumberField(NumberInputCell<N> cell, NumberPropertyEditor<N> editor) Creates a new number field.
NumberField(NumberPropertyEditor<N> editor) Creates a new number field.

Method Summary

Modifier and Type	Method and Description
String	getBaseChars() Returns the base characters.
NumberInputCell<N>	getCell() Get the Cell wrapped by this widget.
String	getDecimalSeparator() Returns the decimal separator.
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.
protected void	onCellParseError(ParseErrorEvent event)
void	setAllowDecimals(boolean allowDecimals) Sets whether decimal value are allowed (defaults to true).
void	setAllowNegative(boolean allowNegative) Sets whether negative value are allowed to be entered into the field (defaults to true).
void	setBaseChars(String baseChars) Sets the base set of characters to evaluate as valid numbers (defaults to '0123456789').
void	setDecimalSeparator(String decimalSeparator) Sets the decimal separator (defaults to LocaleInfo.getCurrentLocale().getNumberConstants().decimalSeparator()).
void	setFormat(NumberFormat format) Sets the cell's number formatter.

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, 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, setValue, showErrors, validate, validate, validateValue

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

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

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

addBeforeHideHandler, addBeforeShowContextMenuHandler, addBeforeShowHandler, addBlurHandler, addDisableHandler, addEnableHandler, addFocusHandler, addHideHandler, addMoveHandler, addResizeHandler, addShowContextMenuHandler, addShowHandler, addStyleDependentName, addStyleOnOver, adjustPosition, adjustSize, applyState, assertAfterRender, assertPreRender, blur, clearSizeCache, disable, disableContextMenu, disableEvents, enable, enableEvents, fireCancellableEvent, fireEvent, focus, getData, getFocusSupport, 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, onAttach, onHide, onHideContextMenu, onLoad, onPosition, onRightClick, onShow, onShowContextMenu, 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

Constructor Detail

NumberField

public NumberField(NumberInputCell<N> cell,
                   NumberPropertyEditor<N> editor)

Creates a new number field.

Parameters:

cell - the number input cell

editor - the property editor

NumberField

public NumberField(NumberPropertyEditor<N> editor)

Creates a new number field.

Parameters:

editor - the property editor

Method Detail

getBaseChars

public String getBaseChars()

Returns the base characters.

Returns:

the base characters

getCell

public NumberInputCell<N> getCell()

Description copied from class: CellComponent

Get the Cell wrapped by this widget.

Overrides:

getCell in class TriggerField<N extends Number>

Returns:

the Cell being wrapped

getDecimalSeparator

public String getDecimalSeparator()

Returns the decimal separator.

Returns:

the decimal separator

getPropertyEditor

public NumberPropertyEditor<N> getPropertyEditor()

Description copied from class: ValueBaseField

Returns the field's property editor.

Overrides:

getPropertyEditor in class ValueBaseField<N extends Number>

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 decimal values

setAllowNegative

public void setAllowNegative(boolean allowNegative)

Sets whether negative value are allowed to be entered into the field (defaults to true).

Setting this does not add validation for negative values, use MinNumberValidator for that.

Parameters:

allowNegative - true to allow negative values

setBaseChars

public void setBaseChars(String baseChars)

Sets the base set of characters to evaluate as valid numbers (defaults to '0123456789').

Parameters:

baseChars - the base characters

setDecimalSeparator

public void setDecimalSeparator(String decimalSeparator)

Sets the decimal separator (defaults to LocaleInfo.getCurrentLocale().getNumberConstants().decimalSeparator()).

Parameters:

decimalSeparator - the decimal separator

setFormat

public void setFormat(NumberFormat format)

Sets the cell's number formatter.

Parameters:

format - the format

onCellParseError

protected void onCellParseError(ParseErrorEvent event)

Overrides:

onCellParseError in class ValueBaseField<N extends Number>