Class ContextMenuTester

    • 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
      ContextMenuTester(T component) Wrap given component for testing.
    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
    • Method Summary

      Modifier and Type Method Description
      void open() Opens the context menu, as if the action is done in the browser.
      void close() Closes the context menu.
      void clickItem(String topLevelText, Array<String> nestedItemsText) Simulates a click on the item that matches the given text.
      void clickItem(int topLevelPosition, Array<int> nestedItemsPositions) Simulates a click on the item at the given position in the menu.
      boolean isItemChecked(String topLevelText, Array<String> nestedItemsText) Checks if the checkable menu item matching given text is checked.
      boolean isItemChecked(int topLevelPosition, Array<int> nestedItemsPositions) Checks if the checkable menu item at given position is checked.
      • Methods inherited from class com.vaadin.testbench.unit.ComponentTester

        find, getComponent, isUsable, setModal
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • ContextMenuTester

        ContextMenuTester(T component)
        Wrap given component for testing.
        Parameters:
        component - target component
    • Method Detail

      • open

         void open()

        Opens the context menu, as if the action is done in the browser. It simulates for example a right click on a UI component with an assigned ContextMenu.

      • close

         void close()

        Closes the context menu.

      • clickItem

         void clickItem(String topLevelText, Array<String> nestedItemsText)

        Simulates a click on the item that matches the given text. For nested menu item provide the text of each menu item in the hierarchy. The path to the menu item must reflect what is seen in the browser, meaning that hidden items are ignored.

        
        
        menu.addItem("Preview", event -> {});
        var subMenu = menu.addItem("Share").getSubMenu();
        subMenu.addItem("Copy link", event -> {});
        subMenu.addItem("Email", event -> {});
        
        // clicks top level menu item with text Preview
        tester.clickItem("Preview");
        
        // clicks nested  menu item with text Email
        tester.clickItem("Share", "Email");
        
        Parameters:
        topLevelText - the text content of the top level menu item, not null.
        nestedItemsText - text content of the nested menu items
      • clickItem

         void clickItem(int topLevelPosition, Array<int> nestedItemsPositions)

        Simulates a click on the item at the given position in the menu. For nested menu item provide the position of each sub menu that should be navigated to reach the request item. The position reflects what is seen in the browser, so hidden items are ignored.

        
        
        menu.addItem("Preview", event -> {});
        var subMenu = menu.addItem("Share").getSubMenu();
        subMenu.addItem("Copy link", event -> {});
        subMenu.addItem("Email", event -> {});
        
        // clicks top level "Preview" menu item at position 0
        tester.clickItem(0);
        
        // clicks then nested menu item at position 1 "Email" through the
        // item "Share" at position 1
        tester.clickItem(1, 1);
        
        Parameters:
        topLevelPosition - the zero-based position of the item in the menu, as it will be seen in the browser.
        nestedItemsPositions - the zero-based position of the nested items, relative to the parent menu
      • isItemChecked

         boolean isItemChecked(String topLevelText, Array<String> nestedItemsText)

        Checks if the checkable menu item matching given text is checked. For nested menu item provide the text of each menu item in the hierarchy. The path to the menu item must reflect what is seen in the browser, meaning that hidden items are ignored.

        
        
        menu.addItem("Preview", event -> {}).setCheckable(true);
        var subMenu = menu.addItem("Share").getSubMenu();
        subMenu.addItem("Copy link", event -> {}).setCheckable(true);
        subMenu.addItem("Email", event -> {}).setCheckable(true);
        
        tester.isItemChecked("Preview");
        
        tester.isItemChecked("Share", "Email");
        
        Parameters:
        topLevelText - the text content of the top level menu item, not null.
        nestedItemsText - text content of the nested menu items
        Returns:

        true if the item at given path is checked, otherwise false.

      • isItemChecked

         boolean isItemChecked(int topLevelPosition, Array<int> nestedItemsPositions)

        Checks if the checkable menu item at given position is checked. For nested menu item provide the position of each sub menu that should be navigated to reach the requested item. The position reflects what is seen in the browser, so hidden items are ignored.

        
        
        menu.addItem("Preview", event -> {}).setCheckable(true);
        var subMenu = menu.addItem("Share").getSubMenu();
        subMenu.addItem("Copy link", event -> {}).setCheckable(true);
        subMenu.addItem("Email", event -> {}).setCheckable(true);
        
        // checks top level "Preview" menu item at position 0
        tester.isItemChecked(0);
        
        // checks  nested menu item at position 1 "Email" through the
        // item "Share" at position 1
        tester.isItemChecked(1, 1);
        
        Parameters:
        topLevelPosition - the zero-based position of the item in the menu, as it will be seen in the browser.
        nestedItemsPositions - the zero-based position of the nested items, relative to the parent menu