ElementQuery (Vaadin TestBench Core 5.4.1 API)

java.lang.Object
- com.vaadin.testbench.ElementQuery<T>

Type Parameters:

T - the type of the AbstractElement subclass representing a Vaadin component
```
public class ElementQuery<T extends AbstractElement>
extends Object
```
Descriptor class used for locating components. Different Element classes that extend AbstractElement class and have ServerClass annotation describing the server side class name of a Vaadin component are used by ElementQuery.
The typical end-user use case for a ElementQuery is as follows - in this example, we're looking for the fifth Vaadin Button from inside a TestBenchTestCase:
ButtonElement e = $(ButtonElement.class).index(4).first();
or
ButtonElement e = $(ButtonElement.class).all().get(4);

Second alternative results in slightly more network traffic. These two are not identical when you use search hierarchy. See the documentation for index(int).

For a more advanced example, we'll find the second Label inside a VerticalLayout inside a GridLayout:
LabelElement e = $(LabelElement.class).index(1).in(VerticalLayoutElement.class) .in(GridLayoutElement.class).first();
To find your own component, extend AbstractElement class and use ServerClass annotation to define it's full class name e.g. com.vaadin.example.MyWidget

Constructor Summary

Constructors
Constructor and Description

ElementQuery(Class<T> elementClass)
Instantiate a new ElementQuery for given type.

Constructors
Constructor and Description
`ElementQuery(Class<T> elementClass)` Instantiate a new ElementQuery for given type.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`<E extends AbstractElement> ElementQuery<E>`	`$(Class<E> cls)` Prepare a `ElementQuery` instance to use for locating components on the client.
`<E extends AbstractElement> ElementQuery<E>`	`$$(Class<E> cls)` Prepare a `ElementQuery` instance to use for locating components on the client.
`List<T>`	`all()` Search the open Vaadin application for a list of matching components relative to given context.
`ElementQuery<T>`	`caption(String caption)` Add a requirement to only accept components with a specified caption value.
`<E extends AbstractElement> ElementQuery<T>`	`child(ElementQuery<E> query)` Adds another query to the search hierarchy of this ElementQuery.
`ElementQuery<T>`	`context(org.openqa.selenium.SearchContext searchContext)` Specify a different `SearchContext` to use.
`boolean`	`exists()` Checks if this ElementQuery describes existing elements.
`T`	`first()` Search the open Vaadin application for a matching component relative to given context.
`protected String`	`generateQuery()` Generates a vaadin locator path.
`T`	`get(int index)` Search the open Vaadin application for a matching component relative to given context.
`protected org.openqa.selenium.SearchContext`	`getContext()` Return the `SearchContext` previously set with the `in(com.vaadin.testbench.ElementQuery<E>)` call.
`T`	`id(String id)` Executes a search for element with given ID.
`<E extends AbstractElement> ElementQuery<T>`	`in(ElementQuery<E> query)` Adds another query to the search hierarchy of this ElementQuery.
`ElementQuery<T>`	`index(int index)` Set an index requirement for the current ElementQuery.
`T`	`last()` Search the open Vaadin application for a matching component relative to given context.
`ElementQuery<T>`	`recursive(boolean recursion)` For advanced use.
`ElementQuery<T>`	`state(String varname, String value)` For advanced use.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - ElementQuery
```
public ElementQuery(Class<T> elementClass)
```
    Instantiate a new ElementQuery for given type.
    
    Parameters:
    
    elementClass - AbstractElement subclass
- Method Detail
  - recursive
```
public ElementQuery<T> recursive(boolean recursion)
```
    For advanced use. Set ElementQuery to either recursive search or a search starting directly from he context.
    
    Parameters:
    
    recursion - Boolean value. false for direct child search
    
    Returns:
    
    a reference to self
  - $
```
public <E extends AbstractElement> ElementQuery<E> $(Class<E> cls)
```
    Prepare a ElementQuery instance to use for locating components on the client. The returned object can be manipulated to uniquely identify the sought-after object. If this function gets called through an element, it uses the element as its search context. Otherwise the search context is the driver.
    
    Type Parameters:
    
    E - the type of the element class
    
    Parameters:
    
    cls - AbstractElement subclass
    
    Returns:
    
    an appropriate ElementQuery instance
  - $$
```
public <E extends AbstractElement> ElementQuery<E> $$(Class<E> cls)
```
    Prepare a ElementQuery instance to use for locating components on the client. The returned object can be manipulated to uniquely identify the sought-after object. If this function gets called through an element, it uses the element as its search context. Otherwise the search context is the driver. This search is not recursive and can find the given hierarchy only if it can be found as direct children of given context. The same can be done with $(Foo.class).recursive(false)
    
    Type Parameters:
    
    E - the type of the element class
    
    Parameters:
    
    cls - AbstractElement subclass
    
    Returns:
    
    an appropriate ElementQuery instance
  - in
```
public <E extends AbstractElement> ElementQuery<T> in(ElementQuery<E> query)
```
    Adds another query to the search hierarchy of this ElementQuery. This search is recursive.
    
    Type Parameters:
    
    E - the type of the element class
    
    Parameters:
    
    query - ElementQuery instance to be used as part of search hierarchy.
    
    Returns:
    
    a reference to self
  - child
```
public <E extends AbstractElement> ElementQuery<T> child(ElementQuery<E> query)
```
    Adds another query to the search hierarchy of this ElementQuery. This search is non-recursive. Only direct children are found.
    
    Type Parameters:
    
    E - the type of the element class
    
    Parameters:
    
    query - ElementQuery instance to be used as part of search hierarchy.
    
    Returns:
    
    a reference to self
  - id
```
public T id(String id)
```
    Executes a search for element with given ID.
    
    Parameters:
    
    id - a String value
    
    Returns:
    
    found element
  - caption
```
public ElementQuery<T> caption(String caption)
```
    Add a requirement to only accept components with a specified caption value. If query has a search hierarchy set with .in() or .childOf() the requirement is applied to the latest referenced Element type.
    
    Parameters:
    
    caption - a String value
    
    Returns:
    
    a reference to self
  - state
```
public ElementQuery<T> state(String varname,
                             String value)
```
    For advanced use. Add a requirement to only accept components that have a certain state variable set to a specific value. If query has a search hierarchy set with .in() or .childOf() the requirement is applied to the latest referenced Element type. Using null as a value checks for existence of the given variable, and accepts any value. This is usually not what you want to do. Please note that names of state variables are component specific and are subject to change.
    
    Parameters:
    
    varname - name of the desired Vaadin object state variable
    
    value - the state variable value as a String
    
    Returns:
    
    a reference to self or null if an invalid variable name was entered
  - index
```
public ElementQuery<T> index(int index)
```
    Set an index requirement for the current ElementQuery. If query has a context hierarchy set using .in() or .childOf() the index requirement is set for the latest referenced Element type. For example the .index() call in $(Foo.class).index(4) would apply to the Foo type (referring to the fifth instance of Foo that can be found in the current search context) in the hierarchy, while in $(Foo.class).in(Bar.class).index(3) it would apply to the Bar type, and the search would refer to all Foo instances found in every Bar instance which is the fourth Bar instance within the search context and any and all sub-contexts. When searching for one Element without search hierarchy this is equivalent to .all().get(index).
    Note the difference between .in() and .childOf():
    $(LabelElement.class).index(1).in(HorizontalLayoutElement.class) does a depth first search in all HorizontalLayout instances and returns the second Label instance from each result.
    $(LabelElement.class).index(1).childOf(HorizontalLayoutElement.class) only finds Labels the second direct children of all HorizontalLayout instances.
    
    Parameters:
    
    index - zero-based index of the desired element
    
    Returns:
    
    a reference to self
  - context
```
public ElementQuery<T> context(org.openqa.selenium.SearchContext searchContext)
```
    Specify a different SearchContext to use.
    
    Parameters:
    
    searchContext - a SearchContext; usually a TestBenchElement instance.
    
    Returns:
    
    a reference to self
  - getContext
```
protected org.openqa.selenium.SearchContext getContext()
```
    Return the SearchContext previously set with the in(com.vaadin.testbench.ElementQuery<E>) call.
    
    Returns:
    
    context
  - first
```
public T first()
```
    Search the open Vaadin application for a matching component relative to given context. NoSuchElement exception is thrown if the first element is not found.
    
    Returns:
    
    Component as a corresponding element
  - last
```
public T last()
```
    Search the open Vaadin application for a matching component relative to given context. NoSuchElement exception is thrown if no element is found.
    
    Returns:
    
    Component as a corresponding element
  - get
```
public T get(int index)
```
    Search the open Vaadin application for a matching component relative to given context. Elements are post filtered with given index. NoSuchElement exception is thrown if there is no element with such index.
    
    Parameters:
    
    index - Post filtering index
    
    Returns:
    
    Component as a corresponding element
  - exists
```
public boolean exists()
```
    Checks if this ElementQuery describes existing elements. Same as .all().isEmpty().
    
    Returns:
    
    true if elements exists, false if not
  - all
```
public List<T> all()
```
    Search the open Vaadin application for a list of matching components relative to given context.
    
    Returns:
    
    Components as a list of corresponding elements
  - generateQuery
```
protected String generateQuery()
```
    Generates a vaadin locator path.
    
    Returns:
    
    String in form of //fullServerSideClassName([(StateVar=StateVal,?)*(index)?])?

Class ElementQuery<T extends AbstractElement>

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ElementQuery

Method Detail

recursive

$

$$

in

child

id

caption

state

index

context

getContext

first

last

get

exists

all

generateQuery