Package com.vaadin.flow.component.checkbox

Class CheckboxTester

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

    Tester for Checkbox components.

    Since:

    1.0

    • 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
      CheckboxTester(T component) Wrap given component for testing.

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description

    • Method Summary

      Modifier and Type Method Description
      boolean isChecked() Checks whether the checkbox is currently checked.
      void check() Checks the checkbox by clicking it, as a user would.
      void uncheck() Unchecks the checkbox 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

      • CheckboxTester

        CheckboxTester(T component)

        Wrap given component for testing.

        Parameters:
        component - target component

    • Method Detail

      • isChecked

         boolean isChecked()

        Checks whether the checkbox is currently checked.

        Returns:

        true if the checkbox is checked, false otherwise

        Since:

        25.3

      • check

         void check()

        Checks the checkbox by clicking it, as a user would.

        Does nothing if the checkbox is already checked, since a user would not click it in that case. The checkbox must be usable either way.

        Since:

        25.3

      • uncheck

         void uncheck()

        Unchecks the checkbox by clicking it, as a user would.

        Does nothing if the checkbox is already unchecked, since a user would not click it in that case. The checkbox must be usable either way.

        Since:

        25.3

      • 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