Package com.vaadin.flow.component.checkbox

Class CheckboxGroupTester<T extends CheckboxGroup<V>,V>

java.lang.Object

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

com.vaadin.flow.component.checkbox.CheckboxGroupTester<T,V>

Type Parameters:

T - component type

public class CheckboxGroupTester<T extends CheckboxGroup<V>,V>
extends ComponentTester<T>

Tester for CheckboxGroup components.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
void	deselectAll()	Deselects all client usable items.
void	deselectItem(String selection)	Deselects an item by its client string representation.
void	deselectItems(String... selection)	Deselects multiple items by client string representation.
void	deselectItems(Collection<String> selection)	Deselects items by client string representation.
Set<V>	getSelected()	Get the list of currently selected items.
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.
void	selectAll()	Selects all client usable items.
void	selectItem(String selection)	Selects an item by its client string representation.
void	selectItems(String... selection)	Selects multiple items by client string representation.
void	selectItems(Collection<String> selection)	Selects multiple items by client string representation.
void	updateSelection(Collection<String> selection, BiConsumer<Collection<V>,Collection<V>> updater)

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

CheckboxGroupTester

public CheckboxGroupTester(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 CheckboxGroup<V>>

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 CheckboxGroup<V>>

See Also:

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

selectItem

public void selectItem(String selection)

Selects an item by its client string representation.

Parameters:

selection - item string representation

selectItems

public void selectItems(String... selection)

Selects multiple items by client string representation.

Parameters:

selection - items string representation

selectItems

public void selectItems(Collection<String> selection)

Selects multiple items by client string representation.

Parameters:

selection - items string representation

selectAll

public void selectAll()

Selects all client usable items.

deselectItem

public void deselectItem(String selection)

Deselects an item by its client string representation.

Parameters:

selection - item string representation

deselectItems

public void deselectItems(String... selection)

Deselects multiple items by client string representation.

Parameters:

selection - items string representation

deselectItems

public void deselectItems(Collection<String> selection)

Deselects items by client string representation.

Parameters:

selection - items string representation

deselectAll

public void deselectAll()

Deselects all client usable items.

getSelected

public Set<V> getSelected()

Get the list of currently selected items.

Returns:

current selection, or an empty list. Never null.

updateSelection

public void updateSelection(Collection<String> selection,
 BiConsumer<Collection<V>,Collection<V>> updater)