org.senchalabs.gwt.gwtdriver.models

Class GwtWidget<F extends GwtWidgetFinder<?>>

java.lang.Object

org.senchalabs.gwt.gwtdriver.models.GwtWidget<F>

Direct Known Subclasses:

Dialog, GwtLabel, Input, WidgetContainer

@GwtWidget.ForWidget(value=com.google.gwt.user.client.ui.Widget.class)
public class GwtWidget<F extends GwtWidgetFinder<?>>
extends Object

Represents a GWT Widget class. Subclasses should add appropriate methods to enable basic interaction with the represented client widget. This class provides access to the WebDriver, to the root WebElement, but everything else should be handled by subclasses, or can be dealt with by dealing directly with the WebElement.

Each GwtWidget may declare a corresponding GwtWidgetFinder type. This should have a no-arg, public constructor so it can be automatically created, and should follow the basic builder pattern to enable finding that type of widget in predictable ways.

The find methods in this class are used to find some widget using that widget's finder type.

A GwtWidget subclass may be annotated with @ForWidgetto indicate a specific widget type that it represents. This is used as a check, to make sure that the dom element the GwtWidget wraps is connected to the right type of Widget.

The is(Class) and as(Class) methods are modeled after GWT's Element classes, and their checks that any given JavaScriptObject is indeed of the type expected, as a JavaScriptObject can be of any of any type and cast arbitrarily. In the same way, a GwtWidget might be mapped onto any element or widget, even if it doesn't map. The is(Class) method allows a test to verify that it is of the type specified, and the as(Class) method creates an object of the specified type by wrapping the current element and driver in the new type. This is usually not required when working with a GwtWidgetFinder and the find methods, as those typically only return elements that already match the widget.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	GwtWidget.ForWidget Declares that the annotated type is a GwtWidget for a particular Widget subclass.

Constructor Summary

Constructors

Constructor and Description
GwtWidget(WebDriver driver, WebElement element) Creates a new GwtWidget type.

Method Summary

Methods

Modifier and Type	Method and Description
<W extends GwtWidget<?>> W	as(Class<W> clazz) Re-wraps the widget's element as some other kind of widget.
protected static String	escapeToString(String str) Helper method to generate a string literal that can be used in an xpath
<W extends GwtWidget<T>,T extends GwtWidgetFinder<W>> T	find(Class<W> widgetType) Starting point to find a widget using the finder dsl - pass in the GwtWidget subclass and an instance of its basic finder will be created, with the current element and driver to act as a starting point.
static <W extends GwtWidget<T>,T extends GwtWidgetFinder<W>> T	find(Class<W> widgetType, WebDriver driver) Static helper method to enable finding without an initial widget to start from.
static <W extends GwtWidget<T>,T extends GwtWidgetFinder<W>> T	find(Class<W> widgetType, WebDriver driver, WebElement element) Static helper method to enable finding without an initial widget to work from.
WebDriver	getDriver() Gets the current webdriver instance used to interact with this widget.
WebElement	getElement() Gets the root WebElement being used as a GWT Widget
<W extends GwtWidget<?>> boolean	is(Class<W> clazz) Checks if this widget is of the specified type and so can

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

GwtWidget

public GwtWidget(WebDriver driver,
         WebElement element)

Creates a new GwtWidget type. Subclasses must invoke this with non-null arguments, and must declare (at least) a constructor accepting the same arguments.

Parameters:

driver - a webdriver instance to use when interacting with the widget or finding other widgets

element - the element to wrap with a GwtDriver instance

Method Detail

getElement

public WebElement getElement()

Gets the root WebElement being used as a GWT Widget

Returns:

the root element of this widget

getDriver

public WebDriver getDriver()

Gets the current webdriver instance used to interact with this widget. Not typically used except internally to avoid passing in a driver in instance methods.

Returns:

the driver used when creating this widget

find

public <W extends GwtWidget<T>,T extends GwtWidgetFinder<W>> T find(Class<W> widgetType)

Starting point to find a widget using the finder dsl - pass in the GwtWidget subclass and an instance of its basic finder will be created, with the current element and driver to act as a starting point.

A find() call is followed by specific invocations on that finder to specify exactly what is being found, and is followed by a done() call, which then tries to find the actual widget.

Parameters:

widgetType - the type of widget to start finding

Returns:

a finder able to return that type of widget when done() is invoked

See Also:

GwtWidgetFinder

find

public static <W extends GwtWidget<T>,T extends GwtWidgetFinder<W>> T find(Class<W> widgetType,
                                                           WebDriver driver)

Static helper method to enable finding without an initial widget to start from. Useful to start writing a test or to find some other high level widget to work with.

This method takes no WebElement, which usually means that either the finder will find its own, or that GwtWidgetFinder.withElement(WebElement) will be invoked.

Parameters:

widgetType -

driver - the WebDriver instance to use when finding

Returns:

a finder able to return that type of widget when done() is invoked.

See Also:

find(Class), find(Class, WebDriver, WebElement)

find

public static <W extends GwtWidget<T>,T extends GwtWidgetFinder<W>> T find(Class<W> widgetType,
                                                           WebDriver driver,
                                                           WebElement element)

Static helper method to enable finding without an initial widget to work from. Useful to start writing a test or to find some other high level widget to work with.

Parameters:

widgetType - the type of widget to start finding

driver - the WebDriver instance to use when finding

element - the element to start finding from

Returns:

a finder able to return that type of widget when done() is invoked

See Also:

find(Class)

as

public <W extends GwtWidget<?>> W as(Class<W> clazz)

Re-wraps the widget's element as some other kind of widget. Requires that the actual widget matches the provided class's @ForWidget annotation.

Parameters:

clazz - the type of widget to create

Returns:

a new instance of the class wrapping the current element and driver.

Throws:

IllegalArgumentException - if the element is not of the specified type

is

public <W extends GwtWidget<?>> boolean is(Class<W> clazz)

Checks if this widget is of the specified type and so can

Parameters:

clazz - the type of widget to test against

Returns:

true if this instance wraps an element that

escapeToString

protected static String escapeToString(String str)

Helper method to generate a string literal that can be used in an xpath

Parameters:

str - a string to be escaped for use as an xpath expression

Returns:

a properly escaped string