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 String
    getErrorMessage()
    Gets the error message to show to the when the component is invalid.
    default boolean
    isInvalid()
    Gets whether the component is currently in invalid state.
    default void
    setErrorMessage(String errorMessage)
    Sets the error message to show to the user when the component is invalid.
    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 the error message to show to the user when the component is invalid.
      Specified by:
      setErrorMessage in interface com.vaadin.flow.component.HasValidation
      Parameters:
      errorMessage - the error message or null to clear it

    • getErrorMessage

      default String getErrorMessage()
      Gets the error message to show to the when the component is invalid.
      Specified by:
      getErrorMessage in interface com.vaadin.flow.component.HasValidation
      Returns:
      the error message or null if not set

    • setInvalid

      default void setInvalid(boolean invalid)
      Sets the invalid state of the component.

      NOTE: If you need to manually control the invalid state, consider enabling manual validation mode with HasValidation.setManualValidation(boolean) to avoid potential conflicts between your custom validation and the component's built-in 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