Package 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<TComponent,TValue>
com.vaadin.flow.component.textfield.TextFieldBase<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.HasAriaLabel, com.vaadin.flow.component.HasElement, com.vaadin.flow.component.HasEnabled, com.vaadin.flow.component.HasHelper, com.vaadin.flow.component.HasLabel, com.vaadin.flow.component.HasPlaceholder, 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, HasClearButton, HasPrefix, HasSuffix, HasThemeVariant<TextFieldVariant>, HasTooltip, HasValidationProperties, InputField<com.vaadin.flow.component.AbstractField.ComponentValueChangeEvent<BigDecimalField,BigDecimal>,BigDecimal>, HasAutocapitalize, HasAutocomplete, HasAutocorrect, HasPrefixAndSuffix, com.vaadin.flow.data.binder.HasValidator<BigDecimal>, com.vaadin.flow.data.value.HasValueChangeMode, Serializable
@Tag("vaadin-big-decimal-field") @JsModule("./vaadin-big-decimal-field.js") @Uses(TextField.class) public class BigDecimalField extends TextFieldBase<BigDecimalField,BigDecimal> implements HasThemeVariant<TextFieldVariant>
BigDecimalField is an input field for handling decimal numbers with high precision. This field uses BigDecimal as the server-side value type, and only allows numeric input.

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

Validation

BigDecimalField comes with a built-in validation mechanism that verifies that the value is parsable into BigDecimal and is not empty when the required constraint is enabled. If validation fails, the component is marked as invalid and an error message is displayed below the input.

Validation is triggered whenever the user applies an input change, for example by pressing Enter or blurring the field. Programmatic value changes trigger validation as well. In eager and lazy value change modes, validation is also triggered on every character press with a delay according to the selected mode.

Error messages for unparsable input and required constraint can be configured with the BigDecimalField.BigDecimalFieldI18n object, using the respective properties. If you want to provide a single catch-all error message, you can also use the setErrorMessage(String) method. Note that such an error message will take priority over i18n error messages if both are set.

For more advanced validation that requires custom rules, you can use Binder. By default, before running custom validators, Binder will also check if the value is parsable and display an error message from the BigDecimalField.BigDecimalFieldI18n object. For the required constraint, Binder provides its own API, see asRequired().

However, if Binder doesn't fit your needs and you want to implement fully custom validation logic, you can disable the constraint validation by setting setManualValidation(boolean) to true. This will allow you to control the invalid state and the error message manually using HasValidationProperties.setInvalid(boolean) and setErrorMessage(String) API.

Author:
Vaadin Ltd.
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static class 
    BigDecimalField.BigDecimalFieldI18n
    The internationalization properties for BigDecimalField.

    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 extends Object>

    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 extends Object>, 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.HasAutocapitalize

    AUTOCAPITALIZE_ATTRIBUTE

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

    AUTOCOMPLETE_ATTRIBUTE

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

    AUTOCORRECT_ATTRIBUTE

    Fields inherited from interface com.vaadin.flow.data.value.HasValueChangeMode

    DEFAULT_CHANGE_TIMEOUT

  • Constructor Summary

    Constructors
    Constructor
    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, 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.
    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.

  • Method Summary

    Modifier and Type
    Method
    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()
     
    BigDecimalField.BigDecimalFieldI18n
    getI18n()
    Gets the internationalization object previously set for this component.
    Locale
    getLocale()
    Gets the locale used by this BigDecimalField.
    BigDecimal
    getValue()
    Returns the current value of the field.
    void
    setErrorMessage(String errorMessage)
    void
    setI18n(BigDecimalField.BigDecimalFieldI18n i18n)
    Sets the internationalization object for this component.
    void
    setLocale(Locale locale)
    Sets the locale for this BigDecimalField.
    void
    setManualValidation(boolean enabled)
     
    protected void
    setModelValue(BigDecimal newModelValue, boolean fromClient)
     
    void
    setRequiredIndicatorVisible(boolean required)
    Sets whether the user is required to provide a value.
    void
    setValue(BigDecimal value)
    Sets the value of this field.
    protected void
    validate()
    Validates the current value against the constraints and sets the invalid property and the errorMessage property based on the result.

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

    addToInput, addToPrefix, addToSuffix, getAriaLabel, getAriaLabelledBy, getTitle, getValueChangeMode, getValueChangeTimeout, isAutofocus, isAutoselect, isRequired, isRequiredIndicatorVisible, setAriaLabel, setAriaLabelledBy, setAutofocus, setAutoselect, setLabel, setRequired, setTitle, setValueChangeMode, setValueChangeTimeout

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

    getSynchronizationRegistration, hasValidValue, setPresentationValue, setSynchronizedEvent

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

    addValueChangeListener, isEmpty, valueEquals

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

    addListener, findAncestor, fireEvent, from, get, getChildren, getElement, getEventBus, getId, getListeners, getParent, getTranslation, getTranslation, getTranslation, getTranslation, getTranslation, getTranslation, getUI, hasListener, isAttached, isTemplateMapped, isVisible, onAttach, onDetach, onEnabledStateChanged, removeFromParent, scrollIntoView, scrollIntoView, 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.AttachNotifier

    addAttachListener

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

    addBlurListener

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

    addCompositionEndListener, addCompositionStartListener, addCompositionUpdateListener

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

    addDetachListener

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

    addFocusShortcut, blur, focus, getTabIndex, setTabIndex

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

    addFocusListener

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

    getAutocapitalize, setAutocapitalize

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

    getAutocomplete, setAutocomplete

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

    isAutocorrect, setAutocorrect

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

    isClearButtonVisible, setClearButtonVisible

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

    getElement

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

    isEnabled, setEnabled

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

    getHelperComponent, getHelperText, setHelperComponent, setHelperText

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

    getLabel

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

    getPlaceholder, setPlaceholder

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

    getPrefixComponent, setPrefixComponent

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

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

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

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

    getSuffixComponent, setSuffixComponent

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

    addThemeVariants, removeThemeVariants

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

    getTooltip, setTooltipText

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

    getErrorMessage, isInvalid, setInvalid

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

    addValueChangeListener, clear, getOptionalValue, isEmpty

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

    isReadOnly, setReadOnly

    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

  • Constructor Details

    • 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)
      • HasPlaceholder.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:

    • 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:
      • TextFieldBase.setLabel(String)
      • AbstractField.setValue(Object)
      • AbstractField.addValueChangeListener(com.vaadin.flow.component.HasValue.ValueChangeListener)

  • Method Details

    • setErrorMessage

      public void setErrorMessage(String errorMessage)

      Distinct error messages for unparsable input and required constraint can be configured with the BigDecimalField.BigDecimalFieldI18n object, using the respective properties. However, note that the error message set with setErrorMessage(String) will take priority and override any i18n error messages if both are set.

      Specified by:
      setErrorMessage in interface com.vaadin.flow.component.HasValidation
      Specified by:
      setErrorMessage in interface HasValidationProperties

    • setRequiredIndicatorVisible

      public void setRequiredIndicatorVisible(boolean required)
      Description copied from class: TextFieldBase
      Sets whether the user is required to provide a value. When required, an indicator appears next to the label and the field invalidates if the value is cleared.

      NOTE: The required indicator is only visible when the field has a label, see TextFieldBase.setLabel(String).

      Specified by:
      setRequiredIndicatorVisible in interface com.vaadin.flow.component.HasValue<com.vaadin.flow.component.AbstractField.ComponentValueChangeEvent<BigDecimalField,BigDecimal>,BigDecimal>
      Specified by:
      setRequiredIndicatorVisible in interface com.vaadin.flow.component.HasValueAndElement<com.vaadin.flow.component.AbstractField.ComponentValueChangeEvent<BigDecimalField,BigDecimal>,BigDecimal>
      Overrides:
      setRequiredIndicatorVisible in class TextFieldBase<BigDecimalField,BigDecimal>
      Parameters:
      required - true to make the field required, false otherwise
      See Also:

    • 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

    • setModelValue

      protected void setModelValue(BigDecimal newModelValue, boolean fromClient)
      Overrides:
      setModelValue in class com.vaadin.flow.component.AbstractField<BigDecimalField,BigDecimal>

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

    • setManualValidation

      public void setManualValidation(boolean enabled)
      Specified by:
      setManualValidation in interface com.vaadin.flow.component.HasValidation

    • validate

      protected void validate()
      Validates the current value against the constraints and sets the invalid property and the errorMessage property based on the result. If a custom error message is provided with setErrorMessage(String), it is used. Otherwise, the error message defined in the i18n object is used.

      The method does nothing if the manual validation mode is enabled.

    • 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

    • getI18n

      public BigDecimalField.BigDecimalFieldI18n getI18n()
      Gets the internationalization object previously set for this component.

      NOTE: Updating the instance that is returned from this method will not update the component if not set again using setI18n(BigDecimalFieldI18n)

      Returns:
      the i18n object or null if no i18n object has been set

    • setI18n

      public void setI18n(BigDecimalField.BigDecimalFieldI18n i18n)
      Sets the internationalization object for this component.
      Parameters:
      i18n - the i18n object, not null