Package com.vaadin.flow.data.binder

Class DefaultBinderValidationErrorHandler

java.lang.Object

com.vaadin.flow.data.binder.DefaultBinderValidationErrorHandler

All Implemented Interfaces:

BinderValidationErrorHandler, Serializable

public class DefaultBinderValidationErrorHandler
extends Object
implements BinderValidationErrorHandler

Default implementation of BinderValidationErrorHandler.

This handler applies visual effects for the field if its type allows this:

• If the field's class implements HasValidation interface then its validity and error message is set based on a ValidationResult
• If the field's class may have a theme (e.g. implements HasTheme or HasElement) then theme name derived from the ErrorLevel of the ValidationResult instance is applied. E.g., for ErrorLevel.WARNING the element will get the "theme"="warning" attribute and value in HTML.

Since:

Author:

Vaadin Ltd

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
DefaultBinderValidationErrorHandler()

Method Summary

Modifier and Type	Method	Description
void	clearError(HasValue<?,?> field)	Clears the error condition of the given field, if any.
protected void	clearErrorTheme(HasValue<?,?> field)	Clears error theme for the field.
protected String	getErrorThemeName(ErrorLevel errorLevel)	Gets the theme name for the ErrorLevel.
protected Optional<ThemeList>	getThemes(HasValue<?,?> field)	Gets themes for the field.
void	handleError(HasValue<?,?> field, ValidationResult result)	Handles a validation error emitted when trying to write the value of the given field.
protected void	setErrorTheme(HasValue<?,?> field, ValidationResult result)	Sets error theme for the field based on result.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultBinderValidationErrorHandler

public DefaultBinderValidationErrorHandler()

Method Detail

handleError

public void handleError(HasValue<?,?> field,
                        ValidationResult result)

Handles a validation error emitted when trying to write the value of the given field.

Specified by:

handleError in interface BinderValidationErrorHandler

Parameters:

field - the field with the invalid value

result - the validation error result

See Also:

BinderValidationErrorHandler.clearError(HasValue)

clearError

public void clearError(HasValue<?,?> field)

Clears the error condition of the given field, if any.

Specified by:

clearError in interface BinderValidationErrorHandler

Parameters:

field - the field with an invalid value

See Also:

BinderValidationErrorHandler.handleError(HasValue, ValidationResult)

getErrorThemeName

protected String getErrorThemeName(ErrorLevel errorLevel)

Gets the theme name for the ErrorLevel.

Parameters:

errorLevel - the error level

Returns:

a theme name for the error level

getThemes

protected Optional<ThemeList> getThemes(HasValue<?,?> field)

Gets themes for the field.

Parameters:

field - a field

Returns:

an optional theme list, or an empty optional if the field doesn't have it

clearErrorTheme

protected void clearErrorTheme(HasValue<?,?> field)

Clears error theme for the field.

Parameters:

field - a feild

setErrorTheme

protected void setErrorTheme(HasValue<?,?> field,
                             ValidationResult result)

Sets error theme for the field based on result.

Parameters:

field - a field

result - a validation result