Package com.vaadin.flow.component.html

Class InputLocator

java.lang.Object

com.vaadin.browserless.locator.Locator<Input,InputLocator>

com.vaadin.flow.component.html.InputLocator

All Implemented Interfaces:

Clickable<Input>, HasAriaLabelFilter<Input,InputLocator>, HasPlaceholderFilter<Input,InputLocator>, HasValueFilter<Input,String,InputLocator>

@Generated("com.vaadin.browserless.locator.processor.LocatorProcessor")
public class InputLocator
extends Locator<Input,InputLocator>
implements Clickable<Input>, HasAriaLabelFilter<Input,InputLocator>, HasPlaceholderFilter<Input,InputLocator>, HasValueFilter<Input,String,InputLocator>

Generated locator for Input, derived from InputTester. 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
InputLocator()
InputLocator(Input component)

Method Summary

Modifier and Type	Method	Description
void	clear()	Empties the field, as when the user deletes its contents (or clicks the clear button, where one is shown).
void	ensureComponentIsUsable()	Ensures the component is in a usable state before interaction.
Input	getComponent()	Gets the component being tested.
String	getValue()	Get the current value of the component.
void	setValue(String value)	Set the value to the component if it is usable.

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.HasAriaLabelFilter

withAriaLabel, withAriaLabelContaining

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

withPlaceholder, withPlaceholderContaining

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

withValue

Constructor Details

InputLocator

public InputLocator()

InputLocator

public InputLocator(Input component)

Method Details

getComponent

public Input getComponent()

Description copied from interface: Clickable

Gets the component being tested.

Specified by:

getComponent in interface Clickable<Input>

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

setValue

public void setValue(String value)

Set the value to the component if it is usable.

For a non interactable component an IllegalStateException will be thrown as the end user would not be able to set a value. Javadoc copied from InputTester.setValue(java.lang.String).

Parameters:

value - value to set

getValue

public String getValue()

Get the current value of the component. Javadoc copied from InputTester.getValue().

Returns:

current component value

Throws:

IllegalStateException - if component not visible

clear

public void clear()

Empties the field, as when the user deletes its contents (or clicks the clear button, where one is shown).

Emptying is something the user can always do, so it needs no clear button: a field may legitimately end up invalid ? a required field, for instance ? once emptied. Javadoc copied from InputTester.clear().

Throws:

IllegalStateException - if the component is not usable