Method Details

• setErrorMessage

  public void setErrorMessage(String errorMessage)

  Sets a single error message to display for all constraint violations. The error message will only appear when the component is flagged as invalid, either as a result of constraint validation or by the developer through HasValidationProperties.setInvalid(boolean) if manual validation mode is enabled.

  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 HasValidation

  Specified by:

  setErrorMessage in interface HasValidationProperties

  Parameters:

  errorMessage - the error message to set, or null to clear

• 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 HasValue<AbstractField.ComponentValueChangeEvent<BigDecimalField,BigDecimal>,BigDecimal>

  Specified by:

  setRequiredIndicatorVisible in interface HasValueAndElement<AbstractField.ComponentValueChangeEvent<BigDecimalField,BigDecimal>,BigDecimal>

  Overrides:

  setRequiredIndicatorVisible in class TextFieldBase<BigDecimalField,BigDecimal>

  Parameters:

  required - true to make the field required, false otherwise

  See Also:

  • BigDecimalField.BigDecimalFieldI18n.setRequiredErrorMessage(String)

• 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()

  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 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:

  • Binder.BindingBuilderImpl.bind(ValueProvider, Setter)

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

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

  Make sure to call super.onAttach when overriding this method.

  Overrides:

  onAttach in class Component

  Parameters:

  attachEvent - the attach event

• 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