Package com.vaadin.flow.component.login

Class LoginOverlayTester<T extends LoginOverlay>

java.lang.Object

com.vaadin.testbench.unit.ComponentTester<T>

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

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

Type Parameters:

T - component type

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

Tester for LoginOverlay components.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
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.testbench.unit.ComponentTester

ensureComponentIsUsable, ensureVisible, find, findAllByQuery, findByQuery, fireDomEvent, fireDomEvent, fireDomEvent, getComponent, getField, getField, getMethod, getMethod, roundTrip, setModal

Methods inherited from class java.lang.Object

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

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