Package com.vaadin.flow.component.shared

Interface HasValidationProperties

All Superinterfaces:

com.vaadin.flow.component.HasElement, com.vaadin.flow.component.HasValidation, Serializable

public interface HasValidationProperties
extends com.vaadin.flow.component.HasElement, com.vaadin.flow.component.HasValidation

Mixin interface for components that provide properties for setting invalid state and error message string to show when invalid.

Author:

Vaadin Ltd

Method Summary

Modifier and Type	Method	Description
default void	bindErrorMessage(com.vaadin.flow.signals.Signal<String> signal)
default void	bindInvalid(com.vaadin.flow.signals.Signal<Boolean> signal)	Binds a given boolean signal to the invalid state of the component.
default String	getErrorMessage()	Gets the error message displayed for all constraint violations if it has been set with setErrorMessage(String).
default boolean	isInvalid()	Gets whether the component is currently in invalid state.
default void	setErrorMessage(String errorMessage)	Sets a single error message to display for all constraint violations.
default void	setInvalid(boolean invalid)	Sets the invalid state of the component.

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

getElement

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

setManualValidation

Method Details

setErrorMessage

default void setErrorMessage(String errorMessage)

Sets a single error message to display for all constraint violations. The error message will only appear when the component is flagged as invalid, either as a result of constraint validation or by the developer through setInvalid(boolean) if manual validation mode is enabled.

Specified by:

setErrorMessage in interface com.vaadin.flow.component.HasValidation

Parameters:

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

getErrorMessage

default String getErrorMessage()

Gets the error message displayed for all constraint violations if it has been set with setErrorMessage(String). Otherwise, gets the current i18n error message if the value is currently invalid.

Specified by:

getErrorMessage in interface com.vaadin.flow.component.HasValidation

Returns:

the error message

bindErrorMessage

default void bindErrorMessage(com.vaadin.flow.signals.Signal<String> signal)

Binds a given signal to the single error message to display for all constraint violations. The error message will only appear when the component is flagged as invalid, either as a result of constraint validation or by the developer through setInvalid(boolean) if manual validation mode is enabled.

Signal's value null clears the error message.

Specified by:

bindErrorMessage in interface com.vaadin.flow.component.HasValidation

Parameters:

signal - the signal to bind the error message to, not null

Since:

25.1

setInvalid

default void setInvalid(boolean invalid)

Sets the invalid state of the component.

NOTE: If you need to manually control the invalid state, enable manual validation mode with HasValidation.setManualValidation(boolean) to avoid potential conflicts between your custom validation and the component's constraint validation.

Specified by:

setInvalid in interface com.vaadin.flow.component.HasValidation

Parameters:

invalid - true for invalid, false for valid

isInvalid

default boolean isInvalid()

Gets whether the component is currently in invalid state.

Specified by:

isInvalid in interface com.vaadin.flow.component.HasValidation

Returns:

true for invalid, false for valid

bindInvalid

default void bindInvalid(com.vaadin.flow.signals.Signal<Boolean> signal)

Binds a given boolean signal to the invalid state of the component.

The invalid state controls whether the component is considered invalid and whether a possible error message is shown. If manual validation mode is enabled with HasValidation.setManualValidation(boolean), then the value provided by the bound signal determines the visual invalid state of the component.

Signal's value null is treated as false.

Specified by:

bindInvalid in interface com.vaadin.flow.component.HasValidation

Parameters:

signal - the signal to bind the invalid state to, not null

Since:

25.1