Navigator (Groovy API Documentation for Geb 0.10.0)

Navigator is a jQuery-style DOM traversal tool that wraps a set of WebDriver WebElements. The code is based on the Doj library written by Kevin Wetzels: http://code.google.com/p/hue/

Methods Summary

Methods
Type	Name and description
`Navigator`	`$(Map<String, Object> predicates)` Shorthand for `find(predicates)`
`Navigator`	`$(Map<String, Object> predicates, int index)` Shorthand for `find(predicates, index)`
`Navigator`	`$(Map<String, Object> predicates, Range<Integer> range)` Shorthand for `find(predicates, range)`
`Navigator`	`$(Map<String, Object> predicates, String selector)` Shorthand for `find(predicates, selector)`
`Navigator`	`$(Map<String, Object> predicates, String selector, int index)` Shorthand for `find(predicates, selector, index)`
`Navigator`	`$(Map<String, Object> predicates, String selector, Range<Integer> range)` Shorthand for `find(predicates, selector, range)`
`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`	`add(String selector)`
`Navigator`	`add(WebElement[] elements)`
`Navigator`	`add(Collection<WebElement> elements)`
`Collection<WebElement>`	`allElements()` Returns all context elements.
`String`	`attr(String name)` Returns the value of the given attribute of the first context element.
`Navigator`	`children()` Creates a new Navigator instance containing all the child elements of the current context elements.
`Navigator`	`children(String selector)` Creates a new Navigator instance containing all the child elements of the current context elements that match the selector.
`Navigator`	`children(Map<String, Object> attributes)` Creates a new Navigator instance containing all the child elements of the current context elements that match the given attributes.
`Navigator`	`children(Map<String, Object> attributes, String selector)` Creates a new Navigator instance containing all the child elements of the current context elements that match the selector and given attributes.
`List<String>`	`classes()` Returns the class names present on all elements.
`Navigator`	`click()` Clicks on the first context element.
`Navigator`	`click(Class<? extends Page> pageClass)`
`Navigator`	`click(Class<? extends Page> pageClass, Wait wait)`
`Navigator`	`click(List<Class<? extends Page>> potentialPageClasses)`
`Navigator`	`click(List<Class<? extends Page>> potentialPageClasses, Wait wait)`
`Navigator`	`closest(String selector)` Creates a new Navigator instance containing the first ancestor element of each of the current context elements that match the selector.
`Navigator`	`closest(Map<String, Object> attributes)` Creates a new Navigator instance containing the first ancestor element of each of the current context elements that match the given attributes.
`Navigator`	`closest(Map<String, Object> attributes, String selector)` Creates a new Navigator instance containing the first ancestor element of each of the current context elements that match the selector and given attributes.
`String`	`css(String propertyName)` Gets the value of a given CSS property.
`Navigator`	`eq(int index)` Gets the wrapped element at the given index.
`Navigator`	`filter(String selector)` Filters the set of elements represented by this Navigator to include only those that match the selector.
`Navigator`	`filter(Map<String, Object> predicates)`
`Navigator`	`filter(Map<String, Object> predicates, String selector)`
`Navigator`	`find(Map<String, Object> predicates)` Creates a new Navigator instance containing the elements whose attributes match the specified values or patterns.
`Navigator`	`find(Map<String, Object> predicates, int index)` Shorthand for `find(predicates, null, index..index)`
`Navigator`	`find(Map<String, Object> predicates, Range<Integer> range)` Shorthand for `find(predicates, null, range)`
`Navigator`	`find(Map<String, Object> predicates, String selector)` Selects elements by both CSS selector and attributes.
`Navigator`	`find(Map<String, Object> predicates, String selector, int index)` Shorthand for `find(predicates, selector, index..index)`
`Navigator`	`find(Map<String, Object> predicates, String selector, Range<Integer> range)` Creates a new Navigator instance containing the elements matching the given CSS selector.
`Navigator`	`find(String selector)` Shorthand for `find(null, selector, null)`
`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`	`findAll(Closure predicate)` Overrides the standard Groovy findAll so that the object returned is a Navigator rather than a Collection.
`Navigator`	`first()` Creates a new Navigator instance containing only the first context element (wrapped).
`WebElement`	`firstElement()` Returns the first context element (not wrapped).
`Navigator`	`getAt(int index)` Gets the wrapped element at the given index.
`Navigator`	`getAt(Range range)` Gets the wrapped elements in the given range.
`Navigator`	`getAt(Collection indexes)` Gets the wrapped elements at the given indexes.
`String`	`getAttribute(String name)` Returns the value of the given attribute of the first context element.
`int`	`getHeight()` Returns the height of the first element the navigator matches or 0 if it matches nothing.
`JQueryAdapter`	`getJquery()` Returns an adapter for calling jQuery methods on the elements in this navigator.
`int`	`getWidth()` Returns the width of the first element the navigator matches or 0 if it matches nothing.
`int`	`getX()` Returns the x coordinate (from the top left corner) of the first element the navigator matches or 0 if it matches nothing.
`int`	`getY()` Returns the y coordinate (from the top left corner) of the first element the navigator matches or 0 if it matches nothing.
`Navigator`	`has(String selector)` Filters the set of elements represented by this Navigator to include only that have one or more descendants that match the selector.
`Navigator`	`has(Map<String, Object> predicates, String selector)` Filters the set of elements represented by this Navigator to include only that have one or more descendants that match the selector and attributes as defined in the predicate.
`Navigator`	`has(Map<String, Object> predicates)` Filters the set of elements represented by this Navigator to include only that have one or more descendants that match the attributes as defined in the predicate.
`boolean`	`hasClass(String className)` Returns true if at least one of the context elements has the given class.
`Navigator`	`head()` Creates a new Navigator instance containing only the first context element (wrapped).
`boolean`	`is(String tag)` Returns true if at least one of the context elements matches the tag.
`boolean`	`isDisabled()` Shorthand for `hasAttribute("disabled")`.
`boolean`	`isDisplayed()` Uses the isDisplayed() of RenderedWebElement to determine if the first element in the context is displayed.
`boolean`	`isEditable()` Shorthand for `!`
`boolean`	`isEmpty()` Returns true when there are no context elements.
`boolean`	`isEnabled()` Shorthand for `!`
`boolean`	`isReadOnly()` Shorthand for `hasAttribute("readonly")`.
`Iterator<Navigator>`	`iterator()`
`Navigator`	`last()` Creates a new Navigator instance containing only the last context element (wrapped).
`WebElement`	`lastElement()` Returns the last context element (not wrapped).
`Navigator`	`leftShift(def value)`
`Navigator`	`next()` Creates a new Navigator instance containing the next sibling elements of the current context elements.
`Navigator`	`next(String selector)` Creates a new Navigator instance containing the next sibling elements of the current context elements, matching the selector.
`Navigator`	`next(Map<String, Object> attributes)` Creates a new Navigator instance containing the next sibling elements of the current context elements, matching the given attributes.
`Navigator`	`next(Map<String, Object> attributes, String selector)` Creates a new Navigator instance containing the next sibling elements of the current context elements, matching the selector and given attributes.
`Navigator`	`nextAll()` Creates a new Navigator instance containing all following sibling elements of the current context elements.
`Navigator`	`nextAll(String selector)` Creates a new Navigator instance containing all following sibling elements of the current context elements that match the selector.
`Navigator`	`nextAll(Map<String, Object> attributes)` Creates a new Navigator instance containing all following sibling elements of the current context elements, matching the given attributes.
`Navigator`	`nextAll(Map<String, Object> attributes, String selector)` Creates a new Navigator instance containing all following sibling elements of the current context elements, matching the selector and given attributes.
`Navigator`	`nextUntil(String selector)` Creates a new Navigator instance containing all following sibling elements of the current context elements up to, but not including, the first to match the selector.
`Navigator`	`nextUntil(Map<String, Object> attributes)` Creates a new Navigator instance containing all following sibling elements of the current context elements up to, but not including, the first to match the given attributes.
`Navigator`	`nextUntil(Map<String, Object> attributes, String selector)` Creates a new Navigator instance containing all following sibling elements of the current context elements up to, but not including, the first to match the selector and given attributes.
`Navigator`	`not(String selector)` Returns a new Navigator instance containing all elements of the current Navigator that do not match the selector.
`Navigator`	`not(Map<String, Object> predicates, String selector)` Returns a new Navigator instance containing all elements of the current Navigator that do not match the selector and attributes as defined in the predicate.
`Navigator`	`not(Map<String, Object> predicates)` Returns a new Navigator instance containing all elements of the current Navigator that do not match the attributes as defined in the predicate.
`Navigator`	`parent()` Creates a new Navigator instance containing the direct parent elements of the current context elements.
`Navigator`	`parent(String selector)` Creates a new Navigator instance containing the direct parent elements of the current context elements that match the selector.
`Navigator`	`parent(Map<String, Object> attributes)` Creates a new Navigator instance containing the direct parent elements of the current context elements that match the given attributes.
`Navigator`	`parent(Map<String, Object> attributes, String selector)` Creates a new Navigator instance containing the direct parent elements of the current context elements that match the selector and given attributes.
`Navigator`	`parents()` Creates a new Navigator instance containing all the ancestor elements of the current context elements.
`Navigator`	`parents(String selector)` Creates a new Navigator instance containing all the ancestor elements of the current context elements that match the selector.
`Navigator`	`parents(Map<String, Object> attributes)` Creates a new Navigator instance containing all the ancestor elements of the current context elements that match the given attributes.
`Navigator`	`parents(Map<String, Object> attributes, String selector)` Creates a new Navigator instance containing all the ancestor elements of the current context elements that match the given attributes.
`Navigator`	`parentsUntil(String selector)` Creates a new Navigator instance containing all the ancestor elements of the current context elements up to but not including the first that matches the selector.
`Navigator`	`parentsUntil(Map<String, Object> attributes)` Creates a new Navigator instance containing all the ancestor elements of the current context elements up to but not including the first that matches the given attributes.
`Navigator`	`parentsUntil(Map<String, Object> attributes, String selector)` Creates a new Navigator instance containing all the ancestor elements of the current context elements up to but not including the first that matches the selector and given attributes.
`Navigator`	`plus(Navigator navigator)` Merges the Navigator instance with the current instance to create a new Navigator instance containing the context elements of both.
`Navigator`	`prevAll()` Creates a new Navigator instance containing all preceding sibling elements of the current context elements.
`Navigator`	`prevAll(String selector)` Creates a new Navigator instance containing all preceding sibling elements of the current context elements, matching the selector.
`Navigator`	`prevAll(Map<String, Object> attributes)` Creates a new Navigator instance containing all preceding sibling elements of the current context elements, matching the given attributes.
`Navigator`	`prevAll(Map<String, Object> attributes, String selector)` Creates a new Navigator instance containing all preceding sibling elements of the current context elements, matching the selector and given attributes.
`Navigator`	`prevUntil(String selector)` Creates a new Navigator instance containing all preceding sibling elements of the current context elements up to, but not including the first matching the selector.
`Navigator`	`prevUntil(Map<String, Object> attributes)` Creates a new Navigator instance containing all preceding sibling elements of the current context elements up to, but not including the first matching the given attributes.
`Navigator`	`prevUntil(Map<String, Object> attributes, String selector)` Creates a new Navigator instance containing all preceding sibling elements of the current context elements up to, but not including the first matching the selector and given attributes.
`Navigator`	`previous()` Creates a new Navigator instance containing the previous sibling elements of the current context elements.
`Navigator`	`previous(String selector)` Creates a new Navigator instance containing the previous sibling elements of the current context elements, matching the selector.
`Navigator`	`previous(Map<String, Object> attributes)` Creates a new Navigator instance containing the previous sibling elements of the current context elements, matching the given attributes.
`Navigator`	`previous(Map<String, Object> attributes, String selector)` Creates a new Navigator instance containing the previous sibling elements of the current context elements, matching the selector and given attributes.
`Navigator`	`remove(int index)` Creates a new Navigator instance by removing the element at the given index from the context.
`Navigator`	`siblings()` Creates a new Navigator instance containing all the sibling elements of the current context elements.
`Navigator`	`siblings(String selector)` Creates a new Navigator instance containing all the sibling elements of the current context elements that match the selector.
`Navigator`	`siblings(Map<String, Object> attributes)` Creates a new Navigator instance containing all the sibling elements of the current context elements that match the given attributes.
`Navigator`	`siblings(Map<String, Object> attributes, String selector)` Creates a new Navigator instance containing all the sibling elements of the current context elements that match the selector and given attributes.
`int`	`size()` Returns the number of context elements.
`String`	`tag()` Returns the tag name of the first context element.
`Navigator`	`tail()` Creates a new Navigator instance containing all but the first context element (wrapped).
`String`	`text()` Returns the text content of the first context element.
`Navigator`	`unique()` Creates a new Navigator instance containing all elements of this instance with duplicate elements removed
`def`	`value()` Returns the value of the first context element for input elements (including textarea, select and button).
`Navigator`	`value(def value)` Sets the value of the form input elements to the given value.
`Navigator`	`verifyNotEmpty()` Throws an exception when the Navigator instance is empty.

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`interface Iterable`	`iterator`
`class Object`	`wait, wait, wait, equals, toString, hashCode, getClass, notify, notifyAll`

- Method Detail
  - Navigator $(Map<String, Object> predicates)
    
    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
    See Also:
    find(java.util.Map)
  - Navigator $(Map<String, Object> predicates, int index)
    
    Shorthand for find(predicates, index)
    Parameters:
    selector
    Returns:
    new Navigator
    See Also:
    find(java.util.Map, int)
  - Navigator $(Map<String, Object> predicates, Range<Integer> range)
    
    Shorthand for find(predicates, range)
    Parameters:
    predicates - attribute predicates
    predicates - range the range of matches to select
    Returns:
    new Navigator
    See Also:
    find(java.util.Map, groovy.lang.Range)
  - Navigator $(Map<String, Object> predicates, 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
    See Also:
    find(java.util.Map, java.lang.String)
  - Navigator $(Map<String, Object> predicates, String selector, int index)
    
    Shorthand for find(predicates, selector, index)
    Parameters:
    selector
    Returns:
    new Navigator
    See Also:
    find(java.util.Map, java.lang.String, int)
  - Navigator $(Map<String, Object> predicates, String selector, Range<Integer> range)
    
    Shorthand for find(predicates, selector, range)
    Parameters:
    selector - a CSS selector
    Returns:
    new Navigator instance containing the matched elements
    See Also:
    find(java.util.Map, groovy.lang.Range)
  - 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
    See Also:
    find(java.lang.String, groovy.lang.Range)
  - Navigator add(String selector)
  - Navigator add(WebElement[] elements)
  - Navigator add(Collection<WebElement> elements)
  - Collection<WebElement> allElements()
    
    Returns all context elements.
    Returns:
    all context elements
  - String attr(String name)
    
    Returns the value of the given attribute of the first context element.
    Parameters:
    name - name of the attribute
    Returns:
    the value of the given attribute of the first context element
  - Navigator children()
    
    Creates a new Navigator instance containing all the child elements of the current context elements.
    Returns:
    new Navigator instance
  - Navigator children(String selector)
    
    Creates a new Navigator instance containing all the child elements of the current context elements that match the selector.
    Parameters:
    selector - to match
    Returns:
    new Navigator instance
  - Navigator children(Map<String, Object> attributes)
    
    Creates a new Navigator instance containing all the child elements of the current context elements that match the given attributes.
    Parameters:
    attributes - to match
    Returns:
    new Navigator instance
  - Navigator children(Map<String, Object> attributes, String selector)
    
    Creates a new Navigator instance containing all the child elements of the current context elements that match the selector and given attributes.
    Parameters:
    attributes - to match
    selector - to match
    Returns:
    new Navigator instance
  - List<String> classes()
    
    Returns the class names present on all elements. The result is a unique set and is in alphabetical order.
    Returns:
    the class names present on all elements.
  - Navigator click()
    
    Clicks on the first context element.
    throws:
    java.io.IOException
    throws:
    java.lang.ClassCastException
  - Navigator click(Class<? extends Page> pageClass)
  - Navigator click(Class<? extends Page> pageClass, Wait wait)
  - Navigator click(List<Class<? extends Page>> potentialPageClasses)
  - Navigator click(List<Class<? extends Page>> potentialPageClasses, Wait wait)
  - Navigator closest(String selector)
    
    Creates a new Navigator instance containing the first ancestor element of each of the current context elements that match the selector.
    Unlike parent(), this method will keep traversing up the DOM until a match is found or the top of the DOM has been found
    
    Parameters:
    selector - to match
    Returns:
    new Navigator instance
  - Navigator closest(Map<String, Object> attributes)
    
    Creates a new Navigator instance containing the first ancestor element of each of the current context elements that match the given attributes.
    Unlike parent(), this method will keep traversing up the DOM until a match is found or the top of the DOM has been found
    
    Parameters:
    attributes - to match
    Returns:
    new Navigator instance
  - Navigator closest(Map<String, Object> attributes, String selector)
    
    Creates a new Navigator instance containing the first ancestor element of each of the current context elements that match the selector and given attributes.
    Unlike parent(), this method will keep traversing up the DOM until a match is found or the top of the DOM has been found
    
    Parameters:
    selector - to match
    attributes - to match
    Returns:
    new Navigator instance
  - String css(String propertyName)
    
    Gets the value of a given CSS property. Color values should be returned as rgba strings, so, for example if the "background-color" property is set as "green" in the HTML source, the returned value will be "rgba(0, 255, 0, 1)". Note that shorthand CSS properties (e.g. background, font, border, border-top, margin, margin-top, padding, padding-top, list-style, outline, pause, cue) are not returned, in accordance with the DOM CSS2 specification - you should directly access the longhand properties (e.g. background-color) to access the desired values.
    Parameters:
    propertyName
    Returns:
    The current, computed value of the property or null if the is not specified.
  - Navigator eq(int index)
    
    Gets the wrapped element at the given index.
    When no such element exists, an empty Navigator instance is returned.
    
    Parameters:
    index - index of the element to retrieve - pass a negative value to start from the back
    Returns:
    new Navigator instance
  - Navigator filter(String selector)
    
    Filters the set of elements represented by this Navigator to include only those that match the selector. Note that unlike find only tag, id and class based selectors are supported for this method regardless of the capabilities of the underlying WebDriver instance.
    Parameters:
    selector - a CSS selector
    Returns:
    a new Navigator instance
  - Navigator filter(Map<String, Object> predicates)
  - Navigator filter(Map<String, Object> predicates, String selector)
  - Navigator find(Map<String, Object> predicates)
    
    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. Note that for selecting by class it is better to use a CSS selector.
    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(Map<String, Object> predicates, int index)
    
    Shorthand for find(predicates, null, index..index)
    Parameters:
    selector
    Returns:
    new Navigator
  - Navigator find(Map<String, Object> predicates, 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> predicates, String selector)
    
    Selects elements by both CSS selector and attributes. For example find("input", name: "firstName") will select all input elements with the name "firstName".
    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 find(Map<String, Object> predicates, String selector, int index)
    
    Shorthand for find(predicates, selector, index..index)
    Parameters:
    selector
    Returns:
    new Navigator
  - Navigator find(Map<String, Object> predicates, 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
  - Navigator find(String selector)
    
    Shorthand for find(null, selector, null)
    Parameters:
    selector
    Returns:
    new Navigator
  - 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 findAll(Closure predicate)
    
    Overrides the standard Groovy findAll so that the object returned is a Navigator rather than a Collection.
  - Navigator first()
    
    Creates a new Navigator instance containing only the first context element (wrapped).
    Returns:
    new Navigator instance
  - WebElement firstElement()
    
    Returns the first context element (not wrapped).
    Returns:
    the first context element (not wrapped)
  - Navigator getAt(int index)
    
    Gets the wrapped element at the given index.
    When no such element exists, an empty Navigator instance is returned.
    
    Parameters:
    index - index of the element to retrieve - pass a negative value to start from the back
    Returns:
    new Navigator instance
  - Navigator getAt(Range range)
    
    Gets the wrapped elements in the given range.
    When no such elements exist, an empty Navigator instance is returned.
    
    Parameters:
    range - range of the elements to retrieve
    Returns:
    new Navigator instance
  - Navigator getAt(Collection indexes)
    
    Gets the wrapped elements at the given indexes.
    When no such elements exist, an empty Navigator instance is returned.
    
    Parameters:
    indexes - indexes of the elements to retrieve
    Returns:
    new Navigator instance
  - String getAttribute(String name)
    
    Returns the value of the given attribute of the first context element.
    Parameters:
    name - name of the attribute
    Returns:
    the value of the given attribute of the first context element
  - int getHeight()
    
    Returns the height of the first element the navigator matches or 0 if it matches nothing.
    To get the height of all matched elements you can use the spread operator navigator*.height
  - JQueryAdapter getJquery()
    
    Returns an adapter for calling jQuery methods on the elements in this navigator.
  - int getWidth()
    
    Returns the width of the first element the navigator matches or 0 if it matches nothing.
    To get the width of all matched elements you can use the spread operator navigator*.width
  - int getX()
    
    Returns the x coordinate (from the top left corner) of the first element the navigator matches or 0 if it matches nothing.
    To get the x coordinate of all matched elements you can use the spread operator navigator*.x
  - int getY()
    
    Returns the y coordinate (from the top left corner) of the first element the navigator matches or 0 if it matches nothing.
    To get the y coordinate of all matched elements you can use the spread operator navigator*.y
  - Navigator has(String selector)
    
    Filters the set of elements represented by this Navigator to include only that have one or more descendants that match the selector.
    Parameters:
    selector - a CSS selector
    Returns:
    a new Navigator instance
  - Navigator has(Map<String, Object> predicates, String selector)
    
    Filters the set of elements represented by this Navigator to include only that have one or more descendants that match the selector and attributes as defined in the predicate.
    Parameters:
    selector - a CSS selector
    predicates - a Map with keys representing attributes and values representing required values or patterns
    Returns:
    a new Navigator instance
  - Navigator has(Map<String, Object> predicates)
    
    Filters the set of elements represented by this Navigator to include only that have one or more descendants that match the attributes as defined in the predicate.
    Parameters:
    predicates - a Map with keys representing attributes and values representing required values or patterns
    Returns:
    a new Navigator instance
  - boolean hasClass(String className)
    
    Returns true if at least one of the context elements has the given class.
    Parameters:
    className - class to check for
    Returns:
    true if at least one of the context elements has the given class
  - Navigator head()
    
    Creates a new Navigator instance containing only the first context element (wrapped).
    Returns:
    new Navigator instance
  - boolean is(String tag)
    
    Returns true if at least one of the context elements matches the tag.
    Parameters:
    tag - tag to match
    Returns:
    true if at least one of the context elements matches the tag
  - boolean isDisabled()
    
    Shorthand for hasAttribute("disabled").
    throws:
    java.lang.UnsupportedOperationException if this navigator contains anything else than a button, input, option, select or textarea
    
    Returns:
    true when the first element is disabled
  - boolean isDisplayed()
    
    Uses the isDisplayed() of RenderedWebElement to determine if the first element in the context is displayed. If the context is empty, or the first element is not a RenderedWebElement, false will be returned.
    Returns:
    true if the first element is displayed
  - boolean isEditable()
    
    Shorthand for !hasAttribute("readonly").
    throws:
    java.lang.UnsupportedOperationException if this navigator contains anything else than an input or a textarea
    
    Returns:
    true when the first element is editable
  - boolean isEmpty()
    
    Returns true when there are no context elements.
    Returns:
    true when there are no context elements
  - boolean isEnabled()
    
    Shorthand for !hasAttribute("disabled").
    throws:
    java.lang.UnsupportedOperationException if this navigator contains anything else than a button, input, option, select or textarea
    
    Returns:
    true when the first element is enabled
  - boolean isReadOnly()
    
    Shorthand for hasAttribute("readonly").
    throws:
    java.lang.UnsupportedOperationException if this navigator contains anything else than an input or a textarea
    
    Returns:
    true when the first element is readonly
  - Iterator<Navigator> iterator()
  - Navigator last()
    
    Creates a new Navigator instance containing only the last context element (wrapped).
    Returns:
    new Navigator instance
  - WebElement lastElement()
    
    Returns the last context element (not wrapped).
    Returns:
    the last context element (not wrapped)
  - Navigator leftShift(def value)
  - Navigator next()
    
    Creates a new Navigator instance containing the next sibling elements of the current context elements.
    Returns:
    new Navigator instance
  - Navigator next(String selector)
    
    Creates a new Navigator instance containing the next sibling elements of the current context elements, matching the selector.
    Unlike next(), this method will keep looking for the first matching sibling until it finds a match or is out of siblings.
    
    Parameters:
    selector - to match
    Returns:
    new Navigator instance
  - Navigator next(Map<String, Object> attributes)
    
    Creates a new Navigator instance containing the next sibling elements of the current context elements, matching the given attributes.
    Unlike next(), this method will keep looking for the first matching sibling until it finds a match or is out of siblings.
    
    Parameters:
    attributes - to match
    Returns:
    new Navigator instance
  - Navigator next(Map<String, Object> attributes, String selector)
    
    Creates a new Navigator instance containing the next sibling elements of the current context elements, matching the selector and given attributes.
    Unlike next(), this method will keep looking for the first matching sibling until it finds a match or is out of siblings.
    
    Parameters:
    attributes - to match
    selector - to match
    Returns:
    new Navigator instance
  - Navigator nextAll()
    
    Creates a new Navigator instance containing all following sibling elements of the current context elements.
    Returns:
    new Navigator instance
  - Navigator nextAll(String selector)
    
    Creates a new Navigator instance containing all following sibling elements of the current context elements that match the selector.
    Unlike next(), this method will keep looking for the first matching sibling until it finds a match or is out of siblings.
    
    Parameters:
    selector - to match
    Returns:
    new Navigator instance
  - Navigator nextAll(Map<String, Object> attributes)
    
    Creates a new Navigator instance containing all following sibling elements of the current context elements, matching the given attributes.
    Unlike next(), this method will keep looking for the first matching sibling until it finds a match or is out of siblings.
    
    Parameters:
    attributes - to match
    Returns:
    new Navigator instance
  - Navigator nextAll(Map<String, Object> attributes, String selector)
    
    Creates a new Navigator instance containing all following sibling elements of the current context elements, matching the selector and given attributes.
    Unlike next(), this method will keep looking for the first matching sibling until it finds a match or is out of siblings.
    
    Parameters:
    attributes - to match
    selector - to match
    Returns:
    new Navigator instance
  - Navigator nextUntil(String selector)
    
    Creates a new Navigator instance containing all following sibling elements of the current context elements up to, but not including, the first to match the selector.
    Parameters:
    selector - to match
    Returns:
    new Navigator instance
  - Navigator nextUntil(Map<String, Object> attributes)
    
    Creates a new Navigator instance containing all following sibling elements of the current context elements up to, but not including, the first to match the given attributes.
    Parameters:
    attributes - to match
    Returns:
    new Navigator instance
  - Navigator nextUntil(Map<String, Object> attributes, String selector)
    
    Creates a new Navigator instance containing all following sibling elements of the current context elements up to, but not including, the first to match the selector and given attributes.
    Parameters:
    attributes - to match
    selector - to match
    Returns:
    new Navigator instance
  - Navigator not(String selector)
    
    Returns a new Navigator instance containing all elements of the current Navigator that do not match the selector.
    Parameters:
    selector - a CSS selector
    Returns:
    a new Navigator instance
  - Navigator not(Map<String, Object> predicates, String selector)
    
    Returns a new Navigator instance containing all elements of the current Navigator that do not match the selector and attributes as defined in the predicate.
    Parameters:
    predicates - a Map with keys representing attributes and values representing required values or patterns
    selector - a CSS selector
    Returns:
    a new Navigator instance
  - Navigator not(Map<String, Object> predicates)
    
    Returns a new Navigator instance containing all elements of the current Navigator that do not match the attributes as defined in the predicate.
    Parameters:
    predicates - a Map with keys representing attributes and values representing required values or patterns
    Returns:
    a new Navigator instance
  - Navigator parent()
    
    Creates a new Navigator instance containing the direct parent elements of the current context elements.
    Returns:
    new Navigator instance
  - Navigator parent(String selector)
    
    Creates a new Navigator instance containing the direct parent elements of the current context elements that match the selector.
    Parameters:
    selector - to match
    Returns:
    new Navigator instance
  - Navigator parent(Map<String, Object> attributes)
    
    Creates a new Navigator instance containing the direct parent elements of the current context elements that match the given attributes.
    Parameters:
    attributes - to match
    Returns:
    new Navigator instance
  - Navigator parent(Map<String, Object> attributes, String selector)
    
    Creates a new Navigator instance containing the direct parent elements of the current context elements that match the selector and given attributes.
    Parameters:
    attributes - to match
    selector - to match
    Returns:
    new Navigator instance
  - Navigator parents()
    
    Creates a new Navigator instance containing all the ancestor elements of the current context elements.
    Returns:
    new Navigator instance
  - Navigator parents(String selector)
    
    Creates a new Navigator instance containing all the ancestor elements of the current context elements that match the selector.
    Parameters:
    selector - to match
    Returns:
    new Navigator instance
  - Navigator parents(Map<String, Object> attributes)
    
    Creates a new Navigator instance containing all the ancestor elements of the current context elements that match the given attributes.
    Parameters:
    attributes - to match
    Returns:
    new Navigator instance
  - Navigator parents(Map<String, Object> attributes, String selector)
    
    Creates a new Navigator instance containing all the ancestor elements of the current context elements that match the given attributes.
    Parameters:
    attributes - to match
    selector - to match
    Returns:
    new Navigator instance
  - Navigator parentsUntil(String selector)
    
    Creates a new Navigator instance containing all the ancestor elements of the current context elements up to but not including the first that matches the selector.
    Parameters:
    selector - to match
    Returns:
    new Navigator instance
  - Navigator parentsUntil(Map<String, Object> attributes)
    
    Creates a new Navigator instance containing all the ancestor elements of the current context elements up to but not including the first that matches the given attributes.
    Parameters:
    attributes - to match
    Returns:
    new Navigator instance
  - Navigator parentsUntil(Map<String, Object> attributes, String selector)
    
    Creates a new Navigator instance containing all the ancestor elements of the current context elements up to but not including the first that matches the selector and given attributes.
    Parameters:
    attributes - to match
    selector - to match
    Returns:
    new Navigator instance
  - Navigator plus(Navigator navigator)
    
    Merges the Navigator instance with the current instance to create a new Navigator instance containing the context elements of both.
    Parameters:
    navigator - navigator to merge with this one
    Returns:
    new Navigator instance
  - Navigator prevAll()
    
    Creates a new Navigator instance containing all preceding sibling elements of the current context elements.
    Returns:
    new Navigator instance
  - Navigator prevAll(String selector)
    
    Creates a new Navigator instance containing all preceding sibling elements of the current context elements, matching the selector.
    Parameters:
    selector - to match
    Returns:
    new Navigator instance
  - Navigator prevAll(Map<String, Object> attributes)
    
    Creates a new Navigator instance containing all preceding sibling elements of the current context elements, matching the given attributes.
    Parameters:
    attributes - to match
    Returns:
    new Navigator instance
  - Navigator prevAll(Map<String, Object> attributes, String selector)
    
    Creates a new Navigator instance containing all preceding sibling elements of the current context elements, matching the selector and given attributes.
    Parameters:
    selector - to match
    attributes - to match
    Returns:
    new Navigator instance
  - Navigator prevUntil(String selector)
    
    Creates a new Navigator instance containing all preceding sibling elements of the current context elements up to, but not including the first matching the selector.
    Parameters:
    selector - to match
    Returns:
    new Navigator instance
  - Navigator prevUntil(Map<String, Object> attributes)
    
    Creates a new Navigator instance containing all preceding sibling elements of the current context elements up to, but not including the first matching the given attributes.
    Parameters:
    attributes - to match
    Returns:
    new Navigator instance
  - Navigator prevUntil(Map<String, Object> attributes, String selector)
    
    Creates a new Navigator instance containing all preceding sibling elements of the current context elements up to, but not including the first matching the selector and given attributes.
    Parameters:
    attributes - to match
    selector - to match
    Returns:
    new Navigator instance
  - Navigator previous()
    
    Creates a new Navigator instance containing the previous sibling elements of the current context elements.
    Returns:
    new Navigator instance
  - Navigator previous(String selector)
    
    Creates a new Navigator instance containing the previous sibling elements of the current context elements, matching the selector.
    Unlike previous(), this method will keep looking for the first matching sibling until it finds a match or is out of siblings.
    
    Parameters:
    selector - to match
    Returns:
    new Navigator instance
  - Navigator previous(Map<String, Object> attributes)
    
    Creates a new Navigator instance containing the previous sibling elements of the current context elements, matching the given attributes.
    Unlike previous(), this method will keep looking for the first matching sibling until it finds a match or is out of siblings.
    
    Parameters:
    attributes - to match
    Returns:
    new Navigator instance
  - Navigator previous(Map<String, Object> attributes, String selector)
    
    Creates a new Navigator instance containing the previous sibling elements of the current context elements, matching the selector and given attributes.
    Unlike previous(), this method will keep looking for the first matching sibling until it finds a match or is out of siblings.
    
    Parameters:
    attributes - to match
    selector - to match
    Returns:
    new Navigator instance
  - Navigator remove(int index)
    
    Creates a new Navigator instance by removing the element at the given index from the context.
    If no such element exists, the current instance is returned.
    
    Parameters:
    index - index of the element to remove - pass a negative value to start from the back
    Returns:
    new Navigator instance
  - Navigator siblings()
    
    Creates a new Navigator instance containing all the sibling elements of the current context elements.
    Returns:
    new Navigator instance
  - Navigator siblings(String selector)
    
    Creates a new Navigator instance containing all the sibling elements of the current context elements that match the selector.
    Parameters:
    selector - to match
    Returns:
    new Navigator instance
  - Navigator siblings(Map<String, Object> attributes)
    
    Creates a new Navigator instance containing all the sibling elements of the current context elements that match the given attributes.
    Parameters:
    attributes - to match
    Returns:
    new Navigator instance
  - Navigator siblings(Map<String, Object> attributes, String selector)
    
    Creates a new Navigator instance containing all the sibling elements of the current context elements that match the selector and given attributes.
    Parameters:
    attributes - to match
    selector - to match
    Returns:
    new Navigator instance
  - int size()
    
    Returns the number of context elements.
    Returns:
    the number of context elements
  - String tag()
    
    Returns the tag name of the first context element.
    Returns:
    the tag name of the first context element
  - Navigator tail()
    
    Creates a new Navigator instance containing all but the first context element (wrapped).
    Returns:
    new Navigator instance
  - String text()
    
    Returns the text content of the first context element.
    Returns:
    the text content of the first context element
  - Navigator unique()
    
    Creates a new Navigator instance containing all elements of this instance with duplicate elements removed
  - def value()
    
    Returns the value of the first context element for input elements (including textarea, select and button).
    In the case of a select, the value of the first selected option is returned.
    
    Returns:
    value of the first context element
  - Navigator value(def value)
    
    Sets the value of the form input elements to the given value.
    Parameters:
    value - value to use
    Returns:
    current Navigator instance
  - Navigator verifyNotEmpty()
    
    Throws an exception when the Navigator instance is empty.
    Returns:
    the current Navigator instance

Summary:
Method

| Detail:
Method

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

[Groovy] Interface Navigator

Methods Summary

Inherited Methods Summary

Method Detail

Navigator $(Map<String, Object> predicates)

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

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

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

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

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

Navigator $(String selector)

Navigator $(String selector, int index)

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

Navigator add(String selector)

Navigator add(WebElement[] elements)

Navigator add(Collection<WebElement> elements)

Collection<WebElement> allElements()

String attr(String name)

Navigator children()

Navigator children(String selector)

Navigator children(Map<String, Object> attributes)

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

List<String> classes()

Navigator click()

Navigator click(Class<? extends Page> pageClass)

Navigator click(Class<? extends Page> pageClass, Wait wait)

Navigator click(List<Class<? extends Page>> potentialPageClasses)

Navigator click(List<Class<? extends Page>> potentialPageClasses, Wait wait)

Navigator closest(String selector)

Navigator closest(Map<String, Object> attributes)

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

String css(String propertyName)

Navigator eq(int index)

Navigator filter(String selector)

Navigator filter(Map<String, Object> predicates)

Navigator filter(Map<String, Object> predicates, String selector)

Navigator find(Map<String, Object> predicates)

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

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

Navigator find(Map<String, Object> predicates, String selector)

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

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

Navigator find(String selector)

Navigator find(String selector, int index)

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

Navigator findAll(Closure predicate)

Navigator first()

WebElement firstElement()

Navigator getAt(int index)

Navigator getAt(Range range)

Navigator getAt(Collection indexes)

String getAttribute(String name)

int getHeight()

JQueryAdapter getJquery()

int getWidth()

int getX()

int getY()

Navigator has(String selector)

Navigator has(Map<String, Object> predicates, String selector)

Navigator has(Map<String, Object> predicates)

boolean hasClass(String className)

Navigator head()

boolean is(String tag)

boolean isDisabled()

boolean isDisplayed()

boolean isEditable()

boolean isEmpty()

boolean isEnabled()

boolean isReadOnly()

Iterator<Navigator> iterator()

Navigator last()

WebElement lastElement()

Navigator leftShift(def value)

Navigator next()

Navigator next(String selector)

Navigator next(Map<String, Object> attributes)

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

Navigator nextAll()

Navigator nextAll(String selector)

Navigator nextAll(Map<String, Object> attributes)