org.safs.selenium.webdriver.lib

Class Select

java.lang.Object

org.safs.selenium.webdriver.lib.Select

Direct Known Subclasses:

DojoSelect

 class Select
extends java.lang.Object

Modified from Source code of Selenium. Models a SELECT tag, providing helper methods to select and deselect options.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CLASS_HTML_SELECT
protected WebElement	element
protected boolean	isMulti

Constructor Summary

Constructors

Constructor and Description
Select(WebElement element) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
void	deselectAll() Clear all selected entries.
void	deselectByIndex(int index) Deselect the option at the given index.
void	deselectByValue(java.lang.String value) Deselect all options that have a value matching the argument.
void	deselectByVisibleText(java.lang.String text) Deselect all options that display text matching the argument.
protected java.lang.String	escapeQuotes(java.lang.String toEscape)
java.util.List<WebElement>	getAllSelectedOptions()
WebElement	getFirstSelectedOption()
java.lang.Object	getItemByIndex(int index)
java.util.List<WebElement>	getOptions()
boolean	isMultiple()
protected boolean	isSupported(WebElement element) The element will be used to create an instance of class Select or subclass.
void	selectByIndex(int index) Select the option at the given index.
void	selectByValue(java.lang.String value) Select all options that have a value matching the argument.
void	selectByVisibleText(java.lang.String text) Select all options that display text matching the argument.

Methods inherited from class java.lang.Object

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

Field Detail

CLASS_HTML_SELECT

public static final java.lang.String CLASS_HTML_SELECT

See Also:

Constant Field Values

element

protected final WebElement element

isMulti

protected final boolean isMulti

Constructor Detail

Select

public Select(WebElement element)
       throws SeleniumPlusException

Constructor. It will call method isSupported(WebElement) to see if element is supported.
If it is not,then an SeleniumPlusException is thrown with SeleniumPlusException.CODE_TYPE_IS_WRONG.

Parameters:

element - SELECT element to wrap

Throws:

SeleniumPlusException - when element is not supported as a combo box.

Method Detail

isSupported

protected boolean isSupported(WebElement element)

The element will be used to create an instance of class Select or subclass.
In the constructor Select(WebElement) or constructor of subclass,
this method will be called to test if the element is supported by this class Select or subclass.
This method will check if the tag name is 'select' or not, if yes then supported, otherwise not supported.

getItemByIndex

public java.lang.Object getItemByIndex(int index)

isMultiple

public boolean isMultiple()

Returns:

Whether this select element support selecting multiple options at the same time? This is done by checking the value of the "multiple" attribute.

getOptions

public java.util.List<WebElement> getOptions()

Returns:

All options belonging to this select tag

getAllSelectedOptions

public java.util.List<WebElement> getAllSelectedOptions()

Returns:

All selected options belonging to this select tag

getFirstSelectedOption

public WebElement getFirstSelectedOption()

Returns:

The first selected option in this select tag (or the currently selected option in a normal select)

selectByVisibleText

public void selectByVisibleText(java.lang.String text)

Select all options that display text matching the argument. That is, when given "Bar" this would select an option like: <option value="foo">Bar</option>

Parameters:

text - The visible text to match against

selectByIndex

public void selectByIndex(int index)

Select the option at the given index. This is done by examing the "index" attribute of an element, and not merely by counting.

Parameters:

index - The option at this index will be selected

selectByValue

public void selectByValue(java.lang.String value)

Select all options that have a value matching the argument. That is, when given "foo" this would select an option like: <option value="foo">Bar</option>

Parameters:

value - The value to match against

deselectAll

public void deselectAll()

Clear all selected entries. This is only valid when the SELECT supports multiple selections.

Throws:

java.lang.UnsupportedOperationException - If the SELECT does not support multiple selections

deselectByValue

public void deselectByValue(java.lang.String value)

Deselect all options that have a value matching the argument. That is, when given "foo" this would deselect an option like: <option value="foo">Bar</option>

Parameters:

value - The value to match against

deselectByIndex

public void deselectByIndex(int index)

Deselect the option at the given index. This is done by examing the "index" attribute of an element, and not merely by counting.

Parameters:

index - The option at this index will be deselected

deselectByVisibleText

public void deselectByVisibleText(java.lang.String text)

Deselect all options that display text matching the argument. That is, when given "Bar" this would deselect an option like: <option value="foo">Bar</option>

Parameters:

text - The visible text to match against

escapeQuotes

protected java.lang.String escapeQuotes(java.lang.String toEscape)