Package com.vaadin.flow.component.login

Class LoginOverlayTester

  • All Implemented Interfaces:
    com.vaadin.browserless.Clickable 
    
public class LoginOverlayTester<T extends LoginOverlay>
extends AbstractLoginTester<T>

    Tester for LoginOverlay components.

    Since:

    1.0

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description

    • Field Summary

      Fields 
      Modifier and Type Field Description
      public final T component

    • Constructor Summary

      Constructors 
      Constructor Description
      LoginOverlayTester(T component) Wrap given component for testing.

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description

    • Method Summary

      Modifier and Type Method Description
      boolean isUsable() Validate that component can be interacted with and should be visible in the UI.
      void openOverlay() Open LoginOverlay to enable logging in through it.
      boolean isOpen() Check if login overlay is open.
      <R extends Component> ComponentQuery<R> findInFooter(Class<R> componentType) Searches the overlay's footer for components of the given type.
      <R extends Component> ComponentQuery<R> findInCustomFormArea(Class<R> componentType) Searches the overlay's custom form area for components of the given type.

      • Methods inherited from class com.vaadin.browserless.ComponentTester

        blur, ensureComponentIsUsable, find, focus, getComponent, isFocused, setModal

      • Methods inherited from class com.vaadin.flow.component.login.AbstractLoginTester

        forgotPassword, login

      • Methods inherited from class com.vaadin.browserless.Clickable

        click, click, click, middleClick, middleClick, rightClick, rightClick

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • LoginOverlayTester

        LoginOverlayTester(T component)

        Wrap given component for testing.

        Parameters:
        component - target component

    • Method Detail

      • isUsable

         boolean isUsable()

        Validate that component can be interacted with and should be visible in the UI. Subclasses overriding this method should also override notUsableReasons to provide additional details to the potential exception thrown by ensureComponentIsUsable.

        Returns:

        true if component can be interacted with by the user

      • openOverlay

         void openOverlay()

        Open LoginOverlay to enable logging in through it.

      • isOpen

         boolean isOpen()

        Check if login overlay is open.

        Returns:

        true if overlay is open and visible

      • findInFooter

         <R extends Component> ComponentQuery<R> findInFooter(Class<R> componentType)

        Searches the overlay's footer for components of the given type.

        The footer is the area below the login form, filled with login.getFooter().add(...). Components nested inside the footer content are found too, so a button inside a footer layout is reached as well as a button added to the footer directly.

        Parameters:
        componentType - the type of the components to search for
        Returns:

        a query for components of the given type in the overlay's footer

        Since:

        25.3

      • findInCustomFormArea

         <R extends Component> ComponentQuery<R> findInCustomFormArea(Class<R> componentType)

        Searches the overlay's custom form area for components of the given type.

        The custom form area is the area inside the login form, filled with login.getCustomFormArea().add(...). Components nested inside it are found too, so a field inside a layout added to the area is reached as well as a field added to the area directly.

        Parameters:
        componentType - the type of the components to search for
        Returns:

        a query for components of the given type in the overlay's custom form area

        Since:

        25.3