DefaultRefreshable (SAFS API DOCUMENT)

java.lang.Object
- org.safs.selenium.webdriver.lib.model.DefaultRefreshable

All Implemented Interfaces:

IRefreshable

Direct Known Subclasses:

Component, Element
```
public class DefaultRefreshable
extends java.lang.Object
implements IRefreshable
```
History:

JUN 12, 2014 (Lei Wang) Initial release.
NOV 05, 2014 (Lei Wang) Modify refresh(): if the 'id' is not null and we cannot get object by id, then stop searching. if we cannot get fresh-webelement, we will not update fields like id, tag-name etc.
FEB 25, 2016 (Lei Wang) Modify refresh(): log a warning message instead of throwing out an Exception if we cannot get webelement by id. Modify searchWebElement(): Use WebDriver as SearchContext to find the object, if it cannot be found with given SearchContext.

Field Summary

Fields
Modifier and Type	Field and Description
`protected java.lang.String`	`cssClass` cssClass is the html css value for this web element, it may be null
`protected java.lang.String`	`id` id is the html id for this web element, it may be null
`protected java.util.Map<?,?>`	`map` The convenient reference to embedded element object.
`protected java.lang.Object`	`object` The wrapped object, represents a control object on the web application This object is refresh-able, which means it can be reset if the control object of web application has changed its status. For now, 2 kinds of type can be accepted, Map returned from a javascript function; WebElement returned by Selenium WebDriver (with certain search criterion).
`protected java.lang.String[]`	`possibleRecognitionStrings` possibleRecognitionStrings is used to refresh the WebElement, it may be null.
`protected org.openqa.selenium.SearchContext`	`searchContext` searchContext is used to refresh the WebElement according to id, tag, cssclass etc, it may be null
`protected java.lang.String`	`tagName` tagName is the html tag name for this web element, should never be null
`protected org.openqa.selenium.WebElement`	`webelement` The convenient reference to embedded element object. This element may become stale, see stale_element If the element is stale, we need to refresh it by getting it again (by id or css or other ways)

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`DefaultRefreshable()` Constructor ONLY for subclass, cannot be used to create an instance outside.
	`DefaultRefreshable(java.lang.Object object)` Constructor used to create an uniformed DefaultRefreshable object. User may override this one to parse their own object, if there are some new attributes to analyze, then user should override `updateFields()` and he MUST TAKE CARE: There are 2 ways to write the overridden constructor: DO NOT forget to call `updateFields()` after calling super(object), below is an example of implementation in subclass.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.String`	`getAttribute(java.lang.String attribute)` Get the value of an attribute from the underlying WebElement object.
`java.lang.String`	`getCssClass()` get the WebElement's CSS Class.
`java.lang.Object`	`getEmbeddedObject()`
`java.lang.String`	`getId()` get the WebElement's ID.
`java.util.Map<?,?>`	`getMap()` The embedded element object (a Map) is returned from a javascript function.
`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()` searchContext is used to find the WebElement according to id, tag, cssclass etc, it may be null. if it is null, `SearchObject.getWebDriver()` will be used a SearchContext. if it is not null, it may be stale itself!
`java.lang.String`	`getTagName()` get the WebElement's Tag Name.
`org.openqa.selenium.WebElement`	`getWebElement()` Try to get the Selenium WebElement object 'webelement', if is null then try to find it by id. It can be used to verify the status.
`protected void`	`initialize(java.lang.Object object)` Set the embedded object and update the component's fields.
`boolean`	`refresh(boolean checkStale)` Refresh the webelement by its 'ID' or 'CSS CLASS' or preset 'Recognition Strings'. And update the value of fields according to the refreshed-WebElement
`void`	`setCssClass(java.lang.String cssClass)`
`void`	`setId(java.lang.String id)`
`void`	`setPossibleRecognitionStrings(java.lang.String[] possibleRecognitionStrings)`
`void`	`setSearchContext(org.openqa.selenium.SearchContext searchContext)`
`void`	`setTagName(java.lang.String tagName)`
`void`	`setWebElement(org.openqa.selenium.WebElement element)` set the embedded WebElement object.
`protected void`	`updateFields()` set/update the class's local fields through the underlying WebElement. Especially after calling `refresh(boolean)`, the underlying WebElement may have been refreshed, and the associated attributes may have different value, it is recommended to call this method to update the class's local field.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - object
```
protected java.lang.Object object
```
    The wrapped object, represents a control object on the web application
    This object is refresh-able, which means it can be reset if the control object
    of web application has changed its status.
    For now, 2 kinds of type can be accepted, Map returned from a javascript function;
    WebElement returned by Selenium WebDriver (with certain search criterion). There are convenient
    references for them, map and webelement.
    For now, Only WebElement can be refreshed by method refresh(boolean).
  - map
```
protected java.util.Map<?,?> map
```
    The convenient reference to embedded element object.
  - webelement
```
protected org.openqa.selenium.WebElement webelement
```
    The convenient reference to embedded element object.
    This element may become stale, see stale_element
    If the element is stale, we need to refresh it by getting it again (by id or css or other ways)
    
    See Also:
    
    refresh(boolean)
  - tagName
```
protected java.lang.String tagName
```
    tagName is the html tag name for this web element, should never be null
  - id
```
protected java.lang.String id
```
    id is the html id for this web element, it may be null
  - cssClass
```
protected java.lang.String cssClass
```
    cssClass is the html css value for this web element, it may be null
  - searchContext
```
protected org.openqa.selenium.SearchContext searchContext
```
    searchContext is used to refresh the WebElement according to id, tag, cssclass etc, it may be null
  - possibleRecognitionStrings
```
protected java.lang.String[] possibleRecognitionStrings
```
    possibleRecognitionStrings is used to refresh the WebElement, it may be null. Example as "id=xxx", "text=xxx" etc.
- Constructor Detail
  - DefaultRefreshable
```
protected DefaultRefreshable()
```
    Constructor ONLY for subclass, cannot be used to create an instance outside.
  - DefaultRefreshable
```
public DefaultRefreshable(java.lang.Object object)
```
    Constructor used to create an uniformed DefaultRefreshable object.
    User may override this one to parse their own object, if there are some new attributes
    to analyze, then user should override updateFields() and he MUST TAKE CARE:
    
    There are 2 ways to write the overridden constructor:
    - DO NOT forget to call updateFields() after calling
      super(object), below is an example of implementation in subclass.
      
      super(object); updateFields();
      The reason is that all fields will be initialized after calling super() or this() in a constructor.
      This is a nature of Java Language. So even here we call updateFields() to set value for
      some fields of sub-class during instantiation of sub-class which overrides method updateFields(),
      but after calling of super(object) in the constructor of sub-class, all fields of sub-class will be
      initialized to the default value; What is set HERE will be LOST!!!
    - Or there is a better way, in the sub class's constructor user just need to call initialize(Object).
      
      initialize(Object);
      in that constructor, the no-parameter constructor DefaultRefreshable() will be called implicitly,
      and the fields of subclass will be initialized, then the method initialize(Object) will be called,
      no fields of subclass will be reinitialized!
      But we should NEVER do anything except calling initialize(Object) in this constructor, the reason is
      that the no-parameter constructor will be called in subclass's constructor, and everything we added here will
      not be visible for constructor in subclass. We MUST do that work in the method initialize(Object) or updateFields()
    Parameters:
    
    object - Object, the element object. It may be a Map returned from javascript; it may be a WebElement.
- Method Detail
  - initialize
```
protected void initialize(java.lang.Object object)
```
    Set the embedded object and update the component's fields.
    
    Parameters:
    
    object -
  - updateFields
```
protected void updateFields()
```
    set/update the class's local fields through the underlying WebElement.
    Especially after calling refresh(boolean), the underlying WebElement may have been
    refreshed, and the associated attributes may have different value, it is recommended
    to call this method to update the class's local field.
    
    See Also:
    
    refresh(boolean)
  - getAttribute
```
public java.lang.String getAttribute(java.lang.String attribute)
```
    Get the value of an attribute from the underlying WebElement object.
    
    Parameters:
    
    attribute - String, the attribute name
    
    Returns:
    
    String, the value of the attribute
  - getWebElement
```
public org.openqa.selenium.WebElement getWebElement()
```
    Try to get the Selenium WebElement object 'webelement', if is null then try to find it by id.
    It can be used to verify the status.
    
    Specified by:
    
    getWebElement in interface IRefreshable
    
    Returns:
    
    WebElement the embedded WebElement object or null.
  - setWebElement
```
public void setWebElement(org.openqa.selenium.WebElement element)
```
    Description copied from interface: IRefreshable
    
    set the embedded WebElement object.
    
    Specified by:
    
    setWebElement in interface IRefreshable
  - getEmbeddedObject
```
public java.lang.Object getEmbeddedObject()
```
    Returns:
    
    Object, the embedded element object
  - getMap
```
public java.util.Map<?,?> getMap()
```
    The embedded element object (a Map) is returned from a javascript function.
    
    Returns:
    
    Map, convenient Map reference of the embedded item object
  - getTagName
```
public java.lang.String getTagName()
```
    Description copied from interface: IRefreshable
    
    get the WebElement's Tag Name.
    
    Specified by:
    
    getTagName in interface IRefreshable
  - setTagName
```
public void setTagName(java.lang.String tagName)
```
  - getId
```
public java.lang.String getId()
```
    Description copied from interface: IRefreshable
    
    get the WebElement's ID.
    
    Specified by:
    
    getId in interface IRefreshable
  - setId
```
public void setId(java.lang.String id)
```
  - getCssClass
```
public java.lang.String getCssClass()
```
    Description copied from interface: IRefreshable
    
    get the WebElement's CSS Class.
    
    Specified by:
    
    getCssClass in interface IRefreshable
  - setCssClass
```
public void setCssClass(java.lang.String cssClass)
```
  - getSearchContext
```
public org.openqa.selenium.SearchContext getSearchContext()
```
    searchContext is used to find the WebElement according to id, tag, cssclass etc, it may be null.
    if it is null, SearchObject.getWebDriver() will be used a SearchContext.
    if it is not null, it may be stale itself!
    
    Specified by:
    
    getSearchContext in interface IRefreshable
  - setSearchContext
```
public void setSearchContext(org.openqa.selenium.SearchContext searchContext)
```
  - getPossibleRecognitionStrings
```
public java.lang.String[] getPossibleRecognitionStrings()
```
    Description copied from interface: IRefreshable
    
    get the possible recognition strings, they will be tried one by one until
    a valid WebElement is got.
    
    Specified by:
    
    getPossibleRecognitionStrings in interface IRefreshable
  - setPossibleRecognitionStrings
```
public void setPossibleRecognitionStrings(java.lang.String[] possibleRecognitionStrings)
```
  - refresh
```
public boolean refresh(boolean checkStale)
```
    Refresh the webelement by its 'ID' or 'CSS CLASS' or preset 'Recognition Strings'.
    And update the value of fields according to the refreshed-WebElement
    
    Specified by:
    
    refresh in interface IRefreshable
    
    Parameters:
    
    checkStale - boolean, whether to check if the webelement is stable before refresh. true, check stable; false, force refresh directly without check.
    
    Returns:
    
    boolean, true if the refresh succeed.

Class DefaultRefreshable

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

object

map

webelement

tagName

id

cssClass

searchContext

possibleRecognitionStrings

Constructor Detail

DefaultRefreshable

DefaultRefreshable

Method Detail

initialize

updateFields

getAttribute

getWebElement

setWebElement

getEmbeddedObject

getMap

getTagName

setTagName

getId

setId

getCssClass

setCssClass

getSearchContext

setSearchContext

getPossibleRecognitionStrings

setPossibleRecognitionStrings

refresh