Package com.vaadin.flow.component.checkbox.testbench

Class CheckboxGroupElement

  • All Implemented Interfaces:
    com.vaadin.testbench.commands.CanCompareScreenshots, com.vaadin.testbench.HasCallFunction, com.vaadin.testbench.HasDriver, com.vaadin.testbench.HasElementQuery, com.vaadin.testbench.HasHelper, com.vaadin.testbench.HasPropertySettersGetters, com.vaadin.testbench.HasSearchContext, com.vaadin.testbench.HasTestBenchCommandExecutor, org.openqa.selenium.SearchContext, org.openqa.selenium.TakesScreenshot, org.openqa.selenium.WebElement, org.openqa.selenium.WrapsElement
    public class CheckboxGroupElement
extends com.vaadin.testbench.TestBenchElement
implements com.vaadin.testbench.HasHelper

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void deselectByText​(String label)
      Attempts to deselect a checkbox that is currently selected, by matching the label.
      List<CheckboxElement> getCheckboxes()
      Gets all checkboxes that are part of this group.
      com.vaadin.testbench.TestBenchElement getErrorMessageComponent()
      Gets the slotted error message component for the element.
      List<String> getOptions()
      Gets the labels of checkboxes that are part of this group.
      List<String> getSelectedTexts()
      Gets the labels of the currently selected checkboxes.
      void selectByText​(String label)
      Attempts to select a checkbox by matching the label.

      • Methods inherited from class com.vaadin.testbench.TestBenchElement

        callFunction, clear, click, click, compareScreen, compareScreen, compareScreen, contextClick, dispatchEvent, dispatchEvent, doubleClick, equals, executeScript, findElement, findElements, focus, getAttribute, getCapabilities, getClassNames, getCommandExecutor, getContext, getCssValue, getDriver, getLocation, getProperty, getPropertyBoolean, getPropertyDouble, getPropertyElement, getPropertyElements, getPropertyInteger, getPropertyString, getRect, getScreenshotAs, getSize, getTagName, getText, getWrappedElement, hasAttribute, hasClassName, hashCode, init, init, isChrome, isDisplayed, isEnabled, isFirefox, isSelected, scroll, scrollIntoView, scrollLeft, sendKeys, setProperty, setProperty, setProperty, setProperty, submit, waitForVaadin, waitUntil, waitUntil, wrap, wrapElement, wrapElements

      • Methods inherited from interface com.vaadin.testbench.HasElementQuery

        $, $

      • Methods inherited from interface com.vaadin.testbench.HasHelper

        getHelperComponent, getHelperText

      • Methods inherited from interface com.vaadin.testbench.HasPropertySettersGetters

        getProperty, getPropertyBoolean, getPropertyDouble, getPropertyElement, getPropertyElements, getPropertyInteger, getPropertyString, setProperty, setProperty, setProperty, setProperty

      • Methods inherited from interface com.vaadin.testbench.HasSearchContext

        getContext

      • Methods inherited from interface org.openqa.selenium.TakesScreenshot

        getScreenshotAs

      • Methods inherited from interface org.openqa.selenium.WebElement

        clear, click, findElement, findElements, getAccessibleName, getAriaRole, getAttribute, getCssValue, getDomAttribute, getDomProperty, getLocation, getRect, getShadowRoot, getSize, getTagName, getText, isDisplayed, isEnabled, isSelected, sendKeys, submit

    • Constructor Detail

      • CheckboxGroupElement

        public CheckboxGroupElement()

    • Method Detail

      • getOptions

        public List<String> getOptions()
        Gets the labels of checkboxes that are part of this group.
        Returns:
        a list of the labels

      • getCheckboxes

        public List<CheckboxElement> getCheckboxes()
        Gets all checkboxes that are part of this group.
        Returns:
        a list of the checkboxes

      • selectByText

        public void selectByText​(String label)
        Attempts to select a checkbox by matching the label. If it is selected does nothing.
        Parameters:
        label - the label of the checkbox to select
        Throws:
        NoSuchElementException - if no matching label was found

      • deselectByText

        public void deselectByText​(String label)
        Attempts to deselect a checkbox that is currently selected, by matching the label. Does nothing if the checkbox is not selected.
        Parameters:
        label - the label of the checkbox to select
        Throws:
        NoSuchElementException - if no matching label was found

      • getSelectedTexts

        public List<String> getSelectedTexts()
        Gets the labels of the currently selected checkboxes.
        Returns:
        the labels of the currently selected checkboxes

      • getErrorMessageComponent

        public com.vaadin.testbench.TestBenchElement getErrorMessageComponent()
        Gets the slotted error message component for the element.
        Returns:
        the slotted component or null if there is no component