Package com.vaadin.flow.component.contextmenu

Class ContextMenuTester<T extends ContextMenu>

java.lang.Object
com.vaadin.testbench.unit.ComponentTester<T>
com.vaadin.flow.component.contextmenu.ContextMenuTester<T>
Type Parameters:
T - component type
All Implemented Interfaces:
Clickable<T>
public class ContextMenuTester<T extends ContextMenu> extends ComponentTester<T>
Tester for ContextMenu components.

  • Constructor Details

    • ContextMenuTester

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

  • Method Details

    • open

      public 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.

      It does not render any client-side overlay. In other words, it only simulates the server-side state changes that would occur when a user opens the menu in the browser.

      Calling open() is not required before using clickItem(...) or find(Class) methods. Those methods operate on the server component state and can be used regardless of the menu opened state. Use open() only if you want to explicitly simulate the act of opening.

      Throws:
      IllegalStateException - if the menu is already opened.

    • close

      public void close()
      Closes the context menu.

    • clickItem

      public void clickItem(String topLevelText, String... nestedItemsText)
      Simulates a click on the item that matches the given text. For a 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. If there are multiple visible items at the same level with the same text, an IllegalStateException is thrown because the target is ambiguous. Disabled or invisible items cannot be clicked and will also cause an IllegalStateException. 
       

 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");
      Note: Opening the menu via open() is not required before invoking this method; the lookup operates on server-side state.
      Parameters:
      topLevelText - the text content of the top level menu item, not null.
      nestedItemsText - text content of the nested menu items
      Throws:
      IllegalArgumentException - if the provided text does not identify a menu item.
      IllegalStateException - if there are multiple matching items at any level, or if the item at the given path is disabled or not visible.

    • clickItem

      public void clickItem(int topLevelPosition, int... nestedItemsPositions)
      Simulates a click on the item at the given position in the menu. For a nested menu item, provide the position of each sub menu that should be navigated to reach the requested item. Positions are zero-based and refer only to items that are visible at each menu level, i.e. hidden items are ignored (the same way as in the browser). Disabled or invisible items cannot be clicked and will cause an IllegalStateException. 
       

 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);
      Note: Opening the menu via open() is not required before invoking this method; the lookup operates on server-side state.
      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
      Throws:
      IllegalArgumentException - if the provided position does not identify a menu item.
      IllegalStateException - if the item at the given position is disabled or not visible.

    • isItemChecked

      public boolean isItemChecked(String topLevelText, 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.
      Throws:
      IllegalArgumentException - if the provided text does not identify a menu item or if the menu item is not checkable.
      IllegalStateException - if the item at given path is not usable.

    • isItemChecked

      public boolean isItemChecked(int topLevelPosition, 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
      Throws:
      IllegalArgumentException - if the provided position does not identify a menu item or if the menu item is not checkable.
      IllegalStateException - if the item at given position is not usable.

    • find

      public <R extends Component> ComponentQuery<R> find(Class<R> componentType)
      Gets a ComponentQuery to search for component of the given type nested inside the wrapped component.

      Can be used to find components in the context menu. Returned components are in a detached state unless open() has been called previously. Example usage: 

       // view:
 ContextMenu menu = new ContextMenu();
 menu.addItem(new VerticalLayout(new Div("Component Item")),
         click -> clickedItems.add("Component Item"));

 // test:
 ContextMenuTester menuTester = test(view.menu);
 menuTester.open();
 Div div = menuTester.find(Div.class).withText("Component Item").single();
 Assertions.assertTrue(div.isAttached());

 menuTester.close();
 div = menuTester.find(Div.class).withText("Component Item").single();
 Assertions.assertFalse(div.isAttached());
      Overrides:
      find in class ComponentTester<T extends ContextMenu>
      Type Parameters:
      R - type of the component to search.
      Parameters:
      componentType - type of the component to search.
      Returns:
      a ComponentQuery instance, searching for wrapped component children.