Package com.vaadin.flow.component.virtuallist

Class VirtualListLocator<Y>

java.lang.Object
com.vaadin.browserless.locator.Locator<VirtualList<Y>,VirtualListLocator<Y>>
com.vaadin.flow.component.virtuallist.VirtualListLocator<Y>
All Implemented Interfaces:
Clickable<VirtualList<Y>>
@Generated("com.vaadin.browserless.locator.processor.LocatorProcessor") public class VirtualListLocator<Y> extends Locator<VirtualList<Y>,VirtualListLocator<Y>> implements Clickable<VirtualList<Y>>
Generated locator for VirtualList, derived from VirtualListTester. 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

    • VirtualListLocator

      public VirtualListLocator(Class<Y> yType)

    • VirtualListLocator

      public VirtualListLocator(VirtualList<Y> component)

  • Method Details

    • getComponent

      public VirtualList<Y> getComponent()
      Description copied from interface: Clickable
      Gets the component being tested.
      Specified by:
      getComponent in interface Clickable<Y>
      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<Y>

    • size

      public int size()
      Get the amount of items in the virtual list. Javadoc copied from VirtualListTester.size().
      Returns:
      number of items in the virtual list

    • getItem

      public Y getItem(int index)
      Get the item at the given index. Javadoc copied from VirtualListTester.getItem(int).
      Parameters:
      index - the zero-based index of the item to get
      Returns:
      virtual list item at index

    • getItemText

      public String getItemText(int index)
      Get the text that is shown on the client for the item at index.

      The index is zero-based.

      For the default renderer ColumnPathRenderer the result is the sent text for defined object path.

      For a ComponentRenderer the result is the rendered component as prettyString.

      More to be added as we find other renderers that need handling. Javadoc copied from VirtualListTester.getItemText(int).

      Parameters:
      index - the zero-based index of the item
      Returns:
      item content that is sent to the client

    • getItemComponent

      public Component getItemComponent(int index)
      Get an initialized copy of the component for the item.

      Note, this is not the actual component. Javadoc copied from VirtualListTester.getItemComponent(int).

      Parameters:
      index - the zero-based index of the item
      Returns:
      initialized component for the target item
      Throws:
      IllegalArgumentException - when the VirtualList is not using a ComponentRenderer

    • getLitRendererPropertyValue

      public <V> V getLitRendererPropertyValue(int index, String propertyName, Class<V> propertyClass)
      Get property value for item's LitRenderer. Javadoc copied from VirtualListTester.getLitRendererPropertyValue(int,java.lang.String,java.lang.Class).
      Type Parameters:
      V - the type of the LitRenderer property
      Parameters:
      index - the zero-based index of the item
      propertyName - the name of the LitRenderer property
      propertyClass - the class of the value of the LitRenderer property
      Returns:
      value of the LitRenderer property
      Throws:
      IllegalArgumentException - when the VirtualList is not using a LitRenderer or when the given type of the property does not match the actual property type

    • invokeLitRendererFunction

      public void invokeLitRendererFunction(int index, String functionName, tools.jackson.databind.node.ArrayNode jsonArray)
      Invoke named function for item's LitRenderer using the supplied JSON arguments. Javadoc copied from VirtualListTester.invokeLitRendererFunction(int,java.lang.String,tools.jackson.databind.node.ArrayNode).
      Parameters:
      index - the zero-based index of the item
      functionName - the name of the LitRenderer function to invoke
      jsonArray - the arguments to pass to the function
      Throws:
      IllegalArgumentException - when the VirtualList is not using a LitRenderer
      See Also:

    • invokeLitRendererFunction

      public void invokeLitRendererFunction(int index, String functionName)
      Invoke named function for item's LitRenderer. Javadoc copied from VirtualListTester.invokeLitRendererFunction(int,java.lang.String).
      Parameters:
      index - the zero-based index of the item
      functionName - the name of the LitRenderer function to invoke
      Throws:
      IllegalArgumentException - when the VirtualList is not using a LitRenderer
      See Also: