Package com.vaadin.flow.component.checkbox

Class SwitchTester

  • All Implemented Interfaces:
    com.vaadin.browserless.Clickable 
    
public class SwitchTester<T extends Switch>
extends ComponentTester<T>

    Tester for Switch components.

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

        ensureComponentIsUsable, find, getComponent, 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

      • 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