com.vaadin.flow.component.textfield

Class NumberField

java.lang.Object

com.vaadin.flow.component.Component

com.vaadin.flow.component.AbstractField<C,T>

com.vaadin.flow.component.AbstractSinglePropertyField<R,T>

com.vaadin.flow.component.textfield.GeneratedVaadinTextField<R,T>

com.vaadin.flow.component.textfield.GeneratedVaadinNumberField<NumberField,Double>

com.vaadin.flow.component.textfield.NumberField

All Implemented Interfaces:

com.vaadin.flow.component.AttachNotifier, com.vaadin.flow.component.BlurNotifier<NumberField>, com.vaadin.flow.component.CompositionNotifier, com.vaadin.flow.component.DetachNotifier, com.vaadin.flow.component.Focusable<NumberField>, com.vaadin.flow.component.FocusNotifier<NumberField>, com.vaadin.flow.component.HasElement, com.vaadin.flow.component.HasEnabled, com.vaadin.flow.component.HasSize, com.vaadin.flow.component.HasStyle, com.vaadin.flow.component.HasTheme, com.vaadin.flow.component.HasValidation, com.vaadin.flow.component.HasValue<com.vaadin.flow.component.AbstractField.ComponentValueChangeEvent<NumberField,Double>,Double>, com.vaadin.flow.component.HasValueAndElement<com.vaadin.flow.component.AbstractField.ComponentValueChangeEvent<NumberField,Double>,Double>, com.vaadin.flow.component.InputNotifier, com.vaadin.flow.component.KeyNotifier, HasAutocapitalize, HasAutocomplete, HasAutocorrect, HasPrefixAndSuffix, com.vaadin.flow.data.value.HasValueChangeMode, Serializable

public class NumberField
extends GeneratedVaadinNumberField<NumberField,Double>
implements com.vaadin.flow.component.HasSize, com.vaadin.flow.component.HasValidation, com.vaadin.flow.data.value.HasValueChangeMode, HasPrefixAndSuffix, com.vaadin.flow.component.InputNotifier, com.vaadin.flow.component.KeyNotifier, com.vaadin.flow.component.CompositionNotifier, HasAutocomplete, HasAutocapitalize, HasAutocorrect

Server-side component for the vaadin-number-field element.

Author:

Vaadin Ltd.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.vaadin.flow.component.textfield.GeneratedVaadinTextField

GeneratedVaadinTextField.ChangeEvent<R extends GeneratedVaadinTextField<R,?>>, GeneratedVaadinTextField.InvalidChangeEvent<R extends GeneratedVaadinTextField<R,?>>

Nested classes/interfaces inherited from class com.vaadin.flow.component.AbstractField

com.vaadin.flow.component.AbstractField.ComponentValueChangeEvent<C extends com.vaadin.flow.component.Component,V>

Nested classes/interfaces inherited from interface com.vaadin.flow.component.BlurNotifier

com.vaadin.flow.component.BlurNotifier.BlurEvent<C extends com.vaadin.flow.component.Component>

Nested classes/interfaces inherited from interface com.vaadin.flow.component.FocusNotifier

com.vaadin.flow.component.FocusNotifier.FocusEvent<C extends com.vaadin.flow.component.Component>

Nested classes/interfaces inherited from interface com.vaadin.flow.component.HasValue

com.vaadin.flow.component.HasValue.ValueChangeEvent<V>, com.vaadin.flow.component.HasValue.ValueChangeListener<E extends com.vaadin.flow.component.HasValue.ValueChangeEvent<?>>

Field Summary

Fields inherited from interface com.vaadin.flow.component.textfield.HasAutocomplete

AUTOCOMPLETE_ATTRIBUTE

Fields inherited from interface com.vaadin.flow.component.textfield.HasAutocapitalize

AUTOCAPITALIZE_ATTRIBUTE

Fields inherited from interface com.vaadin.flow.component.textfield.HasAutocorrect

AUTOCORRECT_ATTRIBUTE

Constructor Summary

Constructors

Constructor and Description
NumberField() Constructs an empty NumberField.
NumberField(com.vaadin.flow.component.HasValue.ValueChangeListener<? super com.vaadin.flow.component.AbstractField.ComponentValueChangeEvent<NumberField,Double>> listener) Constructs an empty NumberField with a value change listener.
NumberField(String label) Constructs an empty NumberField with the given label.
NumberField(String label, Double initialValue, com.vaadin.flow.component.HasValue.ValueChangeListener<? super com.vaadin.flow.component.AbstractField.ComponentValueChangeEvent<NumberField,Double>> listener) Constructs a NumberField with a value change listener, a label and an initial value.
NumberField(String label, com.vaadin.flow.component.HasValue.ValueChangeListener<? super com.vaadin.flow.component.AbstractField.ComponentValueChangeEvent<NumberField,Double>> listener) Constructs an empty NumberField with a value change listener and a label.
NumberField(String label, String placeholder) Constructs an empty NumberField with the given label and placeholder text.

Method Summary

Modifier and Type	Method and Description
Double	getEmptyValue() Returns the value that represents an empty value.
String	getErrorMessage()
String	getLabel() String used for the label element.
double	getMax() The maximum value of the field.
int	getMaxLength() Maximum number of characters (in Unicode code points) that the user can enter.
double	getMin() The minimum value of the field.
int	getMinLength() Minimum number of characters (in Unicode code points) that the user can enter.
String	getPattern() A regular expression that the value is checked against.
String	getPlaceholder() A hint to the user of what can be entered in the component.
double	getStep() Specifies the allowed number intervals of the field.
String	getTitle() Message to show to the user when validation fails.
Double	getValue() Returns the current value of the number field.
com.vaadin.flow.data.value.ValueChangeMode	getValueChangeMode()
boolean	hasControls() Set to true to display value increase/decrease controls.
boolean	isAutofocus() Specify that this control should have input focus when the page loads.
boolean	isAutoselect() Specifies if the field value gets automatically selected when the field gains focus.
boolean	isClearButtonVisible() Gets the visibility state of the button which clears the number field.
boolean	isInvalid()
boolean	isPreventInvalidInput() When set to true, user is prevented from typing a value that conflicts with the given pattern.
void	setAutofocus(boolean autofocus) Description copied from corresponding location in WebComponent:
void	setAutoselect(boolean autoselect) Set to true to always have the field value automatically selected when the field gains focus, false otherwise.
void	setClearButtonVisible(boolean clearButtonVisible) Set to false to hide the clear button which clears the number field.
void	setErrorMessage(String errorMessage) Description copied from corresponding location in WebComponent:
void	setHasControls(boolean hasControls) Description copied from corresponding location in WebComponent:
void	setInvalid(boolean invalid) Description copied from corresponding location in WebComponent:
void	setLabel(String label) Description copied from corresponding location in WebComponent:
void	setMax(double max) Description copied from corresponding location in WebComponent:
void	setMaxLength(int maxLength) Maximum number of characters (in Unicode code points) that the user can enter.
void	setMin(double min) Description copied from corresponding location in WebComponent:
void	setMinLength(int minLength) Minimum number of characters (in Unicode code points) that the user can enter.
void	setPattern(String pattern) Description copied from corresponding location in WebComponent:
void	setPlaceholder(String placeholder) Description copied from corresponding location in WebComponent:
void	setPreventInvalidInput(boolean preventInvalidInput) Description copied from corresponding location in WebComponent:
void	setRequiredIndicatorVisible(boolean requiredIndicatorVisible)
void	setStep(double step) Description copied from corresponding location in WebComponent:
void	setTitle(String title) Description copied from corresponding location in WebComponent:
void	setValue(Double value) Sets the value of this number field.
void	setValueChangeMode(com.vaadin.flow.data.value.ValueChangeMode valueChangeMode)

Methods inherited from class com.vaadin.flow.component.textfield.GeneratedVaadinNumberField

checkValidity, getMaxDouble, getMinDouble, getStepDouble, hasControlsBoolean

Methods inherited from class com.vaadin.flow.component.textfield.GeneratedVaadinTextField

addChangeListener, addInvalidChangeListener, addThemeVariants, addToInput, addToPrefix, addToSuffix, getAutocapitalizeString, getAutocompleteString, getAutocorrectString, getErrorMessageString, getLabelString, getListString, getMaxlengthDouble, getMinlengthDouble, getNameString, getPatternString, getPlaceholderString, getTitleString, isAutofocusBoolean, isAutoselectBoolean, isClearButtonVisibleBoolean, isDisabledBoolean, isInvalidBoolean, isPreventInvalidInputBoolean, isReadonlyBoolean, isRequiredBoolean, remove, removeAll, removeThemeVariants, setAutocapitalize, setAutocomplete, setAutocorrect, setDisabled, setList, setMaxlength, setMinlength, setName, setReadonly, setRequired, validate

Methods inherited from class com.vaadin.flow.component.AbstractSinglePropertyField

hasValidValue, setPresentationValue, setSynchronizedEvent

Methods inherited from class com.vaadin.flow.component.AbstractField

addValueChangeListener, isEmpty, setModelValue, valueEquals

Methods inherited from class com.vaadin.flow.component.Component

addListener, fireEvent, from, get, getChildren, getElement, getEventBus, getId, getLocale, getParent, getTranslation, getTranslation, getUI, hasListener, isTemplateMapped, isVisible, onAttach, onDetach, onEnabledStateChanged, set, setElement, setId, setVisible

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.vaadin.flow.component.HasSize

getHeight, getMaxHeight, getMaxWidth, getMinHeight, getMinWidth, getWidth, setHeight, setHeightFull, setMaxHeight, setMaxWidth, setMinHeight, setMinWidth, setSizeFull, setSizeUndefined, setWidth, setWidthFull

Methods inherited from interface com.vaadin.flow.component.textfield.HasPrefixAndSuffix

getPrefixComponent, getSuffixComponent, setPrefixComponent, setSuffixComponent

Methods inherited from interface com.vaadin.flow.component.InputNotifier

addInputListener

Methods inherited from interface com.vaadin.flow.component.KeyNotifier

addKeyDownListener, addKeyDownListener, addKeyPressListener, addKeyPressListener, addKeyUpListener, addKeyUpListener

Methods inherited from interface com.vaadin.flow.component.CompositionNotifier

addCompositionEndListener, addCompositionStartListener, addCompositionUpdateListener

Methods inherited from interface com.vaadin.flow.component.textfield.HasAutocomplete

getAutocomplete, setAutocomplete

Methods inherited from interface com.vaadin.flow.component.textfield.HasAutocapitalize

getAutocapitalize, setAutocapitalize

Methods inherited from interface com.vaadin.flow.component.textfield.HasAutocorrect

isAutocorrect, setAutocorrect

Methods inherited from interface com.vaadin.flow.component.HasElement

getElement

Methods inherited from interface com.vaadin.flow.component.HasStyle

addClassName, addClassNames, getClassName, getClassNames, getStyle, hasClassName, removeClassName, removeClassNames, setClassName, setClassName

Methods inherited from interface com.vaadin.flow.component.Focusable

addFocusShortcut, blur, focus, getTabIndex, setTabIndex

Methods inherited from interface com.vaadin.flow.component.BlurNotifier

addBlurListener

Methods inherited from interface com.vaadin.flow.component.FocusNotifier

addFocusListener

Methods inherited from interface com.vaadin.flow.component.HasEnabled

isEnabled, setEnabled

Methods inherited from interface com.vaadin.flow.component.HasTheme

addThemeName, addThemeNames, getThemeName, getThemeNames, hasThemeName, removeThemeName, removeThemeNames, setThemeName, setThemeName

Methods inherited from interface com.vaadin.flow.component.HasValueAndElement

isReadOnly, isRequiredIndicatorVisible, setReadOnly

Methods inherited from interface com.vaadin.flow.component.HasValue

clear, getOptionalValue

Methods inherited from interface com.vaadin.flow.component.AttachNotifier

addAttachListener

Methods inherited from interface com.vaadin.flow.component.DetachNotifier

addDetachListener

Constructor Detail

NumberField

public NumberField()

Constructs an empty NumberField.

NumberField

public NumberField(String label)

Constructs an empty NumberField with the given label.

Parameters:

label - the text to set as the label

NumberField

public NumberField(String label,
                   String placeholder)

Constructs an empty NumberField with the given label and placeholder text.

Parameters:

label - the text to set as the label

placeholder - the placeholder text to set

NumberField

public NumberField(com.vaadin.flow.component.HasValue.ValueChangeListener<? super com.vaadin.flow.component.AbstractField.ComponentValueChangeEvent<NumberField,Double>> listener)

Constructs an empty NumberField with a value change listener.

Parameters:

listener - the value change listener

See Also:

AbstractField.addValueChangeListener(com.vaadin.flow.component.HasValue.ValueChangeListener)

NumberField

public NumberField(String label,
                   com.vaadin.flow.component.HasValue.ValueChangeListener<? super com.vaadin.flow.component.AbstractField.ComponentValueChangeEvent<NumberField,Double>> listener)

Constructs an empty NumberField with a value change listener and a label.

Parameters:

label - the text to set as the label

listener - the value change listener

See Also:

setLabel(String), AbstractField.addValueChangeListener(com.vaadin.flow.component.HasValue.ValueChangeListener)

NumberField

public NumberField(String label,
                   Double initialValue,
                   com.vaadin.flow.component.HasValue.ValueChangeListener<? super com.vaadin.flow.component.AbstractField.ComponentValueChangeEvent<NumberField,Double>> listener)

Constructs a NumberField with a value change listener, a label and an initial value.

Parameters:

label - the text to set as the label

initialValue - the initial value

listener - the value change listener

See Also:

setLabel(String), AbstractField.setValue(Object), AbstractField.addValueChangeListener(com.vaadin.flow.component.HasValue.ValueChangeListener)

Method Detail

getValueChangeMode

public com.vaadin.flow.data.value.ValueChangeMode getValueChangeMode()

The default value is ValueChangeMode.ON_CHANGE.

Specified by:

getValueChangeMode in interface com.vaadin.flow.data.value.HasValueChangeMode

setValueChangeMode

public void setValueChangeMode(com.vaadin.flow.data.value.ValueChangeMode valueChangeMode)

Specified by:

setValueChangeMode in interface com.vaadin.flow.data.value.HasValueChangeMode

getErrorMessage

public String getErrorMessage()

Specified by:

getErrorMessage in interface com.vaadin.flow.component.HasValidation

setErrorMessage

public void setErrorMessage(String errorMessage)

Description copied from class: GeneratedVaadinTextField

Description copied from corresponding location in WebComponent:

Error to show when the input value is invalid.

Specified by:

setErrorMessage in interface com.vaadin.flow.component.HasValidation

Overrides:

setErrorMessage in class GeneratedVaadinTextField<NumberField,Double>

Parameters:

errorMessage - the String value to set

isInvalid

public boolean isInvalid()

Specified by:

isInvalid in interface com.vaadin.flow.component.HasValidation

setInvalid

public void setInvalid(boolean invalid)

Description copied from class: GeneratedVaadinTextField

Description copied from corresponding location in WebComponent:

This property is set to true when the control value is invalid.

Specified by:

setInvalid in interface com.vaadin.flow.component.HasValidation

Overrides:

setInvalid in class GeneratedVaadinTextField<NumberField,Double>

Parameters:

invalid - the boolean value to set

setLabel

public void setLabel(String label)

Description copied from class: GeneratedVaadinTextField

Description copied from corresponding location in WebComponent:

String used for the label element.

Overrides:

setLabel in class GeneratedVaadinTextField<NumberField,Double>

Parameters:

label - the String value to set

getLabel

public String getLabel()

String used for the label element.

Returns:

the label property from the webcomponent

setMax

public void setMax(double max)

Description copied from class: GeneratedVaadinNumberField

Description copied from corresponding location in WebComponent:

The maximum value of the field.

Overrides:

setMax in class GeneratedVaadinNumberField<NumberField,Double>

Parameters:

max - the double value to set

getMax

public double getMax()

The maximum value of the field.

Returns:

the max property from the webcomponent

setMin

public void setMin(double min)

Description copied from class: GeneratedVaadinNumberField

Description copied from corresponding location in WebComponent:

The minimum value of the field.

Overrides:

setMin in class GeneratedVaadinNumberField<NumberField,Double>

Parameters:

min - the double value to set

getMin

public double getMin()

The minimum value of the field.

Returns:

the min property from the webcomponent

setStep

public void setStep(double step)

Description copied from class: GeneratedVaadinNumberField

Description copied from corresponding location in WebComponent:

Specifies the allowed number intervals of the field.

Overrides:

setStep in class GeneratedVaadinNumberField<NumberField,Double>

Parameters:

step - the double value to set

getStep

public double getStep()

Specifies the allowed number intervals of the field.

Returns:

the step property from the webcomponent

setPlaceholder

public void setPlaceholder(String placeholder)

Description copied from class: GeneratedVaadinTextField

Description copied from corresponding location in WebComponent:

A hint to the user of what can be entered in the control.

Overrides:

setPlaceholder in class GeneratedVaadinTextField<NumberField,Double>

Parameters:

placeholder - the String value to set

setHasControls

public void setHasControls(boolean hasControls)

Description copied from class: GeneratedVaadinNumberField

Description copied from corresponding location in WebComponent:

Set to true to display value increase/decrease controls.

Overrides:

setHasControls in class GeneratedVaadinNumberField<NumberField,Double>

Parameters:

hasControls - the boolean value to set

hasControls

public boolean hasControls()

Set to true to display value increase/decrease controls.

Returns:

the hasControls property from the webcomponent

getPlaceholder

public String getPlaceholder()

A hint to the user of what can be entered in the component.

Returns:

the placeholder property from the webcomponent

setAutofocus

public void setAutofocus(boolean autofocus)

Description copied from class: GeneratedVaadinTextField

Description copied from corresponding location in WebComponent:

Specify that this control should have input focus when the page loads.

Overrides:

setAutofocus in class GeneratedVaadinTextField<NumberField,Double>

Parameters:

autofocus - the boolean value to set

isAutofocus

public boolean isAutofocus()

Specify that this control should have input focus when the page loads.

Returns:

the autofocus property from the webcomponent

setMaxLength

public void setMaxLength(int maxLength)

Maximum number of characters (in Unicode code points) that the user can enter.

Parameters:

maxLength - the maximum length

getMaxLength

public int getMaxLength()

Maximum number of characters (in Unicode code points) that the user can enter.

Returns:

the maxlength property from the webcomponent

setMinLength

public void setMinLength(int minLength)

Minimum number of characters (in Unicode code points) that the user can enter.

Parameters:

minLength - the minimum length

getMinLength

public int getMinLength()

Minimum number of characters (in Unicode code points) that the user can enter.

Returns:

the minlength property from the webcomponent

isPreventInvalidInput

public boolean isPreventInvalidInput()

When set to true, user is prevented from typing a value that conflicts with the given pattern.

Returns:

the preventInvalidInput property from the webcomponent

setPreventInvalidInput

public void setPreventInvalidInput(boolean preventInvalidInput)

Description copied from class: GeneratedVaadinTextField

Description copied from corresponding location in WebComponent:

When set to true, user is prevented from typing a value that conflicts with the given pattern.

Overrides:

setPreventInvalidInput in class GeneratedVaadinTextField<NumberField,Double>

Parameters:

preventInvalidInput - the boolean value to set

setPattern

public void setPattern(String pattern)

Description copied from class: GeneratedVaadinTextField

Description copied from corresponding location in WebComponent:

A regular expression that the value is checked against. The pattern must match the entire value, not just some subset.

Overrides:

setPattern in class GeneratedVaadinTextField<NumberField,Double>

Parameters:

pattern - the String value to set

getPattern

public String getPattern()

A regular expression that the value is checked against. The pattern must match the entire value, not just some subset.

Returns:

the pattern property from the webcomponent

getTitle

public String getTitle()

Message to show to the user when validation fails.

Returns:

the title property from the webcomponent

setTitle

public void setTitle(String title)

Description copied from class: GeneratedVaadinTextField

Description copied from corresponding location in WebComponent:

Message to show to the user when validation fails.

Overrides:

setTitle in class GeneratedVaadinTextField<NumberField,Double>

Parameters:

title - the String value to set

isAutoselect

public boolean isAutoselect()

Specifies if the field value gets automatically selected when the field gains focus.

Returns:

true if autoselect is active, false otherwise

setAutoselect

public void setAutoselect(boolean autoselect)

Set to true to always have the field value automatically selected when the field gains focus, false otherwise.

Overrides:

setAutoselect in class GeneratedVaadinTextField<NumberField,Double>

Parameters:

autoselect - true to set auto select on, false otherwise

isClearButtonVisible

public boolean isClearButtonVisible()

Gets the visibility state of the button which clears the number field.

Returns:

true if the button is visible, false otherwise

setClearButtonVisible

public void setClearButtonVisible(boolean clearButtonVisible)

Set to false to hide the clear button which clears the number field.

Overrides:

setClearButtonVisible in class GeneratedVaadinTextField<NumberField,Double>

Parameters:

clearButtonVisible - true to set the button visible, false otherwise

getEmptyValue

public Double getEmptyValue()

Returns the value that represents an empty value.

Specified by:

getEmptyValue in interface com.vaadin.flow.component.HasValue<com.vaadin.flow.component.AbstractField.ComponentValueChangeEvent<NumberField,Double>,Double>

Overrides:

getEmptyValue in class com.vaadin.flow.component.AbstractField<NumberField,Double>

setValue

public void setValue(Double value)

Sets the value of this number field. If the new value is not equal to getValue(), fires a value change event.

Specified by:

setValue in interface com.vaadin.flow.component.HasValue<com.vaadin.flow.component.AbstractField.ComponentValueChangeEvent<NumberField,Double>,Double>

Overrides:

setValue in class com.vaadin.flow.component.AbstractField<NumberField,Double>

Parameters:

value - the new value

getValue

public Double getValue()

Returns the current value of the number field. By default, the empty number field will return null .

Specified by:

getValue in interface com.vaadin.flow.component.HasValue<com.vaadin.flow.component.AbstractField.ComponentValueChangeEvent<NumberField,Double>,Double>

Overrides:

getValue in class com.vaadin.flow.component.AbstractField<NumberField,Double>

Returns:

the current value.

setRequiredIndicatorVisible

public void setRequiredIndicatorVisible(boolean requiredIndicatorVisible)

Specified by:

setRequiredIndicatorVisible in interface com.vaadin.flow.component.HasValue<com.vaadin.flow.component.AbstractField.ComponentValueChangeEvent<NumberField,Double>,Double>

Specified by:

setRequiredIndicatorVisible in interface com.vaadin.flow.component.HasValueAndElement<com.vaadin.flow.component.AbstractField.ComponentValueChangeEvent<NumberField,Double>,Double>