org.safs.selenium.webdriver.lib.model

Class AbstractListSelectable

java.lang.Object

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

org.safs.selenium.webdriver.lib.model.AbstractSelectable

org.safs.selenium.webdriver.lib.model.AbstractListSelectable

All Implemented Interfaces:

IListSelectable, IOperable, ISelectable, Supportable

Direct Known Subclasses:

ListView.DefaultSelectableList, ListView.SapSelectable_ListBox, ListView.SapSelectable_m_List, ListView.SapSelectable_m_SelectList, TabControl.DojoTabbable_TabContainer, TabControl.SapTabbable_TabStrip

public abstract class AbstractListSelectable
extends AbstractSelectable
implements IListSelectable

History:

May 30, 2014 (Lei Wang) Initial release.
Oct 15, 2014 (Lei Wang) Add isShowOnPage(): override the superclass method, just return false.
Oct 29, 2014 (Lei Wang) Modify getMatchedElement(): if TextMatchingCriterion only contains 'index', no text to match, get by index.
Mar 27, 2015 (Lei Wang) Remove isShowOnPage(): the method in superclass has been fixed.

Field Summary

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

contentObjects, DEFAULT_WAIT_TIME

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

parent

Constructor Summary

Constructors

Constructor and Description
AbstractListSelectable(Component parent)

Method Summary

Modifier and Type	Method and Description
void	activateItem(int index, boolean verify, org.openqa.selenium.Keys key, java.awt.Point offset) Try to activate (double-click) the item according to the index, and then verify if the item has been really selected according to the parameter 'verify'.
protected Item	convertToItem(Element element)
Item[]	getContent() Try to get the cached content according to the WebElement. If no cached content can be found, then get the real-time content by calling AbstractSelectable.getCacheableContent(), and put the content in the cache and return it. If subclass doesn't need this functionality, then just override this method. If subclass needs this functionality, then override method AbstractSelectable.getCacheableContent()
Item	getMatchedElement(TextMatchingCriterion criterion) according to the element's label to get a Element object.
protected Item	getMatchedItem(int index) according to the index to get a Item object.
void	selectItem(int index, boolean verify, org.openqa.selenium.Keys key, java.awt.Point offset, int mouseButtonNumber) Try to select (single-click) the item according to the index, and then verify if the item has been really selected according to the parameter 'verify'.
protected void	verifyItemSelected(Element element) Note:In subclass, we need to update the 'selected' property of Element. Please call AbstractSelectable.waitAndVerifyItemSelected(Element) instead to verify selection, as the first method will also try the wait for element to be ready and call EmbeddedObject.refresh(boolean).
void	verifyItemSelection(int index, boolean expectSelected) Verify the item (specified by index) is selected or un-selected.

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

activateItem, clearCache, clickElement, getCacheableContent, selectItem, showOnPage, verifyContains, verifyItemSelection, verifyItemSelection, waitAndVerifyItemSelected, waitElementReady, waitElementReady

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

isShowOnPage, isSupported, refresh, webelement

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.safs.selenium.webdriver.lib.model.ISelectable

activateItem, selectItem, verifyContains, verifyItemSelection

Methods inherited from interface org.safs.selenium.webdriver.lib.model.IOperable

clearCache

Methods inherited from interface org.safs.selenium.webdriver.lib.model.Supportable

getSupportedClassNames

Constructor Detail

AbstractListSelectable

public AbstractListSelectable(Component parent)
                       throws SeleniumPlusException

Throws:

SeleniumPlusException

Method Detail

getContent

public Item[] getContent()
                  throws SeleniumPlusException

Description copied from class: AbstractSelectable

Try to get the cached content according to the WebElement.
If no cached content can be found, then get the real-time content by calling AbstractSelectable.getCacheableContent(),
and put the content in the cache and return it.
If subclass doesn't need this functionality, then just override this method.
If subclass needs this functionality, then override method AbstractSelectable.getCacheableContent()

Specified by:

getContent in interface IListSelectable

Specified by:

getContent in interface ISelectable

Overrides:

getContent in class AbstractSelectable

Returns:

Element[] an array of the element

Throws:

SeleniumPlusException

See Also:

AbstractSelectable.getCacheableContent()

getMatchedElement

public Item getMatchedElement(TextMatchingCriterion criterion)
                       throws SeleniumPlusException

Description copied from interface: ISelectable

according to the element's label to get a Element object.

Specified by:

getMatchedElement in interface ISelectable

Parameters:

criterion - TextMatchingCriterion, containing text, partialMatch, matchedIndex as search-criterion.

Returns:

Element, the matched Element object.

Throws:

SeleniumPlusException - if Element cannot be found

getMatchedItem

protected Item getMatchedItem(int index)
                       throws SeleniumPlusException

according to the index to get a Item object.

Parameters:

index - int, the index of the item.

Returns:

Item, the matched Item object.

Throws:

SeleniumPlusException

selectItem

public void selectItem(int index,
                       boolean verify,
                       org.openqa.selenium.Keys key,
                       java.awt.Point offset,
                       int mouseButtonNumber)
                throws SeleniumPlusException

Description copied from interface: ISelectable

Try to select (single-click) the item according to the index, and then verify if the item has been really selected according to the parameter 'verify'. If the parameter key is provided, the selection will happen with that key pressed at the same time. If the parameter offset is provided, then click at offset relative to the top-left corner of view; otherwise at the center. The parameter mouseButtonNumber decides right-click or left-click.
Note: There are maybe some callback methods associated with the item-container, but setting select index MAY NOT invoke them, in the implementation of this method we should make sure those callbacks are invoked (we can fire some events.)

Specified by:

selectItem in interface ISelectable

Parameters:

index - int, the index of the item to select, it is 0-based index.

verify - boolean, if true then verify the selection;

key - org.openqa.selenium.Keys, it is the key to press during selection.
for example Keys.SHIFT, or Keys.CONTROL.
If user doesn't want any key pressed, please provide null

offset - Point, the position relative to the up-left corner to click at
If user provides null, then the center of the item will be used

mouseButtonNumber - int, the mouse-button-number representing right, middle, or left button.
it can be WDLibrary.MOUSE_BUTTON_LEFT or WDLibrary.MOUSE_BUTTON_RIGHT
or WDLibrary.MOUSE_BUTTON_MIDDLE.

Throws:

SeleniumPlusException

activateItem

public void activateItem(int index,
                         boolean verify,
                         org.openqa.selenium.Keys key,
                         java.awt.Point offset)
                  throws SeleniumPlusException

Description copied from interface: ISelectable

Try to activate (double-click) the item according to the index, and then verify if the item has been really selected according to the parameter 'verify'. If the parameter key is provided, the selection will happen with that key pressed at the same time.

Specified by:

activateItem in interface ISelectable

Parameters:

index - int, the index of the item to select, it is 0-based index.

verify - boolean, if true then verify the selection;

key - org.openqa.selenium.Keys, it is the key to press during selection.
for example Keys.SHIFT, or Keys.CONTROL.
If user doesn't want any key pressed, please provide null

offset - Point, the position relative to the up-left corner to click at
If user provides null, then the center of the item will be used

Throws:

SeleniumPlusException

verifyItemSelection

public void verifyItemSelection(int index,
                                boolean expectSelected)
                         throws SeleniumPlusException

Description copied from interface: ISelectable

Verify the item (specified by index) is selected or un-selected.

Specified by:

verifyItemSelection in interface ISelectable

Parameters:

index - int, the index of the item to select, it is 0-based index.

expectSelected - boolean, true if the item is expected 'selected'; false if expected 'unselected'.

Throws:

SeleniumPlusException - if the verification fails.

convertToItem

protected Item convertToItem(Element element)
                      throws SeleniumPlusException

Throws:

SeleniumPlusException

verifyItemSelected

protected void verifyItemSelected(Element element)
                           throws SeleniumPlusException

Description copied from class: AbstractSelectable

Note:In subclass, we need to update the 'selected' property of Element.
Please call AbstractSelectable.waitAndVerifyItemSelected(Element) instead to verify selection,
as the first method will also try the wait for element to be ready and call EmbeddedObject.refresh(boolean).

Overrides:

verifyItemSelected in class AbstractSelectable

Parameters:

element - Element, the element to verify that it is selected.

Throws:

SeleniumPlusException