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>, HasElement, HasEnabled, HasHelper, HasLabel, HasSize, HasStyle, HasTheme, HasValidation, HasValue<AbstractField.ComponentValueChangeEvent<IntegerField,, HasValueAndElement<AbstractField.ComponentValueChangeEvent<IntegerField,, InputNotifier, KeyNotifier, HasClearButton, HasClientValidation, HasPrefix, HasSuffix, HasThemeVariant<TextFieldVariant>, HasTooltip, HasValidationProperties, HasAutocapitalize, HasAutocomplete, HasAutocorrect, HasPrefixAndSuffix, HasValidator<Integer>, HasValueChangeMode, Serializable
@Tag("vaadin-integer-field")
@NpmPackage(value="@vaadin/polymer-legacy-adapter",version="24.0.2") @NpmPackage(value="@vaadin/integer-field",version="24.0.2")
@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.
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.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 TypeMethodDescriptionintgetMax()Gets the maximum allowed value of the field.
intgetMin()Gets the minimum allowed value of the field.
intgetStep()Gets the allowed number intervals of the field.
voidsetMax(int max) Sets the maximum value of the field.
voidsetMin(int min) Sets the minimum value of the field.
voidsetStep(int step) Sets the allowed number intervals of the field.
Methods inherited from class com.vaadin.flow.component.textfield.AbstractNumberField
addValidationStatusChangeListener, getDefaultValidator, getEmptyValue, getMaxDouble, getMinDouble, getStepDouble, getValue, isStepButtonsVisible, onAttach, setMax, setMin, setRequiredIndicatorVisible, setStep, setStepButtonsVisible, setValue, validateMethods inherited from class com.vaadin.flow.component.textfield.TextFieldBase
addToInput, addToPrefix, addToSuffix, getPlaceholder, getTitle, getValueChangeMode, getValueChangeTimeout, isAutofocus, isAutoselect, isRequired, setAutofocus, setAutoselect, setPlaceholder, setRequired, setTitle, setValueChangeMode, setValueChangeTimeoutMethods inherited from class com.vaadin.flow.component.AbstractSinglePropertyField
getSynchronizationRegistration, hasValidValue, setPresentationValue, setSynchronizedEventMethods inherited from class com.vaadin.flow.component.AbstractField
addValueChangeListener, isEmpty, setModelValue, 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.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, setErrorMessage, setInvalidMethods inherited from interface com.vaadin.flow.component.HasValue
clear, getOptionalValueMethods inherited from interface com.vaadin.flow.component.HasValueAndElement
isReadOnly, isRequiredIndicatorVisible, 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
-
setMin
public void setMin(int min) Sets the minimum value of the field. Entering a value which is smaller than
mininvalidates the field.Parameters:
min- the min value to set -
getMin
public int getMin()Gets the minimum allowed value of the field.
Returns:
the min property of the field
See Also:
-
setMax
public void setMax(int max) Sets the maximum value of the field. Entering a value which is greater than
maxinvalidates the field.Parameters:
max- the max value to set -
getMax
public int getMax()Gets the maximum allowed value of the field.
Returns:
the max property of the field
See Also:
-
setStep
public void setStep(int step) Sets the allowed number intervals of the 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 specified by user).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 of the field.
Returns:
the step property of the field
See Also:
-