com.jauntium

Class Document

java.lang.Object

com.jauntium.Element

com.jauntium.Document

All Implemented Interfaces:

Iterable<Element>, org.openqa.selenium.SearchContext, org.openqa.selenium.TakesScreenshot, org.openqa.selenium.WebElement

public class Document
extends Element

Represents an HTML document and provides convenience methods for accessing forms, tables, and pagination.

Method Summary

Modifier and Type	Method and Description
Form	apply(Object... args) Locates the first form in the document that has a large enough number of input fields to accommodate the number of args and then applies the specified parameters in succession to the form's editable (ie, visible and non-disabled) inputs, starting from the input after the most recently edited input, or starting from the first input, if the form has not yet been edited.
Form	getForm(Element formElement)
Form	getForm(int formIndex) Creates and returns a Form object to represent the HTML form denoted by the specified formIndex.
Form	getForm(String tagQuery) Returns an instance of class Form for the first form in the document that is matched by the specified tagQuery.
Form	getForm(org.openqa.selenium.WebElement formElement)
Form	getFormByButtons(String... buttonText) Returns a Form object for the first form Element in the document that contains buttons who's text/values are matched (case insensitive, whitespace-normalized) by the specified text, or throws a NotFound Exception.
int	getFormsCount() Returns the number of forms in the document.
Table	getTable(Element tableElement)
Table	getTable(String tagQuery) Returns an instance of type Table that relates to the first table in the document that matches the specified tagQuery.
Table	getTable(org.openqa.selenium.WebElement tableElement)
Table	getTableByText(String... regex) Returns a Table object for the first table Element in the document that contains th/td elements who's visible text is matched by the specified text, or throws a NotFound Exception.
String	nextPageUrl() Extracts and returns the 'next page' URL from a series of 'page number' hyperlinks within the current document, such as links that represent pages of search results; returns null if no such sequences or if multiple (non-equivalent) sequences were found.

Methods inherited from class com.jauntium.Element

clear, click, findEach, findElement, findElements, findEvery, findFirst, getAt, getAtStr, getAttribute, getAttributeNames, getChildElements, getChildNodes, getChildText, getChildText, getCssValue, getEach, getElement, getFirst, getLocation, getParent, getRect, getRoot, getScreenshotAs, getSize, getTagName, getText, getTextContent, getTextContent, innerHTML, innerHTML, innerHTML, isDisplayed, isEnabled, isSelected, iterator, nextElementSibling, nextNodeSibling, outerHTML, outerHTML, outerHTML, previousElementSibling, previousNodeSibling, remove, removeAttribute, sendKeys, setAttribute, submit, toNode, toString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Method Detail

getForm

public Form getForm(int formIndex)
             throws NotFound

Creates and returns a Form object to represent the HTML form denoted by the specified formIndex.

Parameters:

formIndex - the index of the form in HTML document, where the first form has formIndex 0.

Throws:

NotFound

getForm

public Form getForm(String tagQuery)
             throws NotFound

Returns an instance of class Form for the first form in the document that is matched by the specified tagQuery.

Parameters:

tagQuery - a query that has the general form <tagnameRegex attributeName="attributeValueRegex">childTextRegex where multiple attributes are allowed. In order for the query to match against an element, the tagnameRegex, attribute name, attributeValueRegex and immediateTextRegex must match if they are specified.
tagnameRegex: If tagnameRegex is a whitespace character, it will match any tagname. Otherwise, the tagnameRegex will be treated as case-insensitive and be evaluated against entire tagnames (ie will not match substrings). The tagnameRegex must begin with either an alphabetical character or a round opening bracket, and may not contain whitespace (though it may contain \\s, which matches whitespace)
attributeName: If no attributes are included in the query, the query will match any attributes in a candidate element (including one without attributes). Otherwise, the attributeName in the query is matched as a case-insensitive string, not as a regular expression.
attributeValueRegex: If attributeValueRegex is not present, the attributeName in the query will be matched against candidate attributeNames irrespective of their attributeValues. If attributeValueRegex is present, it will be treated as case-insensitive and be evaluated against the entire corresponding attribute value (ie will not match substrings).
childTextRegex: If childTextRegex is not present, the query will match any child text (including lack of text). Otherwise, childTextRegex will be evaluated against the concatenation of Text children of the Element (ie, not the concatenation of all Text descendants, just children). It's important to note that childTextRegex is case sensitive and by default does match against substrings since it uses Matcher.find().

Throws:

NotFound

getForm

public Form getForm(Element formElement)
             throws NotFound

Throws:

NotFound

getForm

public Form getForm(org.openqa.selenium.WebElement formElement)
             throws NotFound

Throws:

NotFound

getFormByButtons

public Form getFormByButtons(String... buttonText)
                      throws NotFound

Returns a Form object for the first form Element in the document that contains buttons who's text/values are matched (case insensitive, whitespace-normalized) by the specified text, or throws a NotFound Exception.

Parameters:

buttonText - specifies one more buttonText values for matching the button text/values, where the buttonText is case insensitive and whitespace insensitive (ie a whitespace character matches one or more adjacent whitespace characters).

Throws:

NotFound

getTable

public Table getTable(String tagQuery)
               throws NotFound

Returns an instance of type Table that relates to the first table in the document that matches the specified tagQuery.

Parameters:

tagQuery - a query that has the general form <tagnameRegex attributeName="attributeValueRegex">childTextRegex where multiple attributes are allowed. In order for the query to match against an element, the tagnameRegex, attribute name, attributeValueRegex and immediateTextRegex must match if they are specified.
tagnameRegex: If tagnameRegex is a whitespace character, it will match any tagname. Otherwise, the tagnameRegex will be treated as case-insensitive and be evaluated against entire tagnames (ie will not match substrings). The tagnameRegex must begin with either an alphabetical character or a round opening bracket, and may not contain whitespace (though it may contain \\s, which matches whitespace)
attributeName: If no attributes are included in the query, the query will match any attributes in a candidate element (including one without attributes). Otherwise, the attributeName in the query is matched as a case-insensitive string, not as a regular expression.
attributeValueRegex: If attributeValueRegex is not present, the attributeName in the query will be matched against candidate attributeNames irrespective of their attributeValues. If attributeValueRegex is present, it will be treated as case-insensitive and be evaluated against the entire corresponding attribute value (ie will not match substrings).
childTextRegex: If childTextRegex is not present, the query will match any child text (including lack of text). Otherwise, childTextRegex will be evaluated against the concatenation of Text children of the Element (ie, not the concatenation of all Text descendants, just children). It's important to note that childTextRegex is case sensitive and by default does match against substrings since it uses Matcher.find().

Throws:

NotFound

getTable

public Table getTable(Element tableElement)
               throws NotFound

Throws:

NotFound

getTable

public Table getTable(org.openqa.selenium.WebElement tableElement)
               throws NotFound

Throws:

NotFound

getTableByText

public Table getTableByText(String... regex)
                     throws NotFound

Returns a Table object for the first table Element in the document that contains th/td elements who's visible text is matched by the specified text, or throws a NotFound Exception. Text values from the table are obtained using Element.getText() and are matched in a case insensitive manner.

Parameters:

regex - specifies one more regular expression patterns for matching the visible text of one or more cells using Matcher.matches.

Throws:

NotFound

getFormsCount

public int getFormsCount()

Returns the number of forms in the document.

apply

public Form apply(Object... args)
           throws JauntiumException

Locates the first form in the document that has a large enough number of input fields to accommodate the number of args and then applies the specified parameters in succession to the form's editable (ie, visible and non-disabled) inputs, starting from the input after the most recently edited input, or starting from the first input, if the form has not yet been edited.

Parameters:

args - a String arg will populate a textfield/textarea/passwordField OR select the matching menuItem in a dropdown menu OR select the matching right-side label of a radiobutton (unless the string is "\t", in which case it will skip to the next form component); a Boolean arg will set/unset a checkbox; any other type of arg will be treated as a String by calling its toString() method; If number of args exceeds the number of form controls, the extra args are ignored.

Throws:

JauntiumException

nextPageUrl

public String nextPageUrl()

Extracts and returns the 'next page' URL from a series of 'page number' hyperlinks within the current document, such as links that represent pages of search results; returns null if no such sequences or if multiple (non-equivalent) sequences were found.