com.github.bordertech.wcomponents.test.selenium

Class ByWComponentPath

java.lang.Object

org.openqa.selenium.By

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

com.github.bordertech.wcomponents.test.selenium.ByWComponentPath

public class ByWComponentPath
extends ByWComponent

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 used in a search path.

Note: Since there's no mapping from XHTML to the WComponent XML schema, this By implementation will always search from the root component, no matter what the search context is.

See TreeUtil.findWComponents(WComponent, String[]) for details on the path syntax.

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
ByWComponentPath(ComponentWithContext componentWithContext, String path) Creates a ByWComponentPath which searches for a path to a component.
ByWComponentPath(ComponentWithContext componentWithContext, String path, boolean visibleOnly) Creates a ByWComponentPath which searches for a path to a component.
ByWComponentPath(WComponent component, String path) Creates a ByWComponentPath which searches for a path to a component.
ByWComponentPath(WComponent component, String path, boolean visibleOnly) Creates a ByWComponentPath which searches for a path to a component.
ByWComponentPath(WComponent component, UIContext context, String path) Creates a ByWComponentPath which searches for a path to a component.
ByWComponentPath(WComponent component, UIContext context, String path, boolean visibleOnly) Creates a ByWComponentPath which searches for a path to a component.
ByWComponentPath(WComponent component, UIContext context, String path, Object value) Creates a ByWComponentPath which searches for a path to a component.
ByWComponentPath(WComponent component, UIContext context, String path, Object value, boolean visibleOnly) Creates a ByWComponentPath which searches for a path to a component.

Method Summary

Modifier and Type	Method and Description
List<org.openqa.selenium.WebElement>	findElements(org.openqa.selenium.SearchContext searchContext)
Class<? extends WComponent>	getTargetWComponentClass()
String	toString()

Methods inherited from class com.github.bordertech.wcomponents.test.selenium.ByWComponent

findElement, findValue, getComponent, getContext, getValue, narrowResults, setContext

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

ByWComponentPath

public ByWComponentPath(ComponentWithContext componentWithContext,
                        String path)

Creates a ByWComponentPath which searches for a path to a component.

Parameters:

componentWithContext - the component to search for.

path - the path to traverse.

ByWComponentPath

public ByWComponentPath(ComponentWithContext componentWithContext,
                        String path,
                        boolean visibleOnly)

Creates a ByWComponentPath which searches for a path to a component.

Parameters:

componentWithContext - the component to search for.

path - the path to traverse.

visibleOnly - only look for components that are visible

ByWComponentPath

public ByWComponentPath(WComponent component,
                        String path)

Creates a ByWComponentPath which searches for a path to a component.

Parameters:

component - the component instance to search for.

path - the path to traverse.

ByWComponentPath

public ByWComponentPath(WComponent component,
                        String path,
                        boolean visibleOnly)

Creates a ByWComponentPath which searches for a path to a component.

Parameters:

component - the component instance to search for.

path - the path to traverse.

visibleOnly - only look for components that are visible

ByWComponentPath

public ByWComponentPath(WComponent component,
                        UIContext context,
                        String path)

Creates a ByWComponentPath which searches for a path to a component.

Parameters:

component - the component instance to search for.

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

path - the path to traverse.

ByWComponentPath

public ByWComponentPath(WComponent component,
                        UIContext context,
                        String path,
                        boolean visibleOnly)

Creates a ByWComponentPath which searches for a path to a component.

Parameters:

component - the component instance to search for.

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

path - the path to traverse.

visibleOnly - only look for components that are visible

ByWComponentPath

public ByWComponentPath(WComponent component,
                        UIContext context,
                        String path,
                        Object value)

Creates a ByWComponentPath which searches for a path to a component.

Parameters:

component - the component instance to search for.

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

path - the path to traverse.

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

ByWComponentPath

public ByWComponentPath(WComponent component,
                        UIContext context,
                        String path,
                        Object value,
                        boolean visibleOnly)

Creates a ByWComponentPath which searches for a path to a component.

Parameters:

component - the component instance to search for.

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

path - the path to traverse.

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

visibleOnly - only look for components that are visible

Method Detail

findElements

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

Overrides:

findElements in class ByWComponent

toString

public String toString()

Overrides:

toString in class ByWComponent

getTargetWComponentClass

public Class<? extends WComponent> getTargetWComponentClass()

Overrides:

getTargetWComponentClass in class ByWComponent

Returns:

the class of the target WComponent