geb.navigator.Navigator.groovy Maven / Gradle / Ivy
Show all versions of geb-core Show documentation
/*
* Copyright 2012 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package geb.navigator
import geb.Module
import geb.Page
import geb.content.StringRepresentationProvider
import geb.js.JQueryAdapter
import geb.navigator.event.NavigatorEventListener
import geb.waiting.Wait
import org.openqa.selenium.By
import org.openqa.selenium.WebElement
/**
* 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/
*/
interface Navigator extends Iterable, Locator, StringRepresentationProvider {
/**
* Filters the set of elements represented by this Navigator to include only that have one or more descendants
* that match the selector.
* @param selector a CSS selector
* @return a new Navigator instance
*/
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 and attributes as defined in the predicate.
* @param selector a CSS selector
* @param predicates a Map with keys representing attributes and values representing required values or patterns
* @return a new Navigator instance
*/
Navigator has(Map predicates, String selector)
/**
* 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.
* @param predicates a Map with keys representing attributes and values representing required values or patterns
* @return a new Navigator instance
*/
Navigator has(Map predicates)
/**
* Filters the set of elements represented by this Navigator to include only that have one or more descendants
* that match the bySelector.
* @param bySelector a WebDriver By selector
* @return a new Navigator instance
*/
Navigator has(By bySelector)
/**
* Filters the set of elements represented by this Navigator to include only that have one or more descendants
* that match the bySelector and attributes as defined in the predicate.
* @param bySelector a WebDriver By selector
* @param predicates a Map with keys representing attributes and values representing required values or patterns
* @return a new Navigator instance
*/
Navigator has(Map predicates, By bySelector)
/**
* Filters the set of elements represented by this Navigator to include only those that match
* the selector.
* @param selector a CSS selector
* @return a new Navigator instance
*/
Navigator filter(String selector)
Navigator filter(Map predicates)
Navigator filter(Map predicates, String selector)
/**
* Returns a new Navigator instance containing all elements of the current Navigator that do not match the selector.
* @param selector a CSS selector
* @return a 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
* and attributes as defined in the predicate.
* @param predicates a Map with keys representing attributes and values representing required values or patterns
* @param selector a CSS selector
* @return a new Navigator instance
*/
Navigator not(Map predicates, String selector)
/**
* Returns a new Navigator instance containing all elements of the current Navigator that do not match the attributes
* as defined in the predicate.
* @param predicates a Map with keys representing attributes and values representing required values or patterns
* @return a new Navigator instance
*/
Navigator not(Map predicates)
/**
* Filters the set of elements represented by this Navigator to exclude that have one or more descendants
* that match the selector.
* @param selector a CSS selector
* @return a new Navigator instance
*/
Navigator hasNot(String selector)
/**
* Filters the set of elements represented by this Navigator to exclude that have one or more descendants
* that match the selector and attributes as defined in the predicate.
* @param selector a CSS selector
* @param predicates a Map with keys representing attributes and values representing excluded values or patterns
* @return a new Navigator instance
*/
Navigator hasNot(Map predicates, String selector)
/**
* Filters the set of elements represented by this Navigator to exclude that have one or more descendants
* that match the attributes as defined in the predicate.
* @param predicates a Map with keys representing attributes and values representing excluded values or patterns
* @return a new Navigator instance
*/
Navigator hasNot(Map predicates)
/**
* Filters the set of elements represented by this Navigator to exclude that have one or more descendants
* that match the bySelector.
* @param bySelector a WebDriver By selector
* @return a new Navigator instance
*/
Navigator hasNot(By bySelector)
/**
* Filters the set of elements represented by this Navigator to exclude that have one or more descendants
* that match the bySelector and attributes as defined in the predicate.
* @param bySelector a WebDriver By selector
* @param predicates a Map with keys representing attributes and values representing required values or patterns
* @return a new Navigator instance
*/
Navigator hasNot(Map predicates, By bySelector)
/**
* Gets the wrapped element at the given index.
*
* When no such element exists, an empty Navigator instance is returned.
*
* @param index index of the element to retrieve - pass a negative value to start from the back
* @return new Navigator instance
*/
Navigator eq(int index)
/**
* Gets the wrapped element at the given index.
*
* When no such element exists, an empty Navigator instance is returned.
*
* @param index index of the element to retrieve - pass a negative value to start from the back
* @return new Navigator instance
*/
Navigator getAt(int index)
/**
* Gets the wrapped elements in the given range.
*
* When no such elements exist, an empty Navigator instance is returned.
*
* @param range range of the elements to retrieve
* @return new Navigator instance
*/
Navigator getAt(Range range)
/**
* Gets the wrapped elements at the given indexes.
*
* When no such elements exist, an empty Navigator instance is returned.
*
* @param indexes indexes of the elements to retrieve
* @return new Navigator instance
*/
Navigator getAt(Collection indexes)
Navigator add(String selector)
Navigator add(By bySelector)
Navigator add(WebElement[] elements)
Navigator add(Collection elements)
/**
* 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.
*
* @param index index of the element to remove - pass a negative value to start from the back
* @return new Navigator instance
*/
Navigator remove(int index)
/**
* Merges the Navigator instance with the current instance to create a new
* Navigator instance containing the context elements of both.
* @param navigator navigator to merge with this one
* @return new Navigator instance
*/
Navigator plus(Navigator navigator)
/**
* Creates a new Navigator instance containing the next sibling elements of the
* current context elements.
* @return new Navigator instance
*/
Navigator next()
/**
* Creates a new Navigator instance containing the next sibling elements of the
* current context elements, matching the selector.
*
* Unlike {@link #next()}, this method will keep looking for the first
* matching sibling until it finds a match or is out of siblings.
*
* @param selector to match
* @return new Navigator instance
*/
Navigator next(String selector)
/**
* Creates a new Navigator instance containing the next sibling elements of the
* current context elements, matching the given attributes.
*
* Unlike {@link #next()}, this method will keep looking for the first
* matching sibling until it finds a match or is out of siblings.
*
* @param attributes to match
* @return new Navigator instance
*/
Navigator next(Map attributes)
/**
* Creates a new Navigator instance containing the next sibling elements of the
* current context elements, matching the selector and given attributes.
*
* Unlike {@link #next()}, this method will keep looking for the first
* matching sibling until it finds a match or is out of siblings.
*
* @param attributes to match
* @param selector to match
* @return new Navigator instance
*/
Navigator next(Map attributes, String selector)
/**
* Creates a new Navigator instance containing all following sibling elements of the
* current context elements.
* @return new Navigator instance
*/
Navigator nextAll()
/**
* Creates a new Navigator instance containing all following sibling elements of the
* current context elements that match the selector.
*
* Unlike {@link #next()}, this method will keep looking for the first
* matching sibling until it finds a match or is out of siblings.
*
* @param selector to match
* @return new Navigator instance
*/
Navigator nextAll(String selector)
/**
* Creates a new Navigator instance containing all following sibling elements of the
* current context elements, matching the given attributes.
*
* Unlike {@link #next()}, this method will keep looking for the first
* matching sibling until it finds a match or is out of siblings.
*
* @param attributes to match
* @return new Navigator instance
*/
Navigator nextAll(Map attributes)
/**
* Creates a new Navigator instance containing all following sibling elements of the
* current context elements, matching the selector and given attributes.
*
* Unlike {@link #next()}, this method will keep looking for the first
* matching sibling until it finds a match or is out of siblings.
*
* @param attributes to match
* @param selector to match
* @return new Navigator instance
*/
Navigator nextAll(Map 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.
*
* @param selector to match
* @return 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 given attributes.
*
* @param attributes to match
* @return new Navigator instance
*/
Navigator nextUntil(Map 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 selector and given attributes.
*
* @param attributes to match
* @param selector to match
* @return new Navigator instance
*/
Navigator nextUntil(Map attributes, String selector)
/**
* Creates a new Navigator instance containing the previous sibling elements of the
* current context elements.
* @return new Navigator instance
*/
Navigator previous()
/**
* Creates a new Navigator instance containing all preceding sibling elements of the
* current context elements.
* @return new Navigator instance
*/
Navigator prevAll()
/**
* Creates a new Navigator instance containing the previous sibling elements of the
* current context elements, matching the selector.
*
* Unlike {@link #previous()}, this method will keep looking for the first
* matching sibling until it finds a match or is out of siblings.
*
* @param selector to match
* @return new Navigator instance
*/
Navigator previous(String selector)
/**
* Creates a new Navigator instance containing the previous sibling elements of the
* current context elements, matching the given attributes.
*
* Unlike {@link #previous()}, this method will keep looking for the first
* matching sibling until it finds a match or is out of siblings.
*
* @param attributes to match
* @return new Navigator instance
*/
Navigator previous(Map attributes)
/**
* Creates a new Navigator instance containing the previous sibling elements of the
* current context elements, matching the selector and given attributes.
*
* Unlike {@link #previous()}, this method will keep looking for the first
* matching sibling until it finds a match or is out of siblings.
*
* @param attributes to match
* @param selector to match
* @return new Navigator instance
*/
Navigator previous(Map attributes, String selector)
/**
* Creates a new Navigator instance containing all preceding sibling elements of the
* current context elements, matching the selector.
*
* @param selector to match
* @return new Navigator instance
*/
Navigator prevAll(String selector)
/**
* Creates a new Navigator instance containing all preceding sibling elements of the
* current context elements, matching the given attributes.
*
* @param attributes to match
* @return new Navigator instance
*/
Navigator prevAll(Map attributes)
/**
* Creates a new Navigator instance containing all preceding sibling elements of the
* current context elements, matching the selector and given attributes.
*
* @param selector to match
* @param attributes to match
* @return new Navigator instance
*/
Navigator prevAll(Map 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.
*
* @param selector to match
* @return 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 given attributes.
*
* @param attributes to match
* @return new Navigator instance
*/
Navigator prevUntil(Map 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 selector and given attributes.
*
* @param attributes to match
* @param selector to match
* @return new Navigator instance
*/
Navigator prevUntil(Map attributes, String selector)
/**
* Creates a new Navigator instance containing the direct parent elements of the
* current context elements.
* @return new Navigator instance
*/
Navigator parent()
/**
* Creates a new Navigator instance containing the direct parent elements of the current
* context elements that match the selector.
*
* @param selector to match
* @return 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 given attributes.
*
* @param attributes to match
* @return new Navigator instance
*/
Navigator parent(Map attributes)
/**
* Creates a new Navigator instance containing the direct parent elements of the current
* context elements that match the selector and given attributes.
*
* @param attributes to match
* @param selector to match
* @return new Navigator instance
*/
Navigator parent(Map attributes, String selector)
/**
* Creates a new Navigator instance containing all the ancestor elements of the
* current context elements.
* @return new Navigator instance
*/
Navigator parents()
/**
* Creates a new Navigator instance containing all the ancestor elements of the
* current context elements that match the selector.
*
* @param selector to match
* @return 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 given attributes.
*
* @param attributes to match
* @return new Navigator instance
*/
Navigator parents(Map attributes)
/**
* Creates a new Navigator instance containing all the ancestor elements of the
* current context elements that match the given attributes.
*
* @param attributes to match
* @param selector to match
* @return new Navigator instance
*/
Navigator parents(Map 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.
*
* @param selector to match
* @return 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 given attributes.
*
* @param attributes to match
* @return new Navigator instance
*/
Navigator parentsUntil(Map 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 selector and given attributes.
*
* @param attributes to match
* @param selector to match
* @return new Navigator instance
*/
Navigator parentsUntil(Map attributes, String selector)
/**
* Creates a new Navigator instance containing the first ancestor element of each of the current
* context elements that match the selector.
*
* Unlike {@link #parent()}, this method will keep traversing up the DOM
* until a match is found or the top of the DOM has been found
*
* @param selector to match
* @return new Navigator instance
*/
Navigator closest(String selector)
/**
* Creates a new Navigator instance containing the first ancestor element of each of the current
* context elements that match the given attributes.
*
* Unlike {@link #parent()}, this method will keep traversing up the DOM
* until a match is found or the top of the DOM has been found
*
* @param attributes to match
* @return new Navigator instance
*/
Navigator closest(Map attributes)
/**
* 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 {@link #parent()}, this method will keep traversing up the DOM
* until a match is found or the top of the DOM has been found
*
* @param selector to match
* @param attributes to match
* @return new Navigator instance
*/
Navigator closest(Map attributes, String selector)
/**
* Creates a new Navigator instance containing all the child elements of the
* current context elements.
* @return new Navigator instance
*/
Navigator children()
/**
* Creates a new Navigator instance containing all the child elements of the
* current context elements that match the selector.
*
* @param selector to match
* @return 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 given attributes.
*
* @param attributes to match
* @return new Navigator instance
*/
Navigator children(Map attributes)
/**
* Creates a new Navigator instance containing all the child elements of the
* current context elements that match the selector and given attributes.
*
* @param attributes to match
* @param selector to match
* @return new Navigator instance
*/
Navigator children(Map attributes, String selector)
/**
* Creates a new Navigator instance containing all the sibling elements of the
* current context elements.
* @return new Navigator instance
*/
Navigator siblings()
/**
* Creates a new Navigator instance containing all the sibling elements of the
* current context elements that match the selector.
*
* @param selector to match
* @return 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 given attributes.
*
* @param attributes to match
* @return new Navigator instance
*/
Navigator siblings(Map attributes)
/**
* Creates a new Navigator instance containing all the sibling elements of the
* current context elements that match the selector and given attributes.
*
* @param attributes to match
* @param selector to match
* @return new Navigator instance
*/
Navigator siblings(Map attributes, String selector)
/**
* Returns true if the sole context element has the given class or false for empty Navigators.
* Cannot be called on multi element Navigators.
*
* @param className class to check for
* @return true if the sole context element has the given class
* @throws geb.error.SingleElementNavigatorOnlyMethodException when called on a multi element navigator
*/
boolean hasClass(String className)
/**
* Returns true if the sole context element tag name matches the string passed as the argument or false for empty Navigators.
* Cannot be called on multi element Navigators.
*
* @param tag tag name to match
* @return true if at least one of the context elements matches the tag
* @throws geb.error.SingleElementNavigatorOnlyMethodException when called on a multi element navigator
*/
boolean is(String tag)
/**
* Returns true if the sole context element is displayed or false for empty Navigators.
* Cannot be called on multi element Navigators.
*
* @return true if the first element is displayed
* @throws geb.error.SingleElementNavigatorOnlyMethodException when called on a multi element navigator
*/
boolean isDisplayed()
/**
* Returns the tag name of the sole context element or null for empty Navigators.
* Cannot be called on multi element Navigators.
*
* @return the tag name of the sole context element
* @throws geb.error.SingleElementNavigatorOnlyMethodException when called on a multi element navigator
*/
String tag()
/**
* Returns the visible (i.e. not hidden by CSS) inner text content of the sole context element and its sub-elements or null for empty Navigators.
* Cannot be called on multi element Navigators.
*
* @return the text content of the sole context element
* @throws geb.error.SingleElementNavigatorOnlyMethodException when called on a multi element navigator
*/
String text()
/**
* Returns the value of the given attribute of the sole context element or null for empty Navigators.
* Cannot be called on multi element Navigators.
*
* @param name name of the attribute
* @return the value of the given attribute of the sole context element
* @throws geb.error.SingleElementNavigatorOnlyMethodException when called on a multi element navigator
*/
String getAttribute(String name)
/**
* Returns the value of the given attribute of the sole context element or null for empty Navigators.
* Cannot be called on multi element Navigators.
*
* @param name name of the attribute
* @return the value of the given attribute of the sole context element
* @throws geb.error.SingleElementNavigatorOnlyMethodException when called on a multi element navigator
*/
String attr(String name)
/**
* Returns an alphabetically sorted list of class names present on the sole context element or an empty list for empty Navigators.
* Cannot be called on multi element Navigators.
*
* @return an alphabetically sorted list of class names present on the sole context element
* @throws geb.error.SingleElementNavigatorOnlyMethodException when called on a multi element navigator
*/
List classes()
/**
* Returns the value of the sole context element for input elements
* (including textarea, select and button) or null for empty Navigators.
* Cannot be called on multi element Navigators.
*
* In the case of a select, the value of the selected option or a list of selected options is returned.
*
*
* @return value of the sole context element
* @throws geb.error.SingleElementNavigatorOnlyMethodException when called on a multi element navigator
*/
def value()
/**
* Sets the value of the form input elements to the given value.
* @param value value to use
* @return current Navigator instance
*/
Navigator value(value)
Navigator leftShift(value)
/**
* Clicks on the sole context element.
* Cannot be called on multi element Navigators.
*
* @throws geb.error.SingleElementNavigatorOnlyMethodException when called on a multi element navigator
*/
Navigator click()
/**
* Clicks on the sole context element, verifies the at checker (if it is defined) of the class passed as the argument and sets it as the current page.
* Cannot be called on multi element Navigators.
*
* @param pageClass page class to be used as the new current page after clicking the element
* @return this
* @throws geb.error.SingleElementNavigatorOnlyMethodException when called on a multi element navigator
*/
Navigator click(Class pageClass)
/**
* Clicks on the sole context element, verifies the at checker (if it is defined) of the instance passed as the argument and sets it as the current page.
* Cannot be called on multi element Navigators.
*
* @param pageInstance page instance to be used as the new current page after clicking the element
* @return this
* @throws geb.error.SingleElementNavigatorOnlyMethodException when called on a multi element navigator
*/
Navigator click(Page pageInstance)
/**
* Clicks on the sole context element, verifies the at checker (if it is defined) of the instance passed as the argument and sets it as the current page.
* Cannot be called on multi element Navigators.
*
* @param pageClass page class to be used as the new current page after clicking the element
* @param wait configuration to be used for waiting for the at checker to succeed
* @return this
* @throws geb.error.SingleElementNavigatorOnlyMethodException when called on a multi element navigator
*/
Navigator click(Class pageClass, Wait wait)
/**
* Clicks on the sole context element, verifies the at checker (if it is defined) of the instance passed as the argument and sets it as the current page.
* Cannot be called on multi element Navigators.
*
* @param pageInstance page instance to be used as the new current page after clicking the element
* @param wait configuration to be used for waiting for the at checker to succeed
* @return this
* @throws geb.error.SingleElementNavigatorOnlyMethodException when called on a multi element navigator
*/
Navigator click(Page pageInstance, Wait wait)
/**
* Clicks on the sole context element, finds the first page from the list for which the at checker is defined and sets it as the current page.
* Cannot be called on multi element Navigators.
*
* @param potentialPages a list of classes extending {@link geb.Page} or a list of instances of such classes
* @return this
* @throws geb.error.SingleElementNavigatorOnlyMethodException when called on a multi element navigator
*/
Navigator click(List potentialPages)
/**
* Clicks on the sole context element, finds the first page from the list for which the at checker is defined and sets it as the current page.
* Cannot be called on multi element Navigators.
*
* @param potentialPages a list of classes extending {@link geb.Page} or a list of instances of such classes
* @param wait configuration to be used for waiting for the at checkers to succeed
* @return this
* @throws geb.error.SingleElementNavigatorOnlyMethodException when called on a multi element navigator
*/
Navigator click(List potentialPages, Wait wait)
/**
* Returns the number of context elements.
* @return the number of context elements
*/
int size()
/**
* Returns true when there are no context elements.
* @return true when there are no context elements
*/
boolean isEmpty()
/**
* Creates a new Navigator instance containing only the first context element (wrapped).
* @return new Navigator instance
*/
Navigator head()
/**
* Creates a new Navigator instance containing only the first context element (wrapped).
* @return new Navigator instance
*/
Navigator first()
/**
* Creates a new Navigator instance containing only the last context element (wrapped).
* @return new Navigator instance
*/
Navigator last()
/**
* Creates a new Navigator instance containing all but the first context element (wrapped).
* @return new Navigator instance
*/
Navigator tail()
/**
* Returns the sole context element (not wrapped).
* Cannot be called on multi element Navigators.
*
* @return the sole context element (not wrapped)
* @throws geb.error.SingleElementNavigatorOnlyMethodException when called on a multi element navigator
*/
// tag::web_element_returning_methods[]
WebElement singleElement()
// end::web_element_returning_methods[]
/**
* Returns the first context element (not wrapped).
* @return the first context element (not wrapped)
*/
// tag::web_element_returning_methods[]
WebElement firstElement()
// end::web_element_returning_methods[]
/**
* Returns the last context element (not wrapped).
* @return the last context element (not wrapped)
*/
// tag::web_element_returning_methods[]
WebElement lastElement()
// end::web_element_returning_methods[]
/**
* Returns all context elements.
* @return all context elements
*/
// tag::web_element_returning_methods[]
Collection allElements()
// end::web_element_returning_methods[]
Iterator elementIterator()
Iterator iterator()
/**
* Overrides the standard Groovy findAll so that the object returned is a Navigator rather than a Collection.
*/
Navigator findAll(Closure predicate)
/**
* Throws an exception when the Navigator instance is empty.
* @return the current Navigator instance
*/
Navigator verifyNotEmpty()
/**
* Returns an adapter for calling jQuery methods on the elements in this navigator.
*/
JQueryAdapter getJquery()
/**
* Returns the height of the sole element the navigator matches or 0 if it matches nothing.
* Cannot be called on multi element Navigators.
*
* To get the height of all matched elements you can use the spread operator {@code navigator*.height}
*
* @throws geb.error.SingleElementNavigatorOnlyMethodException when called on a multi element navigator
*/
int getHeight()
/**
* Returns the width of the sole element the navigator matches or 0 if it matches nothing.
* Cannot be called on multi element Navigators.
*
* To get the width of all matched elements you can use the spread operator {@code navigator*.width}
*
* @throws geb.error.SingleElementNavigatorOnlyMethodException when called on a multi element navigator
*/
int getWidth()
/**
* Returns the x coordinate (from the top left corner) of the sole element the navigator matches or 0 if it matches nothing.
* Cannot be called on multi element Navigators.
*
* To get the x coordinate of all matched elements you can use the spread operator {@code navigator*.x}
*
* @throws geb.error.SingleElementNavigatorOnlyMethodException when called on a multi element navigator
*/
int getX()
/**
* Returns the y coordinate (from the top left corner) of the sole element the navigator matches or 0 if it matches nothing.
* Cannot be called on multi element Navigators.
*
* To get the y coordinate of all matched elements you can use the spread operator {@code navigator*.y}
*
* @throws geb.error.SingleElementNavigatorOnlyMethodException when called on a multi element navigator
*/
int getY()
/**
* Creates a new Navigator instance containing all elements of this instance with duplicate elements removed
*/
Navigator unique()
/**
* Gets the value of a given CSS property of the sole context element or null for empty Navigators.
* Cannot be called on multi element Navigators.
*
*
* 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.
*
* @return The current, computed value of the property or null if the is not specified.
* @throws geb.error.SingleElementNavigatorOnlyMethodException when called on a multi element navigator
*/
String css(String propertyName)
/**
* Create and initialize an instance of the given module class, using {@code this} as its base.
*
* @param moduleClass a class extending {@link geb.Module}
* @return an initialized instance of the module class passed as the argument
*/
public T module(Class moduleClass)
/**
* Initialize a module instance using {@code this} as its base.
*
* @param module an instance of a class extending {@link geb.Module}
* @return an initialized instance of passed as the argument
*/
public T module(T module)
/**
* Create and initialize a list of module instances using navigators created from web elements which make up {@code this} navigator as their bases.
*
* @param moduleClass a class extending {@link geb.Module}
* @return a list of initialized instances of the module class passed as the argument
*/
public List moduleList(Class moduleClass)
/**
* Create a list of module instances using the provided factory and initialize them using navigators created from web elements which make up {@code this} navigator as their bases.
*
* @param moduleFactory a closure that should return a new module instance every time it's called
* @return a list of initialized module instances created using the factory closure passed in as the argument
*/
public List moduleList(Closure moduleFactory)
/**
* Checks if the sole element of {@code this} navigator is focused by comparing it to the element returned from {@link org.openqa.selenium.WebDriver.TargetLocator#activeElement()}.
* If the navigator is empty {@code false} will be returned. Cannot be called on multi element Navigators.
*
* @return {@code true} if the first element is focused
* @throws geb.error.SingleElementNavigatorOnlyMethodException when called on a multi element navigator
*/
boolean isFocused()
/**
* Provides the text to be returned from {@code toString()} as well as to be used as part of the value returned from {@code toString()} if this navigator backs a template derived
* content element.
*/
String getStringRepresentation()
void setEventListener(NavigatorEventListener listener)
}