com.github.bordertech.wcomponents.test.selenium

Class ByLabel

java.lang.Object

org.openqa.selenium.By

com.github.bordertech.wcomponents.test.selenium.ByLabel

public class ByLabel
extends org.openqa.selenium.By

An implementation of By which can find HTML elements by the element's label.

Since:

1.3.0

Author:

Joshua Barclay

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

Field Summary

Fields

Modifier and Type	Field and Description
static String	XPATH_LABEL_TEXT_CONTAINS_RELATIVE The XPATH for matching a label that contains the text.
static String	XPATH_LABEL_TEXT_CONTAINS_ROOT The XPATH for matching a label that contains the text.
static String	XPATH_LABEL_TEXT_EXACT_RELATIVE The XPATH for matching a label with exact text.
static String	XPATH_LABEL_TEXT_EXACT_ROOT The XPATH for matching a label with exact text.

Constructor Summary

Constructors

Constructor and Description
ByLabel(String labelId) ByLabel using the label's ID.
ByLabel(String labelText, boolean partialMatch) ByLabel using the label's text, either as an exact or partial match.
ByLabel(String labelText, boolean partialMatch, boolean relative) ByLabel using the label's text, either as an exact or partial match and using a relative XPATh to explicitly look 'inside' the current element.

Method Summary

Modifier and Type	Method and Description
List<org.openqa.selenium.WebElement>	findElements(org.openqa.selenium.SearchContext context) Find the elements by label.

Methods inherited from class org.openqa.selenium.By

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

Methods inherited from class java.lang.Object

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

Field Detail

XPATH_LABEL_TEXT_EXACT_ROOT

public static final String XPATH_LABEL_TEXT_EXACT_ROOT

The XPATH for matching a label with exact text.

See Also:

Constant Field Values

XPATH_LABEL_TEXT_CONTAINS_ROOT

public static final String XPATH_LABEL_TEXT_CONTAINS_ROOT

The XPATH for matching a label that contains the text.

See Also:

Constant Field Values

XPATH_LABEL_TEXT_EXACT_RELATIVE

public static final String XPATH_LABEL_TEXT_EXACT_RELATIVE

The XPATH for matching a label with exact text.

See Also:

Constant Field Values

XPATH_LABEL_TEXT_CONTAINS_RELATIVE

public static final String XPATH_LABEL_TEXT_CONTAINS_RELATIVE

The XPATH for matching a label that contains the text.

See Also:

Constant Field Values

Constructor Detail

ByLabel

public ByLabel(String labelId)

ByLabel using the label's ID.

Parameters:

labelId - the ID of the label.

ByLabel

public ByLabel(String labelText,
               boolean partialMatch,
               boolean relative)

ByLabel using the label's text, either as an exact or partial match and using a relative XPATh to explicitly look 'inside' the current element.

Parameters:

labelText - the text used to find the label

partialMatch - whether it can be a partial text match

relative - whether to use a relative xpath lookup

ByLabel

public ByLabel(String labelText,
               boolean partialMatch)

ByLabel using the label's text, either as an exact or partial match.

Parameters:

labelText - the text used to find the label.

partialMatch - whether it can be a partial text match.

Method Detail

findElements

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

Find the elements by label.

Specified by:

findElements in class org.openqa.selenium.By

Parameters:

context - the search context.

Returns:

the matching elements.