Package com.vaadin.flow.component.html

Class RangeInputLocator

java.lang.Object

com.vaadin.browserless.locator.Locator<RangeInput,RangeInputLocator>

com.vaadin.flow.component.html.RangeInputLocator

All Implemented Interfaces:

Clickable<RangeInput>, HasAriaLabelFilter<RangeInput,RangeInputLocator>, HasValueFilter<RangeInput,Double,RangeInputLocator>

@Generated("com.vaadin.browserless.locator.processor.LocatorProcessor")
public class RangeInputLocator
extends Locator<RangeInput,RangeInputLocator>
implements Clickable<RangeInput>, HasAriaLabelFilter<RangeInput,RangeInputLocator>, HasValueFilter<RangeInput,Double,RangeInputLocator>

Generated locator for RangeInput, derived from RangeInputTester. 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
RangeInputLocator()
RangeInputLocator(RangeInput component)

Method Summary

Modifier and Type	Method	Description
void	decrease()	Decreases the value by the amount defined by component step.
void	decrease(int times)	Decreases the value by a specified multiple of the component step setting.
void	ensureComponentIsUsable()	Ensures the component is in a usable state before interaction.
RangeInput	getComponent()	Gets the component being tested.
Double	getValue()	Get the current value of the component.
void	increase()	Increase the value by the amount defined by component step.
void	increase(int times)	Increases the value by a specified multiple of the component step setting.
void	setValue(Double 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, withoutAttribute, withoutAttribute, withoutClassName

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

withValue

Constructor Details

RangeInputLocator

public RangeInputLocator()

RangeInputLocator

public RangeInputLocator(RangeInput component)

Method Details

getComponent

public RangeInput getComponent()

Description copied from interface: Clickable

Gets the component being tested.

Specified by:

getComponent in interface Clickable<RangeInput>

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

getValue

public Double getValue()

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

Returns:

current component value

Throws:

IllegalStateException - if component not visible

setValue

public void setValue(Double 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.

The value must be in the component min - max range, and should be valid according to the step scale factor, otherwise an IllegalArgumentException is thrown. Javadoc copied from RangeInputTester.setValue(java.lang.Double).

Parameters:

value - value to set

Throws:

IllegalStateException - if component is not interactable

IllegalArgumentException - if the value is not valid based on min, max and step settings.

increase

public void increase()

Increase the value by the amount defined by component step.

If the step is not defined, an IllegalStateException is thrown. An IllegalArgumentException is thrown if increase operation exceeds the max boundaries. Javadoc copied from RangeInputTester.increase().

Throws:

IllegalStateException - if component is not interactable or the step is not defined.

increase

public void increase(int times)

Increases the value by a specified multiple of the component step setting.

If the step is not defined, an IllegalStateException is thrown. An IllegalArgumentException is thrown if increase operation exceeds the max boundaries. Javadoc copied from RangeInputTester.increase(int).

Parameters:

times - The number of times the component step value should be multiplied before adding to the component value. Must be a non-negative integer.

Throws:

IllegalArgumentException - If the times parameter is a negative integer.

IllegalStateException - if component is not interactable or the step is not defined.

decrease

public void decrease()

Decreases the value by the amount defined by component step.

If the step is not defined, an IllegalStateException is thrown. An IllegalArgumentException is thrown if increase operation exceeds the min boundaries. Javadoc copied from RangeInputTester.decrease().

Throws:

IllegalStateException - if component is not interactable or the step is not defined.

decrease

public void decrease(int times)

Decreases the value by a specified multiple of the component step setting.

If the step is not defined, an IllegalStateException is thrown. An IllegalArgumentException is thrown if increase operation exceeds the min boundaries. Javadoc copied from RangeInputTester.decrease(int).

Parameters:

times - The number of times the component step value should be multiplied before subtracting from the component value. Must be a non-negative integer.

Throws:

IllegalArgumentException - If the times parameter is a negative integer.

IllegalStateException - if component is not interactable or the step is not defined.