Package com.vaadin.flow.component.checkbox

Class CheckboxGroupTester

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

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description

    • Method Summary

      Modifier and Type Method Description
      boolean isUsable() Validate that component can be interacted with and should be visible in the UI.
      void selectItem(String selection) Selects an item by its client string representation.
      void selectItems(Array<String> selection) Selects multiple items by client string representation.
      void selectItems(Collection<String> selection) Selects multiple items by client string representation.
      void selectAll() Selects all client usable items.
      void deselectItem(String selection) Deselects an item by its client string representation.
      void deselectItems(Array<String> selection) Deselects multiple items by client string representation.
      void deselectItems(Collection<String> selection) Deselects items by client string representation.
      void deselectAll() Deselects all client usable items.
      Set<V> getSelected() Get the list of currently selected items.
      void updateSelection(Collection<String> selection, BiConsumer<Collection<V>, Collection<V>> updater)

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

        find, getComponent, setModal

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • CheckboxGroupTester

        CheckboxGroupTester(T component)
        Wrap given component for testing.
        Parameters:
        component - target component

    • Method Detail

      • 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

      • selectItem

         void selectItem(String selection)

        Selects an item by its client string representation.

        Parameters:
        selection - item string representation

      • selectItems

         void selectItems(Array<String> selection)

        Selects multiple items by client string representation.

        Parameters:
        selection - items string representation

      • selectItems

         void selectItems(Collection<String> selection)

        Selects multiple items by client string representation.

        Parameters:
        selection - items string representation

      • selectAll

         void selectAll()

        Selects all client usable items.

      • deselectItem

         void deselectItem(String selection)

        Deselects an item by its client string representation.

        Parameters:
        selection - item string representation

      • deselectItems

         void deselectItems(Array<String> selection)

        Deselects multiple items by client string representation.

        Parameters:
        selection - items string representation

      • deselectItems

         void deselectItems(Collection<String> selection)

        Deselects items by client string representation.

        Parameters:
        selection - items string representation

      • deselectAll

         void deselectAll()

        Deselects all client usable items.

      • getSelected

         Set<V> getSelected()

        Get the list of currently selected items.

        Returns:

        current selection, or an empty list. Never null.