Package com.vaadin.flow.component.dashboard

Class DashboardLocator

java.lang.Object

com.vaadin.browserless.locator.Locator<Dashboard,DashboardLocator>

com.vaadin.flow.component.dashboard.DashboardLocator

All Implemented Interfaces:

Clickable<Dashboard>, HasThemeFilter<Dashboard,DashboardLocator>

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

Generated locator for Dashboard, derived from DashboardTester. 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
DashboardLocator()
DashboardLocator(Dashboard component)

Method Summary

Modifier and Type	Method	Description
void	ensureComponentIsUsable()	Ensures the component is in a usable state before interaction.
Dashboard	getComponent()	Gets the component being tested.
void	moveWidget(DashboardWidget widget, int toIndex)	Simulates a user dragging the given widget to a new position within its current container (the dashboard root, or the section it belongs to).
void	removeWidget(DashboardWidget widget)	Simulates a user removing the given widget by clicking its remove button.
void	resizeWidget(DashboardWidget widget, int colspan, int rowspan)	Simulates a user resizing the given widget to the given column and row span.

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

atIndex, component, components, exists, inside, inside, invalidate, self, with, withAttribute, withAttribute, withClassName, withCondition, withId, 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

DashboardLocator

public DashboardLocator()

DashboardLocator

public DashboardLocator(Dashboard component)

Method Details

getComponent

public Dashboard getComponent()

Description copied from interface: Clickable

Gets the component being tested.

Specified by:

getComponent in interface Clickable<Dashboard>

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

moveWidget

public void moveWidget(DashboardWidget widget,
 int toIndex)

Simulates a user dragging the given widget to a new position within its current container (the dashboard root, or the section it belongs to). Javadoc copied from DashboardTester.moveWidget(com.vaadin.flow.component.dashboard.DashboardWidget,int).

Parameters:

widget - the widget to move, not null

toIndex - the target index among the widget's siblings

Throws:

IllegalStateException - if the dashboard is not editable

IllegalArgumentException - if the widget is not in this dashboard or the target index is out of bounds

resizeWidget

public void resizeWidget(DashboardWidget widget,
 int colspan,
 int rowspan)

Simulates a user resizing the given widget to the given column and row span. Javadoc copied from DashboardTester.resizeWidget(com.vaadin.flow.component.dashboard.DashboardWidget,int,int).

Parameters:

widget - the widget to resize, not null

colspan - the new column span

rowspan - the new row span

Throws:

IllegalStateException - if the dashboard is not editable

IllegalArgumentException - if the widget is not in this dashboard

removeWidget

public void removeWidget(DashboardWidget widget)

Simulates a user removing the given widget by clicking its remove button.

If the dashboard has a custom remove handler, it receives the event and decides whether to remove the widget; otherwise the widget is removed immediately. Javadoc copied from DashboardTester.removeWidget(com.vaadin.flow.component.dashboard.DashboardWidget).

Parameters:

widget - the widget to remove, not null

Throws:

IllegalStateException - if the dashboard is not editable

IllegalArgumentException - if the widget is not in this dashboard