Package com.vaadin.flow.component.sidenav

Class SideNavLocator

java.lang.Object
com.vaadin.browserless.locator.Locator<SideNav,SideNavLocator>
com.vaadin.flow.component.sidenav.SideNavLocator
All Implemented Interfaces:
Clickable<SideNav>, HasThemeFilter<SideNav,SideNavLocator>
@Generated("com.vaadin.browserless.locator.processor.LocatorProcessor") public class SideNavLocator extends Locator<SideNav,SideNavLocator> implements Clickable<SideNav>, HasThemeFilter<SideNav,SideNavLocator>
Generated locator for SideNav, derived from SideNavTester. Filter steps are inherited from Locator; action methods delegate to a fresh tester around the resolved component, so behavioral changes belong on the tester, not here.

  • Constructor Details

    • SideNavLocator

      public SideNavLocator()

    • SideNavLocator

      public SideNavLocator(SideNav component)

  • Method Details

    • getComponent

      public SideNav getComponent()
      Description copied from interface: Clickable
      Gets the component being tested.
      Specified by:
      getComponent in interface Clickable<SideNav>
      Returns:
      the component under test

    • ensureComponentIsUsable

      public void ensureComponentIsUsable()
      Description copied from interface: Clickable
      Ensures the component is in a usable state before interaction.
      Specified by:
      ensureComponentIsUsable in interface Clickable<SideNav>

    • clickItem

      public void clickItem(String topLevelLabel, String... nestedItemLabels)
      Simulates a click on the item that matches the given label. For nested navigation item provide the label of each item in the hierarchy. The path to the navigation item must reflect what is seen in the browser, meaning that hidden items are ignored. For the same reason, items inside collapsed nodes cannot be clicked and an exception is thrown. Use expandAndClickItem(String, String...) to expand intermediate node and click on the desired item. 
       

 sideNav.addItem(new SideNavItem("Home", HomeView.class));
 SideNavItem childNav = new SideNavItem("Messages");
 childNav.addItem(new SideNavItem("Inbox", InboxView.class));
 childNav.addItem(new SideNavItem("Sent", SentView.class));
 sideNav.addItem(childNav);

 // clicks top level navigation item with label Home
 tester.clickItem("Home");

 // clicks nested navigation item with label Sent
 wrapper.clickItem("Messages", "Sent");
      Javadoc copied from SideNavTester.clickItem(java.lang.String,java.lang.String[]).
      Parameters:
      topLevelLabel - the text content of the top level SideNav item label, not null.
      nestedItemLabels - labels of the nested SideNav items
      Throws:
      IllegalArgumentException - if the provided text does not identify a SideNav item.
      IllegalStateException - if the item at given path is not usable.
      See Also:

    • expandAndClickItem

      public void expandAndClickItem(String topLevelLabel, String... nestedItemLabels)
      Simulates a click on the item that matches the given label, expanding potential parent collapsed nodes. For nested navigation item provide the label of each item in the hierarchy. The path to the navigation item must reflect what is seen in the browser, meaning that hidden items are ignored. For the same reason, items inside collapsed nodes cannot be clicked and an exception is thrown. 
       

 sideNav.addItem(new SideNavItem("Home", HomeView.class));
 SideNavItem childNav = new SideNavItem("Messages");
 childNav.addItem(new SideNavItem("Inbox", InboxView.class));
 childNav.addItem(new SideNavItem("Sent", SentView.class));
 sideNav.addItem(childNav);

 // clicks nested navigation item with label Sent
 wrapper.expandAndClickItem("Messages", "Sent");
      Javadoc copied from SideNavTester.expandAndClickItem(java.lang.String,java.lang.String[]).
      Parameters:
      topLevelLabel - the text content of the top level SideNav item label, not null.
      nestedItemLabels - labels of the nested SideNav items
      Throws:
      IllegalArgumentException - if the provided text does not identify a SideNav item.
      IllegalStateException - if the item at given path is not usable.
      See Also:

    • click

      public void click()
      Simulates a click on the SideNav label, expanding or collapsing item list. Javadoc copied from SideNavTester.click().
      Specified by:
      click in interface Clickable<SideNav>
      Throws:
      IllegalStateException - if the SideNav component is not collapsible or not usable.
      See Also:

    • toggleItem

      public void toggleItem(String topLevelLabel, String... nestedItemLabels)
      Simulates a click on the item that matches the given label. For nested navigation item provide the label of each item in the hierarchy. The path to the navigation item must reflect what is seen in the browser, meaning that hidden items are ignored. For the same reason, items inside collapsed nodes cannot be clicked and an exception is thrown. Use expandAndClickItem(String, String...) to expand intermediate node and click on the desired item. 
       

 sideNav.addItem(new SideNavItem("Home", HomeView.class));
 SideNavItem childNav = new SideNavItem("Messages");
 childNav.addItem(new SideNavItem("Inbox", InboxView.class));
 childNav.addItem(new SideNavItem("Sent", SentView.class));
 sideNav.addItem(childNav);

 // clicks top level navigation item with label Home
 tester.clickItem("Home");

 // clicks nested navigation item with label Sent
 wrapper.clickItem("Messages", "Sent");
      Javadoc copied from SideNavTester.toggleItem(java.lang.String,java.lang.String[]).
      Parameters:
      topLevelLabel - the text content of the top level SideNav item label, not null.
      nestedItemLabels - labels of the nested SideNav items
      Throws:
      IllegalArgumentException - if the provided text does not identify a SideNav item.
      IllegalStateException - if the item at given path is not usable.
      See Also:

    • toggle

      public void toggle()
      Simulates a click on the SideNav toggle button, expanding or collapsing item list. Javadoc copied from SideNavTester.toggle().
      Throws:
      IllegalStateException - if the SideNav component is not collapsible or not usable.
      See Also: