SwitchTester

All Implemented Interfaces:: com.vaadin.browserless.Clickable


public class SwitchTester<T extends Switch>
extends ComponentTester<T>

Tester for Switch components.

Since:: 25.3

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description

Field Summary

Fields
Modifier and Type	Field	Description
`public final T`	`component`

Constructor Summary

Constructors
Constructor	Description
`SwitchTester(T component)`	Wrap given component for testing.

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`boolean`	`isOn()`	Checks whether the switch is currently on.
`void`	`switchOn()`	Switches the switch on by clicking it, as a user would.
`void`	`switchOff()`	Switches the switch off by clicking it, as a user would.
`boolean`	`isUsable()`	Validate that component can be interacted with and should be visible in the UI.
`void`	`click(int button, MetaKeys metaKeys)`	Performs a click with the specified button and meta keys.

Methods inherited from class com.vaadin.browserless.ComponentTester
blur, ensureComponentIsUsable, find, focus, getComponent, isFocused, setModal
Methods inherited from class com.vaadin.browserless.Clickable
click, click, middleClick, middleClick, rightClick, rightClick
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - SwitchTester
```
SwitchTester(T component)
```
    Wrap given component for testing.
    
    Parameters:
    
    component - target component
- Method Detail
  - isOn
```
 boolean isOn()
```
    Checks whether the switch is currently on.
    
    Returns:
    
    true if the switch is on, false otherwise
  - switchOn
```
 void switchOn()
```
    Switches the switch on by clicking it, as a user would.
    Does nothing if the switch is already on, since a user would not click it in that case. The switch must be usable either way.
  - switchOff
```
 void switchOff()
```
    Switches the switch off by clicking it, as a user would.
    Does nothing if the switch is already off, since a user would not click it in that case. The switch must be usable either way.
  - isUsable
```
 boolean isUsable()
```
    Validate that component can be interacted with and should be visible in the UI. Subclasses overriding this method should also override notUsableReasons to provide additional details to the potential exception thrown by ensureComponentIsUsable.
    
    Returns:
    
    true if component can be interacted with by the user
  - click
```
 void click(int button, MetaKeys metaKeys)
```
    Performs a click with the specified button and meta keys.
    
    Parameters:
    
    button - the mouse button (0=left, 1=middle, 2=right)
    
    metaKeys - the meta keys pressed during click