org.safs.selenium.webdriver.lib

Class ComboBox.HtmlSelect

java.lang.Object

org.safs.selenium.webdriver.lib.model.EmbeddedObject

org.safs.selenium.webdriver.lib.ComboBox.HtmlSelect

All Implemented Interfaces:

ComboBox.Selectable, IOperable, Supportable

Direct Known Subclasses:

ComboBox.AbstractSelect

Enclosing class:

ComboBox

protected static class ComboBox.HtmlSelect
extends EmbeddedObject
implements ComboBox.Selectable

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

See Also:

ComboBox.Selectable

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CLASS_NAME traditional HTML tag <select>
protected boolean	isMulti
static java.lang.String[]	supportedClazzes

Fields inherited from class org.safs.selenium.webdriver.lib.model.EmbeddedObject

parent

Constructor Summary

Constructors

Constructor and Description
HtmlSelect(Component component) Constructor.

Method Summary

Modifier and Type	Method and Description
void	clearCache()
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<Option>	getAllSelectedOptions()
java.util.List<java.lang.String>	getAllSelectedOptionsText()
Option	getFirstSelectedOption()
Option	getItemByIndex(int index)
protected java.lang.String	getLongestSubstringWithoutSpace(java.lang.String s)
java.util.List<Option>	getOptions()
java.util.List<java.lang.String>	getOptionsValue()
java.util.List<java.lang.String>	getOptionsVisibleText()
java.lang.String	getOptionValue(int index)
java.lang.String	getOptionVisibleText(int index)
java.lang.String[]	getSupportedClassNames()
void	hidePopup()
boolean	isMultiple()
protected boolean	isSelected(java.lang.Object option)
boolean	isSupported(org.openqa.selenium.WebElement element) The element will be used to create an instance of class ComboBox.HtmlSelect 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.
protected boolean	selectOption(java.lang.Object option)
protected void	setSelected(java.lang.Object option)
void	showPopup()

Methods inherited from class org.safs.selenium.webdriver.lib.model.EmbeddedObject

isShowOnPage, refresh, webelement

Methods inherited from class java.lang.Object

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

Field Detail

CLASS_NAME

public static final java.lang.String CLASS_NAME

traditional HTML tag <select>

See Also:

Constant Field Values

supportedClazzes

public static final java.lang.String[] supportedClazzes

isMulti

protected final boolean isMulti

Constructor Detail

HtmlSelect

public HtmlSelect(Component component)
           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:

webelement - SELECT element to wrap, such as html tag <select>, dijit.form.ComboBox, or dijit.form.Select etc

Throws:

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

Method Detail

clearCache

public void clearCache()

Specified by:

clearCache in interface IOperable

isSupported

public boolean isSupported(org.openqa.selenium.WebElement element)

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

Specified by:

isSupported in interface Supportable

Overrides:

isSupported in class EmbeddedObject

Parameters:

element - WebElement, the element to check.

getSupportedClassNames

public java.lang.String[] getSupportedClassNames()

Specified by:

getSupportedClassNames in interface Supportable

Returns:

String[], an array of class-name supported by this class

getItemByIndex

public Option getItemByIndex(int index)

Specified by:

getItemByIndex in interface ComboBox.Selectable

Parameters:

index - int, the index for an option, 0-based.

Returns:

Option, the option object according to the index

isMultiple

public boolean isMultiple()

Specified by:

isMultiple in interface ComboBox.Selectable

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<Option> getOptions()

Specified by:

getOptions in interface ComboBox.Selectable

Returns:

All options belonging to this select tag

getOptionsVisibleText

public java.util.List<java.lang.String> getOptionsVisibleText()

Specified by:

getOptionsVisibleText in interface ComboBox.Selectable

Returns:

List, All the options text.

getOptionsValue

public java.util.List<java.lang.String> getOptionsValue()

Specified by:

getOptionsValue in interface ComboBox.Selectable

Returns:

List, All the options value.

getOptionVisibleText

public java.lang.String getOptionVisibleText(int index)

Specified by:

getOptionVisibleText in interface ComboBox.Selectable

Parameters:

index - int, the index for an option, 0-based.

Returns:

String, the option text according to the index

getOptionValue

public java.lang.String getOptionValue(int index)

Specified by:

getOptionValue in interface ComboBox.Selectable

Parameters:

index - int, the index for an option, 0-based.

Returns:

String, the option value according to the index

getAllSelectedOptions

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

Specified by:

getAllSelectedOptions in interface ComboBox.Selectable

Returns:

All selected options belonging to this select tag

getAllSelectedOptionsText

public java.util.List<java.lang.String> getAllSelectedOptionsText()

Specified by:

getAllSelectedOptionsText in interface ComboBox.Selectable

Returns:

List, All the selected options text.

getFirstSelectedOption

public Option getFirstSelectedOption()

Specified by:

getFirstSelectedOption in interface ComboBox.Selectable

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>

Specified by:

selectByVisibleText in interface ComboBox.Selectable

Parameters:

text - The visible text to match against

getLongestSubstringWithoutSpace

protected java.lang.String getLongestSubstringWithoutSpace(java.lang.String s)

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.

Specified by:

selectByIndex in interface ComboBox.Selectable

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>

Specified by:

selectByValue in interface ComboBox.Selectable

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.

Specified by:

deselectAll in interface ComboBox.Selectable

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>

Specified by:

deselectByValue in interface ComboBox.Selectable

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.

Specified by:

deselectByIndex in interface ComboBox.Selectable

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>

Specified by:

deselectByVisibleText in interface ComboBox.Selectable

Parameters:

text - The visible text to match against

escapeQuotes

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

isSelected

protected boolean isSelected(java.lang.Object option)

selectOption

protected boolean selectOption(java.lang.Object option)

setSelected

protected void setSelected(java.lang.Object option)

hidePopup

public void hidePopup()
               throws SeleniumPlusException

Specified by:

hidePopup in interface ComboBox.Selectable

Throws:

SeleniumPlusException

showPopup

public void showPopup()
               throws SeleniumPlusException

Specified by:

showPopup in interface ComboBox.Selectable

Throws:

SeleniumPlusException