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:
AttachNotifier, BlurNotifier<BigDecimalField>, CompositionNotifier, DetachNotifier, Focusable<BigDecimalField>, FocusNotifier<BigDecimalField>, HasAriaLabel, HasElement, HasEnabled, HasHelper, HasLabel, HasPlaceholder, HasSize, HasStyle, HasTheme, HasValidation, HasValue<AbstractField.ComponentValueChangeEvent<BigDecimalField,BigDecimal>,BigDecimal>, HasValueAndElement<AbstractField.ComponentValueChangeEvent<BigDecimalField,BigDecimal>,BigDecimal>, InputNotifier, KeyNotifier, HasClearButton, HasClientValidation, HasPrefix, HasSuffix, HasThemeVariant<TextFieldVariant>, HasTooltip, HasValidationProperties, InputField<AbstractField.ComponentValueChangeEvent<BigDecimalField,BigDecimal>,BigDecimal>, HasAutocapitalize, HasAutocomplete, HasAutocorrect, HasPrefixAndSuffix, HasValidator<BigDecimal>, HasValueChangeMode, Serializable
@Tag("vaadin-big-decimal-field") @NpmPackage(value="@vaadin/polymer-legacy-adapter", version="24.3.11") @JsModule("@vaadin/polymer-legacy-adapter/style-modules.js") @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).

Author:
Vaadin Ltd.
See Also:

  • Constructor Details

  • Method Details

    • getEmptyValue

      public BigDecimal getEmptyValue()
      Description copied from interface: HasValue
      Returns the value that represents an empty value.

      By default HasValue is expected to support null as empty values. Specific implementations might not support this.

      Specified by:
      getEmptyValue in interface HasValue<AbstractField.ComponentValueChangeEvent<BigDecimalField,BigDecimal>,BigDecimal>
      Overrides:
      getEmptyValue in class AbstractField<BigDecimalField,BigDecimal>
      Returns:
      empty value

    • 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 HasValue<AbstractField.ComponentValueChangeEvent<BigDecimalField,BigDecimal>,BigDecimal>
      Overrides:
      setValue in class AbstractField<BigDecimalField,BigDecimal>
      Parameters:
      value - the new value

    • setModelValue

      protected void setModelValue(BigDecimal newModelValue, boolean fromClient)
      Description copied from class: AbstractField
      Updates the model value if the value has actually changed. Subclasses should call this method whenever the user has changed the value. A value change event is fired if the new value is different from the previous value according to AbstractField.valueEquals(Object, Object).

      If the value is from the client-side and this field is in readonly mode, then the new model value will be ignored. AbstractField.setPresentationValue(Object) will be called with the previous model value so that the representation shown to the user can be reverted.

      See AbstractField for an overall description on the difference between model values and presentation values.

      Overrides:
      setModelValue in class AbstractField<BigDecimalField,BigDecimal>
      Parameters:
      newModelValue - the new internal value to use
      fromClient - true if the new value originates from the client; otherwise false

    • getValue

      public BigDecimal getValue()
      Returns the current value of the field. By default, the empty BigDecimalField will return null.
      Specified by:
      getValue in interface HasValue<AbstractField.ComponentValueChangeEvent<BigDecimalField,BigDecimal>,BigDecimal>
      Overrides:
      getValue in class AbstractField<BigDecimalField,BigDecimal>
      Returns:
      the current value.

    • setManualValidation

      public void setManualValidation(boolean enabled)
      Description copied from interface: HasValidation
      Sets whether manual validation mode is enabled for the component.

      When enabled, the component doesn't perform its built-in constraint validation on value change, blur, and other events. This allows manually controlling the invalid state and error messages using the HasValidation.setInvalid(boolean) and HasValidation.setErrorMessage(String) methods. Manual mode is helpful when there is a need for a totally custom validation logic that cannot be achieved with Binder.

      Example: 

       Field field = new Field();
 field.setManualValidation(true);
 field.addValueChangeListener(event -> {
     if (Objects.equal(event.getValue(), "")) {
         field.setInvalid(true);
         field.setErrorMessage("The field is required.");
     } else {
         field.setInvalid(false);
     }
 });

      For components that don't have built-in validation, the method has no effect.

      Specified by:
      setManualValidation in interface HasValidation
      Parameters:
      enabled - whether to enable manual validation mode.

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

    • getDefaultValidator

      public Validator<BigDecimal> getDefaultValidator()
      Description copied from interface: HasValidator
      Returns a validator that checks the state of the Value. This should be overridden for components with internal value conversion or validation, e.g. when the user is providing a string that has to be parsed into a date. An invalid input from user will be exposed to a Binder and can be seen as a validation failure.
      Specified by:
      getDefaultValidator in interface HasValidator<BigDecimal>
      Returns:
      state validator

    • addValidationStatusChangeListener

      public Registration addValidationStatusChangeListener(ValidationStatusChangeListener<BigDecimal> listener)
      Description copied from interface: HasValidator
      Enables the implementing components to notify changes in their validation status to the observers.

      Note: This method can be overridden by the implementing classes e.g. components, to enable the associated Binder.Binding instance subscribing for their validation change events and revalidate itself.

      This method primarily designed for notifying the Binding about the validation status changes of a bound component at the client-side. WebComponents such as <vaadin-date-picker> or any other component that accept a formatted text as input should be able to communicate their invalid status to their server-side instance, and a bound server-side component instance must notify its binding about this validation status change as well. When the binding instance revalidates, a chain of validators and convertors get executed one of which is the default validator provided by HasValidator.getDefaultValidator(). Thus, In order for the binding to be able to show/clear errors for its associated bound field, it is important that implementing components take that validation status into account while implementing any validator and converter including HasValidator.getDefaultValidator(). Here is an example: 

       @Tag("date-picker-demo")
 public class DatePickerDemo implements HasValidator<LocalDate> {

     // Each web component has a way to communicate its validation status
     // to its server-side component instance. The following clientSideValid
     // state is introduced here just for the sake of simplicity of this code
     // snippet:
     boolean clientSideValid = true;

     /**
      * Note how clientSideValid engaged in the definition
      * of this method. It is important to reflect this status either
      * in the returning validation result of this method or any other
      * validation that is associated with this component.
      */
     @Override
     public Validator getDefaultValidator() {
          return (value, valueContext) -> clientSideValid ? ValidationResult.ok()
                 : ValidationResult.error("Invalid date format");
     }

     private final Collection<ValidationStatusChangeListener<LocalDate>>
         validationStatusListeners = new ArrayList<>();

     /**
      * This enables the binding to subscribe for the validation status
      * change events that are fired by this component and revalidate
      * itself respectively.
      */
     @Override
     public Registration addValidationStatusChangeListener(
             ValidationStatusChangeListener<LocalDate> listener) {
         validationStatusListeners.add(listener);
         return () -> validationStatusListeners.remove(listener);
     }

     private void fireValidationStatusChangeEvent(
             boolean newValidationStatus) {
         if (this.clientSideValid != newValidationStatus) {
             this.clientSideValid = newValidationStatus;
             var event = new ValidationStatusChangeEvent<>(this,
                     newValidationStatus);
             validationStatusListeners.forEach(
                     listener -> listener.validationStatusChanged(event));
         }
     }
 }
      Specified by:
      addValidationStatusChangeListener in interface HasValidator<BigDecimal>
      Returns:
      Registration of the added listener.
      See Also:

    • 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 Component
      Returns:
      the locale of this field, never null

    • onAttach

      protected void onAttach(AttachEvent attachEvent)
      Description copied from class: Component
      Called when the component is attached to a UI.

      The default implementation does nothing.

      This method is invoked before the AttachEvent is fired for the component.

      Overrides:
      onAttach in class Component
      Parameters:
      attachEvent - the attach event