Package com.vaadin.flow.component.masterdetaillayout

Class MasterDetailLayoutLocator

java.lang.Object

com.vaadin.browserless.locator.Locator<MasterDetailLayout,MasterDetailLayoutLocator>

com.vaadin.flow.component.masterdetaillayout.MasterDetailLayoutLocator

All Implemented Interfaces:

Clickable<MasterDetailLayout>

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

Generated locator for MasterDetailLayout, derived from MasterDetailLayoutTester. 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
MasterDetailLayoutLocator()
MasterDetailLayoutLocator(MasterDetailLayout component)

Method Summary

Modifier and Type	Method	Description
void	ensureComponentIsUsable()	Ensures the component is in a usable state before interaction.
MasterDetailLayout	getComponent()	Gets the component being tested.
Component	getDetail()	Gets the component currently shown in the detail area.
Component	getDetailPlaceholder()	Gets the placeholder component currently shown in the detail area.
Component	getMaster()	Gets the component currently shown in the master area.
boolean	isDetailPlaceholderVisible()	Checks whether the detail placeholder is currently shown to the user.

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

Constructor Details

MasterDetailLayoutLocator

public MasterDetailLayoutLocator()

MasterDetailLayoutLocator

public MasterDetailLayoutLocator(MasterDetailLayout component)

Method Details

getComponent

public MasterDetailLayout getComponent()

Description copied from interface: Clickable

Gets the component being tested.

Specified by:

getComponent in interface Clickable<MasterDetailLayout>

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

getMaster

public Component getMaster()

Gets the component currently shown in the master area. Javadoc copied from MasterDetailLayoutTester.getMaster().

Returns:

the component in the master area, or null if there is no component in the master area

Throws:

IllegalStateException - if the layout is not visible to the user

getDetail

public Component getDetail()

Gets the component currently shown in the detail area. Javadoc copied from MasterDetailLayoutTester.getDetail().

Returns:

the component in the detail area, or null if no detail content is set

Throws:

IllegalStateException - if the layout is not visible to the user

getDetailPlaceholder

public Component getDetailPlaceholder()

Gets the placeholder component currently shown in the detail area. The placeholder is only shown to the user while no detail content is set. Javadoc copied from MasterDetailLayoutTester.getDetailPlaceholder().

Returns:

the placeholder component shown in the detail area, or null if no placeholder is set

Throws:

IllegalStateException - if the layout is not visible to the user, or if detail content is set so the placeholder is not shown

isDetailPlaceholderVisible

public boolean isDetailPlaceholderVisible()

Checks whether the detail placeholder is currently shown to the user. A placeholder is shown when one is set and there is no detail content. Javadoc copied from MasterDetailLayoutTester.isDetailPlaceholderVisible().

Returns:

true if the placeholder is shown, false otherwise

Throws:

IllegalStateException - if the layout is not visible to the user