Package com.github.grossopa.selenium.component.mui.config

Class MuiConfig

  • public class MuiConfig
extends Object
    The root configuration for material UI components
    Since:
    1.0
    Author:
    Jack Yin

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static String ATTR_CLASS
      class attribute name

    • Constructor Summary

      Constructors 
      Constructor Description
      MuiConfig()  

    • Method Summary

      Modifier and Type Method Description
      org.openqa.selenium.By buttonLocator()
      For locating the button from direct parent container
      List<com.github.grossopa.selenium.core.component.WebComponent> findVisiblePopoverLayers​(com.github.grossopa.selenium.core.ComponentWebDriver driver, boolean includeMenu)
      Finds the currently visible Popover layers.
      String getIsCheckedCss()
      Gets the isChecked CSS.
      String getIsDisabledCss()
      Gets the isDisabled CSS.
      String getIsSelectedCss()
      Gets the isSelected CSS.
      String getRootCss​(String componentName)
      Builds the root component css name from the component name, it is used for determining the root node of all MUI component.
      boolean isChecked​(com.github.grossopa.selenium.core.component.WebComponent component)
      Checks whether the component has the checked css present.
      boolean isDisabled​(com.github.grossopa.selenium.core.component.WebComponent component)
      Checks whether the component has the disabled css present.
      boolean isSelected​(com.github.grossopa.selenium.core.component.WebComponent component)
      Checks whether the component has the selected css present.
      org.openqa.selenium.By menuPagerLocator()
      Gets the Menu Pager elements inner the MuiPopover-root which is bound to a MuiMenu component.
      org.openqa.selenium.By popoverLocator()
      For locating the popover layer of current page.
      org.openqa.selenium.By radioLocator()
      For locating the radio from direct parent container
      org.openqa.selenium.By sliderThumbLocator()
      For locating the thumb element of the Slider.
      boolean validateByCss​(com.github.grossopa.selenium.core.component.WebComponent component, String cssName)
      Validates whether the given component / item is the desired component by checking the css present.
      boolean validateComponentByCss​(com.github.grossopa.selenium.core.component.WebComponent component, String componentName)
      Validates whether the given component is the desired component by checking the css present.

    • Constructor Detail

      • MuiConfig

        public MuiConfig()

    • Method Detail

      • buttonLocator

        public org.openqa.selenium.By buttonLocator()
        For locating the button from direct parent container
        Returns:
        the instance of button locator

      • radioLocator

        public org.openqa.selenium.By radioLocator()
        For locating the radio from direct parent container
        Returns:
        the instance of radio locator

      • popoverLocator

        public org.openqa.selenium.By popoverLocator()
        For locating the popover layer of current page.

        Default xpath: /html/body/div[contains(@class, 'MuiPopover')]

        Returns:
        the instance of popover locator

      • menuPagerLocator

        public org.openqa.selenium.By menuPagerLocator()
        Gets the Menu Pager elements inner the MuiPopover-root which is bound to a MuiMenu component.
        Returns:
        the Menu Pager elements inner the MuiPopover-root which is bound to a MuiMenu component.

      • sliderThumbLocator

        public org.openqa.selenium.By sliderThumbLocator()
        For locating the thumb element of the Slider.
        Returns:
        the instance of Slider thumb locator

      • isChecked

        public boolean isChecked​(com.github.grossopa.selenium.core.component.WebComponent component)
        Checks whether the component has the checked css present.
        Parameters:
        component - the component to check
        Returns:
        whether the checked css presents
        See Also:
        getIsCheckedCss()

      • isSelected

        public boolean isSelected​(com.github.grossopa.selenium.core.component.WebComponent component)
        Checks whether the component has the selected css present.
        Parameters:
        component - the component to check
        Returns:
        whether the selected css presents
        See Also:
        getIsSelectedCss()

      • isDisabled

        public boolean isDisabled​(com.github.grossopa.selenium.core.component.WebComponent component)
        Checks whether the component has the disabled css present.
        Parameters:
        component - the component to check
        Returns:
        whether the disabled css presents
        See Also:
        getIsDisabledCss()

      • getIsCheckedCss

        public String getIsCheckedCss()
        Gets the isChecked CSS. default value is "Mui-checked"
        Returns:
        the isChecked CSS

      • getIsSelectedCss

        public String getIsSelectedCss()
        Gets the isSelected CSS. default value is "Mui-selected"
        Returns:
        the isSelected CSS

      • getIsDisabledCss

        public String getIsDisabledCss()
        Gets the isDisabled CSS. default value is "Mui-disabled"
        Returns:
        the isDisabled CSS

      • getRootCss

        public String getRootCss​(String componentName)
        Builds the root component css name from the component name, it is used for determining the root node of all MUI component.
        Parameters:
        componentName - the component name in camel format
        Returns:
        the built css

      • validateComponentByCss

        public boolean validateComponentByCss​(com.github.grossopa.selenium.core.component.WebComponent component,
                                      String componentName)
        Validates whether the given component is the desired component by checking the css present.
        Parameters:
        component - the target component to check
        componentName - the component name
        Returns:
        true for the WebComponent is the desired component type
        See Also:
        getRootCss(String)

      • validateByCss

        public boolean validateByCss​(com.github.grossopa.selenium.core.component.WebComponent component,
                             String cssName)
        Validates whether the given component / item is the desired component by checking the css present.
        Parameters:
        component - the target component to check
        cssName - the expected css name
        Returns:
        true for the WebComponent is the desired component/ item type
        See Also:
        getRootCss(String)

      • findVisiblePopoverLayers

        public List<com.github.grossopa.selenium.core.component.WebComponent> findVisiblePopoverLayers​(com.github.grossopa.selenium.core.ComponentWebDriver driver,
                                                                                               boolean includeMenu)
        Finds the currently visible Popover layers.

        As of 2020-10, It seems that Menu component will by default produce a lot of presentation layers on the page no matter it's displayed or not, hence we need to explicitly exclude them from the search result sometimes for a more accurate searching for e.g. MuiSelect.

        Parameters:
        driver - the current driver
        includeMenu - whether should include the menu layer with child could be found by menuPagerLocator()
        Returns:
        the visible presentation layer