org.safs.selenium.webdriver.lib.model

Interface IRefreshable

All Known Implementing Classes:

CheckBox, ComboBox, Component, DefaultRefreshable, EditBox, Element, HierarchicalElement, Item, ListView, Menu, MenuItem, Option, OptionForHtmlSelect, ScrollBar, TabControl, Tree, TreeNode

public interface IRefreshable

 According to a 'Recognition String', we can get a WebElement through Selenium.
 This WebElement represents a control on the web application, and it can be used
 to manipulate the control by Selenium. But sometimes, this WebElement will
 become stale (calling a javascript function on the same control) and cannot
 be used anymore. At this situation, the WebElement needs to be refreshed.
 

History:

Jun 12, 2014 (Lei Wang) Initial release.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getCssClass() get the WebElement's CSS Class.
java.lang.String	getId() get the WebElement's ID.
java.lang.String[]	getPossibleRecognitionStrings() get the possible recognition strings, they will be tried one by one until a valid WebElement is got.
org.openqa.selenium.SearchContext	getSearchContext() get the SearchContext, used during refresh of WebElement. If it is null, the search of WebElement will be processed through WebDriver, which means to search on the whole web page.
java.lang.String	getTagName() get the WebElement's Tag Name.
org.openqa.selenium.WebElement	getWebElement() get the embedded WebElement object.
boolean	refresh(boolean checkStale) Refresh the embedded WebElement object.
void	setWebElement(org.openqa.selenium.WebElement webelement) set the embedded WebElement object.

Method Detail

getId

java.lang.String getId()

get the WebElement's ID.

getTagName

java.lang.String getTagName()

get the WebElement's Tag Name.

getCssClass

java.lang.String getCssClass()

get the WebElement's CSS Class.

getSearchContext

org.openqa.selenium.SearchContext getSearchContext()

get the SearchContext, used during refresh of WebElement.
If it is null, the search of WebElement will be processed through WebDriver,
which means to search on the whole web page.

getPossibleRecognitionStrings

java.lang.String[] getPossibleRecognitionStrings()

get the possible recognition strings, they will be tried one by one until
a valid WebElement is got.

getWebElement

org.openqa.selenium.WebElement getWebElement()

get the embedded WebElement object.

setWebElement

void setWebElement(org.openqa.selenium.WebElement webelement)

set the embedded WebElement object.

refresh

boolean refresh(boolean checkStale)

Refresh the embedded WebElement object. A stale element reference exception is thrown in one of two cases, the first being more common than the second:
1. The element has been deleted entirely.
The most frequent cause of this is that page that the element was part of has been refreshed,
or the user has navigated away to another page. A less common, but still common cause is
where a JS library has deleted an element and replaced it with one with the same ID or attributes.
In this case, although the replacement elements may look identical they are different;
the driver has no way to determine that the replacements are actually what's expected.
2. The element is no longer attached to the DOM.

If some native javascript APIs are called, the web element may become stale. In this case, this
method needs to be called.

Parameters:

checkStale - boolean, if true then check if the element is stale or not before refresh; ohterwise, then refresh the element directly. The check will spend some time, if you don't want to waste time, use false.

Returns:

boolean, true if the refresh succeed.