Package com.vaadin.flow.component.textfield

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

  • All Implemented Interfaces:
    com.vaadin.flow.component.AttachNotifier, com.vaadin.flow.component.BlurNotifier<C>, com.vaadin.flow.component.CompositionNotifier, com.vaadin.flow.component.DetachNotifier, com.vaadin.flow.component.Focusable<C>, com.vaadin.flow.component.FocusNotifier<C>, 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<C,​T>,​T>, com.vaadin.flow.component.HasValueAndElement<com.vaadin.flow.component.AbstractField.ComponentValueChangeEvent<C,​T>,​T>, com.vaadin.flow.component.InputNotifier, com.vaadin.flow.component.KeyNotifier, HasAllowedCharPattern, HasClearButton, HasThemeVariant<TextFieldVariant>, HasTooltip, HasAutocapitalize, HasAutocomplete, HasAutocorrect, HasPrefixAndSuffix, com.vaadin.flow.data.binder.HasValidator<T>, com.vaadin.flow.data.value.HasValueChangeMode, Serializable
    Direct Known Subclasses:
    IntegerField, NumberField
    public abstract class AbstractNumberField<C extends AbstractNumberField<C,​T>,​T extends Number>
extends GeneratedVaadinNumberField<C,​T>
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, HasClearButton, HasAllowedCharPattern, HasThemeVariant<TextFieldVariant>, HasTooltip, com.vaadin.flow.data.binder.HasValidator<T>
    Abstract base class for components based on vaadin-number-field element and its subclasses.
    Author:
    Vaadin Ltd.
    See Also:
    Serialized Form

    • Constructor Detail

      • AbstractNumberField

        public AbstractNumberField​(com.vaadin.flow.function.SerializableFunction<String,​T> parser,
                           com.vaadin.flow.function.SerializableFunction<T,​String> formatter,
                           double absoluteMin,
                           double absoluteMax,
                           boolean isInitialValueOptional)
        Sets up the common logic for number fields.

        If isInitialValueOptional is true then the initial value is used only if element has no "value" property value, otherwise element "value" property is ignored and the initial value is set.

        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
        isInitialValueOptional - if isInitialValueOptional is true then the initial value is used only if element has no "value" property value, otherwise element "value" property is ignored and the initial value is set

      • AbstractNumberField

        public AbstractNumberField​(com.vaadin.flow.function.SerializableFunction<String,​T> parser,
                           com.vaadin.flow.function.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

      • 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<C extends AbstractNumberField<C,​T>,​T extends Number>
        Parameters:
        errorMessage - the String value to set

      • 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

      • hasControls

        @Deprecated
public boolean hasControls()
        Deprecated.
        since 23.3. Use isStepButtonsVisible() instead.
        Gets whether the control buttons for increasing/decreasing the value are visible.
        Returns:
        true if buttons are visible, false otherwise
        See Also:
        setStep(double)

      • setStepButtonsVisible

        public void setStepButtonsVisible​(boolean stepButtonsVisible)
        Sets the visibility of the buttons for increasing/decreasing the value accordingly to the default or specified step.
        Parameters:
        stepButtonsVisible - true if control buttons should be visible; false if those should be hidden
        See Also:
        setStep(double)

      • isStepButtonsVisible

        public boolean isStepButtonsVisible()
        Gets whether the 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

      • getEmptyValue

        public T getEmptyValue()
        Returns the value that represents an empty value.
        Specified by:
        getEmptyValue in interface com.vaadin.flow.component.HasValue<C extends AbstractNumberField<C,​T>,​T extends Number>
        Overrides:
        getEmptyValue in class com.vaadin.flow.component.AbstractField<C extends AbstractNumberField<C,​T>,​T extends Number>

      • setValue

        public void setValue​(T value)
        Sets the value of this number field. If the new value is not equal to getValue(), fires a value change event.
        Specified by:
        setValue in interface com.vaadin.flow.component.HasValue<C extends AbstractNumberField<C,​T>,​T extends Number>
        Overrides:
        setValue in class com.vaadin.flow.component.AbstractField<C extends AbstractNumberField<C,​T>,​T extends Number>
        Parameters:
        value - the new value

      • getValue

        public T getValue()
        Returns the current value of the number field. By default, the empty number field will return null .
        Specified by:
        getValue in interface com.vaadin.flow.component.HasValue<C extends AbstractNumberField<C,​T>,​T extends Number>
        Overrides:
        getValue in class com.vaadin.flow.component.AbstractField<C extends AbstractNumberField<C,​T>,​T extends Number>
        Returns:
        the current value.

      • 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

      • 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<C extends AbstractNumberField<C,​T>,​T extends Number>
        Parameters:
        invalid - the boolean value to set

      • isInvalid

        public boolean isInvalid()
        Specified by:
        isInvalid in interface com.vaadin.flow.component.HasValidation

      • getDefaultValidator

        public com.vaadin.flow.data.binder.Validator<T> getDefaultValidator()
        Specified by:
        getDefaultValidator in interface com.vaadin.flow.data.binder.HasValidator<C extends AbstractNumberField<C,​T>>

      • 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)
        Specified by:
        setRequiredIndicatorVisible in interface com.vaadin.flow.component.HasValue<C extends AbstractNumberField<C,​T>,​T extends Number>
        Specified by:
        setRequiredIndicatorVisible in interface com.vaadin.flow.component.HasValueAndElement<C extends AbstractNumberField<C,​T>,​T extends Number>

      • onAttach

        protected void onAttach​(com.vaadin.flow.component.AttachEvent attachEvent)
        Overrides:
        onAttach in class com.vaadin.flow.component.Component

      • isFeatureFlagEnabled

        protected boolean isFeatureFlagEnabled​(com.vaadin.experimental.Feature feature)
        Returns true if the given feature flag is enabled, false otherwise.

        Exposed with protected visibility to support mocking

        The method requires the VaadinService instance to obtain the available feature flags, otherwise, the feature is considered disabled.

        Parameters:
        feature - the feature flag.
        Returns:
        whether the feature flag is enabled.