com.github.bordertech.wcomponents.test.selenium.element

Class SeleniumWComponentInputWebElement

java.lang.Object

com.github.bordertech.wcomponents.test.selenium.element.SeleniumWComponentWebElement

com.github.bordertech.wcomponents.test.selenium.element.SeleniumWComponentInputWebElement

All Implemented Interfaces:

org.openqa.selenium.SearchContext, org.openqa.selenium.TakesScreenshot, org.openqa.selenium.WebElement

Direct Known Subclasses:

SeleniumWCheckBoxWebElement, SeleniumWRadioButtonWebElement, SeleniumWSelectWebElement, SeleniumWTextAreaWebElement, SeleniumWTextFieldWebElement

public class SeleniumWComponentInputWebElement
extends SeleniumWComponentWebElement

Parent class for all elements that represent user input. An element might be an input even if it represent read-only state, e.g. a <span> element for a read-only text input.

Since:

1.3.0

Author:

Joshua Barclay, Mark Reeves

Field Summary

Fields

Modifier and Type	Field and Description
static String	EDITABLE_TAG The tag name of the editable CheckBox element.
static String	TOP_LEVEL_TAG The tag name of the wrapping element for text-like inputs WTextField, WEmailField, WPhoneNumberField, WPasswordField.

Constructor Summary

Constructors

Constructor and Description
SeleniumWComponentInputWebElement(org.openqa.selenium.WebElement element, org.openqa.selenium.WebDriver driver) Construct an input element.

Method Summary

Modifier and Type	Method and Description
void	clear()
void	click()
void	clickNoWait() Perform a click action without waiting for the WComponent ready status Used when the click will result in a non-WComponents page.
String	getActiveId() Get the id of the default "active" part of the component.
String	getAttribute(String name) Retrieve the given attribute for the element, but if the attribute requested is the value instead return the result of getValue().
SeleniumWComponentWebElement	getInputField()
org.openqa.selenium.WebElement	getSuggestionList()
String	getValue()
boolean	isCombo()
boolean	isEnabled()
boolean	isMandatory()
boolean	isReadOnly()
void	sendKeys(boolean wait, CharSequence... keys) Send a key sequence and optionally wait for page ready afterwards.
void	sendKeys(CharSequence... keys)

Methods inherited from class com.github.bordertech.wcomponents.test.selenium.element.SeleniumWComponentWebElement

clickElementNoWait, findElement, findElementImmediate, findElements, findElementsImmediate, getCssValue, getDriver, getElement, getLocation, getRect, getScreenshotAs, getSize, getTagName, getText, getUserContextForSession, isDisplayed, isHidden, isSelected, submit, waitForPageReady, wrapElement

Methods inherited from class java.lang.Object

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

Field Detail

TOP_LEVEL_TAG

public static final String TOP_LEVEL_TAG

The tag name of the wrapping element for text-like inputs WTextField, WEmailField, WPhoneNumberField, WPasswordField.

See Also:

Constant Field Values

EDITABLE_TAG

public static final String EDITABLE_TAG

The tag name of the editable CheckBox element.

See Also:

Constant Field Values

Constructor Detail

SeleniumWComponentInputWebElement

public SeleniumWComponentInputWebElement(org.openqa.selenium.WebElement element,
                                         org.openqa.selenium.WebDriver driver)

Construct an input element.

Parameters:

element - the web element.

driver - the driver.

Method Detail

getInputField

public SeleniumWComponentWebElement getInputField()

Returns:

the editable input field of a WTextField.

getValue

public String getValue()

Returns:

the value of the input component.

getAttribute

public String getAttribute(String name)

Retrieve the given attribute for the element, but if the attribute requested is the value instead return the result of getValue().

Specified by:

getAttribute in interface org.openqa.selenium.WebElement

Overrides:

getAttribute in class SeleniumWComponentWebElement

Parameters:

name - the attribute to find

Returns:

the value of the attribute

isReadOnly

public boolean isReadOnly()

Returns:

true if the field is in a read-only state.

isEnabled

public boolean isEnabled()

Specified by:

isEnabled in interface org.openqa.selenium.WebElement

Overrides:

isEnabled in class SeleniumWComponentWebElement

sendKeys

public void sendKeys(CharSequence... keys)

Specified by:

sendKeys in interface org.openqa.selenium.WebElement

Overrides:

sendKeys in class SeleniumWComponentWebElement

sendKeys

public void sendKeys(boolean wait,
                     CharSequence... keys)

Send a key sequence and optionally wait for page ready afterwards.

Overrides:

sendKeys in class SeleniumWComponentWebElement

Parameters:

wait - if true then wait for page ready after sending the keys

keys - The keys to send

clear

public void clear()

Specified by:

clear in interface org.openqa.selenium.WebElement

Overrides:

clear in class SeleniumWComponentWebElement

getActiveId

public String getActiveId()

Description copied from class: SeleniumWComponentWebElement

Get the id of the default "active" part of the component. This may not be the WComponent id.

Overrides:

getActiveId in class SeleniumWComponentWebElement

Returns:

the active component's id, by default this is the WComponent id.

click

public void click()

Description copied from class: SeleniumWComponentWebElement

Specified by:

click in interface org.openqa.selenium.WebElement

Overrides:

click in class SeleniumWComponentWebElement

clickNoWait

public void clickNoWait()

Description copied from class: SeleniumWComponentWebElement

Perform a click action without waiting for the WComponent ready status

Used when the click will result in a non-WComponents page.

Overrides:

clickNoWait in class SeleniumWComponentWebElement

isCombo

public boolean isCombo()

Returns:

true if the input is a combo box

isMandatory

public boolean isMandatory()

Returns:

true if the input is mandatory

getSuggestionList

public org.openqa.selenium.WebElement getSuggestionList()

Returns:

the element representing a combo boxes list of suggestions if the element is a combo otherwise null