Locator (Groovy API Documentation for Geb 2.3.1)

geb.navigator.BasicLocator

All Superinterfaces:

BasicLocator

Allows to create Navigators by selecting WebElements using different criteria (CSS selectors, attribute maps, indexes, ranges and By selectors).

Field Summary

Fields
Modifiers	Name	Description
`static String`	`MATCH_ALL_SELECTOR`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`Navigator`	`$(String selector)` Shorthand for `find(selector)`
	`Navigator`	`$(String selector, int index)` Shorthand for `find(selector, index)`.
	`Navigator`	`$(String selector, Range<Integer> range)` Shorthand for `find(selector, range)`
	`Navigator`	`$(Map<String, Object> attributes, By bySelector)` Shorthand for `find(predicates, bySelector)`
	`Navigator`	`$(Map<String, Object> attributes, By bySelector, int index)` Shorthand for `find(predicates, bySelector, index)`
	`Navigator`	`$(Map<String, Object> attributes, By bySelector, Range<Integer> range)` Shorthand for `find(predicates, bySelector, range)`
	`Navigator`	`$(By bySelector)` Shorthand for `find(bySelector)`
	`Navigator`	`$(By bySelector, int index)` Shorthand for `find(bySelector, index)`.
	`Navigator`	`$(By bySelector, Range<Integer> range)` Shorthand for `find(bySelector, range)`
	`Navigator`	`$(Map<String, Object> attributes)` Shorthand for `find(predicates)`
	`Navigator`	`$(Map<String, Object> attributes, int index)` Shorthand for `find(predicates, index)`
	`Navigator`	`$(Map<String, Object> attributes, Range<Integer> range)` Shorthand for `find(predicates, range)`
	`Navigator`	`$(Map<String, Object> attributes, String selector)` Shorthand for `find(predicates, selector)`
	`Navigator`	`$(Map<String, Object> attributes, String selector, int index)` Shorthand for `find(predicates, selector, index)`
	`Navigator`	`$(Map<String, Object> attributes, String selector, Range<Integer> range)` Shorthand for `find(predicates, selector, range)`
	`Navigator`	`find(String selector)` Shorthand for `find(null, selector, null)`
	`Navigator`	`find(Map<String, Object> attributes)` Creates a new Navigator instance containing the elements whose attributes match the specified values or patterns.
	`Navigator`	`find(String selector, int index)` Shorthand for `find(selector)[indexOfElement]`.
	`Navigator`	`find(String selector, Range<Integer> range)` Shorthand for `find(null, selector, range)`
	`Navigator`	`find(Map<String, Object> attributes, By bySelector)` Selects elements by both `By` selector and attributes.
	`Navigator`	`find(Map<String, Object> attributes, By bySelector, int index)` Shorthand for `find(predicates, bySelector, index..index)`
	`Navigator`	`find(Map<String, Object> attributes, By bySelector, Range<Integer> range)` Creates a new Navigator instance containing the elements matching the given `By` type selector.
	`Navigator`	`find(By bySelector, int index)` Shorthand for `find(bySelector)[indexOfElement]`.
	`Navigator`	`find(By bySelector, Range<Integer> range)` Shorthand for `find(null, bySelector, range)`
	`Navigator`	`find(Map<String, Object> attributes, int index)` Shorthand for `find(predicates, null, index..index)`
	`Navigator`	`find(Map<String, Object> attributes, Range<Integer> range)` Shorthand for `find(predicates, null, range)`
	`Navigator`	`find(Map<String, Object> attributes, String selector, int index)` Shorthand for `find(predicates, selector, index..index)`
	`Navigator`	`find(Map<String, Object> attributes, String selector, Range<Integer> range)` Creates a new Navigator instance containing the elements matching the given CSS selector.

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`interface BasicLocator`	`find, find`

- Field Detail
  - public static final String MATCH_ALL_SELECTOR
- Method Detail
  - Navigator $(String selector)
    
    Shorthand for find(selector)
    Parameters:
    selector
    Returns:
    new Navigator
    See Also:
    find(java.lang.String)
  - Navigator $(String selector, int index)
    
    Shorthand for find(selector, index).
    Parameters:
    selector - a CSS selector
    index - index of the required element in the selection
    Returns:
    new Navigator instance containing a single element
    See Also:
    find(java.lang.String, int)
  - Navigator $(String selector, Range<Integer> range)
    
    Shorthand for find(selector, range)
    Parameters:
    selector - The css selector
    Returns:
    new Navigator
  - Navigator $(Map<String, Object> attributes, By bySelector)
    
    Shorthand for find(predicates, bySelector)
    Parameters:
    bySelector - a WebDriver By selector
    predicates - a Map with keys representing attributes and values representing required values or patterns
    Returns:
    a new Navigator instance containing the matched elements
  - Navigator $(Map<String, Object> attributes, By bySelector, int index)
    
    Shorthand for find(predicates, bySelector, index)
    Parameters:
    bySelector - a WebDriver By selector
    Returns:
    new Navigator
  - Navigator $(Map<String, Object> attributes, By bySelector, Range<Integer> range)
    
    Shorthand for find(predicates, bySelector, range)
    Parameters:
    bySelector - a WebDriver By selector
    Returns:
    new Navigator instance containing the matched elements
  - Navigator $(By bySelector)
    
    Shorthand for find(bySelector)
    Parameters:
    bySelector - a WebDriver By selector
    Returns:
    new Navigator
    See Also:
    BasciLocator#find(org.openqa.selenium.By)
  - Navigator $(By bySelector, int index)
    
    Shorthand for find(bySelector, index).
    Parameters:
    bySelector - a WebDriver By selector
    index - index of the required element in the selection
    Returns:
    new Navigator instance containing a single element
    See Also:
    find(org.openqa.selenium.By, int)
  - Navigator $(By bySelector, Range<Integer> range)
    
    Shorthand for find(bySelector, range)
    Parameters:
    bySelector - a WebDriver By selector
    Returns:
    new Navigator
  - Navigator $(Map<String, Object> attributes)
    
    Shorthand for find(predicates)
    Parameters:
    predicates - a Map with keys representing attributes and values representing required values or patterns
    Returns:
    a new Navigator instance containing the matched elements
  - Navigator $(Map<String, Object> attributes, int index)
    
    Shorthand for find(predicates, index)
    Parameters:
    selector
    Returns:
    new Navigator
  - Navigator $(Map<String, Object> attributes, Range<Integer> range)
    
    Shorthand for find(predicates, range)
    Parameters:
    predicates - attribute predicates
    predicates - range the range of matches to select
    Returns:
    new Navigator
  - Navigator $(Map<String, Object> attributes, String selector)
    
    Shorthand for find(predicates, selector)
    Parameters:
    selector - a CSS selector
    predicates - a Map with keys representing attributes and values representing required values or patterns
    Returns:
    a new Navigator instance containing the matched elements
  - Navigator $(Map<String, Object> attributes, String selector, int index)
    
    Shorthand for find(predicates, selector, index)
    Parameters:
    selector
    Returns:
    new Navigator
  - Navigator $(Map<String, Object> attributes, String selector, Range<Integer> range)
    
    Shorthand for find(predicates, selector, range)
    Parameters:
    selector - a CSS selector
    Returns:
    new Navigator instance containing the matched elements
  - Navigator find(String selector)
    
    Shorthand for find(null, selector, null)
    Parameters:
    selector
    Returns:
    new Navigator
  - Navigator find(Map<String, Object> attributes)
    
    Creates a new Navigator instance containing the elements whose attributes match the specified values or patterns. The key 'text' can be used to match the text contained in elements. Regular expression Pattern objects may be used as values.
    Examples:
    
    find(name: "firstName")
    
    selects all elements with the name "firstName"
    
    find(name: "firstName", readonly: "readonly")
    
    selects all elements with the name "firstName" that are read-only
    
    find(text: "I can has cheezburger")
    
    selects all elements containing the exact text
    
    find(text: ~/I can has.+/)
    
    selects all elements whose text matches a regular expression
    
    Parameters:
    predicates - a Map with keys representing attributes and values representing required values or patterns
    Returns:
    a new Navigator instance containing the matched elements
  - Navigator find(String selector, int index)
    
    Shorthand for find(selector)[indexOfElement].
    Parameters:
    selector - a CSS selector
    index - index of the required element in the selection
    Returns:
    new Navigator instance containing a single element
  - Navigator find(String selector, Range<Integer> range)
    
    Shorthand for find(null, selector, range)
    Parameters:
    selector - The css selector
    Returns:
    new Navigator
  - Navigator find(Map<String, Object> attributes, By bySelector)
    
    Selects elements by both By selector and attributes. For example find(By.tagName("input"), name: "firstName") will select all input elements with the name "firstName".
    Parameters:
    bySelector - a WebDriver By selector
    predicates - a Map with keys representing attributes and values representing required values or patterns
    Returns:
    a new Navigator instance containing the matched elements
  - Navigator find(Map<String, Object> attributes, By bySelector, int index)
    
    Shorthand for find(predicates, bySelector, index..index)
    Parameters:
    bySelector - a WebDriver By selector
    Returns:
    new Navigator
  - Navigator find(Map<String, Object> attributes, By bySelector, Range<Integer> range)
    
    Creates a new Navigator instance containing the elements matching the given By type selector. Any By type capabilities supported by the underlying WebDriver instance are supported.
    Parameters:
    bySelector - a WebDriver By selector
    Returns:
    new Navigator instance containing the matched elements
  - Navigator find(By bySelector, int index)
    
    Shorthand for find(bySelector)[indexOfElement].
    Parameters:
    bySelector - a WebDriver By selector
    index - index of the required element in the selection
    Returns:
    new Navigator instance containing a single element
  - Navigator find(By bySelector, Range<Integer> range)
    
    Shorthand for find(null, bySelector, range)
    Parameters:
    bySelector - a WebDriver By selector
    Returns:
    new Navigator
  - Navigator find(Map<String, Object> attributes, int index)
    
    Shorthand for find(predicates, null, index..index)
    Parameters:
    selector
    Returns:
    new Navigator
  - Navigator find(Map<String, Object> attributes, Range<Integer> range)
    
    Shorthand for find(predicates, null, range)
    Parameters:
    predicates - attribute predicates
    predicates - range the range of matches to select
    Returns:
    new Navigator
  - Navigator find(Map<String, Object> attributes, String selector, int index)
    
    Shorthand for find(predicates, selector, index..index)
    Parameters:
    selector
    Returns:
    new Navigator
  - Navigator find(Map<String, Object> attributes, String selector, Range<Integer> range)
    
    Creates a new Navigator instance containing the elements matching the given CSS selector. Any CSS capabilities supported by the underlying WebDriver instance are supported. If the underlying WebDriver instance does not natively support finding elements by CSS selectors then tag, id and class name selectors may be applied (in any combination).
    Examples:
    
    h1
    
    selects all 'h1' elements
    
    .article
    
    selects all elements with the class 'article'
    
    #header
    
    selects the element with the id 'header'
    
    div.article p
    
    selects all p elements that are descendants of a div with class 'article'
    
    h1, h2
    
    selects all h1 and h2 elements
    
    li:odd
    
    selects odd-numbered li elements (CSS3 selectors like this are only supported when supported by the underlying WebDriver instance)
    
    Parameters:
    selector - a CSS selector
    Returns:
    new Navigator instance containing the matched elements

Summary:
Field
Method

| Detail:
Field
Method

Groovy API Documentation for Geb 2.3.1 - Licensed under the Apache License, Version 2.0 - http://www.gebish.org

[Groovy] Interface Locator

Field Summary

Methods Summary

Inherited Methods Summary

Field Detail

public static final String MATCH_ALL_SELECTOR

Method Detail

Navigator $(String selector)

Navigator $(String selector, int index)

Navigator $(String selector, Range<Integer> range)

Navigator $(Map<String, Object> attributes, By bySelector)

Navigator $(Map<String, Object> attributes, By bySelector, int index)

Navigator $(Map<String, Object> attributes, By bySelector, Range<Integer> range)

Navigator $(By bySelector)

Navigator $(By bySelector, int index)

Navigator $(By bySelector, Range<Integer> range)

Navigator $(Map<String, Object> attributes)

Navigator $(Map<String, Object> attributes, int index)

Navigator $(Map<String, Object> attributes, Range<Integer> range)

Navigator $(Map<String, Object> attributes, String selector)

Navigator $(Map<String, Object> attributes, String selector, int index)

Navigator $(Map<String, Object> attributes, String selector, Range<Integer> range)

Navigator find(String selector)

Navigator find(Map<String, Object> attributes)

Navigator find(String selector, int index)

Navigator find(String selector, Range<Integer> range)

Navigator find(Map<String, Object> attributes, By bySelector)

Navigator find(Map<String, Object> attributes, By bySelector, int index)

Navigator find(Map<String, Object> attributes, By bySelector, Range<Integer> range)

Navigator find(By bySelector, int index)

Navigator find(By bySelector, Range<Integer> range)

Navigator find(Map<String, Object> attributes, int index)

Navigator find(Map<String, Object> attributes, Range<Integer> range)

Navigator find(Map<String, Object> attributes, String selector, int index)

Navigator find(Map<String, Object> attributes, String selector, Range<Integer> range)