Package com.vaadin.flow.component.html

Class AnchorLocator

java.lang.Object

com.vaadin.browserless.locator.Locator<Anchor,AnchorLocator>

com.vaadin.flow.component.html.AnchorLocator

All Implemented Interfaces:

Clickable<Anchor>, HasAriaLabelFilter<Anchor,AnchorLocator>, HasTextFilter<Anchor,AnchorLocator>

@Generated("com.vaadin.browserless.locator.processor.LocatorProcessor")
public class AnchorLocator
extends Locator<Anchor,AnchorLocator>
implements Clickable<Anchor>, HasTextFilter<Anchor,AnchorLocator>, HasAriaLabelFilter<Anchor,AnchorLocator>

Generated locator for Anchor, derived from AnchorTester. 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
AnchorLocator()
AnchorLocator(Anchor component)

Method Summary

Modifier and Type	Method	Description
void	click()	Click the anchor for navigation if target is a registered route in the application.
void	download(OutputStream outputStream)	Download the stream resource linked by the anchor.
void	ensureComponentIsUsable()	Ensures the component is in a usable state before interaction.
Anchor	getComponent()	Gets the component being tested.
String	getHref()	Gets the URL that the anchor links to.
String	getPath()	Gets the path for the router-link.
QueryParameters	getQueryParameters()	Gets the query parameters for the router-link.
String	getText()	Get the text for target html component.
String	getTitle()	Get the title string set for the html component if available.
HasElement	navigate()	Navigate to the anchor target if it's a registered route in the application.

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, middleClick, middleClick, rightClick, rightClick

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

withAriaLabel, withAriaLabelContaining

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

withText, withTextContaining

Constructor Details

AnchorLocator

public AnchorLocator()

AnchorLocator

public AnchorLocator(Anchor component)

Method Details

getComponent

public Anchor getComponent()

Description copied from interface: Clickable

Gets the component being tested.

Specified by:

getComponent in interface Clickable<Anchor>

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

getHref

public String getHref()

Gets the URL that the anchor links to. Javadoc copied from AnchorTester.getHref().

Returns:

the href value, or "" if no href has been set

getPath

public String getPath()

Gets the path for the router-link. Returns an empty String if there is no corresponding navigation target. Javadoc copied from AnchorTester.getPath().

Returns:

a String containing the navigation target path or empty if not present

getQueryParameters

public QueryParameters getQueryParameters()

Gets the query parameters for the router-link. Javadoc copied from AnchorTester.getQueryParameters().

Returns:

a

invalid reference

QueryParameters

containing the navigation target's query parameters

navigate

public HasElement navigate()

Navigate to the anchor target if it's a registered route in the application. Javadoc copied from AnchorTester.navigate().

Returns:

navigated view

Throws:

IllegalStateException - if anchor href is not a String or not a route

click

public void click()

Click the anchor for navigation if target is a registered route in the application. This is equivalent to calling navigate(). For cases where you need to access the navigated view, use navigate() instead as it returns the target view. Javadoc copied from AnchorTester.click().

Specified by:

click in interface Clickable<Anchor>

Throws:

IllegalStateException - if anchor href is not a String or not a route

download

public void download(OutputStream outputStream)

Download the stream resource linked by the anchor. Javadoc copied from AnchorTester.download(java.io.OutputStream).

Parameters:

outputStream - output stream to write the stream resource to

Throws:

IllegalStateException - if the anchor does not link to a stream resource

getText

public String getText()

Get the text for target html component. Javadoc copied from HtmlContainerTester.getText().

Returns:

text of component

Throws:

IllegalStateException - if component not visible

getTitle

public String getTitle()

Get the title string set for the html component if available. Javadoc copied from HtmlComponentTester.getTitle().

Returns:

title string

Throws:

IllegalStateException - if not title has been set