Package com.vaadin.flow.component.splitlayout

Class SplitLayoutLocator

java.lang.Object

com.vaadin.browserless.locator.Locator<SplitLayout,SplitLayoutLocator>

com.vaadin.flow.component.splitlayout.SplitLayoutLocator

All Implemented Interfaces:

Clickable<SplitLayout>, HasThemeFilter<SplitLayout,SplitLayoutLocator>

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

Generated locator for SplitLayout, derived from SplitLayoutTester. 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
SplitLayoutLocator()
SplitLayoutLocator(SplitLayout component)

Method Summary

Modifier and Type	Method	Description
void	dragSplitterTo(double position)	Simulates the user dragging the splitter so that the primary split gets the given percentage of the available space.
void	ensureComponentIsUsable()	Ensures the component is in a usable state before interaction.
SplitLayout	getComponent()	Gets the component being tested.
Component	getPrimaryComponent()	Gets the component shown in the primary split.
Component	getSecondaryComponent()	Gets the component shown in the secondary split.
Double	getSplitterPosition()	Gets the relative position of the splitter, as a percentage between 0 and 100 of the space given to the primary split.

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

SplitLayoutLocator

public SplitLayoutLocator()

SplitLayoutLocator

public SplitLayoutLocator(SplitLayout component)

Method Details

getComponent

public SplitLayout getComponent()

Description copied from interface: Clickable

Gets the component being tested.

Specified by:

getComponent in interface Clickable<SplitLayout>

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

dragSplitterTo

public void dragSplitterTo(double position)

Simulates the user dragging the splitter so that the primary split gets the given percentage of the available space.

The drag is delivered the same way the browser delivers it, so the component updates its splitter position and notifies splitter drag end listeners.

The component rounds the position it derives from a drag to two decimals, so getSplitterPosition() reports 33.33 after dragging to 33.333. Javadoc copied from SplitLayoutTester.dragSplitterTo(double).

Parameters:

position - the new splitter position, as a percentage between 0 and 100

Throws:

IllegalArgumentException - if the position is not between 0 and 100

IllegalStateException - if the layout is not usable

getSplitterPosition

public Double getSplitterPosition()

Gets the relative position of the splitter, as a percentage between 0 and 100 of the space given to the primary split. A position that comes from a drag is rounded to two decimals by the component. Javadoc copied from SplitLayoutTester.getSplitterPosition().

Returns:

the splitter position, or null if it has neither been set on the server nor been dragged by the user

Throws:

IllegalStateException - if the layout is not visible to the user

getPrimaryComponent

public Component getPrimaryComponent()

Gets the component shown in the primary split. Javadoc copied from SplitLayoutTester.getPrimaryComponent().

Returns:

the primary component, or null if the primary split is empty

Throws:

IllegalStateException - if the layout is not visible to the user

getSecondaryComponent

public Component getSecondaryComponent()

Gets the component shown in the secondary split. Javadoc copied from SplitLayoutTester.getSecondaryComponent().

Returns:

the secondary component, or null if the secondary split is empty

Throws:

IllegalStateException - if the layout is not visible to the user