Package com.vaadin.flow.component.textfield

Class BigDecimalFieldLocator

java.lang.Object

com.vaadin.browserless.locator.Locator<BigDecimalField,BigDecimalFieldLocator>

com.vaadin.flow.component.textfield.BigDecimalFieldLocator

All Implemented Interfaces:

Clickable<BigDecimalField>, HasAriaLabelFilter<BigDecimalField,BigDecimalFieldLocator>, HasLabelFilter<BigDecimalField,BigDecimalFieldLocator>, HasPlaceholderFilter<BigDecimalField,BigDecimalFieldLocator>, HasThemeFilter<BigDecimalField,BigDecimalFieldLocator>, HasValueFilter<BigDecimalField,BigDecimal,BigDecimalFieldLocator>

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

Generated locator for BigDecimalField, derived from TextFieldTester. 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
BigDecimalFieldLocator()
BigDecimalFieldLocator(BigDecimalField 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.
BigDecimalField	getComponent()	Gets the component being tested.
void	setValue(BigDecimal value)	Set the given value for the component, as the user would type 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

BigDecimalFieldLocator

public BigDecimalFieldLocator()

BigDecimalFieldLocator

public BigDecimalFieldLocator(BigDecimalField component)

Method Details

getComponent

public BigDecimalField getComponent()

Description copied from interface: Clickable

Gets the component being tested.

Specified by:

getComponent in interface Clickable<BigDecimalField>

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

setValue

public void setValue(BigDecimal value)

Set the given value for the component, as the user would type it.

A value that only breaks a validation constraint ? shorter than minLength, not matching pattern, 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 HasValidation.isInvalid() instead of expecting this method to throw.

A value the user physically cannot type is refused: the browser truncates what is over maxLength and filters out the keystrokes allowedCharPattern does not match, so a longer value or a disallowed character fails with an IllegalArgumentException. So does null on a field whose empty value is not null, as a text input has no null state ? emptying the field is clear(). Javadoc copied from TextFieldTester.setValue(java.lang.Object).

Parameters:

value - value to set

Throws:

IllegalStateException - if the component is not usable

IllegalArgumentException - if the value is one the user could not have typed

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 TextFieldTester.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 TextFieldTester.clickClearButton().

Throws:

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