Web.WebInteraction

public class Web.WebInteraction<R>

Analogous to a ViewInteraction or a DataInteraction, a WebInteraction exposes a fluent API to the underlying WebView.

Summary

Public methods
Web.WebInteraction<E>
<E> check(WebAssertion<E> assertion)

Evaluates the given WebAssertion.
Web.WebInteraction<R>

Performs a force enable of Javascript on a WebView.
R
get()

Returns the result of a prior call to perform or check.
Web.WebInteraction<R>

Causes this WebInteraction to have it's javascript evaluated in a particular DOM window.
Web.WebInteraction<R>

Causes this WebInteraction to have it's javascript evaluated in a particular DOM window.
Web.WebInteraction<E>
<E> perform(Atom<E> atom)

Executes the provided atom within the current context (the combination of Window and Element References).
Web.WebInteraction<R>

Removes the Element and Window references from this interaction.
Web.WebInteraction<R>

Allows for contextually evaluating this WebInteraction with the selected element.
Web.WebInteraction<R>

Causes this WebInteraction to supply the given ElementReference to the Atom prior to evaluation.
Web.WebInteraction<R>

Causes this WebInteraction to supply the given ElementReference to the Atom prior to evaluation.
Web.WebInteraction<R>

Disables all Timeouts on this WebInteraction.
Web.WebInteraction<R>
@CheckReturnValue
withTimeout(long amount, TimeUnit unit)

Sets a specific timeout for this WebInteraction.

Public methods

check

public Web.WebInteraction<E> <E> check(WebAssertion<E> assertion)

Evaluates the given WebAssertion.

The WebAssertion's atom is evaluated, after it's evaluation completes, the WebAssertion is run on the main thread to perform further checks. The WebAssertion is given the Atom's result and the WebView it had run against.

After this method completes, the result of the atom's evaluation is avaliable via get.

forceJavascriptEnabled

public Web.WebInteraction<R> forceJavascriptEnabled()

Performs a force enable of Javascript on a WebView.

All WebView interactions are done via Javascript - therefore the WebView we are working on must support Javascript evaluation.

Enabling Javascript may cause the WebView under test to be reloaded. This is necessary to ensure the test infrastructure javascript bridges are loaded by the WebView.

get

public R get()

Returns the result of a prior call to perform or check.

inWindow

@CheckReturnValue
public Web.WebInteraction<R> inWindow(WindowReference window)

Causes this WebInteraction to have it's javascript evaluated in a particular DOM window.

By default Javascript may be evaluated in the main window. However in an application which uses frames, you may want to evaluate in another frame.

inWindow

@CheckReturnValue
public Web.WebInteraction<R> inWindow(Atom<WindowReference> windowPicker)

Causes this WebInteraction to have it's javascript evaluated in a particular DOM window.

This method accepts an Atom which will be evaluated in the main window to choose a particular DOM window for further interactions. This method will block until the the provided Atom returns with a result.

perform

public Web.WebInteraction<E> <E> perform(Atom<E> atom)

Executes the provided atom within the current context (the combination of Window and Element References).

This method blocks until the Atom returns. The result of the Atom's evaluation is used to create a new instance of WebInteraction which can be used to access the result of the Atom's evaluation.

reset

public Web.WebInteraction<R> reset()

Removes the Element and Window references from this interaction.

This is usually necessary when a prior action (for example a click) introduces a navigation that invalidates the ElementReference and WindowReference pointers.

withContextualElement

@CheckReturnValue
public Web.WebInteraction<R> withContextualElement(Atom<ElementReference> elementPicker)

Allows for contextually evaluating this WebInteraction with the selected element.

Specifically the elementPicker atom will be evaluated with the CURRENTLY selected element to discover the new element to work against.

This allows callers to interact with a document that looks like this: 

<div id="teacher">
  <div id="person_name">
    <p>Socrates</p>
  </div>
</div>
<div id="student">
  <div id="person_name">
    <p>Plato</p>
  </div>
</div>
With code like this: 
onWebView()
  .withElement(findElement(Locator.ID, "teacher"))
  .withContextualElement(findElement(Locator.ID, "person_name"))
  .check(webMatches(getText(), containsString("Socrates")));

withElement

@CheckReturnValue
public Web.WebInteraction<R> withElement(ElementReference element)

Causes this WebInteraction to supply the given ElementReference to the Atom prior to evaluation.

Calling this method resets any previously selected ElementReference.

{@see Atom#getArguments}

withElement

@CheckReturnValue
public Web.WebInteraction<R> withElement(Atom<ElementReference> elementPicker)

Causes this WebInteraction to supply the given ElementReference to the Atom prior to evaluation.

{@see Atom#getArguments}

This method accepts an Atomwhich it will evaluate on the current context's Window. This method blocks until the evaluation completes.

Calling this method resets any previously selected ElementReference.

If you want to evaluate the elementPicker in the context of the previously selected ElementReference {@see #withContextualElement}

withNoTimeout

@CheckReturnValue
public Web.WebInteraction<R> withNoTimeout()

Disables all Timeouts on this WebInteraction.

Javascript evaluation is performed asynchronously on the WebKit/Chromium thread. By default we wait a short while for the result to be delivered back to the test.

withTimeout

@CheckReturnValue
public Web.WebInteraction<R> withTimeout(long amount, TimeUnit unit)

Sets a specific timeout for this WebInteraction.