org.safs.selenium.webdriver.lib.model

Interface ISelectable

All Superinterfaces:

IOperable

All Known Subinterfaces:

IHierarchicalSelectable, IListSelectable, IMenuSelectable, ITreeSelectable

All Known Implementing Classes:

AbstractHierarchicalSelectable, AbstractListSelectable, AbstractMenuSelectable, AbstractSelectable, AbstractTreeSelectable, ListView, ListView.DefaultSelectableList, ListView.SapSelectable_ListBox, ListView.SapSelectable_m_List, ListView.SapSelectable_m_SelectList, Menu, Menu.DefaultSelectable_Menu, Menu.SapSelectable_Menu, Menu.SAS_HC_PushMenu, TabControl.DojoTabbable_TabContainer, TabControl.SapTabbable_TabStrip, Tree, Tree.DefaultSelectable_Tree, Tree.SapSelectable_Tree

public interface ISelectable
extends IOperable

History:

  Apr 25, 2014    (Lei Wang) Initial release.
  May 05, 2014    (Lei Wang) Modify methods selectItem and verifyItemSelection to accept one more parameter 'matchIndex'.
  May 05, 2014    (Lei Wang) Modify methods selectItem to accept one more parameter 'key'.
  May 29, 2014    (Lei Wang) Modify methods selectItem to accept more parameter 'offset' and 'mouseButtonNumber'.
                           Add methods activateItem to double click item.
 

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'.
void	activateItem(TextMatchingCriterion criterion, boolean verify, org.openqa.selenium.Keys key, java.awt.Point offset) Try to activate (double-click) the item according to the item's text (fully or partially given), and then verify if the item has been really selected according to the parameter 'verify'.
Element[]	getContent() Get all elements.
Element	getMatchedElement(TextMatchingCriterion criterion) according to the element's label to get a Element 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'.
void	selectItem(TextMatchingCriterion criterion, boolean verify, org.openqa.selenium.Keys key, java.awt.Point offset, int mouseButtonNumber) Try to select (single-click) the item according to the item's text (fully or partially given), and then verify if the item has been really selected according to the parameter 'verify'.
void	verifyContains(TextMatchingCriterion criterion) Verify the item (specified by text, partialMatch and matchIndex) is contained.
void	verifyItemSelection(int index, boolean expectSelected) Verify the item (specified by index) is selected or un-selected.
void	verifyItemSelection(TextMatchingCriterion criterion, boolean expectSelected) Verify the item (specified by text, partialMatch and matchIndex) is selected or un-selected.

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

clearCache

Method Detail

selectItem

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

Try to select (single-click) the item according to the item's text (fully or partially given), 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 text MAY NOT invoke them, in the implementation of this method we should make sure those callbacks are invoked (we can fire some events.)

Parameters:

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

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

selectItem

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

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.)

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

void activateItem(TextMatchingCriterion criterion,
                  boolean verify,
                  org.openqa.selenium.Keys key,
                  java.awt.Point offset)
           throws SeleniumPlusException

Try to activate (double-click) the item according to the item's text (fully or partially given), 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.

Parameters:

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

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

activateItem

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

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.

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

void verifyItemSelection(TextMatchingCriterion criterion,
                         boolean expectSelected)
                  throws SeleniumPlusException

Verify the item (specified by text, partialMatch and matchIndex) is selected or un-selected.

Parameters:

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

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

Throws:

SeleniumPlusException - if the verification fails.

verifyItemSelection

void verifyItemSelection(int index,
                         boolean expectSelected)
                  throws SeleniumPlusException

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

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.

verifyContains

void verifyContains(TextMatchingCriterion criterion)
             throws SeleniumPlusException

Verify the item (specified by text, partialMatch and matchIndex) is contained.

Parameters:

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

Throws:

SeleniumPlusException - if the verification fails.

getMatchedElement

Element getMatchedElement(TextMatchingCriterion criterion)
                   throws SeleniumPlusException

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

Parameters:

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

Returns:

Element, the matched Element object.

Throws:

SeleniumPlusException - if Element cannot be found

getContent

Element[] getContent()
              throws SeleniumPlusException

Get all elements.

Returns:

Element[] an array of the element

Throws:

SeleniumPlusException