Package com.vaadin.flow.component.dialog

Class DialogLocator

java.lang.Object

com.vaadin.browserless.locator.Locator<Dialog,DialogLocator>

com.vaadin.flow.component.dialog.DialogLocator

All Implemented Interfaces:

Clickable<Dialog>, HasThemeFilter<Dialog,DialogLocator>

@Generated("com.vaadin.browserless.locator.processor.LocatorProcessor")
public class DialogLocator
extends Locator<Dialog,DialogLocator>
implements Clickable<Dialog>, HasThemeFilter<Dialog,DialogLocator>

Generated locator for Dialog, derived from DialogTester. Filter steps are inherited from Locator; action methods delegate to a fresh tester around the resolved component, so behavioral changes belong on the tester, not here.

Constructor Summary

Constructors

Constructor	Description
DialogLocator()
DialogLocator(Dialog component)

Method Summary

Modifier and Type	Method	Description
void	clickOutside()	Simulates clicking outside the dialog to close it.
void	close()	Close the dialog from the server side, like the application calling Dialog.close().
void	ensureComponentIsUsable()	Ensures the component is in a usable state before interaction.
Dialog	getComponent()	Gets the component being tested.
boolean	isOpen()	Check if the dialog is open.
void	open()	Open the dialog.
void	pressEscape()	Simulates pressing Escape to close the dialog.

Methods inherited from class com.vaadin.browserless.locator.Locator

atIndex, component, components, exists, inside, inside, invalidate, self, with, withAttribute, withAttribute, withClassName, withCondition, withId, withinSlot, withoutAttribute, withoutAttribute, withoutClassName, withTestId

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

Methods inherited from interface com.vaadin.browserless.locator.HasThemeFilter

withoutTheme, withoutTheme, withTheme, withTheme

Constructor Details

DialogLocator

public DialogLocator()

DialogLocator

public DialogLocator(Dialog component)

Method Details

getComponent

public Dialog getComponent()

Description copied from interface: Clickable

Gets the component being tested.

Specified by:

getComponent in interface Clickable<Dialog>

Returns:

the component under test

ensureComponentIsUsable

public void ensureComponentIsUsable()

Description copied from interface: Clickable

Ensures the component is in a usable state before interaction.

Specified by:

ensureComponentIsUsable in interface Clickable<Dialog>

open

public void open()

Open the dialog. Javadoc copied from DialogTester.open().

close

public void close()

Close the dialog from the server side, like the application calling Dialog.close().

This is not something the user can do: the dialog is closed regardless of Dialog.isCloseOnEsc() and Dialog.isCloseOnOutsideClick(), and no Dialog.DialogCloseActionEvent is fired, so a close action listener cannot veto it. To simulate the user dismissing the dialog, use pressEscape() or clickOutside() instead. Javadoc copied from DialogTester.close().

pressEscape

public void pressEscape()

Simulates pressing Escape to close the dialog.

If the application has registered a close action listener, a Dialog.DialogCloseActionEvent is fired instead of closing the dialog, leaving it up to the listener whether to close it. Javadoc copied from DialogTester.pressEscape().

Throws:

IllegalStateException - if the dialog is not usable, e.g. not open, or close-on-Esc is disabled

clickOutside

public void clickOutside()

Simulates clicking outside the dialog to close it.

If the application has registered a close action listener, a Dialog.DialogCloseActionEvent is fired instead of closing the dialog, leaving it up to the listener whether to close it. Javadoc copied from DialogTester.clickOutside().

Throws:

IllegalStateException - if the dialog is not usable, e.g. not open, or close-on-outside-click is disabled

isOpen

public boolean isOpen()

Check if the dialog is open. Javadoc copied from DialogTester.isOpen().

Returns:

true if the dialog is open