Package com.vaadin.flow.component.textfield

Class NumberField.NumberFieldI18n

java.lang.Object

com.vaadin.flow.component.textfield.NumberField.NumberFieldI18n

All Implemented Interfaces:

AbstractNumberFieldI18n, Serializable

Enclosing class:

NumberField

public static class NumberField.NumberFieldI18n
extends Object
implements AbstractNumberFieldI18n

The internationalization properties for NumberField.

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
NumberFieldI18n()

Method Summary

Modifier and Type	Method	Description
String	getBadInputErrorMessage()	Gets the error message displayed when the field contains user input that the server is unable to convert to type Number.
String	getMaxErrorMessage()	Gets the error message displayed when the field value is greater than the maximum allowed value.
String	getMinErrorMessage()	Gets the error message displayed when the field value is smaller than the minimum allowed value.
String	getRequiredErrorMessage()	Gets the error message displayed when the field is required but empty.
String	getStepErrorMessage()	Gets the error message displayed when the field value is not a multiple of the step value.
NumberField.NumberFieldI18n	setBadInputErrorMessage(String errorMessage)	Sets the error message to display when the field contains user input that the server is unable to convert to type Number.
NumberField.NumberFieldI18n	setMaxErrorMessage(String errorMessage)	Sets the error message to display when the field value is greater than the maximum allowed value.
NumberField.NumberFieldI18n	setMinErrorMessage(String errorMessage)	Sets the error message to display when the field value is smaller than the minimum allowed value.
NumberField.NumberFieldI18n	setRequiredErrorMessage(String errorMessage)	Sets the error message to display when the field is required but empty.
NumberField.NumberFieldI18n	setStepErrorMessage(String errorMessage)	Sets the error message to display when the field value is not a multiple of the step value.

Methods inherited from class java.lang.Object

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

Constructor Details

NumberFieldI18n

public NumberFieldI18n()

Method Details

getBadInputErrorMessage

public String getBadInputErrorMessage()

Gets the error message displayed when the field contains user input that the server is unable to convert to type Number.

Specified by:

getBadInputErrorMessage in interface AbstractNumberFieldI18n

Returns:

the error message or null if not set

setBadInputErrorMessage

public NumberField.NumberFieldI18n setBadInputErrorMessage(String errorMessage)

Sets the error message to display when the field contains user input that the server is unable to convert to type Number.

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

Parameters:

errorMessage - the error message to set, or null to clear

Returns:

this instance for method chaining

getRequiredErrorMessage

public String getRequiredErrorMessage()

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

Specified by:

getRequiredErrorMessage in interface AbstractNumberFieldI18n

Returns:

the error message or null if not set

See Also:

• TextFieldBase.isRequired()
• TextFieldBase.setRequired(boolean)

setRequiredErrorMessage

public NumberField.NumberFieldI18n setRequiredErrorMessage(String errorMessage)

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

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

Parameters:

errorMessage - the error message to set, or null to clear

Returns:

this instance for method chaining

See Also:

• TextFieldBase.isRequired()
• TextFieldBase.setRequired(boolean)

getMinErrorMessage

public String getMinErrorMessage()

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

Specified by:

getMinErrorMessage in interface AbstractNumberFieldI18n

Returns:

the error message or null if not set

See Also:

• NumberField.setMin(double)
• NumberField.getMin()

setMinErrorMessage

public NumberField.NumberFieldI18n setMinErrorMessage(String errorMessage)

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

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

Parameters:

errorMessage - the error message to set, or null to clear

Returns:

this instance for method chaining

See Also:

• NumberField.setMin(double)
• NumberField.getMin()

getMaxErrorMessage

public String getMaxErrorMessage()

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

Specified by:

getMaxErrorMessage in interface AbstractNumberFieldI18n

Returns:

the error message or null if not set

See Also:

• NumberField.setMax(double)
• NumberField.getMax()

setMaxErrorMessage

public NumberField.NumberFieldI18n setMaxErrorMessage(String errorMessage)

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

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

Parameters:

errorMessage - the error message to set, or null to clear

Returns:

this instance for method chaining

See Also:

• NumberField.setMax(double)
• NumberField.getMax()

getStepErrorMessage

public String getStepErrorMessage()

Gets the error message displayed when the field value is not a multiple of the step value.

Specified by:

getStepErrorMessage in interface AbstractNumberFieldI18n

Returns:

the error message or null if not set

See Also:

• NumberField.setStep(double)
• NumberField.getStep()

setStepErrorMessage

public NumberField.NumberFieldI18n setStepErrorMessage(String errorMessage)

Sets the error message to display when the field value is not a multiple of the step value.

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

Parameters:

errorMessage - the error message to set, or null to clear

Returns:

this instance for method chaining

See Also:

• NumberField.setStep(double)
• NumberField.getStep()