com.vaadin.flow.component.textfield

Class BigDecimalField

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<BigDecimalField,BigDecimal>

com.vaadin.flow.component.textfield.BigDecimalField

All Implemented Interfaces:

com.vaadin.flow.component.AttachNotifier, com.vaadin.flow.component.BlurNotifier<BigDecimalField>, com.vaadin.flow.component.CompositionNotifier, com.vaadin.flow.component.DetachNotifier, com.vaadin.flow.component.Focusable<BigDecimalField>, com.vaadin.flow.component.FocusNotifier<BigDecimalField>, com.vaadin.flow.component.HasElement, com.vaadin.flow.component.HasEnabled, com.vaadin.flow.component.HasHelper, com.vaadin.flow.component.HasLabel, 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<BigDecimalField,BigDecimal>,BigDecimal>, com.vaadin.flow.component.HasValueAndElement<com.vaadin.flow.component.AbstractField.ComponentValueChangeEvent<BigDecimalField,BigDecimal>,BigDecimal>, com.vaadin.flow.component.InputNotifier, com.vaadin.flow.component.KeyNotifier, HasClientValidation, HasAutocapitalize, HasAutocomplete, HasAutocorrect, HasPrefixAndSuffix, com.vaadin.flow.data.binder.HasValidator<BigDecimal>, com.vaadin.flow.data.value.HasValueChangeMode, Serializable

@Tag(value="vaadin-big-decimal-field")
 @JavaScript(value="frontend://vaadin-big-decimal-field.js")
 @JsModule(value="./vaadin-big-decimal-field.js")
public class BigDecimalField
extends GeneratedVaadinTextField<BigDecimalField,BigDecimal>
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, com.vaadin.flow.component.HasHelper, com.vaadin.flow.component.HasLabel, com.vaadin.flow.data.binder.HasValidator<BigDecimal>, HasClientValidation

Server-side component for the vaadin-big-decimal-field element. This field uses BigDecimal as the server-side value type, which allows handling decimal numbers with high precision. The component also prevents users from entering characters which can't be used in a decimal number, such as alphabets.

When setting values from the server-side, the scale of the provided BigDecimal is preserved in the presentation format shown to the user, as described in setValue(BigDecimal).

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.shared.HasClientValidation

HasClientValidation.ClientValidatedEvent

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.data.value.HasValueChangeMode

DEFAULT_CHANGE_TIMEOUT

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
BigDecimalField() Constructs an empty BigDecimalField.
BigDecimalField(com.vaadin.flow.component.HasValue.ValueChangeListener<? super com.vaadin.flow.component.AbstractField.ComponentValueChangeEvent<BigDecimalField,BigDecimal>> listener) Constructs an empty BigDecimalField with a value change listener.
BigDecimalField(String label) Constructs an empty BigDecimalField with the given label.
BigDecimalField(String label, BigDecimal initialValue, com.vaadin.flow.component.HasValue.ValueChangeListener<? super com.vaadin.flow.component.AbstractField.ComponentValueChangeEvent<BigDecimalField,BigDecimal>> listener) Constructs an empty BigDecimalField with a label,a value change listener and an initial value.
BigDecimalField(String label, BigDecimal initialValue, String placeholder) Constructs a BigDecimalField with the given label, an initial value and placeholder text.
BigDecimalField(String label, com.vaadin.flow.component.HasValue.ValueChangeListener<? super com.vaadin.flow.component.AbstractField.ComponentValueChangeEvent<BigDecimalField,BigDecimal>> listener) Constructs an empty BigDecimalField with a label and a value change listener.
BigDecimalField(String label, String placeholder) Constructs an empty BigDecimalField with the given label and placeholder text.

Method Summary

Modifier and Type	Method and Description
com.vaadin.flow.shared.Registration	addValidationStatusChangeListener(com.vaadin.flow.data.binder.ValidationStatusChangeListener<BigDecimal> listener)
com.vaadin.flow.data.binder.Validator<BigDecimal>	getDefaultValidator()
BigDecimal	getEmptyValue()
String	getErrorMessage()
String	getLabel() String used for the label element.
Locale	getLocale() Gets the locale used by this BigDecimalField.
String	getPlaceholder() A hint to the user of what can be entered in the component.
String	getTitle() The text usually displayed in a tooltip popup when the mouse is over the field.
BigDecimal	getValue() Returns the current value of the field.
com.vaadin.flow.data.value.ValueChangeMode	getValueChangeMode()
int	getValueChangeTimeout()
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 field.
protected boolean	isEnforcedFieldValidationEnabled() Whether the full experience validation is enforced for the component.
boolean	isInvalid()
protected void	onAttach(com.vaadin.flow.component.AttachEvent attachEvent)
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 text field.
void	setErrorMessage(String errorMessage) Description copied from corresponding location in WebComponent:
void	setInvalid(boolean invalid) Description copied from corresponding location in WebComponent:
void	setLabel(String label) Sets the label for this component.
void	setLocale(Locale locale) Sets the locale for this BigDecimalField.
void	setPlaceholder(String placeholder) Description copied from corresponding location in WebComponent:
void	setTitle(String title) Description copied from corresponding location in WebComponent:
void	setValue(BigDecimal value) Sets the value of this field.
void	setValueChangeMode(com.vaadin.flow.data.value.ValueChangeMode valueChangeMode)
void	setValueChangeTimeout(int valueChangeTimeout)
protected void	validate() Performs server-side validation of the current value.

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

addChangeListener, addInvalidChangeListener, addThemeVariants, addToInput, addToPrefix, addToSuffix, checkValidity, 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, setPattern, setPreventInvalidInput, setReadonly, setRequired

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

getSynchronizationRegistration, 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, getParent, getTranslation, getTranslation, getTranslation, getTranslation, getUI, hasListener, isAttached, isTemplateMapped, isVisible, 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

getCssSize, getHeight, getHeightUnit, getMaxHeight, getMaxWidth, getMinHeight, getMinWidth, getWidth, getWidthUnit, setHeight, setHeight, setHeightFull, setMaxHeight, setMaxHeight, setMaxWidth, setMaxWidth, setMinHeight, setMinHeight, setMinWidth, setMinWidth, setSizeFull, setSizeUndefined, setWidth, 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.HasHelper

getHelperComponent, getHelperText, setHelperComponent, setHelperText

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

getElement

Methods inherited from interface com.vaadin.flow.component.shared.HasClientValidation

addClientValidatedEventListener

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, setRequiredIndicatorVisible

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

BigDecimalField

public BigDecimalField()

Constructs an empty BigDecimalField.

BigDecimalField

public BigDecimalField(String label)

Constructs an empty BigDecimalField with the given label.

Parameters:

label - the text to set as the label

BigDecimalField

public BigDecimalField(String label,
                       String placeholder)

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

Parameters:

label - the text to set as the label

placeholder - the placeholder text to set

BigDecimalField

public BigDecimalField(String label,
                       BigDecimal initialValue,
                       String placeholder)

Constructs a BigDecimalField with the given label, an initial value and placeholder text.

Parameters:

label - the text to set as the label

initialValue - the initial value

placeholder - the placeholder text to set

See Also:

AbstractField.setValue(Object), setPlaceholder(String)

BigDecimalField

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

Constructs an empty BigDecimalField with a value change listener.

Parameters:

listener - the value change listener

See Also:

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

BigDecimalField

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

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

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)

BigDecimalField

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

Constructs an empty BigDecimalField with a label,a value change listener 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

setValueChangeTimeout

public void setValueChangeTimeout(int valueChangeTimeout)

Specified by:

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

getValueChangeTimeout

public int getValueChangeTimeout()

Specified by:

getValueChangeTimeout 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<BigDecimalField,BigDecimal>

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<BigDecimalField,BigDecimal>

Parameters:

invalid - the boolean value to set

setLabel

public void setLabel(String label)

Sets the label for this component.

Specified by:

setLabel in interface com.vaadin.flow.component.HasLabel

Overrides:

setLabel in class GeneratedVaadinTextField<BigDecimalField,BigDecimal>

Parameters:

label - value for the label property in the webcomponent

getLabel

public String getLabel()

String used for the label element.

Specified by:

getLabel in interface com.vaadin.flow.component.HasLabel

Returns:

the label 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<BigDecimalField,BigDecimal>

Parameters:

placeholder - the String value to set

getPlaceholder

public String getPlaceholder()

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

Returns:

the placeholder property from the webcomponent

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<BigDecimalField,BigDecimal>

Parameters:

autoselect - true to set auto select on, false otherwise

isClearButtonVisible

public boolean isClearButtonVisible()

Gets the visibility state of the button which clears the 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 text field.

Overrides:

setClearButtonVisible in class GeneratedVaadinTextField<BigDecimalField,BigDecimal>

Parameters:

clearButtonVisible - true to set the button visible, false otherwise

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<BigDecimalField,BigDecimal>

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

getTitle

public String getTitle()

The text usually displayed in a tooltip popup when the mouse is over the field.

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:

The text usually displayed in a tooltip popup when the mouse is over the field.

Overrides:

setTitle in class GeneratedVaadinTextField<BigDecimalField,BigDecimal>

Parameters:

title - the String value to set

getEmptyValue

public BigDecimal getEmptyValue()

Specified by:

getEmptyValue in interface com.vaadin.flow.component.HasValue<com.vaadin.flow.component.AbstractField.ComponentValueChangeEvent<BigDecimalField,BigDecimal>,BigDecimal>

Overrides:

getEmptyValue in class com.vaadin.flow.component.AbstractField<BigDecimalField,BigDecimal>

setValue

public void setValue(BigDecimal value)

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

You can adjust how the value is presented in the field with the APIs provided by the value type BigDecimal. For example, you can change the number of decimal places with BigDecimal.setScale(int). This doesn't however restrict the user from entering values with different number of decimals. Note that BigDecimals are immutable, so their methods will return new instances instead of editing the existing ones. Scientific notation (such as 1e9) is turned into plain number format for the presentation.

Specified by:

setValue in interface com.vaadin.flow.component.HasValue<com.vaadin.flow.component.AbstractField.ComponentValueChangeEvent<BigDecimalField,BigDecimal>,BigDecimal>

Overrides:

setValue in class com.vaadin.flow.component.AbstractField<BigDecimalField,BigDecimal>

Parameters:

value - the new value

getValue

public BigDecimal getValue()

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

Specified by:

getValue in interface com.vaadin.flow.component.HasValue<com.vaadin.flow.component.AbstractField.ComponentValueChangeEvent<BigDecimalField,BigDecimal>,BigDecimal>

Overrides:

getValue in class com.vaadin.flow.component.AbstractField<BigDecimalField,BigDecimal>

Returns:

the current value.

validate

protected void validate()

Performs server-side validation of the current value. This is needed because it is possible to circumvent the client-side validation constraints using browser development tools.

Overrides:

validate in class GeneratedVaadinTextField<BigDecimalField,BigDecimal>

getDefaultValidator

public com.vaadin.flow.data.binder.Validator<BigDecimal> getDefaultValidator()

Specified by:

getDefaultValidator in interface com.vaadin.flow.data.binder.HasValidator<BigDecimal>

addValidationStatusChangeListener

public com.vaadin.flow.shared.Registration addValidationStatusChangeListener(com.vaadin.flow.data.binder.ValidationStatusChangeListener<BigDecimal> listener)

Specified by:

addValidationStatusChangeListener in interface com.vaadin.flow.data.binder.HasValidator<BigDecimal>

setLocale

public void setLocale(Locale locale)

Sets the locale for this BigDecimalField. It is used to determine which decimal separator (the radix point) should be used.

Parameters:

locale - the locale to set, not null

getLocale

public Locale getLocale()

Gets the locale used by this BigDecimalField. It is used to determine which decimal separator (the radix point) should be used.

Overrides:

getLocale in class com.vaadin.flow.component.Component

Returns:

the locale of this field, never null

onAttach

protected void onAttach(com.vaadin.flow.component.AttachEvent attachEvent)

Overrides:

onAttach in class com.vaadin.flow.component.Component

isEnforcedFieldValidationEnabled

protected boolean isEnforcedFieldValidationEnabled()

Whether the full experience validation is enforced for the component.

Exposed with protected visibility to support mocking

The method requires the VaadinSession instance to obtain the application configuration properties, otherwise, the feature is considered disabled.

Returns:

true if enabled, false otherwise.