SearchTool (Ibello API 1.21.1 API)

public interface SearchTool

Interface for searching elements on a page. It offers a fluent interface for element search. Examples:

Search a single element:

 SearchTool find = ...;
 WebElement element = find.using(By.LABEL, "Field #${0}:", 1).first();

Search multiple elements (below a specific one):

 WebElement currentRow = ...;
 SearchTool find = ...;
 WebElements element = find.using(By.TAG_NAME, "tr").below(currentRow).all();

About ibello search engine see hu.ibello.search.

Author:: Kornél Simon

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`SearchTool`	`above(WebElement anchor)` Modifies the element search so the desired element should be above the anchor element.
`WebElements`	`all()` Get all elements on the page that match the conditions.
`SearchTool`	`asAncestorOf(By by, String pattern, Object... parameters)` Modifies the element search so the desired element should be the ancestor of the anchor element.
`default SearchTool`	`asAncestorOf(String pattern, Object... parameters)` Modifies the element search so the desired element should be the ancestor of the anchor element.
`SearchTool`	`below(WebElement anchor)` Modifies the element search so the desired element should be below the anchor element.
`WebElement`	`first()` Get only the first element on the page which matches the conditions.
`SearchTool`	`inColumnOf(WebElement anchor)` Modifies the element search so the desired element should be in the same column as the anchor element.
`SearchTool`	`inRowOf(WebElement anchor)` Modifies the element search so the desired element should be in the same row as the anchor element.
`SearchTool`	`leftFrom(WebElement anchor)` Modifies the element search so the desired element should be left from the anchor element.
`SearchTool`	`nearestTo(WebElement anchor)` Modifies the element search to capture the nearest elements to the given anchor element.
`default WebElement`	`nth(int index)` Get the nth element on the page which matches the conditions.
`SearchTool`	`rightFrom(WebElement anchor)` Modifies the element search so the desired element should be right from the anchor element.
`SearchTool`	`using(By by, String pattern, Object... parameters)` Sets the main search conditions for the element search.
`default SearchTool`	`using(String pattern, Object... parameters)` Sets the main search conditions for the element search.

- Method Detail
  - using
```
SearchTool using(By by,
                 String pattern,
                 Object... parameters)
```
    Sets the main search conditions for the element search.
    
    The by argument specifies the main search algorithm. It is an enum constant of By.
    
    The meaning of pattern argument depends on the value of by. For more information, see enum constants of By.
    
    The parameters is a vararg. It specifies parameters in the pattern argument. If pattern contain parameter substitution markers then the method will substitute the parameters into those places. A parameter substitution marker is a 0-based index surrounded by ${ and }. For example, if pattern is "${0}-${1}", then the method will replace ${0} with the first parameter, and ${1} with the second parameter. If the parameters are "a" and 1, then the result pattern will be "a-1".
    
    Parameters:
    
    by - search algorithm
    
    pattern - search pattern
    
    parameters - substitute parameters of pattern
    
    Returns:
    
    this SearchTool instance
    
    See Also:
    
    Find
  - using
```
default SearchTool using(String pattern,
                         Object... parameters)
```
    Sets the main search conditions for the element search.
    
    The search algorithm of the anchor is By.CSS_SELECTOR. The pattern argument should be a CSS selector.
    
    The parameters is a vararg. It specifies parameters in the pattern argument. If pattern contain parameter substitution markers then the method will substitute the parameters into those places. A parameter substitution marker is a 0-based index surrounded by ${ and }. For example, if pattern is "#${0}-${1}", then the method will replace ${0} with the first parameter, and ${1} with the second parameter. If the parameters are "a" and 1, then the result pattern will be "#a-1".
    
    Parameters:
    
    pattern - search pattern
    
    parameters - substitute parameters of pattern
    
    Returns:
    
    this SearchTool instance
    
    See Also:
    
    using(By, String, Object...), Find
  - inRowOf
```
SearchTool inRowOf(WebElement anchor)
```
    Modifies the element search so the desired element should be in the same row as the anchor element. It means that the horizontal center line of the anchor should fit into the boundaries of the desired element.
    
    Parameters:
    
    anchor - another element on the page
    
    Returns:
    
    this SearchTool instance
    
    See Also:
    
    Position, PositionType.ROW
  - inColumnOf
```
SearchTool inColumnOf(WebElement anchor)
```
    Modifies the element search so the desired element should be in the same column as the anchor element. It means that the vertical center line of the anchor should fit into the boundaries of the desired element.
    
    Parameters:
    
    anchor - another element on the page
    
    Returns:
    
    this SearchTool instance
    
    See Also:
    
    Position, PositionType.COLUMN
  - leftFrom
```
SearchTool leftFrom(WebElement anchor)
```
    Modifies the element search so the desired element should be left from the anchor element. It means that the x coordinate of the desired element's right edge if less than or equal to the x coordinate of the anchor element's left edge.
    
    Parameters:
    
    anchor - another element on the page
    
    Returns:
    
    this SearchTool instance
    
    See Also:
    
    Position, PositionType.LEFT_FROM
  - rightFrom
```
SearchTool rightFrom(WebElement anchor)
```
    Modifies the element search so the desired element should be right from the anchor element. It means that the x coordinate of the desired element's left edge if greater than or equal to the x coordinate of the anchor element's right edge.
    
    Parameters:
    
    anchor - another element on the page
    
    Returns:
    
    this SearchTool instance
    
    See Also:
    
    Position, PositionType.RIGHT_FROM
  - above
```
SearchTool above(WebElement anchor)
```
    Modifies the element search so the desired element should be above the anchor element. It means that the bottom y coordinate of the desired element is less than or equal to the top y coordinate of the anchor element.
    
    Parameters:
    
    anchor - another element on the page
    
    Returns:
    
    this SearchTool instance
    
    See Also:
    
    Position, PositionType.ABOVE
  - below
```
SearchTool below(WebElement anchor)
```
    Modifies the element search so the desired element should be below the anchor element. It means that the top y coordinate of the desired element is greater than or equal to the bottom y coordinate of the anchor element.
    
    Parameters:
    
    anchor - another element on the page
    
    Returns:
    
    this SearchTool instance
    
    See Also:
    
    Position, PositionType.BELOW
  - asAncestorOf
```
SearchTool asAncestorOf(By by,
                        String pattern,
                        Object... parameters)
```
    Modifies the element search so the desired element should be the ancestor of the anchor element. The anchor element is specified by it's search conditions.
    The by argument specifies the search algorithm. It is an enum constant of By.
    
    The meaning of pattern argument depends on the value of by. For more information, see enum constants of By.
    
    The parameters is a vararg. It specifies parameters in the pattern argument. If pattern contain parameter substitution markers then the method will substitute the parameters into those places. A parameter substitution marker is a 0-based index surrounded by ${ and }. For example, if pattern is "${0}-${1}", then the method will replace ${0} with the first parameter, and ${1} with the second parameter. If the parameters are "a" and 1, then the result pattern will be "a-1".
    
    Parameters:
    
    by - search algorithm of anchor element
    
    pattern - search pattern of anchor element
    
    parameters - search parameters of anchor element
    
    Returns:
    
    this SearchTool instance
    
    See Also:
    
    Relation, RelationType.ANCESTOR_OF
  - asAncestorOf
```
default SearchTool asAncestorOf(String pattern,
                                Object... parameters)
```
    Modifies the element search so the desired element should be the ancestor of the anchor element. The anchor element is specified by it's search conditions.
    The search algorithm of the anchor is By.CSS_SELECTOR. The pattern argument should be a CSS selector.
    
    The parameters is a vararg. It specifies parameters in the pattern argument. If pattern contain parameter substitution markers then the method will substitute the parameters into those places. A parameter substitution marker is a 0-based index surrounded by ${ and }. For example, if pattern is "#${0}-${1}", then the method will replace ${0} with the first parameter, and ${1} with the second parameter. If the parameters are "a" and 1, then the result pattern will be "#a-1".
    
    Parameters:
    
    pattern - search pattern of anchor element
    
    parameters - search parameters of anchor element
    
    Returns:
    
    this SearchTool instance
    
    See Also:
    
    Relation, RelationType.ANCESTOR_OF
  - nearestTo
```
SearchTool nearestTo(WebElement anchor)
```
    Modifies the element search to capture the nearest elements to the given anchor element.
    
    Parameters:
    
    anchor - another element on the page
    
    Returns:
    
    this SearchTool instance
  - first
```
WebElement first()
```
    Get only the first element on the page which matches the conditions.
    
    This method always returns a non-null object, even if the element is not present on the page at the time of the search. The returned WebElement instance can be used for different actions and assertions later - there is no need to search with the same arguments again.
    
    Returns:
    
    the first element which matches the conditions
  - nth
```
default WebElement nth(int index)
```
    Get the nth element on the page which matches the conditions. The index of the element should be specified with the parameter. It is 0-based, so the index of the first element is 0, the second is 1, and so on.
    
    This method always returns a non-null object, even if the element is not present on the page at the time of the search. The returned WebElement instance can be used for different actions and assertions later - there is no need to search with the same arguments again.
    
    Parameters:
    
    index - 0-based index of the element
    
    Returns:
    
    the element with the given index
  - all
```
WebElements all()
```
    Get all elements on the page that match the conditions.
    
    This method always returns a non-null object, even if the elements are not present on the page at the time of the search. The returned WebElements instance can be used for different actions and assertions later - there is no need to search with the same arguments again.
    
    Returns:
    
    all elements that match the conditions

Interface SearchTool

Method Summary

Method Detail

using

using

inRowOf

inColumnOf

leftFrom

rightFrom

above

below

asAncestorOf

asAncestorOf

nearestTo

first

nth

all