com.github.markusbernhardt.selenium2library.keywords

Class SelectElement

java.lang.Object

com.github.markusbernhardt.selenium2library.RunOnFailureKeywordsAdapter

com.github.markusbernhardt.selenium2library.keywords.SelectElement

All Implemented Interfaces:

RunOnFailureKeywords

public class SelectElement
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
SelectElement()

Method Summary

Methods

Modifier and Type	Method and Description
protected List<String>	getLabelsForOptions(List<org.openqa.selenium.WebElement> options)
List<String>	getListItems(String locator) Returns the values in the select list identified by locator.
String	getSelectedListLabel(String locator) Returns the visible label of the first selected element from the select list identified by locator.
List<String>	getSelectedListLabels(String locator) Returns the visible labels of the first selected elements as a list from the select list identified by locator.
String	getSelectedListValue(String locator) Returns the value of the first selected element from the select list identified by locator.
List<String>	getSelectedListValues(String locator) Returns the values of the first selected elements as a list from the select list identified by locator.
protected org.openqa.selenium.support.ui.Select	getSelectList(String locator)
protected List<org.openqa.selenium.WebElement>	getSelectListOptions(org.openqa.selenium.support.ui.Select select)
protected List<org.openqa.selenium.WebElement>	getSelectListOptions(String locator)
protected List<org.openqa.selenium.WebElement>	getSelectListOptionsSelected(String locator)
protected List<String>	getValuesForOptions(List<org.openqa.selenium.WebElement> options)
protected boolean	isMultiselectList(org.openqa.selenium.support.ui.Select select)
void	listSelectionShouldBe(String locator, String... items) Verify the selection of the select list identified by locatoris exactly *items.
void	listShouldHaveNoSelections(String locator) Verify the select list identified by locatorhas no selections.
void	pageShouldContainList(String locator)
void	pageShouldContainList(String locator, String message)
void	pageShouldContainList(String locator, String message, String logLevel) Verify the select list identified by locator is found on the current page.
void	pageShouldNotContainList(String locator)
void	pageShouldNotContainList(String locator, String message)
void	pageShouldNotContainList(String locator, String message, String logLevel) Verify the select list identified by locator is not found on the current page.
void	selectAllFromList(String locator) Select all values of the multi-select list identified by locator.
void	selectFromList(String locator, String... items) Select the given *items of the multi-select list identified by locator.
void	selectFromListByIndex(String locator, String... indexes) Select the given *indexes of the multi-select list identified by locator.
void	selectFromListByLabel(String locator, String... labels) Select the given *labels of the multi-select list identified by locator.
void	selectFromListByValue(String locator, String... values) Select the given *values of the multi-select list identified by locator.
void	unselectFromList(String locator, String... items) Unselect the given *items of the multi-select list identified by locator.
void	unselectFromListByIndex(String locator, Integer... indexes) Unselect the given *indexes of the multi-select list identified by locator.
void	unselectFromListByLabel(String locator, String... labels) Unselect the given *labels of the multi-select list identified by locator.
void	unselectFromListByValue(String locator, String... values) Unselect the given *values of the multi-select list 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

SelectElement

public SelectElement()

Method Detail

getListItems

public List<String> getListItems(String locator)

Returns the values in the select list identified by locator.

Select list keywords work on both lists and combo boxes. Key attributes for select lists are id and name. See `Introduction` for details about locators.

Parameters:

locator - The locator to locate the select list.

Returns:

The select list values

getSelectedListLabel

public String getSelectedListLabel(String locator)

Returns the visible label of the first selected element from the select list identified by locator.

Select list keywords work on both lists and combo boxes. Key attributes for select lists are id and name. See `Introduction` for details about locators.

Parameters:

locator - The locator to locate the select list.

Returns:

The first visible select list label

getSelectedListLabels

public List<String> getSelectedListLabels(String locator)

Returns the visible labels of the first selected elements as a list from the select list identified by locator.

Fails if there is no selection.

Select list keywords work on both lists and combo boxes. Key attributes for select lists are id and name. See `Introduction` for details about locators.

Parameters:

locator - The locator to locate the select list.

Returns:

The list of visible select list labels

getSelectedListValue

public String getSelectedListValue(String locator)

Returns the value of the first selected element from the select list identified by locator.

The return value is read from the value attribute of the selected element.

Select list keywords work on both lists and combo boxes. Key attributes for select lists are id and name. See `Introduction` for details about locators.

Parameters:

locator - The locator to locate the select list.

Returns:

The first select list value

getSelectedListValues

public List<String> getSelectedListValues(String locator)

Returns the values of the first selected elements as a list from the select list identified by locator.

Fails if there is no selection. The return values are read from the value attribute of the selected element.

Select list keywords work on both lists and combo boxes. Key attributes for select lists are id and name. See `Introduction` for details about locators.

Parameters:

locator - The locator to locate the select list.

Returns:

The list of select list values

listSelectionShouldBe

public void listSelectionShouldBe(String locator,
                         String... items)

Verify the selection of the select list identified by locatoris exactly *items.

If you want to verify no option is selected, simply give no items.

Select list keywords work on both lists and combo boxes. Key attributes for select lists are id and name. See `Introduction` for details about locators.

Parameters:

locator - The locator to locate the select list.

items - The list of items to verify

listShouldHaveNoSelections

public void listShouldHaveNoSelections(String locator)

Verify the select list identified by locatorhas no selections.

Select list keywords work on both lists and combo boxes. Key attributes for select lists are id and name. See `Introduction` for details about locators.

Parameters:

locator - The locator to locate the select list.

pageShouldContainList

public void pageShouldContainList(String locator)

pageShouldContainList

public void pageShouldContainList(String locator,
                         String message)

pageShouldContainList

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

Verify the select list identified by locator is found on the current page.

Select list keywords work on both lists and combo boxes. Key attributes for select lists are id and name. See `Introduction` for details about locators and log levels.

Parameters:

locator - The locator to locate the select list.

message - Default=NONE. Optional custom error message.

logLevel - Default=INFO. Optional log level.

pageShouldNotContainList

public void pageShouldNotContainList(String locator)

pageShouldNotContainList

public void pageShouldNotContainList(String locator,
                            String message)

pageShouldNotContainList

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

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

Select list keywords work on both lists and combo boxes. Key attributes for select lists are id and name. See `Introduction` for details about locators and log levels.

Parameters:

locator - The locator to locate the select list.

message - Default=NONE. Optional custom error message.

logLevel - Default=INFO. Optional log level.

selectAllFromList

public void selectAllFromList(String locator)

Select all values of the multi-select list identified by locator.

Select list keywords work on both lists and combo boxes. Key attributes for select lists are id and name. See `Introduction` for details about locators.

Parameters:

locator - The locator to locate the multi-select list.

selectFromList

public void selectFromList(String locator,
                  String... items)

Select the given *items of the multi-select list identified by locator.

An exception is raised for a single-selection list if the last value does not exist in the list and a warning for all other non-existing items. For a multi-selection list, an exception is raised for any and all non-existing values.

Select list keywords work on both lists and combo boxes. Key attributes for select lists are id and name. See `Introduction` for details about locators.

Parameters:

locator - The locator to locate the multi-select list.

items - The list of items to select

selectFromListByIndex

public void selectFromListByIndex(String locator,
                         String... indexes)

Select the given *indexes of the multi-select list identified by locator.

Tries to select by value AND by label. It's generally faster to use 'by index/value/label' keywords.

Select list keywords work on both lists and combo boxes. Key attributes for select lists are id and name. See `Introduction` for details about locators.

Parameters:

locator - The locator to locate the multi-select list.

indexes - The list of indexes to select

selectFromListByValue

public void selectFromListByValue(String locator,
                         String... values)

Select the given *values of the multi-select list identified by locator.

Select list keywords work on both lists and combo boxes. Key attributes for select lists are id and name. See `Introduction` for details about locators.

Parameters:

locator - The locator to locate the multi-select list.

values - The list of values to select

selectFromListByLabel

public void selectFromListByLabel(String locator,
                         String... labels)

Select the given *labels of the multi-select list identified by locator.

Select list keywords work on both lists and combo boxes. Key attributes for select lists are id and name. See `Introduction` for details about locators.

Parameters:

locator - The locator to locate the multi-select list.

labels - The list of labels to select

unselectFromList

public void unselectFromList(String locator,
                    String... items)

Unselect the given *items of the multi-select list identified by locator.

As a special case, giving an empty *items list will remove all selections.

Tries to unselect by value AND by label. It's generally faster to use 'by index/value/label' keywords.

Select list keywords work on both lists and combo boxes. Key attributes for select lists are id and name. See `Introduction` for details about locators.

Parameters:

locator - The locator to locate the multi-select list.

items - The list of items to select

unselectFromListByIndex

public void unselectFromListByIndex(String locator,
                           Integer... indexes)

Unselect the given *indexes of the multi-select list identified by locator.

Select list keywords work on both lists and combo boxes. Key attributes for select lists are id and name. See `Introduction` for details about locators.

Parameters:

locator - The locator to locate the multi-select list.

indexes - The list of indexes to select

unselectFromListByValue

public void unselectFromListByValue(String locator,
                           String... values)

Unselect the given *values of the multi-select list identified by locator.

Select list keywords work on both lists and combo boxes. Key attributes for select lists are id and name. See `Introduction` for details about locators.

Parameters:

locator - The locator to locate the multi-select list.

values - The list of values to select

unselectFromListByLabel

public void unselectFromListByLabel(String locator,
                           String... labels)

Unselect the given *labels of the multi-select list identified by locator.

Select list keywords work on both lists and combo boxes. Key attributes for select lists are id and name. See `Introduction` for details about locators.

Parameters:

locator - The locator to locate the multi-select list.

labels - The list of labels to select

getLabelsForOptions

protected List<String> getLabelsForOptions(List<org.openqa.selenium.WebElement> options)

getSelectList

protected org.openqa.selenium.support.ui.Select getSelectList(String locator)

getSelectListOptions

protected List<org.openqa.selenium.WebElement> getSelectListOptions(org.openqa.selenium.support.ui.Select select)

getSelectListOptions

protected List<org.openqa.selenium.WebElement> getSelectListOptions(String locator)

getSelectListOptionsSelected

protected List<org.openqa.selenium.WebElement> getSelectListOptionsSelected(String locator)

getValuesForOptions

protected List<String> getValuesForOptions(List<org.openqa.selenium.WebElement> options)

isMultiselectList

protected boolean isMultiselectList(org.openqa.selenium.support.ui.Select select)