com.github.bordertech.wcomponents.test.selenium

Class ByWComponent

java.lang.Object

org.openqa.selenium.By

com.github.bordertech.wcomponents.test.selenium.ByWComponent

Direct Known Subclasses:

ByWComponentPath

public class ByWComponent
extends org.openqa.selenium.By

This By implementation will only work if the servlet is running in the same JVM as the test. While this is the easiest way to write tests, those tests will not be reusable for verifying environments.

An implementation of By which can find HTML elements which correspond to (most) WComponents. Only WComponents which emit elements with ids can be searched on. This means that components such as WText and "WComponent" itself can not be searched for.

Since:

1.0.0

Author:

Yiannis Paschalidis

Nested Class Summary

Nested classes/interfaces inherited from class org.openqa.selenium.By

org.openqa.selenium.By.ByClassName, org.openqa.selenium.By.ByCssSelector, org.openqa.selenium.By.ById, org.openqa.selenium.By.ByLinkText, org.openqa.selenium.By.ByName, org.openqa.selenium.By.ByPartialLinkText, org.openqa.selenium.By.ByTagName, org.openqa.selenium.By.ByXPath

Constructor Summary

Constructors

Constructor and Description
ByWComponent(ComponentWithContext componentWithContext) Creates a ByWComponent which searches for a component instance in the given context.
ByWComponent(WComponent component) Creates a ByWComponent which searches for a component instance.
ByWComponent(WComponent component, UIContext context) Creates a ByWComponent which searches for a component instance in the given context.
ByWComponent(WComponent component, UIContext context, Object value) Creates a ByWComponent which searches for a component instance in the given context.

Method Summary

Methods

Modifier and Type	Method and Description
protected List<org.openqa.selenium.WebElement>	findElement(org.openqa.selenium.SearchContext searchContext, UIContext uiContext, WComponent component, Object compValue) Perform the driver search for the given component.
List<org.openqa.selenium.WebElement>	findElements(org.openqa.selenium.SearchContext searchContext)
static org.openqa.selenium.WebElement	findValue(org.openqa.selenium.WebElement current, WComponent component, UIContext context, Object value) Narrows down the search for a WebElement to find the appropriate value.
protected WComponent	getComponent()
protected UIContext	getContext()
Class<? extends WComponent>	getTargetWComponentClass()
protected Object	getValue()
static void	narrowResults(List<org.openqa.selenium.WebElement> results, WComponent component, UIContext context, Object value) Narrows the results of a search using the given value.
void	setContext(UIContext context) Set the context.
String	toString()

Methods inherited from class org.openqa.selenium.By

className, cssSelector, equals, findElement, hashCode, id, linkText, name, partialLinkText, tagName, xpath

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ByWComponent

public ByWComponent(ComponentWithContext componentWithContext)

Creates a ByWComponent which searches for a component instance in the given context. If searching for a repeated component, the context should be the row context for the row you want to return.

Parameters:

componentWithContext - the component to search for.

ByWComponent

public ByWComponent(WComponent component)

Creates a ByWComponent which searches for a component instance.

Parameters:

component - the component instance to search for.

ByWComponent

public ByWComponent(WComponent component,
            UIContext context)

Creates a ByWComponent which searches for a component instance in the given context. If searching for a repeated component, the context should be the row context for the row you want to return.

Parameters:

component - the component instance to search for.

context - the context to search in, use null for the default context.

ByWComponent

public ByWComponent(WComponent component,
            UIContext context,
            Object value)

Creates a ByWComponent which searches for a component instance in the given context. If searching for a repeated component, the context should be the row context for the row you want to return.

Parameters:

component - the component instance to search for.

context - the context to search in, use null for the default context.

value - If not null, narrow the search by value for e.g. list or drop-down entries.

Method Detail

setContext

public void setContext(UIContext context)

Set the context.

Parameters:

context - the context to set.

getContext

protected UIContext getContext()

Returns:

the UIContext.

getComponent

protected WComponent getComponent()

Returns:

the component.

getValue

protected Object getValue()

Returns:

the value.

findElement

protected List<org.openqa.selenium.WebElement> findElement(org.openqa.selenium.SearchContext searchContext,
                                               UIContext uiContext,
                                               WComponent component,
                                               Object compValue)

Perform the driver search for the given component.

Parameters:

searchContext - the SearchContext to search within.

uiContext - the UIContext to retrieve the id/name from.

component - the component to find.

compValue - the component value to match.

Returns:

a list of matching elements.

findElements

public List<org.openqa.selenium.WebElement> findElements(org.openqa.selenium.SearchContext searchContext)

Specified by:

findElements in class org.openqa.selenium.By

toString

public String toString()

Overrides:

toString in class org.openqa.selenium.By

getTargetWComponentClass

public Class<? extends WComponent> getTargetWComponentClass()

Returns:

the class of the target WComponent

findValue

public static org.openqa.selenium.WebElement findValue(org.openqa.selenium.WebElement current,
                                       WComponent component,
                                       UIContext context,
                                       Object value)

Narrows down the search for a WebElement to find the appropriate value.

Parameters:

current - the current WebElement which was reached during a search.

component - the component corresponding to the given WebElement.

context - the context for the component.

value - the value to search for.

Returns:

the WebElement with the given value, or null if not found.

narrowResults

public static void narrowResults(List<org.openqa.selenium.WebElement> results,
                 WComponent component,
                 UIContext context,
                 Object value)

Narrows the results of a search using the given value. A search is performed under each search result for an element with the given value. Existing results are either replaced or removed, depending on whether a match was found.

Parameters:

results - the search results to modify.

component - the component.

context - the context for the component.

value - the value to search for.