Package com.vaadin.flow.component.login

Class LoginOverlayTester<T extends LoginOverlay>

java.lang.Object

com.vaadin.browserless.ComponentTester<T>

com.vaadin.flow.component.login.AbstractLoginTester<T>

com.vaadin.flow.component.login.LoginOverlayTester<T>

Type Parameters:

T - component type

All Implemented Interfaces:

Clickable<T>

public class LoginOverlayTester<T extends LoginOverlay>
extends AbstractLoginTester<T>

Tester for LoginOverlay components.

Since:

1.0

Constructor Summary

Constructors

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

Method Summary

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

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

forgotPassword, login

Methods inherited from class com.vaadin.browserless.ComponentTester

canSetValueAsUser, clearAsUser, clickClearButtonAsUser, ensureComponentIsUsable, ensureComponentIsUsable, ensureComponentIsUsableOrDetach, ensureVisible, ensureVisible, find, findAllByQuery, findByQuery, fireDomEvent, fireDomEvent, fireDomEvent, getComponent, getField, getField, getMethod, getMethod, isComponentReadOnly, isUsable, notUsableReasons, roundTrip, setModal, setPropertyAsUser, setValueAsUser, setValueAsUser

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.vaadin.browserless.Clickable

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

Constructor Details

LoginOverlayTester

public LoginOverlayTester(T component)

Wrap given component for testing.

Parameters:

component - target component

Method Details

isUsable

public boolean isUsable()

Description copied from class: ComponentTester

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

Overrides:

isUsable in class ComponentTester<T extends LoginOverlay>

Returns:

true if component can be interacted with by the user

See Also:

• ComponentTester.notUsableReasons(Consumer)
• ComponentTester.ensureComponentIsUsable()

notUsableReasons

protected void notUsableReasons(Consumer<String> collector)

Description copied from class: ComponentTester

Provides messages explaining why the component is actually not usable. Subclasses overriding ComponentTester.isUsable() should also override this method to provide additional details to the potential exception throw by ComponentTester.ensureComponentIsUsable().

Overrides:

notUsableReasons in class ComponentTester<T extends LoginOverlay>

See Also:

• ComponentTester.isUsable()
• ComponentTester.ensureComponentIsUsable()

openOverlay

public void openOverlay()

Open LoginOverlay to enable logging in through it.

isOpen

public boolean isOpen()

Check if login overlay is open.

Returns:

true if overlay is open and visible

findInFooter

public <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.

Type Parameters:

R - the type of the components to search for

Parameters:

componentType - the type of the components to search for

Returns:

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

Throws:

IllegalStateException - if the overlay is not usable, e.g. not open

findInCustomFormArea

public <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.

Type Parameters:

R - the type of the components to search for

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

Throws:

IllegalStateException - if the overlay is not usable, e.g. not open