Class AbstractNumberField<C extends AbstractNumberField<C,T>,T extends Number>
- All Implemented Interfaces:
AttachNotifier
,BlurNotifier<C>
,CompositionNotifier
,DetachNotifier
,Focusable<C>
,FocusNotifier<C>
,HasAriaLabel
,HasElement
,HasEnabled
,HasHelper
,HasLabel
,HasPlaceholder
,HasSize
,HasStyle
,HasValidation
,HasValue<AbstractField.ComponentValueChangeEvent<C,
,T>, T> HasValueAndElement<AbstractField.ComponentValueChangeEvent<C,
,T>, T> InputNotifier
,KeyNotifier
,HasClearButton
,HasClientValidation
,HasPrefix
,HasSuffix
,HasTooltip
,HasValidationProperties
,InputField<AbstractField.ComponentValueChangeEvent<C,
,T>, T> HasAutocapitalize
,HasAutocomplete
,HasAutocorrect
,HasPrefixAndSuffix
,HasValidator<T>
,HasValueChangeMode
,Serializable
- Direct Known Subclasses:
IntegerField
,NumberField
vaadin-number-field
element and its subclasses.- Author:
- Vaadin Ltd.
- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from class com.vaadin.flow.component.AbstractField
AbstractField.ComponentValueChangeEvent<C extends Component,
V> Nested classes/interfaces inherited from interface com.vaadin.flow.component.BlurNotifier
BlurNotifier.BlurEvent<C extends Component>
Nested classes/interfaces inherited from interface com.vaadin.flow.component.FocusNotifier
FocusNotifier.FocusEvent<C extends Component>
Nested classes/interfaces inherited from interface com.vaadin.flow.component.shared.HasClientValidation
HasClientValidation.ClientValidatedEvent
Nested classes/interfaces inherited from interface com.vaadin.flow.component.HasValue
HasValue.ValueChangeEvent<V>, HasValue.ValueChangeListener<E extends 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
ConstructorsConstructorDescriptionAbstractNumberField
(SerializableFunction<String, T> parser, SerializableFunction<T, String> formatter, double absoluteMin, double absoluteMax) Sets up the common logic for number fields. -
Method Summary
Modifier and TypeMethodDescriptionEnables the implementing components to notify changes in their validation status to the observers.Returns a validator that checks the state of the Value.Returns the value that represents an empty value.protected AbstractNumberFieldI18n
getI18n()
Gets the internationalization object previously set for this component.protected double
Gets the maximum value for this field.protected double
Gets the minimum value for this field.protected double
Gets the allowed number intervals for this field.getValue()
Returns the current value of the number field.boolean
Gets whether the buttons for increasing/decreasing the value are visible.protected void
onAttach
(AttachEvent attachEvent) Called when the component is attached to a UI.protected void
Sets the internationalization object for this component.void
setManualValidation
(boolean enabled) Sets whether manual validation mode is enabled for the component.protected void
setMax
(double max) Sets the maximum value for this field.protected void
setMin
(double min) Sets the minimum value for this field.protected void
setModelValue
(T newModelValue, boolean fromClient) Updates the model value if the value has actually changed.protected void
setStep
(double step) Sets the allowed number intervals for this field.void
setStepButtonsVisible
(boolean stepButtonsVisible) Sets the visibility of the buttons for increasing/decreasing the value accordingly to the default or specified step.void
Sets the value of this number field.void
setValueChangeMode
(ValueChangeMode valueChangeMode) Sets new value change mode for the component.protected void
validate()
Validates the current value against the constraints and sets theinvalid
property and theerrorMessage
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, setRequiredIndicatorVisible, setTitle, 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, getLocale, getParent, getTranslation, getTranslation, getTranslation, getTranslation, getTranslation, getTranslation, getUI, hasListener, isAttached, isTemplateMapped, isVisible, 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.shared.HasClientValidation
addClientValidatedEventListener
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.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.shared.HasTooltip
getTooltip, setTooltipText
Methods inherited from interface com.vaadin.flow.component.shared.HasValidationProperties
getErrorMessage, isInvalid, setErrorMessage, 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
-
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 valueformatter
- function to format the server-side value into client-side value stringabsoluteMin
- the smallest possible value of the number type of the field, will be used as the default min value at server-sideabsoluteMax
- the largest possible value of the number type of the field, will be used as the default max value at server-side
-
-
Method Details
-
setValueChangeMode
Description copied from interface:HasValueChangeMode
Sets new value change mode for the component.- Specified by:
setValueChangeMode
in interfaceHasValueChangeMode
- Overrides:
setValueChangeMode
in classTextFieldBase<C extends AbstractNumberField<C,
T>, T extends Number> - Parameters:
valueChangeMode
- new value change mode, ornull
to disable the value synchronization
-
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:
-
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:
-
getEmptyValue
Returns the value that represents an empty value.- Specified by:
getEmptyValue
in interfaceHasValue<C extends AbstractNumberField<C,
T>, T extends Number> - Overrides:
getEmptyValue
in classAbstractField<C extends AbstractNumberField<C,
T>, T extends Number> - Returns:
- empty value
-
setValue
Sets the value of this number field. If the new value is not equal togetValue()
, fires a value change event. -
setModelValue
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 toAbstractField.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 classAbstractField<C extends AbstractNumberField<C,
T>, T extends Number> - Parameters:
newModelValue
- the new internal value to usefromClient
-true
if the new value originates from the client; otherwisefalse
-
getValue
Returns the current value of the number field. By default, the empty number field will returnnull
. -
setMin
protected void setMin(double min) Sets the minimum value for this field.- Parameters:
min
- the double value to set
-
getMinDouble
protected double getMinDouble()Gets the minimum value for this field. -
setMax
protected void setMax(double max) Sets the maximum value for this field.- Parameters:
max
- the double value to set
-
getMaxDouble
protected double getMaxDouble()Gets the maximum value for this field. -
setStep
protected void setStep(double step) Sets the allowed number intervals for this field.- Parameters:
step
- the double value to set
-
getStepDouble
protected double getStepDouble()Gets the allowed number intervals for this field. -
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 aBinder
and can be seen as a validation failure.- Returns:
- state validator
-
addValidationStatusChangeListener
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 byHasValidator.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 includingHasValidator.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)); } } }- Returns:
- Registration of the added listener.
- See Also:
-
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)
andHasValidation.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.
- Parameters:
enabled
- whether to enable manual validation mode.
-
validate
protected void validate()Validates the current value against the constraints and sets theinvalid
property and theerrorMessage
property based on the result. If a custom error message is provided withHasValidationProperties.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.
-
onAttach
Description copied from class:Component
Called when the component is attached to a UI.This method is invoked before the
Make sure to callAttachEvent
is fired for the component.super.onAttach
when overriding this method. -
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(AbstractNumberFieldI18n)
- Returns:
- the i18n object or
null
if no i18n object has been set
-
setI18n
Sets the internationalization object for this component.- Parameters:
i18n
- the i18n object, notnull
-