com.github.markusbernhardt.selenium2library.keywords

Class FormElement

java.lang.Object

com.github.markusbernhardt.selenium2library.RunOnFailureKeywordsAdapter

com.github.markusbernhardt.selenium2library.keywords.FormElement

All Implemented Interfaces:

RunOnFailureKeywords

public class FormElement
extends RunOnFailureKeywordsAdapter

Field Summary

Fields

Modifier and Type	Field and Description
protected Element	element Instantiated Element keyword bean
protected Logging	logging Instantiated Logging keyword bean

Constructor Summary

Constructors

Constructor and Description
FormElement()

Method Summary

Methods

Modifier and Type	Method and Description
void	checkboxShouldBeSelected(String locator) Verify the checkbox identified by locator is selected/checked.
void	checkboxShouldNotBeSelected(String locator) Verify the checkbox identified by locator is not selected/checked.
void	chooseFile(String locator, String filePath) Types the given filePath into the input field identified by locator.
void	clickButton(String locator) Click on the button identified by locator.
protected org.openqa.selenium.WebElement	getCheckbox(String locator)
protected List<org.openqa.selenium.WebElement>	getRadioButtons(String groupName)
protected org.openqa.selenium.WebElement	getRadioButtonWithValue(String groupName, String value)
protected String	getValueFromRadioButtons(List<org.openqa.selenium.WebElement> elements)
void	inputPassword(String locator, String text) Types the given text into the password field identified by locator.
void	inputText(String locator, String text) Types the given text into the text field identified by locator.
protected void	inputTextIntoTextField(String locator, String text)
protected boolean	isFormElement(org.openqa.selenium.WebElement element)
void	pageShouldContainButton(String locator)
void	pageShouldContainButton(String locator, String message)
void	pageShouldContainButton(String locator, String message, String logLevel) Verify the button identified by locator is found on the current page.
void	pageShouldContainCheckbox(String locator)
void	pageShouldContainCheckbox(String locator, String message)
void	pageShouldContainCheckbox(String locator, String message, String logLevel) Verify the checkbox identified by locator is found on the current page.
void	pageShouldContainRadioButton(String locator)
void	pageShouldContainRadioButton(String locator, String message)
void	pageShouldContainRadioButton(String locator, String message, String logLevel) Verify the radio button identified by locator is found on the current page.
void	pageShouldContainTextfield(String locator)
void	pageShouldContainTextfield(String locator, String message)
void	pageShouldContainTextfield(String locator, String message, String logLevel) Verify the text field identified by locator is found on the current page.
void	pageShouldNotContainButton(String locator)
void	pageShouldNotContainButton(String locator, String message)
void	pageShouldNotContainButton(String locator, String message, String logLevel) Verify the button identified by locator is not found on the current page.
void	pageShouldNotContainCheckbox(String locator)
void	pageShouldNotContainCheckbox(String locator, String message)
void	pageShouldNotContainCheckbox(String locator, String message, String logLevel) Verify the checkbox identified by locator is not found on the current page.
void	pageShouldNotContainRadioButton(String locator)
void	pageShouldNotContainRadioButton(String locator, String message)
void	pageShouldNotContainRadioButton(String locator, String message, String logLevel) Verify the radio button identified by locator is not found on the current page.
void	pageShouldNotContainTextfield(String locator)
void	pageShouldNotContainTextfield(String locator, String message)
void	pageShouldNotContainTextfield(String locator, String message, String logLevel) Verify the text field identified by locator is not found on the current page.
void	radioButtonShouldBeSetTo(String groupName, String value) Verify the radio button group identified by groupName has its selection set to value.
void	radioButtonShouldNotBeSelected(String groupName) Verify the radio button group identified by groupName has no selection.
void	selectCheckbox(String locator) Select the checkbox identified by locator.
void	selectRadioButton(String groupName, String value) Sets the selection of the radio button group identified by groupName to value.
void	submitForm()
void	submitForm(String locator) Submit the form identified by locator.
void	textareaShouldContain(String locator, String text)
void	textareaShouldContain(String locator, String text, String message) Verify the text area identified by locator contains text.
void	textareaShouldNotContain(String locator, String text)
void	textareaShouldNotContain(String locator, String text, String message) Verify the text area identified by locator does not contain text.
void	textareaValueShouldBe(String locator, String text)
void	textareaValueShouldBe(String locator, String text, String message) Verify the text area identified by locator is exactly text.
void	textareaValueShouldNotBe(String locator, String text)
void	textareaValueShouldNotBe(String locator, String text, String message) Verify the text area identified by locator is not exactly text.
void	textfieldShouldContain(String locator, String text)
void	textfieldShouldContain(String locator, String text, String message) Verify the text field identified by locator contains text.
void	textfieldShouldNotContain(String locator, String text)
void	textfieldShouldNotContain(String locator, String text, String message) Verify the text field identified by locator does not contain text.
void	textfieldValueShouldBe(String locator, String text)
void	textfieldValueShouldBe(String locator, String text, String message) Verify the text field identified by locator is exactly text.
void	textfieldValueShouldNotBe(String locator, String text)
void	textfieldValueShouldNotBe(String locator, String text, String message) Verify the text field identified by locator is not exactly text.
void	unselectCheckbox(String locator) Unselect the checkbox identified by locator.

Methods inherited from class com.github.markusbernhardt.selenium2library.RunOnFailureKeywordsAdapter

runOnFailureByAspectJ

Methods inherited from class java.lang.Object

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

Field Detail

element

protected Element element

Instantiated Element keyword bean

logging

protected Logging logging

Instantiated Logging keyword bean

Constructor Detail

FormElement

public FormElement()

Method Detail

submitForm

public void submitForm()

submitForm

public void submitForm(String locator)

Submit the form identified by locator.

If the locator is empty, the first form in the page will be submitted.

Key attributes for forms are id and name. See `Introduction` for details about locators.

Parameters:

locator - Default=NONE. The locator to locate the form.

checkboxShouldBeSelected

public void checkboxShouldBeSelected(String locator)

Verify the checkbox identified by locator is selected/checked.

Key attributes for checkboxes are id and name. See `Introduction` for details about locators.

Parameters:

locator - The locator to locate the checkbox.

checkboxShouldNotBeSelected

public void checkboxShouldNotBeSelected(String locator)

Verify the checkbox identified by locator is not selected/checked.

Key attributes for checkboxes are id and name. See `Introduction` for details about locators.

Parameters:

locator - The locator to locate the checkbox.

pageShouldContainCheckbox

public void pageShouldContainCheckbox(String locator)

pageShouldContainCheckbox

public void pageShouldContainCheckbox(String locator,
                             String message)

pageShouldContainCheckbox

public void pageShouldContainCheckbox(String locator,
                             String message,
                             String logLevel)

Verify the checkbox identified by locator is found on the current page.

Key attributes for checkboxes are id and name. See `Introduction` for details about log levels and locators.

Parameters:

locator - The locator to locate the checkbox.

message - Default=NONE. Optional custom error message.

logLevel - Default=INFO. Optional log level.

pageShouldNotContainCheckbox

public void pageShouldNotContainCheckbox(String locator)

pageShouldNotContainCheckbox

public void pageShouldNotContainCheckbox(String locator,
                                String message)

pageShouldNotContainCheckbox

public void pageShouldNotContainCheckbox(String locator,
                                String message,
                                String logLevel)

Verify the checkbox identified by locator is not found on the current page.

Key attributes for checkboxes are id and name. See `Introduction` for details about log levels and locators.

Parameters:

locator - The locator to locate the checkbox.

message - Default=NONE. Optional custom error message.

logLevel - Default=INFO. Optional log level.

selectCheckbox

public void selectCheckbox(String locator)

Select the checkbox identified by locator.

Does nothing, if the checkbox is already selected.

Key attributes for checkboxes are id and name. See `Introduction` for details about locators.

Parameters:

locator - The locator to locate the checkbox.

unselectCheckbox

public void unselectCheckbox(String locator)

Unselect the checkbox identified by locator.

Does nothing, if the checkbox is not selected.

Key attributes for checkboxes are id and name. See `Introduction` for details about locators.

Parameters:

locator - The locator to locate the checkbox.

pageShouldContainRadioButton

public void pageShouldContainRadioButton(String locator)

pageShouldContainRadioButton

public void pageShouldContainRadioButton(String locator,
                                String message)

pageShouldContainRadioButton

public void pageShouldContainRadioButton(String locator,
                                String message,
                                String logLevel)

Verify the radio button identified by locator is found on the current page.

Key attributes for radio buttons are id and name. See `Introduction` for details about log levels and locators.

Parameters:

locator - The locator to locate the radio button.

message - Default=NONE. Optional custom error message.

logLevel - Default=INFO. Optional log level.

pageShouldNotContainRadioButton

public void pageShouldNotContainRadioButton(String locator)

pageShouldNotContainRadioButton

public void pageShouldNotContainRadioButton(String locator,
                                   String message)

pageShouldNotContainRadioButton

public void pageShouldNotContainRadioButton(String locator,
                                   String message,
                                   String logLevel)

Verify the radio button identified by locator is not found on the current page.

Key attributes for radio buttons are id and name. See `Introduction` for details about log levels and locators.

Parameters:

locator - The locator to locate the radio button.

message - Default=NONE. Optional custom error message.

logLevel - Default=INFO. Optional log level.

radioButtonShouldBeSetTo

public void radioButtonShouldBeSetTo(String groupName,
                            String value)

Verify the radio button group identified by groupName has its selection set to value.

See `Select Radio Button` for details about locating radio buttons.

Parameters:

groupName - The radio button group name.

value - The expected value.

radioButtonShouldNotBeSelected

public void radioButtonShouldNotBeSelected(String groupName)

Verify the radio button group identified by groupName has no selection.

See `Select Radio Button` for details about locating radio buttons.

Parameters:

groupName - The radio button group name.

selectRadioButton

public void selectRadioButton(String groupName,
                     String value)

Sets the selection of the radio button group identified by groupName to value.

Example:

Select Radio Button	size	XL	# Matches HTML like <input type="radio" name="size" value="XL">XL</input>
Select Radio Button	size	sizeXL	# Matches HTML like <input type="radio" name="size" value="XL" id="sizeXL">XL</input>

Parameters:

groupName - The radio button group name.

value - The value or id attribute of the radio button to set.

chooseFile

public void chooseFile(String locator,
              String filePath)

Types the given filePath into the input field identified by locator.

This keyword is most often used to input files into upload forms. The file specified with filePath must be available on the same host where the Selenium Server is running.

Example:

Choose File

my_upload_field

/home/user/files/trades.csv

Key attributes for input fields are id and name. See `Introduction` for details about locators.

Parameters:

locator - The locator to locate the input field.

filePath - The file path to input

inputPassword

public void inputPassword(String locator,
                 String text)

Types the given text into the password field identified by locator.

Key attributes for input fields are id and name. See `Introduction` for details about locators.

Parameters:

locator - The locator to locate the password field.

text - The password to input

inputText

public void inputText(String locator,
             String text)

Types the given text into the text field identified by locator.

Key attributes for input fields are id and name. See `Introduction` for details about locators.

Parameters:

locator - The locator to locate the text field.

text - The password to input

pageShouldContainTextfield

public void pageShouldContainTextfield(String locator)

pageShouldContainTextfield

public void pageShouldContainTextfield(String locator,
                              String message)

pageShouldContainTextfield

public void pageShouldContainTextfield(String locator,
                              String message,
                              String logLevel)

Verify the text field identified by locator is found on the current page.

Key attributes for text field are id and name. See `Introduction` for details about log levels and locators.

Parameters:

locator - The locator to locate the text field.

message - Default=NONE. Optional custom error message.

logLevel - Default=INFO. Optional log level.

pageShouldNotContainTextfield

public void pageShouldNotContainTextfield(String locator)

pageShouldNotContainTextfield

public void pageShouldNotContainTextfield(String locator,
                                 String message)

pageShouldNotContainTextfield

public void pageShouldNotContainTextfield(String locator,
                                 String message,
                                 String logLevel)

Verify the text field identified by locator is not found on the current page.

Key attributes for text field are id and name. See `Introduction` for details about log levels and locators.

Parameters:

locator - The locator to locate the text field.

message - Default=NONE. Optional custom error message.

logLevel - Default=INFO. Optional log level.

textfieldValueShouldBe

public void textfieldValueShouldBe(String locator,
                          String text)

textfieldValueShouldBe

public void textfieldValueShouldBe(String locator,
                          String text,
                          String message)

Verify the text field identified by locator is exactly text.

Key attributes for text field are id and name. See `Introduction` for details about log levels and locators.

Parameters:

locator - The locator to locate the text field.

text - The text to verify.

message - Default=NONE. Optional custom error message.

See Also:

textfieldShouldContain(java.lang.String, java.lang.String), textfieldShouldNotContain(java.lang.String, java.lang.String), textfieldValueShouldNotBe(java.lang.String, java.lang.String)

textfieldValueShouldNotBe

public void textfieldValueShouldNotBe(String locator,
                             String text)

textfieldValueShouldNotBe

public void textfieldValueShouldNotBe(String locator,
                             String text,
                             String message)

Verify the text field identified by locator is not exactly text.

Key attributes for text field are id and name. See `Introduction` for details about log levels and locators.

Parameters:

locator - The locator to locate the text field.

text - The text to verify.

message - Default=NONE. Optional custom error message.

See Also:

textfieldShouldContain(java.lang.String, java.lang.String), textfieldShouldNotContain(java.lang.String, java.lang.String), textfieldValueShouldBe(java.lang.String, java.lang.String)

textfieldShouldContain

public void textfieldShouldContain(String locator,
                          String text)

textfieldShouldContain

public void textfieldShouldContain(String locator,
                          String text,
                          String message)

Verify the text field identified by locator contains text.

Key attributes for text field are id and name. See `Introduction` for details about log levels and locators.

Parameters:

locator - The locator to locate the text field.

text - The text to verify.

message - Default=NONE. Optional custom error message.

See Also:

textfieldShouldNotContain(java.lang.String, java.lang.String), textfieldValueShouldBe(java.lang.String, java.lang.String), textfieldValueShouldNotBe(java.lang.String, java.lang.String)

textfieldShouldNotContain

public void textfieldShouldNotContain(String locator,
                             String text)

textfieldShouldNotContain

public void textfieldShouldNotContain(String locator,
                             String text,
                             String message)

Verify the text field identified by locator does not contain text.

Key attributes for text field are id and name. See `Introduction` for details about log levels and locators.

Parameters:

locator - The locator to locate the text field.

text - The text to verify.

message - Default=NONE. Optional custom error message.

See Also:

textfieldShouldContain(java.lang.String, java.lang.String), textfieldValueShouldBe(java.lang.String, java.lang.String), textfieldValueShouldNotBe(java.lang.String, java.lang.String)

textareaShouldContain

public void textareaShouldContain(String locator,
                         String text)

textareaShouldContain

public void textareaShouldContain(String locator,
                         String text,
                         String message)

Verify the text area identified by locator contains text.

Key attributes for text areas are id and name. See `Introduction` for details about log levels and locators.

Parameters:

locator - The locator to locate the text area.

text - The text to verify.

message - Default=NONE. Optional custom error message.

See Also:

textareaShouldNotContain(java.lang.String, java.lang.String), textareaValueShouldBe(java.lang.String, java.lang.String), textareaValueShouldNotBe(java.lang.String, java.lang.String)

textareaShouldNotContain

public void textareaShouldNotContain(String locator,
                            String text)

textareaShouldNotContain

public void textareaShouldNotContain(String locator,
                            String text,
                            String message)

Verify the text area identified by locator does not contain text.

Key attributes for text areas are id and name. See `Introduction` for details about log levels and locators.

Parameters:

locator - The locator to locate the text area.

text - The text to verify.

message - Default=NONE. Optional custom error message.

See Also:

textareaShouldContain(java.lang.String, java.lang.String), textareaValueShouldBe(java.lang.String, java.lang.String), textareaValueShouldNotBe(java.lang.String, java.lang.String)

textareaValueShouldBe

public void textareaValueShouldBe(String locator,
                         String text)

textareaValueShouldBe

public void textareaValueShouldBe(String locator,
                         String text,
                         String message)

Verify the text area identified by locator is exactly text.

Key attributes for text area are id and name. See `Introduction` for details about log levels and locators.

Parameters:

locator - The locator to locate the text area.

text - The text to verify.

message - Default=NONE. Optional custom error message.

See Also:

textareaShouldContain(java.lang.String, java.lang.String), textareaShouldNotContain(java.lang.String, java.lang.String), textareaValueShouldNotBe(java.lang.String, java.lang.String)

textareaValueShouldNotBe

public void textareaValueShouldNotBe(String locator,
                            String text)

textareaValueShouldNotBe

public void textareaValueShouldNotBe(String locator,
                            String text,
                            String message)

Verify the text area identified by locator is not exactly text.

Key attributes for text area are id and name. See `Introduction` for details about log levels and locators.

Parameters:

locator - The locator to locate the text area.

text - The text to verify.

message - Default=NONE. Optional custom error message.

See Also:

textareaShouldContain(java.lang.String, java.lang.String), textareaShouldNotContain(java.lang.String, java.lang.String), textareaValueShouldBe(java.lang.String, java.lang.String)

clickButton

public void clickButton(String locator)

Click on the button identified by locator.

Key attributes for buttons are id, name and value. See `Introduction` for details about locators.

Parameters:

locator - The locator to locate the link.

pageShouldContainButton

public void pageShouldContainButton(String locator)

pageShouldContainButton

public void pageShouldContainButton(String locator,
                           String message)

pageShouldContainButton

public void pageShouldContainButton(String locator,
                           String message,
                           String logLevel)

Verify the button identified by locator is found on the current page.

Key attributes for buttons are id, name and value. See `Introduction` for details about log levels and locators.

Parameters:

locator - The locator to locate the button.

message - Default=NONE. Optional custom error message.

logLevel - Default=INFO. Optional log level.

pageShouldNotContainButton

public void pageShouldNotContainButton(String locator)

pageShouldNotContainButton

public void pageShouldNotContainButton(String locator,
                              String message)

pageShouldNotContainButton

public void pageShouldNotContainButton(String locator,
                              String message,
                              String logLevel)

Verify the button identified by locator is not found on the current page.

Key attributes for buttons are id, name and value. See `Introduction` for details about log levels and locators.

Parameters:

locator - The locator to locate the button.

message - Default=NONE. Optional custom error message.

logLevel - Default=INFO. Optional log level.

getCheckbox

protected org.openqa.selenium.WebElement getCheckbox(String locator)

getRadioButtons

protected List<org.openqa.selenium.WebElement> getRadioButtons(String groupName)

getRadioButtonWithValue

protected org.openqa.selenium.WebElement getRadioButtonWithValue(String groupName,
                                                     String value)

getValueFromRadioButtons

protected String getValueFromRadioButtons(List<org.openqa.selenium.WebElement> elements)

inputTextIntoTextField

protected void inputTextIntoTextField(String locator,
                          String text)

isFormElement

protected boolean isFormElement(org.openqa.selenium.WebElement element)