We use cookies to serve our customers and website visitors in the best possible way. Cookies are used for the proper functioning of the website and for improving the user experience, monitoring visitor traffic and marketing purposes. By continuing to browse the site, you agree to our use of cookies. You can read more about cookies here.
com.vaadin.flow.component.textfield.
Class IntegerField
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<C,T>
com.vaadin.flow.component.textfield.AbstractNumberField<IntegerField,Integer>
com.vaadin.flow.component.textfield.IntegerField
All Implemented Interfaces:
AttachNotifier, BlurNotifier<IntegerField>, CompositionNotifier, DetachNotifier, Focusable<IntegerField>, FocusNotifier<IntegerField>, HasAriaLabel, HasElement, HasEnabled, HasHelper, HasLabel, HasPlaceholder, HasSize, HasStyle, HasTheme, HasValidation, HasValue<AbstractField.ComponentValueChangeEvent<IntegerField,, HasValueAndElement<AbstractField.ComponentValueChangeEvent<IntegerField,, InputNotifier, KeyNotifier, HasClearButton, HasClientValidation, HasPrefix, HasSuffix, HasThemeVariant<TextFieldVariant>, HasTooltip, HasValidationProperties, InputField<AbstractField.ComponentValueChangeEvent<IntegerField,, HasAutocapitalize, HasAutocomplete, HasAutocorrect, HasPrefixAndSuffix, HasValidator<Integer>, HasValueChangeMode, Serializable
@Tag("vaadin-integer-field")
@NpmPackage(value="@vaadin/polymer-legacy-adapter",version="24.7.0-alpha7") @NpmPackage(value="@vaadin/integer-field",version="24.7.0-alpha7")
@JsModule("@vaadin/polymer-legacy-adapter/style-modules.js") @JsModule("@vaadin/integer-field/src/vaadin-integer-field.js")
public class IntegerField
extends AbstractNumberField<IntegerField,Integer>
implements HasThemeVariant<TextFieldVariant>
IntegerField is an extension of Text Field that only accepts integer numbers.
Validation
Integer Field comes with a built-in validation mechanism based on constraints. Validation is triggered whenever the user applies an input change, for example by pressing Enter or blurring the field. Programmatic value changes trigger validation as well. In eager and lazy value change modes, validation is also triggered on every character press with a delay according to the selected mode.
Validation verifies that the value is parsable into Integer and
satisfies the specified constraints. If validation fails, the component is
marked as invalid and an error message is displayed below the input.
The following constraints are supported:
Error messages for unparsable input and constraints can be configured with
the IntegerField.IntegerFieldI18n object, using the respective properties. If you
want to provide a single catch-all error message, you can also use the
setErrorMessage(String) method. Note that such an error message will
take priority over i18n error messages if both are set.
For more advanced validation that requires custom rules, you can use
Binder. By default, before running custom validators, Binder will
also check if the value is parsable and satisfies the component constraints,
displaying error messages from the IntegerField.IntegerFieldI18n object. The
exception is the required constraint, for which Binder provides its own API,
see asRequired().
However, if Binder doesn't fit your needs and you want to implement fully
custom validation logic, you can disable the constraint validation by setting
AbstractNumberField.setManualValidation(boolean) to true. This will allow you to control
the invalid state and the error message manually using
HasValidationProperties.setInvalid(boolean) and setErrorMessage(String) API.
Author:
Vaadin Ltd.
See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic classThe internationalization properties for
IntegerField.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.ClientValidatedEventNested 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_ATTRIBUTEFields inherited from interface com.vaadin.flow.component.textfield.HasAutocomplete
AUTOCOMPLETE_ATTRIBUTEFields inherited from interface com.vaadin.flow.component.textfield.HasAutocorrect
AUTOCORRECT_ATTRIBUTEFields inherited from interface com.vaadin.flow.data.value.HasValueChangeMode
DEFAULT_CHANGE_TIMEOUT -
Constructor Summary
ConstructorsConstructorDescriptionConstructs an empty
IntegerField.IntegerField(HasValue.ValueChangeListener<? super AbstractField.ComponentValueChangeEvent<IntegerField, Integer>> listener) Constructs an empty
IntegerFieldwith a value change listener.IntegerField(String label) Constructs an empty
IntegerFieldwith the given label.IntegerField(String label, HasValue.ValueChangeListener<? super AbstractField.ComponentValueChangeEvent<IntegerField, Integer>> listener) Constructs an empty
IntegerFieldwith a value change listener and a label.IntegerField(String label, Integer initialValue, HasValue.ValueChangeListener<? super AbstractField.ComponentValueChangeEvent<IntegerField, Integer>> listener) Constructs a
IntegerFieldwith a value change listener, a label and an initial value.IntegerField(String label, String placeholder) Constructs an empty
IntegerFieldwith the given label and placeholder text. -
Method Summary
Modifier and TypeMethodDescriptiongetI18n()Gets the internationalization object previously set for this component.
intgetMax()Gets the maximum value for the field.
intgetMin()Gets the minimum value for this field.
intgetStep()Gets the allowed number intervals for this field.
voidsetErrorMessage(String errorMessage) Sets a single error message to display for all constraint violations.
voidSets the internationalization object for this component.
voidsetMax(int max) Sets the maximum value for the field.
voidsetMin(int min) Sets the minimum value for the field.
voidsetRequiredIndicatorVisible(boolean required) Sets whether the user is required to provide a value.
voidsetStep(int step) Sets the allowed number intervals for this field.
Methods inherited from class com.vaadin.flow.component.textfield.AbstractNumberField
addValidationStatusChangeListener, getDefaultValidator, getEmptyValue, getMaxDouble, getMinDouble, getStepDouble, getValue, isStepButtonsVisible, onAttach, setI18n, setManualValidation, setMax, setMin, setModelValue, setStep, setStepButtonsVisible, setValue, setValueChangeMode, validateMethods 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, setTitle, setValueChangeTimeoutMethods inherited from class com.vaadin.flow.component.AbstractSinglePropertyField
getSynchronizationRegistration, hasValidValue, setPresentationValue, setSynchronizedEventMethods inherited from class com.vaadin.flow.component.AbstractField
addValueChangeListener, isEmpty, valueEqualsMethods 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, setVisibleMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface com.vaadin.flow.component.AttachNotifier
addAttachListenerMethods inherited from interface com.vaadin.flow.component.BlurNotifier
addBlurListenerMethods inherited from interface com.vaadin.flow.component.CompositionNotifier
addCompositionEndListener, addCompositionStartListener, addCompositionUpdateListenerMethods inherited from interface com.vaadin.flow.component.DetachNotifier
addDetachListenerMethods inherited from interface com.vaadin.flow.component.Focusable
addFocusShortcut, blur, focus, getTabIndex, setTabIndexMethods inherited from interface com.vaadin.flow.component.FocusNotifier
addFocusListenerMethods inherited from interface com.vaadin.flow.component.textfield.HasAutocapitalize
getAutocapitalize, setAutocapitalizeMethods inherited from interface com.vaadin.flow.component.textfield.HasAutocomplete
getAutocomplete, setAutocompleteMethods inherited from interface com.vaadin.flow.component.textfield.HasAutocorrect
isAutocorrect, setAutocorrectMethods inherited from interface com.vaadin.flow.component.shared.HasClearButton
isClearButtonVisible, setClearButtonVisibleMethods inherited from interface com.vaadin.flow.component.shared.HasClientValidation
addClientValidatedEventListenerMethods inherited from interface com.vaadin.flow.component.HasElement
getElementMethods inherited from interface com.vaadin.flow.component.HasEnabled
isEnabled, setEnabledMethods inherited from interface com.vaadin.flow.component.HasHelper
getHelperComponent, getHelperText, setHelperComponent, setHelperTextMethods inherited from interface com.vaadin.flow.component.HasPlaceholder
getPlaceholder, setPlaceholderMethods inherited from interface com.vaadin.flow.component.shared.HasPrefix
getPrefixComponent, setPrefixComponentMethods 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, setWidthFullMethods inherited from interface com.vaadin.flow.component.HasStyle
addClassName, addClassNames, getClassName, getClassNames, getStyle, hasClassName, removeClassName, removeClassNames, setClassName, setClassNameMethods inherited from interface com.vaadin.flow.component.shared.HasSuffix
getSuffixComponent, setSuffixComponentMethods inherited from interface com.vaadin.flow.component.HasTheme
addThemeName, addThemeNames, getThemeName, getThemeNames, hasThemeName, removeThemeName, removeThemeNames, setThemeName, setThemeNameMethods inherited from interface com.vaadin.flow.component.shared.HasThemeVariant
addThemeVariants, removeThemeVariantsMethods inherited from interface com.vaadin.flow.component.shared.HasTooltip
getTooltip, setTooltipTextMethods inherited from interface com.vaadin.flow.component.shared.HasValidationProperties
getErrorMessage, isInvalid, setInvalidMethods inherited from interface com.vaadin.flow.component.HasValue
addValueChangeListener, clear, getOptionalValue, isEmptyMethods inherited from interface com.vaadin.flow.component.HasValueAndElement
isReadOnly, setReadOnlyMethods inherited from interface com.vaadin.flow.component.InputNotifier
addInputListenerMethods inherited from interface com.vaadin.flow.component.KeyNotifier
addKeyDownListener, addKeyDownListener, addKeyPressListener, addKeyPressListener, addKeyUpListener, addKeyUpListener
-
Constructor Details
-
IntegerField
public IntegerField()Constructs an empty
IntegerField. -
IntegerField
Constructs an empty
IntegerFieldwith the given label.Parameters:
label- the text to set as the label -
IntegerField
Constructs an empty
IntegerFieldwith the given label and placeholder text.Parameters:
label- the text to set as the labelplaceholder- the placeholder text to set -
IntegerField
public IntegerField(HasValue.ValueChangeListener<? super AbstractField.ComponentValueChangeEvent<IntegerField, Integer>> listener) Constructs an empty
IntegerFieldwith a value change listener.Parameters:
listener- the value change listenerSee Also:
-
IntegerField
public IntegerField(String label, HasValue.ValueChangeListener<? super AbstractField.ComponentValueChangeEvent<IntegerField, Integer>> listener) Constructs an empty
IntegerFieldwith a value change listener and a label.Parameters:
label- the text to set as the labellistener- the value change listenerSee Also:
-
IntegerField
public IntegerField(String label, Integer initialValue, HasValue.ValueChangeListener<? super AbstractField.ComponentValueChangeEvent<IntegerField, Integer>> listener) Constructs a
IntegerFieldwith a value change listener, a label and an initial value.Parameters:
label- the text to set as the labelinitialValue- the initial valuelistener- the value change listenerSee Also:
-
-
Method Details
-
setErrorMessage
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 different constraints can be configured with the
IntegerField.IntegerFieldI18nobject, using the respective properties. However, note that the error message set withsetErrorMessage(String)will take priority and override any i18n error messages if both are set.Specified by:
setErrorMessagein interfaceHasValidationSpecified by:
setErrorMessagein interfaceHasValidationPropertiesParameters:
errorMessage- the error message to set, ornullto clear -
setRequiredIndicatorVisible
public void setRequiredIndicatorVisible(boolean required) Description copied from class:
TextFieldBaseSets 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:
setRequiredIndicatorVisiblein interfaceHasValue<AbstractField.ComponentValueChangeEvent<IntegerField,Integer>, Integer> Specified by:
setRequiredIndicatorVisiblein interfaceHasValueAndElement<AbstractField.ComponentValueChangeEvent<IntegerField,Integer>, Integer> Overrides:
setRequiredIndicatorVisiblein classTextFieldBase<IntegerField,Integer> Parameters:
required-trueto make the field required,falseotherwiseSee Also:
-
setMin
public void setMin(int min) Sets the minimum value for the field. This will configure the field to invalidate if the entered value is below the minimum. It will also limit the decrementing of the value when step buttons are enabled.
The minimum value is inclusive.
Parameters:
min- the minimum integer value to setSee Also:
-
getMin
public int getMin()Gets the minimum value for this field. The constraint activates only if the value was explicitly set with
setMin(int).Returns:
the minimum integer value
See Also:
-
setMax
public void setMax(int max) Sets the maximum value for the field. This will configure the field to invalidate if the entered value is above the maximum. It will also limit the incrementing of the value when step buttons are enabled.
The maximum value is inclusive.
Parameters:
max- the maximum integer value to setSee Also:
-
getMax
public int getMax()Gets the maximum value for the field. The constraint activates only if the value was explicitly set with
setMax(int).Returns:
the maximum integer value
See Also:
-
setStep
public void setStep(int step) Sets the allowed number intervals for this field. This specifies how much the value will be increased/decreased when clicking on the
step buttons. It is also used to invalidate the field, if the value doesn't align with the specified step andmin(if explicitly specified by developer).Parameters:
step- the new step to setThrows:
IllegalArgumentException- if the argument is less or equal to zero. -
getStep
public int getStep()Gets the allowed number intervals for this field. The constraint activates only if the step was explicitly set with
setStep(int).Returns:
the step property of the field
See Also:
-
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(IntegerFieldI18n)Overrides:
getI18nin classAbstractNumberField<IntegerField,Integer> Returns:
the i18n object or
nullif no i18n object has been set -
setI18n
Sets the internationalization object for this component.
Parameters:
i18n- the i18n object, notnull
-