com.vaadin.flow.component.textfield

Class TextField

java.lang.Object

com.vaadin.flow.component.Component

com.vaadin.flow.component.AbstractField<C,T>

com.vaadin.flow.component.AbstractSinglePropertyField<R,T>

com.vaadin.flow.component.textfield.GeneratedVaadinTextField<TextField,String>

com.vaadin.flow.component.textfield.TextField

All Implemented Interfaces:

com.vaadin.flow.component.AttachNotifier, com.vaadin.flow.component.BlurNotifier<TextField>, com.vaadin.flow.component.CompositionNotifier, com.vaadin.flow.component.DetachNotifier, com.vaadin.flow.component.Focusable<TextField>, com.vaadin.flow.component.FocusNotifier<TextField>, 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<TextField,String>,String>, com.vaadin.flow.component.HasValueAndElement<com.vaadin.flow.component.AbstractField.ComponentValueChangeEvent<TextField,String>,String>, com.vaadin.flow.component.InputNotifier, com.vaadin.flow.component.KeyNotifier, HasClientValidation, HasAutocapitalize, HasAutocomplete, HasAutocorrect, HasPrefixAndSuffix, com.vaadin.flow.data.binder.HasValidator<String>, com.vaadin.flow.data.value.HasValueChangeMode, Serializable

public class TextField
extends GeneratedVaadinTextField<TextField,String>
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, com.vaadin.flow.data.binder.HasValidator<String>, HasClientValidation

Server-side component for the vaadin-text-field element.

Author:

Vaadin Ltd

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.vaadin.flow.component.textfield.GeneratedVaadinTextField

GeneratedVaadinTextField.ChangeEvent<R extends GeneratedVaadinTextField<R,?>>, GeneratedVaadinTextField.InvalidChangeEvent<R extends GeneratedVaadinTextField<R,?>>

Nested classes/interfaces inherited from class com.vaadin.flow.component.AbstractField

com.vaadin.flow.component.AbstractField.ComponentValueChangeEvent<C extends com.vaadin.flow.component.Component,V>

Nested classes/interfaces inherited from interface com.vaadin.flow.component.shared.HasClientValidation

HasClientValidation.ClientValidatedEvent

Nested classes/interfaces inherited from interface com.vaadin.flow.component.BlurNotifier

com.vaadin.flow.component.BlurNotifier.BlurEvent<C extends com.vaadin.flow.component.Component>

Nested classes/interfaces inherited from interface com.vaadin.flow.component.FocusNotifier

com.vaadin.flow.component.FocusNotifier.FocusEvent<C extends com.vaadin.flow.component.Component>

Nested classes/interfaces inherited from interface com.vaadin.flow.component.HasValue

com.vaadin.flow.component.HasValue.ValueChangeEvent<V>, com.vaadin.flow.component.HasValue.ValueChangeListener<E extends com.vaadin.flow.component.HasValue.ValueChangeEvent<?>>

Field Summary

Fields inherited from interface com.vaadin.flow.data.value.HasValueChangeMode

DEFAULT_CHANGE_TIMEOUT

Fields inherited from interface com.vaadin.flow.component.textfield.HasAutocomplete

AUTOCOMPLETE_ATTRIBUTE

Fields inherited from interface com.vaadin.flow.component.textfield.HasAutocapitalize

AUTOCAPITALIZE_ATTRIBUTE

Fields inherited from interface com.vaadin.flow.component.textfield.HasAutocorrect

AUTOCORRECT_ATTRIBUTE

Constructor Summary

Constructors

Constructor and Description
TextField() Constructs an empty TextField.
TextField(com.vaadin.flow.component.HasValue.ValueChangeListener<? super com.vaadin.flow.component.AbstractField.ComponentValueChangeEvent<TextField,String>> listener) Constructs an empty TextField with a value change listener.
TextField(String label) Constructs an empty TextField with the given label.
TextField(String label, com.vaadin.flow.component.HasValue.ValueChangeListener<? super com.vaadin.flow.component.AbstractField.ComponentValueChangeEvent<TextField,String>> listener) Constructs an empty TextField with a label and a value change listener.
TextField(String label, String placeholder) Constructs an empty TextField with the given label and placeholder text.
TextField(String label, String initialValue, com.vaadin.flow.component.HasValue.ValueChangeListener<? super com.vaadin.flow.component.AbstractField.ComponentValueChangeEvent<TextField,String>> listener) Constructs an empty TextField with a label,a value change listener and an initial value.
TextField(String label, String initialValue, String placeholder) Constructs a TextField with the given label, an initial value and placeholder text.

Method Summary

Modifier and Type	Method and Description
com.vaadin.flow.shared.Registration	addValidationStatusChangeListener(com.vaadin.flow.data.binder.ValidationStatusChangeListener<String> listener)
com.vaadin.flow.data.binder.Validator<String>	getDefaultValidator()
String	getEmptyValue()
String	getErrorMessage()
String	getLabel() String used for the label element.
int	getMaxLength() Maximum number of characters (in Unicode code points) that the user can enter.
int	getMinLength() Minimum number of characters (in Unicode code points) that the user can enter.
String	getPattern() A regular expression that the value is checked against.
String	getPlaceholder() A hint to the user of what can be entered in the component.
String	getTitle() The text usually displayed in a tooltip popup when the mouse is over the field.
String	getValue() Returns the current value of the text field.
com.vaadin.flow.data.value.ValueChangeMode	getValueChangeMode()
int	getValueChangeTimeout()
boolean	isAutofocus() Specify that this control should have input focus when the page loads.
boolean	isAutoselect() Specifies if the field value gets automatically selected when the field gains focus.
boolean	isClearButtonVisible() Gets the visibility state of the button which clears the text field.
protected boolean	isEnforcedFieldValidationEnabled() Whether the full experience validation is enforced for the component.
boolean	isInvalid()
boolean	isPreventInvalidInput() When set to true, user is prevented from typing a value that conflicts with the given pattern.
boolean	isRequired() Specifies that the user must fill in a value.
protected void	onAttach(com.vaadin.flow.component.AttachEvent attachEvent)
void	setAutofocus(boolean autofocus) Description copied from corresponding location in WebComponent:
void	setAutoselect(boolean autoselect) Set to true to always have the field value automatically selected when the field gains focus, false otherwise.
void	setClearButtonVisible(boolean clearButtonVisible) Set to false to hide the clear button which clears the text field.
void	setErrorMessage(String errorMessage) Description copied from corresponding location in WebComponent:
void	setInvalid(boolean invalid) Description copied from corresponding location in WebComponent:
void	setLabel(String label) Sets the label for this component.
void	setMaxLength(int maxLength) Maximum number of characters (in Unicode code points) that the user can enter.
void	setMinLength(int minLength) Minimum number of characters (in Unicode code points) that the user can enter.
void	setPattern(String pattern) Description copied from corresponding location in WebComponent:
void	setPlaceholder(String placeholder) Description copied from corresponding location in WebComponent:
void	setPreventInvalidInput(boolean preventInvalidInput) Description copied from corresponding location in WebComponent:
void	setRequired(boolean required) Specifies that the user must fill in a value.
void	setRequiredIndicatorVisible(boolean requiredIndicatorVisible)
void	setTitle(String title) Description copied from corresponding location in WebComponent:
void	setValue(String value) Sets the value of this text field.
void	setValueChangeMode(com.vaadin.flow.data.value.ValueChangeMode valueChangeMode)
void	setValueChangeTimeout(int valueChangeTimeout)
protected void	validate() Performs server-side validation of the current value and the validation constraints of the field, such as setPattern(String).

Methods inherited from class com.vaadin.flow.component.textfield.GeneratedVaadinTextField

addChangeListener, addInvalidChangeListener, addThemeVariants, addToInput, addToPrefix, addToSuffix, checkValidity, getAutocapitalizeString, getAutocompleteString, getAutocorrectString, getErrorMessageString, getLabelString, getListString, getMaxlengthDouble, getMinlengthDouble, getNameString, getPatternString, getPlaceholderString, getTitleString, isAutofocusBoolean, isAutoselectBoolean, isClearButtonVisibleBoolean, isDisabledBoolean, isInvalidBoolean, isPreventInvalidInputBoolean, isReadonlyBoolean, isRequiredBoolean, remove, removeAll, removeThemeVariants, setAutocapitalize, setAutocomplete, setAutocorrect, setDisabled, setList, setMaxlength, setMinlength, setName, setReadonly

Methods inherited from class com.vaadin.flow.component.AbstractSinglePropertyField

getSynchronizationRegistration, hasValidValue, setPresentationValue, setSynchronizedEvent

Methods inherited from class com.vaadin.flow.component.AbstractField

addValueChangeListener, isEmpty, setModelValue, valueEquals

Methods inherited from class com.vaadin.flow.component.Component

addListener, fireEvent, from, get, getChildren, getElement, getEventBus, getId, getLocale, getParent, getTranslation, getTranslation, getTranslation, getTranslation, getUI, hasListener, isAttached, isTemplateMapped, isVisible, onDetach, onEnabledStateChanged, 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.HasSize

getCssSize, 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.textfield.HasPrefixAndSuffix

getPrefixComponent, getSuffixComponent, setPrefixComponent, setSuffixComponent

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

Methods inherited from interface com.vaadin.flow.component.CompositionNotifier

addCompositionEndListener, addCompositionStartListener, addCompositionUpdateListener

Methods inherited from interface com.vaadin.flow.component.textfield.HasAutocomplete

getAutocomplete, setAutocomplete

Methods inherited from interface com.vaadin.flow.component.textfield.HasAutocapitalize

getAutocapitalize, setAutocapitalize

Methods inherited from interface com.vaadin.flow.component.textfield.HasAutocorrect

isAutocorrect, setAutocorrect

Methods inherited from interface com.vaadin.flow.component.HasHelper

getHelperComponent, getHelperText, setHelperComponent, setHelperText

Methods inherited from interface com.vaadin.flow.component.HasElement

getElement

Methods inherited from interface com.vaadin.flow.component.shared.HasClientValidation

addClientValidatedEventListener

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

addFocusShortcut, blur, focus, getTabIndex, setTabIndex

Methods inherited from interface com.vaadin.flow.component.BlurNotifier

addBlurListener

Methods inherited from interface com.vaadin.flow.component.FocusNotifier

addFocusListener

Methods inherited from interface com.vaadin.flow.component.HasEnabled

isEnabled, setEnabled

Methods inherited from interface com.vaadin.flow.component.HasTheme

addThemeName, addThemeNames, getThemeName, getThemeNames, hasThemeName, removeThemeName, removeThemeNames, setThemeName, setThemeName

Methods inherited from interface com.vaadin.flow.component.HasValueAndElement

isReadOnly, isRequiredIndicatorVisible, setReadOnly

Methods inherited from interface com.vaadin.flow.component.HasValue

clear, getOptionalValue

Methods inherited from interface com.vaadin.flow.component.AttachNotifier

addAttachListener

Methods inherited from interface com.vaadin.flow.component.DetachNotifier

addDetachListener

Constructor Detail

TextField

public TextField()

Constructs an empty TextField.

TextField

public TextField(String label)

Constructs an empty TextField with the given label.

Parameters:

label - the text to set as the label

TextField

public TextField(String label,
                 String placeholder)

Constructs an empty TextField with the given label and placeholder text.

Parameters:

label - the text to set as the label

placeholder - the placeholder text to set

TextField

public TextField(String label,
                 String initialValue,
                 String placeholder)

Constructs a TextField with the given label, an initial value and placeholder text.

Parameters:

label - the text to set as the label

initialValue - the initial value

placeholder - the placeholder text to set

See Also:

AbstractField.setValue(Object), setPlaceholder(String)

TextField

public TextField(com.vaadin.flow.component.HasValue.ValueChangeListener<? super com.vaadin.flow.component.AbstractField.ComponentValueChangeEvent<TextField,String>> listener)

Constructs an empty TextField with a value change listener.

Parameters:

listener - the value change listener

See Also:

AbstractField.addValueChangeListener(com.vaadin.flow.component.HasValue.ValueChangeListener)

TextField

public TextField(String label,
                 com.vaadin.flow.component.HasValue.ValueChangeListener<? super com.vaadin.flow.component.AbstractField.ComponentValueChangeEvent<TextField,String>> listener)

Constructs an empty TextField with a label and a value change listener.

Parameters:

label - the text to set as the label

listener - the value change listener

See Also:

setLabel(String), AbstractField.addValueChangeListener(com.vaadin.flow.component.HasValue.ValueChangeListener)

TextField

public TextField(String label,
                 String initialValue,
                 com.vaadin.flow.component.HasValue.ValueChangeListener<? super com.vaadin.flow.component.AbstractField.ComponentValueChangeEvent<TextField,String>> listener)

Constructs an empty TextField with a label,a value change listener and an initial value.

Parameters:

label - the text to set as the label

initialValue - the initial value

listener - the value change listener

See Also:

setLabel(String), AbstractField.setValue(Object), AbstractField.addValueChangeListener(com.vaadin.flow.component.HasValue.ValueChangeListener)

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<TextField,String>

Parameters:

errorMessage - the String value to set

isInvalid

public boolean isInvalid()

Specified by:

isInvalid in interface com.vaadin.flow.component.HasValidation

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<TextField,String>

Parameters:

invalid - the boolean value to set

setLabel

public void setLabel(String label)

Sets the label for this component.

Specified by:

setLabel in interface com.vaadin.flow.component.HasLabel

Overrides:

setLabel in class GeneratedVaadinTextField<TextField,String>

Parameters:

label - value for the label property in the webcomponent

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

setPlaceholder

public void setPlaceholder(String placeholder)

Description copied from class: GeneratedVaadinTextField

Description copied from corresponding location in WebComponent:

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

Overrides:

setPlaceholder in class GeneratedVaadinTextField<TextField,String>

Parameters:

placeholder - the String value to set

getPlaceholder

public String getPlaceholder()

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

Returns:

the placeholder 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<TextField,String>

Parameters:

autoselect - true to set auto select on, false otherwise

isClearButtonVisible

public boolean isClearButtonVisible()

Gets the visibility state of the button which clears the text field.

Returns:

true if the button is visible, false otherwise

setClearButtonVisible

public void setClearButtonVisible(boolean clearButtonVisible)

Set to false to hide the clear button which clears the text field.

Overrides:

setClearButtonVisible in class GeneratedVaadinTextField<TextField,String>

Parameters:

clearButtonVisible - true to set the button visible, false otherwise

setAutofocus

public void setAutofocus(boolean autofocus)

Description copied from class: GeneratedVaadinTextField

Description copied from corresponding location in WebComponent:

Specify that this control should have input focus when the page loads.

Overrides:

setAutofocus in class GeneratedVaadinTextField<TextField,String>

Parameters:

autofocus - the boolean value to set

isAutofocus

public boolean isAutofocus()

Specify that this control should have input focus when the page loads.

Returns:

the autofocus property from the webcomponent

setMaxLength

public void setMaxLength(int maxLength)

Maximum number of characters (in Unicode code points) that the user can enter.

Parameters:

maxLength - the maximum length

getMaxLength

public int getMaxLength()

Maximum number of characters (in Unicode code points) that the user can enter.

Returns:

the maxlength property from the webcomponent

setMinLength

public void setMinLength(int minLength)

Minimum number of characters (in Unicode code points) that the user can enter.

Parameters:

minLength - the minimum length

getMinLength

public int getMinLength()

Minimum number of characters (in Unicode code points) that the user can enter.

Returns:

the minlength property from the webcomponent

isRequired

public boolean isRequired()

Specifies that the user must fill in a value.

Returns:

the required property from the webcomponent

setRequired

public void setRequired(boolean required)

Specifies that the user must fill in a value.

NOTE: The required indicator will not be visible, if there is no label property set for the textfield.

Overrides:

setRequired in class GeneratedVaadinTextField<TextField,String>

Parameters:

required - the boolean value to set

isPreventInvalidInput

public boolean isPreventInvalidInput()

When set to true, user is prevented from typing a value that conflicts with the given pattern.

Returns:

the preventInvalidInput property from the webcomponent

setPreventInvalidInput

public void setPreventInvalidInput(boolean preventInvalidInput)

Description copied from class: GeneratedVaadinTextField

Description copied from corresponding location in WebComponent:

When set to true, user is prevented from typing a value that conflicts with the given pattern, maxlength or minlength properties.

Overrides:

setPreventInvalidInput in class GeneratedVaadinTextField<TextField,String>

Parameters:

preventInvalidInput - the boolean value to set

setPattern

public void setPattern(String pattern)

Description copied from class: GeneratedVaadinTextField

Description copied from corresponding location in WebComponent:

A regular expression that the value is checked against. The pattern must match the entire value, not just some subset.

Overrides:

setPattern in class GeneratedVaadinTextField<TextField,String>

Parameters:

pattern - the String value to set

getPattern

public String getPattern()

A regular expression that the value is checked against. The pattern must match the entire value, not just some subset.

Returns:

the pattern 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

setTitle

public void setTitle(String title)

Description copied from class: GeneratedVaadinTextField

Description copied from corresponding location in WebComponent:

The text usually displayed in a tooltip popup when the mouse is over the field.

Overrides:

setTitle in class GeneratedVaadinTextField<TextField,String>

Parameters:

title - the String value to set

getEmptyValue

public String getEmptyValue()

Specified by:

getEmptyValue in interface com.vaadin.flow.component.HasValue<com.vaadin.flow.component.AbstractField.ComponentValueChangeEvent<TextField,String>,String>

Overrides:

getEmptyValue in class com.vaadin.flow.component.AbstractField<TextField,String>

setValue

public void setValue(String value)

Sets the value of this text field. If the new value is not equal to getValue(), fires a value change event. Throws NullPointerException, if the value is null.

Note: Binder will take care of the null conversion when integrates with text field, as long as no new converter is defined.

Specified by:

setValue in interface com.vaadin.flow.component.HasValue<com.vaadin.flow.component.AbstractField.ComponentValueChangeEvent<TextField,String>,String>

Overrides:

setValue in class com.vaadin.flow.component.AbstractField<TextField,String>

Parameters:

value - the new value, not null

getValue

public String getValue()

Returns the current value of the text field. By default, the empty text field will return an empty string.

Specified by:

getValue in interface com.vaadin.flow.component.HasValue<com.vaadin.flow.component.AbstractField.ComponentValueChangeEvent<TextField,String>,String>

Overrides:

getValue in class com.vaadin.flow.component.AbstractField<TextField,String>

Returns:

the current value.

setRequiredIndicatorVisible

public void setRequiredIndicatorVisible(boolean requiredIndicatorVisible)

Specified by:

setRequiredIndicatorVisible in interface com.vaadin.flow.component.HasValue<com.vaadin.flow.component.AbstractField.ComponentValueChangeEvent<TextField,String>,String>

Specified by:

setRequiredIndicatorVisible in interface com.vaadin.flow.component.HasValueAndElement<com.vaadin.flow.component.AbstractField.ComponentValueChangeEvent<TextField,String>,String>

getDefaultValidator

public com.vaadin.flow.data.binder.Validator<String> getDefaultValidator()

Specified by:

getDefaultValidator in interface com.vaadin.flow.data.binder.HasValidator<String>

addValidationStatusChangeListener

public com.vaadin.flow.shared.Registration addValidationStatusChangeListener(com.vaadin.flow.data.binder.ValidationStatusChangeListener<String> listener)

Specified by:

addValidationStatusChangeListener in interface com.vaadin.flow.data.binder.HasValidator<String>

validate

protected void validate()

Performs server-side validation of the current value and the validation constraints of the field, such as setPattern(String). This is needed because it is possible to circumvent the client-side validation constraints using browser development tools.

Overrides:

validate in class GeneratedVaadinTextField<TextField,String>

onAttach

protected void onAttach(com.vaadin.flow.component.AttachEvent attachEvent)

Overrides:

onAttach in class com.vaadin.flow.component.Component

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.