Package com.vaadin.flow.component.tabs

Class TabsTester<T extends Tabs>

java.lang.Object

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

com.vaadin.flow.component.tabs.TabsTester<T>

Type Parameters:

T - component type

public class TabsTester<T extends Tabs>
extends ComponentTester<T>

Tester for Tabs components.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
Tab	getTab(int index)	Gets the visible tab at given index.
Tab	getTab(String label)	Gets the visible tab with the given label.
boolean	isSelected(int index)	Checks if the visible tab at the given index is currently selected.
boolean	isSelected(String label)	Checks if the tab with the given label is currently selected.
void	select(int index)	Selects a visible tab based on its zero-based index.
void	select(String label)	Selects the tab with the given label.

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

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

Methods inherited from class java.lang.Object

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

Constructor Details

TabsTester

public TabsTester(T component)

Wrap given component for testing.

Parameters:

component - target component

Method Details

select

public void select(String label)

Selects the tab with the given label.

Parameters:

label - the tab label

select

public void select(int index)

Selects a visible tab based on its zero-based index.

The index refers to the zero-base position of the currently visible tabs. For example, if there are three tabs A (position 0), B (position 1) and C (position 2), but tab 'B' is hidden, then to select tab 'C', the call must be select(1) and not select(2).

Parameters:

index - the zero-based index of the selected tab, negative value to unselect

Throws:

IllegalStateException - if tab at given index is not visible in the browser

IllegalArgumentException - if the index is less than zero or greater than the number of visible tabs.

isSelected

public boolean isSelected(String label)

Checks if the tab with the given label is currently selected.

Parameters:

label - the tab label

Returns:

true if the tab is selected, false otherwise.

isSelected

public boolean isSelected(int index)

Checks if the visible tab at the given index is currently selected.

The index refers to the zero-base position of the currently visible tabs. For example, if there are three tabs A (position 0), B (position 1) and C (position 2), but tab 'B' is hidden, then to check if tab 'C' is selected, the call must be isSelected(1) and not isSelected(2).

Parameters:

index - the zero-based index of the tab

Returns:

true if the tab is selected, false otherwise.

Throws:

IllegalStateException - if tab at given index is not visible in the browser

IllegalArgumentException - if the index is less than zero or greater than the number of visible tabs.

getTab

public Tab getTab(String label)

Gets the visible tab with the given label.

Parameters:

label - the tab label

Throws:

IllegalStateException - if tab is not visible

getTab

public Tab getTab(int index)

Gets the visible tab at given index.

The index refers to the zero-base position of the currently visible tabs. For example, if there are three tabs A (position 0), B (position 1) and C (position 2), but tab 'B' is hidden, then to get tab 'C', the call must be getTab(1) and not getTab(2).

Parameters:

index - the zero-based index of the selected tab, negative value to unselect

Throws:

IllegalStateException - if tab at given index is not visible in the browser

IllegalArgumentException - if the index is less than zero or greater than the number of visible tabs.