Package 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<TComponent,TValue>

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

com.vaadin.flow.component.textfield.TextField

All Implemented Interfaces:

AttachNotifier, BlurNotifier<TextField>, CompositionNotifier, DetachNotifier, Focusable<TextField>, FocusNotifier<TextField>, HasAriaLabel, HasElement, HasEnabled, HasHelper, HasLabel, HasPlaceholder, HasSize, HasStyle, HasTheme, HasValidation, HasValue<AbstractField.ComponentValueChangeEvent<TextField,String>,String>, HasValueAndElement<AbstractField.ComponentValueChangeEvent<TextField,String>,String>, InputNotifier, KeyNotifier, HasAllowedCharPattern, HasClearButton, HasClientValidation, HasPrefix, HasSuffix, HasThemeVariant<TextFieldVariant>, HasTooltip, HasValidationProperties, InputField<AbstractField.ComponentValueChangeEvent<TextField,String>,String>, HasAutocapitalize, HasAutocomplete, HasAutocorrect, HasPrefixAndSuffix, HasValidator<String>, HasValueChangeMode, Serializable

@Tag("vaadin-text-field")
@NpmPackage(value="@vaadin/polymer-legacy-adapter",version="24.4.0") @NpmPackage(value="@vaadin/text-field",version="24.4.0")
@JsModule("@vaadin/polymer-legacy-adapter/style-modules.js") @JsModule("@vaadin/text-field/src/vaadin-text-field.js")
public class TextField
extends TextFieldBase<TextField,String>
implements HasAllowedCharPattern, HasThemeVariant<TextFieldVariant>

Text Field allows the user to input and edit text. Prefix and suffix components, such as icons, are also supported.

Author:

Vaadin Ltd

See Also:

• Serialized Form

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

Constructors

Constructor	Description
TextField()	Constructs an empty TextField.
TextField(HasValue.ValueChangeListener<? super 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, HasValue.ValueChangeListener<? super 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, HasValue.ValueChangeListener<? super 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	Description
Validator<String>	getDefaultValidator()	Returns a validator that checks the state of the Value.
String	getEmptyValue()	Returns the value that represents an empty value.
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	getValue()	Returns the current value of the text field.
protected void	onAttach(AttachEvent attachEvent)	Called when the component is attached to a UI.
void	setManualValidation(boolean enabled)	Sets whether manual validation mode is enabled for the 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)	Sets a regular expression for the value to pass on the client-side.
void	setRequired(boolean required)	Specifies that the user must fill in a value.
void	setRequiredIndicatorVisible(boolean requiredIndicatorVisible)	Sets the required indicator visible or not.
void	setValue(String value)	Sets the value of this text field.
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.TextFieldBase

addToInput, addToPrefix, addToSuffix, getAriaLabel, getAriaLabelledBy, getTitle, getValueChangeMode, getValueChangeTimeout, isAutofocus, isAutoselect, isRequired, setAriaLabel, setAriaLabelledBy, setAutofocus, setAutoselect, setLabel, setTitle, setValueChangeMode, 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, setModelValue, 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.shared.HasAllowedCharPattern

getAllowedCharPattern, setAllowedCharPattern

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

getLabel

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

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

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

addThemeVariants, removeThemeVariants

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.data.binder.HasValidator

addValidationStatusChangeListener

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

addValueChangeListener, clear, getOptionalValue, isEmpty

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

isReadOnly, isRequiredIndicatorVisible, 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

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)
• HasPlaceholder.setPlaceholder(String)

TextField

public TextField(HasValue.ValueChangeListener<? super 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,
 HasValue.ValueChangeListener<? super 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:

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

TextField

public TextField(String label,
 String initialValue,
 HasValue.ValueChangeListener<? super 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:

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

Method Details

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

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

Parameters:

required - the boolean value to set

setPattern

public void setPattern(String pattern)

Sets a regular expression for the value to pass on the client-side. The pattern must be a valid JavaScript Regular Expression that matches the entire value, not just some subset.

Parameters:

pattern - the new String pattern

See Also:

• https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#htmlattrdefpattern
• https://html.spec.whatwg.org/multipage/input.html#attr-input-pattern

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

getEmptyValue

public String getEmptyValue()

Description copied from interface: HasValue

Returns the value that represents an empty value.

By default HasValue is expected to support null as empty values. Specific implementations might not support this.

Specified by:

getEmptyValue in interface HasValue<AbstractField.ComponentValueChangeEvent<TextField,String>,String>

Overrides:

getEmptyValue in class AbstractField<TextField,String>

Returns:

empty value

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 HasValue<AbstractField.ComponentValueChangeEvent<TextField,String>,String>

Overrides:

setValue in class 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 HasValue<AbstractField.ComponentValueChangeEvent<TextField,String>,String>

Overrides:

getValue in class AbstractField<TextField,String>

Returns:

the current value.

setRequiredIndicatorVisible

public void setRequiredIndicatorVisible(boolean requiredIndicatorVisible)

Description copied from interface: HasValue

Sets the required indicator visible or not.

If set visible, it is visually indicated in the user interface.

The method is intended to be used with Binder which does server-side validation. In case HTML element has its own (client-side) validation it should be disabled when setRequiredIndicatorVisible(true) is called and re-enabled back on setRequiredIndicatorVisible(false). It's responsibility of each component implementation to follow the contract so that the method call doesn't do anything else than show/hide the "required" indication. Usually components provide their own setRequired method which should be called in case the client-side validation is required.

Specified by:

setRequiredIndicatorVisible in interface HasValue<AbstractField.ComponentValueChangeEvent<TextField,String>,String>

Specified by:

setRequiredIndicatorVisible in interface HasValueAndElement<AbstractField.ComponentValueChangeEvent<TextField,String>,String>

Parameters:

requiredIndicatorVisible - true to make the required indicator visible, false if not

getDefaultValidator

public Validator<String> 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 a Binder and can be seen as a validation failure.

Specified by:

getDefaultValidator in interface HasValidator<String>

Returns:

state validator

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) and HasValidation.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.

Specified by:

setManualValidation in interface HasValidation

Parameters:

enabled - whether to enable manual validation mode.

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.

onAttach

protected void onAttach(AttachEvent attachEvent)

Description copied from class: Component

Called when the component is attached to a UI.

This method is invoked before the AttachEvent is fired for the component.

Make sure to call super.onAttach when overriding this method.

Overrides:

onAttach in class Component

Parameters:

attachEvent - the attach event