Package com.vaadin.flow.component.textfield

Class TextField.TextFieldI18n

java.lang.Object

com.vaadin.flow.component.textfield.TextField.TextFieldI18n

All Implemented Interfaces:

Serializable

Enclosing class:

TextField

public static class TextField.TextFieldI18n
extends Object
implements Serializable

The internationalization properties for TextField.

Since:

24.5

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
TextFieldI18n()

Method Summary

Modifier and Type	Method	Description
String	getMaxLengthErrorMessage()	Gets the error message displayed when the field value is longer than the maximum allowed length.
String	getMinLengthErrorMessage()	Gets the error message displayed when the field value is shorter than the minimum allowed length.
String	getPatternErrorMessage()	Gets the error message displayed when the field value does not match the pattern.
String	getRequiredErrorMessage()	Gets the error message displayed when the field is required but empty.
TextField.TextFieldI18n	setMaxLengthErrorMessage(String errorMessage)	Sets the error message to display when the field value is longer than the maximum allowed length.
TextField.TextFieldI18n	setMinLengthErrorMessage(String errorMessage)	Sets the error message to display when the field value is shorter than the minimum allowed length.
TextField.TextFieldI18n	setPatternErrorMessage(String errorMessage)	Sets the error message to display when the field value does not match the pattern.
TextField.TextFieldI18n	setRequiredErrorMessage(String errorMessage)	Sets the error message to display when the field is required but empty.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

TextFieldI18n

public TextFieldI18n()

Method Details

getRequiredErrorMessage

public String getRequiredErrorMessage()

Gets the error message displayed when the field is required but empty.

Returns:

the error message or null if not set

See Also:

• TextFieldBase.isRequiredIndicatorVisible()
• TextField.setRequiredIndicatorVisible(boolean)

setRequiredErrorMessage

public TextField.TextFieldI18n setRequiredErrorMessage(String errorMessage)

Sets the error message to display when the field is required but empty.

Note, custom error messages set with TextField.setErrorMessage(String) take priority over i18n error messages.

Parameters:

errorMessage - the error message or null to clear it

Returns:

this instance for method chaining

See Also:

• TextFieldBase.isRequiredIndicatorVisible()
• TextField.setRequiredIndicatorVisible(boolean)

getMinLengthErrorMessage

public String getMinLengthErrorMessage()

Gets the error message displayed when the field value is shorter than the minimum allowed length.

Returns:

the error message or null if not set

See Also:

• TextField.getMinLength()
• TextField.setMinLength(int)

setMinLengthErrorMessage

public TextField.TextFieldI18n setMinLengthErrorMessage(String errorMessage)

Sets the error message to display when the field value is shorter than the minimum allowed length.

Note, custom error messages set with TextField.setErrorMessage(String) take priority over i18n error messages.

Parameters:

errorMessage - the error message or null to clear it

Returns:

this instance for method chaining

See Also:

• TextField.getMinLength()
• TextField.setMinLength(int)

getMaxLengthErrorMessage

public String getMaxLengthErrorMessage()

Gets the error message displayed when the field value is longer than the maximum allowed length.

Returns:

the error message or null if not set

See Also:

• TextField.getMaxLength()
• TextField.setMaxLength(int)

setMaxLengthErrorMessage

public TextField.TextFieldI18n setMaxLengthErrorMessage(String errorMessage)

Sets the error message to display when the field value is longer than the maximum allowed length.

Note, custom error messages set with TextField.setErrorMessage(String) take priority over i18n error messages.

Parameters:

errorMessage - the error message or null to clear it

Returns:

this instance for method chaining

See Also:

• TextField.getMaxLength()
• TextField.setMaxLength(int)

getPatternErrorMessage

public String getPatternErrorMessage()

Gets the error message displayed when the field value does not match the pattern.

Returns:

the error message or null if not set

See Also:

• TextField.getPattern()
• TextField.setPattern(String)

setPatternErrorMessage

public TextField.TextFieldI18n setPatternErrorMessage(String errorMessage)

Sets the error message to display when the field value does not match the pattern.

Note, custom error messages set with TextField.setErrorMessage(String) take priority over i18n error messages.

Parameters:

errorMessage - the error message or null to clear it

Returns:

this instance for method chaining

See Also:

• TextField.getPattern()
• TextField.setPattern(String)