Package com.vaadin.flow.component.checkbox

Class CheckboxTester<T extends Checkbox>

java.lang.Object

com.vaadin.testbench.unit.ComponentTester<T>

com.vaadin.flow.component.checkbox.CheckboxTester<T>

Type Parameters:

T - component type

public class CheckboxTester<T extends Checkbox>
extends ComponentTester<T>

Tester for Checkbox components.

Constructor Summary

Constructors

Constructor	Description
CheckboxTester(T component)	Wrap given component for testing.

Method Summary

Modifier and Type	Method	Description
void	click()	If the component is usable, send click to component as if it was from the client.
boolean	isUsable()	Validate that component can be interacted with and should be visible in the UI.
protected void	notUsableReasons(Consumer<String> collector)	Provides messages explaining why the component is actually not usable.

Methods inherited from class com.vaadin.testbench.unit.ComponentTester

ensureComponentIsUsable, ensureVisible, find, findAllByQuery, findByQuery, fireDomEvent, fireDomEvent, fireDomEvent, getComponent, getField, getField, getMethod, getMethod, roundTrip, setModal

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

CheckboxTester

public CheckboxTester(T component)

Wrap given component for testing.

Parameters:

component - target component

Method Details

isUsable

public boolean isUsable()

Description copied from class: ComponentTester

Validate that component can be interacted with and should be visible in the UI. Subclasses overriding this method should also override ComponentTester.notUsableReasons(Consumer) to provide additional details to the potential exception thrown by ComponentTester.ensureComponentIsUsable().

Overrides:

isUsable in class ComponentTester<T extends Checkbox>

Returns:

true if component can be interacted with by the user

See Also:

• ComponentTester.notUsableReasons(Consumer)
• ComponentTester.ensureComponentIsUsable()

notUsableReasons

protected void notUsableReasons(Consumer<String> collector)

Description copied from class: ComponentTester

Provides messages explaining why the component is actually not usable. Subclasses overriding ComponentTester.isUsable() should also override this method to provide additional details to the potential exception throw by ComponentTester.ensureComponentIsUsable().

Overrides:

notUsableReasons in class ComponentTester<T extends Checkbox>

See Also:

• ComponentTester.isUsable()
• ComponentTester.ensureComponentIsUsable()

click

public void click()

If the component is usable, send click to component as if it was from the client. Checkbox status changes from unchecked to checked or vice versa.