Package com.vaadin.flow.component.popover

Class PopoverTester

java.lang.Object

com.vaadin.browserless.ComponentTester<Popover>

com.vaadin.flow.component.popover.PopoverTester

All Implemented Interfaces:

Clickable<Popover>

public class PopoverTester
extends ComponentTester<Popover>

Tester for Popover components.

Constructor Summary

Constructors

Constructor	Description
PopoverTester(Popover component)	Wrap given component for testing.

Method Summary

Modifier and Type	Method	Description
void	clickOutside()	Simulates clicking outside the popover to close it.
void	clickTarget()	Simulates clicking the target component to open the popover.
void	close()	Close the popover.
void	focusTarget()	Simulates focusing the target component to open the popover.
static PopoverTester	forTarget(ComponentQuery<? extends Component> query)	Creates a PopoverTester for the popover that targets the component matching the given query.
static PopoverTester	forTarget(Component target)	Creates a PopoverTester for the popover that targets the given component.
void	hoverTarget()	Simulates hovering the target component to open the popover.
boolean	isOpen()	Check if the popover 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	open()	Open the popover.
void	pressEscape()	Simulates pressing Escape to close the popover.

Methods inherited from class com.vaadin.browserless.ComponentTester

ensureComponentIsUsable, ensureComponentIsUsable, ensureVisible, ensureVisible, find, findAllByQuery, findByQuery, fireDomEvent, fireDomEvent, fireDomEvent, getComponent, getField, getField, getMethod, getMethod, isUsable, notUsableReasons, roundTrip, setModal, 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

PopoverTester

public PopoverTester(Popover component)

Wrap given component for testing.

Parameters:

component - target component

Method Details

forTarget

public static PopoverTester forTarget(ComponentQuery<? extends Component> query)

Creates a PopoverTester for the popover that targets the component matching the given query.

Parameters:

query - a query that resolves to the target component

Returns:

a tester for the popover targeting the matched component

Throws:

NoSuchElementException - if no popover targets the matched component

forTarget

public static PopoverTester forTarget(Component target)

Creates a PopoverTester for the popover that targets the given component.

Parameters:

target - the target component of the popover

Returns:

a tester for the popover targeting the given component

Throws:

NoSuchElementException - if no popover targets the given component

open

public void open()

Open the popover.

close

public void close()

Close the popover.

clickTarget

public void clickTarget()

Simulates clicking the target component to open the popover.

Throws:

IllegalStateException - if no target is set or open-on-click is disabled

hoverTarget

public void hoverTarget()

Simulates hovering the target component to open the popover.

Throws:

IllegalStateException - if no target is set or open-on-hover is disabled

focusTarget

public void focusTarget()

Simulates focusing the target component to open the popover.

Throws:

IllegalStateException - if no target is set or open-on-focus is disabled

pressEscape

public void pressEscape()

Simulates pressing Escape to close the popover.

Throws:

IllegalStateException - if the popover is not open or close-on-Esc is disabled

clickOutside

public void clickOutside()

Simulates clicking outside the popover to close it.

Throws:

IllegalStateException - if the popover is not open or close-on-outside-click is disabled

isOpen

public boolean isOpen()

Check if the popover is open.

Returns:

true if the popover is open

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<Popover>

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<Popover>

See Also:

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