Package com.vaadin.flow.component.datepicker

Class DatePickerLocator

java.lang.Object

com.vaadin.browserless.locator.Locator<DatePicker,DatePickerLocator>

com.vaadin.flow.component.datepicker.DatePickerLocator

All Implemented Interfaces:

Clickable<DatePicker>, HasAriaLabelFilter<DatePicker,DatePickerLocator>, HasLabelFilter<DatePicker,DatePickerLocator>, HasPlaceholderFilter<DatePicker,DatePickerLocator>, HasThemeFilter<DatePicker,DatePickerLocator>, HasValueFilter<DatePicker,LocalDate,DatePickerLocator>

@Generated("com.vaadin.browserless.locator.processor.LocatorProcessor")
public class DatePickerLocator
extends Locator<DatePicker,DatePickerLocator>
implements Clickable<DatePicker>, HasLabelFilter<DatePicker,DatePickerLocator>, HasAriaLabelFilter<DatePicker,DatePickerLocator>, HasPlaceholderFilter<DatePicker,DatePickerLocator>, HasValueFilter<DatePicker,LocalDate,DatePickerLocator>, HasThemeFilter<DatePicker,DatePickerLocator>

Generated locator for DatePicker, derived from DatePickerTester. 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
DatePickerLocator()
DatePickerLocator(DatePicker 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	clickClearButton()	Empties the field by clicking its clear button, as the user would.
void	ensureComponentIsUsable()	Ensures the component is in a usable state before interaction.
DatePicker	getComponent()	Gets the component being tested.
boolean	isValid()	Checks whether the field is currently valid, applying the same constraints as the component itself ? required, min and max ? and honouring an invalid state set from the outside, as a Binder or a custom validator does.
void	setValue(LocalDate date)	Set the given date as value to the component, as the user would enter it.

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

withLabel, withLabelContaining

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

withPlaceholder, withPlaceholderContaining

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

withoutTheme, withoutTheme, withTheme, withTheme

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

withValue

Constructor Details

DatePickerLocator

public DatePickerLocator()

DatePickerLocator

public DatePickerLocator(DatePicker component)

Method Details

getComponent

public DatePicker getComponent()

Description copied from interface: Clickable

Gets the component being tested.

Specified by:

getComponent in interface Clickable<DatePicker>

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

setValue

public void setValue(LocalDate date)

Set the given date as value to the component, as the user would enter it.

A date that violates the component's constraints ? outside min - max, or the empty value on a required field ? is committed all the same, because the browser commits it too and simply leaves the field invalid. Assert that outcome with isValid() instead of expecting this method to throw. Javadoc copied from DatePickerTester.setValue(java.time.LocalDate).

Parameters:

date - date to set to the component

Throws:

IllegalStateException - if the component is not usable

isValid

public boolean isValid()

Checks whether the field is currently valid, applying the same constraints as the component itself ? required, min and max ? and honouring an invalid state set from the outside, as a Binder or a custom validator does.

A field can hold a value that does not satisfy its constraints ? the user can type one, setValue(LocalDate) commits it as the browser does, and the value can also be set on the server ? so a test asserting on validation state checks this instead of expecting a value to be refused. Javadoc copied from DatePickerTester.isValid().

Returns:

true if the field is not marked invalid and its current value satisfies the constraints of the field

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 DatePickerTester.clear().

Throws:

IllegalStateException - if the component is not usable

clickClearButton

public void clickClearButton()

Empties the field by clicking its clear button, as the user would.

Unlike clear(), which models selecting the contents and deleting them and is therefore always available, this requires the clear button to be visible ? a hidden clear button is not something the user can click. Javadoc copied from DatePickerTester.clickClearButton().

Throws:

IllegalStateException - if the component is not usable, or its clear button is not visible