Interface HasHelper

Method Detail

• getHelperText

  default String getHelperText()

  String used for the helper text.

  Returns:

  the helperText property from the web component

• setHelperText

  default void setHelperText​(String helperText)

  String used for the helper text. It shows a text adjacent to the field that can be used, e.g., to inform to the users which values it expects. Example: a text "The password must contain numbers" for the PasswordField.

  In case both setHelperText(String) and setHelperComponent(Component) are used, only the element defined by setHelperComponent(Component) will be visible, regardless of the order on which they are defined.

  Parameters:

  helperText - the String value to set

• setHelperComponent

  default void setHelperComponent​(Component component)

  Adds the given component into helper slot of component, replacing any existing helper component. It adds the component adjacent to the field that can be used, e.g., to inform to the users which values it expects. Example: a component that shows the password strength for the PasswordField.

  Parameters:

  component - the component to set, can be null to remove existing helper component

  See Also:

  setHelperText(String)

• getHelperComponent

  default Component getHelperComponent()

  Gets the component in the helper slot of this field.

  Returns:

  the helper component of this field, or null if no helper component has been set

  See Also:

  setHelperComponent(Component)