com.vaadin.flow.component.virtuallist.
Class VirtualListTester<T extends VirtualList<Y>,Y>
Type Parameters:
T
- component type
Y
- value type
Tester for VirtualList components.
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptiongetItem
(int index) Get the item at the given index.
getItemComponent
(int index) Get an initialized copy of the component for the item.
getItemText
(int index) Get the text that is shown on the client for the item at index.
<V> V
getLitRendererPropertyValue
(int index, String propertyName, Class<V> propertyClass) Get property value for item's LitRenderer.
void
invokeLitRendererFunction
(int index, String functionName) Invoke named function for item's LitRenderer.
void
invokeLitRendererFunction
(int index, String functionName, elemental.json.JsonArray jsonArray) Invoke named function for item's LitRenderer using the supplied JSON arguments.
int
size()
Get the amount of items in the virtual list.
Methods inherited from class com.vaadin.testbench.unit.ComponentTester
ensureComponentIsUsable, ensureComponentIsUsable, ensureVisible, ensureVisible, find, findAllByQuery, findByQuery, fireDomEvent, fireDomEvent, fireDomEvent, getComponent, getField, getField, getMethod, getMethod, isUsable, isUsable, notUsableReasons, notUsableReasons, roundTrip, setModal
-
Constructor Details
-
VirtualListTester
Wrap given component for testing.
Parameters:
component
- target component
-
-
Method Details
-
size
public int size()Get the amount of items in the virtual list.
Returns:
number of items in the virtual list
-
getItem
Get the item at the given index.
Parameters:
index
- the zero-based index of the item to getReturns:
virtual list item at index
-
getItemText
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.
Parameters:
index
- the zero-based index of the itemReturns:
item content that is sent to the client
-
getItemComponent
Get an initialized copy of the component for the item.
Note, this is not the actual component.
Parameters:
index
- the zero-based index of the itemReturns:
initialized component for the target item
Throws:
IllegalArgumentException
- when the VirtualList is not using a ComponentRenderer -
getLitRendererPropertyValue
Get property value for item's LitRenderer.
Type Parameters:
V
- the type of the LitRenderer propertyParameters:
index
- the zero-based index of the itempropertyName
- the name of the LitRenderer propertypropertyClass
- the class of the value of the LitRenderer propertyReturns:
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, elemental.json.JsonArray jsonArray) Invoke named function for item's LitRenderer using the supplied JSON arguments.
Parameters:
index
- the zero-based index of the itemfunctionName
- the name of the LitRenderer function to invokejsonArray
- the arguments to pass to the functionThrows:
IllegalArgumentException
- when the VirtualList is not using a LitRendererSee Also:
-
invokeLitRendererFunction
Invoke named function for item's LitRenderer.
Parameters:
index
- the zero-based index of the itemfunctionName
- the name of the LitRenderer function to invokeThrows:
IllegalArgumentException
- when the VirtualList is not using a LitRendererSee Also:
-