org.safs.selenium.webdriver.lib

Class ListView.SapSelectable_ListBox

java.lang.Object

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

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

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

org.safs.selenium.webdriver.lib.ListView.SapSelectable_ListBox

All Implemented Interfaces:

IListSelectable, IOperable, ISelectable, Supportable

Enclosing class:

ListView

protected static class ListView.SapSelectable_ListBox
extends AbstractListSelectable

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CLASS_NAME_LISTBOX
static java.lang.String[]	supportedClazzes

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
SapSelectable_ListBox(Component component)

Method Summary

Modifier and Type	Method and Description
protected void	clickElement(Element element, org.openqa.selenium.Keys key, java.awt.Point offset, int mouseButtonNumber, int numberOfClick) Try to get the Selenium WebElement object from parameter 'element', then click that WebElement object. After calling this method, the parent of Element may become stale.
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()
java.lang.String[]	getSupportedClassNames()
protected void	showOnPage(Element element) Make the element is in the container, and visible on the page. For example, some element may not be visible if there are too many elements in its container; User can scroll to make the element visible on the page. User may need to wait for a while so that the element related object can be updated (like position-onscreen, visibility etc.) This method gives a default implementation: it will scroll and align the top of element to the top of container. Before this method is called, it is suggested to call EmbeddedObject.isShowOnPage(Element) firstly.
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).

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

activateItem, convertToItem, getMatchedElement, getMatchedItem, selectItem, verifyItemSelection

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

activateItem, clearCache, getCacheableContent, selectItem, 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

Field Detail

CLASS_NAME_LISTBOX

public static final java.lang.String CLASS_NAME_LISTBOX

See Also:

Constant Field Values

supportedClazzes

public static final java.lang.String[] supportedClazzes

Constructor Detail

SapSelectable_ListBox

public SapSelectable_ListBox(Component component)
                      throws SeleniumPlusException

Throws:

SeleniumPlusException

Method Detail

getSupportedClassNames

public java.lang.String[] getSupportedClassNames()

Returns:

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

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 AbstractListSelectable

Returns:

Element[] an array of the element

Throws:

SeleniumPlusException

See Also:

AbstractSelectable.getCacheableContent()

clickElement

protected void clickElement(Element element,
                            org.openqa.selenium.Keys key,
                            java.awt.Point offset,
                            int mouseButtonNumber,
                            int numberOfClick)
                     throws SeleniumPlusException

Description copied from class: AbstractSelectable

Try to get the Selenium WebElement object from parameter 'element', then click that WebElement object.
After calling this method, the parent of Element may become stale. We may need to call EmbeddedObject.refresh(boolean).
Atter calling this method, user may need to verify that element has been selected. Please call AbstractSelectable.waitAndVerifyItemSelected(Element)
instead of AbstractSelectable.verifyItemSelected(Element), as the first method will also try the wait for element
to be ready and call EmbeddedObject.refresh(boolean).

Overrides:

clickElement in class AbstractSelectable

Parameters:

element - Element, the element to select

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

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.

numberOfClick - int, 1 means single-click, 2 means double-click

Throws:

SeleniumPlusException

See Also:

#refresh(boolean)}, AbstractSelectable.waitAndVerifyItemSelected(Element)

showOnPage

protected void showOnPage(Element element)
                   throws SeleniumPlusException

Description copied from class: AbstractSelectable

Make the element is in the container, and visible on the page.
For example, some element may not be visible if there are too many elements in its container;
User can scroll to make the element visible on the page.
User may need to wait for a while so that the element related object can be updated (like position-onscreen, visibility etc.)

This method gives a default implementation:
it will scroll and align the top of element to the top of container.
Before this method is called, it is suggested to call EmbeddedObject.isShowOnPage(Element) firstly.

Overrides:

showOnPage in class AbstractSelectable

Parameters:

element - Element, the element needs to be visible on page

Throws:

SeleniumPlusException

See Also:

#isShowOnPage(Element)}

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 AbstractListSelectable

Parameters:

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

Throws:

SeleniumPlusException