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:

AttachNotifier, BlurNotifier<TextField>, CompositionNotifier, DetachNotifier, Focusable<TextField>, FocusNotifier<TextField>, HasElement, HasEnabled, HasSize, HasStyle, HasTheme, HasValidation, HasValue<AbstractField.ComponentValueChangeEvent<TextField,String>,String>, HasValueAndElement<AbstractField.ComponentValueChangeEvent<TextField,String>,String>, InputNotifier, KeyNotifier, HasAutocapitalize, HasAutocomplete, HasAutocorrect, HasPrefixAndSuffix, HasValueChangeMode, Serializable

public class TextField
extends GeneratedVaadinTextField<TextField,String>
implements HasSize, HasValidation, HasValueChangeMode, HasPrefixAndSuffix, InputNotifier, KeyNotifier, CompositionNotifier, HasAutocomplete, HasAutocapitalize, HasAutocorrect

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

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

HasValue.ValueChangeEvent<V>, HasValue.ValueChangeListener<E extends 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(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 and Description
String	getEmptyValue() Returns the value that represents an empty value.
String	getErrorMessage() Gets current error message from the component.
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.
ValueChangeMode	getValueChangeMode() Gets current value change mode of the component.
int	getValueChangeTimeout() Returns the currently set timeout, for how often HasValue.ValueChangeEvents are triggered when the ValueChangeMode is set to ValueChangeMode.LAZY, or ValueChangeMode.TIMEOUT.
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.
boolean	isInvalid() Returns true if component input is invalid, false otherwise.
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.
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) Description copied from corresponding location in WebComponent:
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) Sets the required indicator visible or not.
void	setTitle(String title) Description copied from corresponding location in WebComponent:
void	setValue(String value) Sets the value of this text field.
void	setValueChangeMode(ValueChangeMode valueChangeMode) Sets new value change mode for the component.
void	setValueChangeTimeout(int valueChangeTimeout) Sets how often HasValue.ValueChangeEvents are triggered when the ValueChangeMode is set to ValueChangeMode.LAZY, or ValueChangeMode.TIMEOUT.
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, getUI, hasListener, isTemplateMapped, isVisible, onAttach, 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

getHeight, getMaxHeight, getMaxWidth, getMinHeight, getMinWidth, getWidth, setHeight, setHeightFull, setMaxHeight, setMaxWidth, setMinHeight, setMinWidth, setSizeFull, setSizeUndefined, 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.HasElement

getElement

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(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:

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:

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

Method Detail

getValueChangeMode

public ValueChangeMode getValueChangeMode()

Gets current value change mode of the component.

The default value is ValueChangeMode.ON_CHANGE.

Specified by:

getValueChangeMode in interface HasValueChangeMode

Returns:

current value change mode of the component, or null if the value is not synchronized

setValueChangeMode

public void setValueChangeMode(ValueChangeMode valueChangeMode)

Description copied from interface: HasValueChangeMode

Sets new value change mode for the component.

Specified by:

setValueChangeMode in interface HasValueChangeMode

Parameters:

valueChangeMode - new value change mode, or null to disable the value synchronization

setValueChangeTimeout

public void setValueChangeTimeout(int valueChangeTimeout)

Description copied from interface: HasValueChangeMode

Sets how often HasValue.ValueChangeEvents are triggered when the ValueChangeMode is set to ValueChangeMode.LAZY, or ValueChangeMode.TIMEOUT.

Implementations should use ValueChangeMode.applyChangeTimeout(ValueChangeMode, int, DomListenerRegistration).

Specified by:

setValueChangeTimeout in interface HasValueChangeMode

Parameters:

valueChangeTimeout - the timeout in milliseconds of how often HasValue.ValueChangeEvents are triggered.

getValueChangeTimeout

public int getValueChangeTimeout()

Description copied from interface: HasValueChangeMode

Returns the currently set timeout, for how often HasValue.ValueChangeEvents are triggered when the ValueChangeMode is set to ValueChangeMode.LAZY, or ValueChangeMode.TIMEOUT.

Specified by:

getValueChangeTimeout in interface HasValueChangeMode

Returns:

the timeout in milliseconds of how often HasValue.ValueChangeEvents are triggered.

getErrorMessage

public String getErrorMessage()

Description copied from interface: HasValidation

Gets current error message from the component.

Specified by:

getErrorMessage in interface HasValidation

Returns:

current error message

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 HasValidation

Overrides:

setErrorMessage in class GeneratedVaadinTextField<TextField,String>

Parameters:

errorMessage - the String value to set

isInvalid

public boolean isInvalid()

Description copied from interface: HasValidation

Returns true if component input is invalid, false otherwise.

Specified by:

isInvalid in interface HasValidation

Returns:

whether the component input is valid

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 HasValidation

Overrides:

setInvalid in class GeneratedVaadinTextField<TextField,String>

Parameters:

invalid - the boolean value to set

setLabel

public void setLabel(String label)

Description copied from class: GeneratedVaadinTextField

Description copied from corresponding location in WebComponent:

String used for the label element.

Overrides:

setLabel in class GeneratedVaadinTextField<TextField,String>

Parameters:

label - the String value to set

getLabel

public String getLabel()

String used for the label element.

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.

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()

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

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>