com.vaadin.flow.component.textfield.

Class AbstractNumberField<C extends AbstractNumberField<C,T>,T extends Number>

    • Constructor Detail

      • AbstractNumberField

        public AbstractNumberField(SerializableFunction<String,T> parser,
                           SerializableFunction<T,String> formatter,
                           double absoluteMin,
                           double absoluteMax)

        Sets up the common logic for number fields.

        Parameters:

        parser - function to parse the client-side value string into server-side value

        formatter - function to format the server-side value into client-side value string

        absoluteMin - the smallest possible value of the number type of the field, will be used as the default min value at server-side

        absoluteMax - the largest possible value of the number type of the field, will be used as the default max value at server-side

    • Method Detail

      • setValueChangeMode

        public void setValueChangeMode(ValueChangeMode valueChangeMode)

        Description copied from interface: HasValueChangeMode

        Sets new value change mode for the component.

        Specified by:

        setValueChangeMode in interface HasValueChangeMode

        Parameters:

        valueChangeMode - new value change mode, or null to disable the value synchronization

      • getErrorMessage

        public String getErrorMessage()

        Description copied from interface: HasValidation

        Gets current error message from the component.

        Specified by:

        getErrorMessage in interface HasValidation

        Returns:

        current error message

      • getLabel

        public String getLabel()

        String used for the label element.

        Specified by:

        getLabel in interface HasLabel

        Returns:

        the label property from the webcomponent

      • setHasControls

        public void setHasControls(boolean hasControls)

        Sets the visibility of the control buttons for increasing/decreasing the value accordingly to the default or specified step.

        Overrides:

        setHasControls in class GeneratedVaadinNumberField<C extends AbstractNumberField<C,T>,T extends Number>

        Parameters:

        hasControls - true if control buttons should be visible; false if those should be hidden

        See Also:

        setStep(double)

      • hasControls

        public boolean hasControls()

        Gets whether the control buttons for increasing/decreasing the value are visible.

        Returns:

        true if buttons are visible, false otherwise

        See Also:

        setStep(double)

      • getPlaceholder

        public String getPlaceholder()

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

        Returns:

        the placeholder property from the webcomponent

      • 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

      • 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<C extends AbstractNumberField<C,T>,T extends Number>

        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

      • getMinDouble

        protected double getMinDouble()

        Description copied from class: GeneratedVaadinNumberField

        Description copied from corresponding location in WebComponent:

        The minimum value of the field.

        This property is not synchronized automatically from the client side, so the returned value may not be the same as in client side.

        Overrides:

        getMinDouble in class GeneratedVaadinNumberField<C extends AbstractNumberField<C,T>,T extends Number>

        Returns:

        the min property from the webcomponent

      • getMaxDouble

        protected double getMaxDouble()

        Description copied from class: GeneratedVaadinNumberField

        Description copied from corresponding location in WebComponent:

        The maximum value of the field.

        This property is not synchronized automatically from the client side, so the returned value may not be the same as in client side.

        Overrides:

        getMaxDouble in class GeneratedVaadinNumberField<C extends AbstractNumberField<C,T>,T extends Number>

        Returns:

        the max property from the webcomponent

      • getStepDouble

        protected double getStepDouble()

        Description copied from class: GeneratedVaadinNumberField

        Description copied from corresponding location in WebComponent:

        Specifies the allowed number intervals of the field.

        This property is not synchronized automatically from the client side, so the returned value may not be the same as in client side.

        Overrides:

        getStepDouble in class GeneratedVaadinNumberField<C extends AbstractNumberField<C,T>,T extends Number>

        Returns:

        the step property from the webcomponent

      • isInvalid

        public boolean isInvalid()

        Description copied from interface: HasValidation

        Returns true if component input is invalid, false otherwise.

        Specified by:

        isInvalid in interface HasValidation

        Returns:

        whether the component input is valid

      • getDefaultValidator

        public Validator<T> 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<T extends Number>

        Returns:

        state validator

      • addValidationStatusChangeListener

        public Registration addValidationStatusChangeListener(ValidationStatusChangeListener<T> 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<T extends Number>

        Returns:

        Registration of the added listener.

        See Also:

        Binder.BindingBuilderImpl.bind(ValueProvider, Setter)

      • 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<C extends AbstractNumberField<C,T>,T extends Number>

      • setRequiredIndicatorVisible

        public void setRequiredIndicatorVisible(boolean requiredIndicatorVisible)

        Description copied from interface: HasValue

        Sets the required indicator visible or not.

        If set visible, it is visually indicated in the user interface.

        The method is intended to be used with Binder which does server-side validation. In case HTML element has its own (client-side) validation it should be disabled when setRequiredIndicatorVisible(true) is called and re-enabled back on setRequiredIndicatorVisible(false). It's responsibility of each component implementation to follow the contract so that the method call doesn't do anything else than show/hide the "required" indication. Usually components provide their own setRequired method which should be called in case the client-side validation is required.

        Specified by:

        setRequiredIndicatorVisible in interface HasValue<AbstractField.ComponentValueChangeEvent<C extends AbstractNumberField<C,T>,T extends Number>,T extends Number>

        Specified by:

        setRequiredIndicatorVisible in interface HasValueAndElement<AbstractField.ComponentValueChangeEvent<C extends AbstractNumberField<C,T>,T extends Number>,T extends Number>

        Parameters:

        requiredIndicatorVisible - true to make the required indicator visible, false if not

      • 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

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