Element (SAFS API DOCUMENT)

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

All Implemented Interfaces:

IRefreshable

Direct Known Subclasses:

HierarchicalElement, Item
```
public class Element
extends DefaultRefreshable
```
It represents originally sap.ui.core.Element

Field Summary

Fields
Modifier and Type	Field and Description
`protected org.openqa.selenium.WebElement`	`clickableWebElement` clickableWebElement represents the WebElement that is clickable.
`protected boolean`	`disabled`
`protected java.lang.String`	`iconURL`
`protected java.lang.String`	`label` The property `label` is text that is shown on the component. If the text containing leading/ending spaces, then it will be trimmed and stored in this property.
`static java.lang.String`	`PROPERTY_CLASS` 'class' property returns the value of attribut 'class' of the specified DOM node.
`static java.lang.String`	`PROPERTY_DISABLED` 'disabled' if the element is disabled.
`static java.lang.String`	`PROPERTY_EXPANDED` 'expanded' if the element is expanded
`static java.lang.String`	`PROPERTY_ICON` 'icon' the url of icon, if the element contains an icon.
`static java.lang.String`	`PROPERTY_ID` 'id' used to find the element on the page
`static java.lang.String`	`PROPERTY_INDEX` 'index' the index of the element within its container ComboBox/ListBox etc.
`static java.lang.String`	`PROPERTY_LABEL` 'label' the text of the element shown on the page
`static java.lang.String`	`PROPERTY_SELECTABLE` 'selectable' if the element is selectable.
`static java.lang.String`	`PROPERTY_SELECTED` 'selected' if the element is selected.
`static java.lang.String`	`PROPERTY_TEXTCONTENT` 'textContent' property returns the textual content of the specified DOM node, and all its descendants.
`static java.lang.String`	`PROPERTY_VALUE` 'value' the value/key of the element, be transfered during submit
`static java.lang.String`	`PROPERTY_VISIBLE` 'visible' if the element is visible.
`protected boolean`	`selected`
`protected boolean`	`visible`

Fields inherited from class org.safs.selenium.webdriver.lib.model.DefaultRefreshable
cssClass, id, map, object, possibleRecognitionStrings, searchContext, tagName, webelement

Constructor Summary

Constructors
Modifier Constructor and Description

protected Element()

Element(java.lang.Object object)

Constructors
Modifier	Constructor and Description
`protected`	`Element()`
	`Element(java.lang.Object object)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected java.lang.String`	`_getLabel()` It is used to retrieve the text value shown on the web component from the embedded object.
`java.lang.String`	`contentValue()`
`boolean`	`equals(java.lang.Object node)`
`protected org.openqa.selenium.WebElement`	`getClickableWebElement()` This method tries to return a precise WebElement to click at.
`java.lang.String`	`getIconURL()`
`java.lang.String`	`getLabel()`
`boolean`	`isDisabled()`
`boolean`	`isSelected()`
`boolean`	`isVisible()`
`static java.lang.String`	`parseWebElementText(org.openqa.selenium.WebElement aWebElement)`
`void`	`setSelected(boolean selected)`
`java.lang.String`	`toString()`
`void`	`updateFields()` set/update the class's fields through the underlying WebElement or AbstractMap.

Methods inherited from class org.safs.selenium.webdriver.lib.model.DefaultRefreshable
getAttribute, getCssClass, getEmbeddedObject, getId, getMap, getPossibleRecognitionStrings, getSearchContext, getTagName, getWebElement, initialize, refresh, setCssClass, setId, setPossibleRecognitionStrings, setSearchContext, setTagName, setWebElement

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

- Field Detail
  - PROPERTY_ID
```
public static final java.lang.String PROPERTY_ID
```
    'id' used to find the element on the page
    
    See Also:
    
    Constant Field Values
  - PROPERTY_LABEL
```
public static final java.lang.String PROPERTY_LABEL
```
    'label' the text of the element shown on the page
    
    See Also:
    
    Constant Field Values
  - PROPERTY_VALUE
```
public static final java.lang.String PROPERTY_VALUE
```
    'value' the value/key of the element, be transfered during submit
    
    See Also:
    
    Constant Field Values
  - PROPERTY_INDEX
```
public static final java.lang.String PROPERTY_INDEX
```
    'index' the index of the element within its container ComboBox/ListBox etc.
    
    See Also:
    
    Constant Field Values
  - PROPERTY_SELECTED
```
public static final java.lang.String PROPERTY_SELECTED
```
    'selected' if the element is selected.
    
    See Also:
    
    Constant Field Values
  - PROPERTY_DISABLED
```
public static final java.lang.String PROPERTY_DISABLED
```
    'disabled' if the element is disabled.
    
    See Also:
    
    Constant Field Values
  - PROPERTY_EXPANDED
```
public static final java.lang.String PROPERTY_EXPANDED
```
    'expanded' if the element is expanded
    
    See Also:
    
    Constant Field Values
  - PROPERTY_SELECTABLE
```
public static final java.lang.String PROPERTY_SELECTABLE
```
    'selectable' if the element is selectable.
    
    See Also:
    
    Constant Field Values
  - PROPERTY_ICON
```
public static final java.lang.String PROPERTY_ICON
```
    'icon' the url of icon, if the element contains an icon.
    
    See Also:
    
    Constant Field Values
  - PROPERTY_TEXTCONTENT
```
public static final java.lang.String PROPERTY_TEXTCONTENT
```
    'textContent' property returns the textual content of the specified DOM node, and all its descendants.
    
    See Also:
    
    Constant Field Values
  - PROPERTY_CLASS
```
public static final java.lang.String PROPERTY_CLASS
```
    'class' property returns the value of attribut 'class' of the specified DOM node.
    
    See Also:
    
    Constant Field Values
  - PROPERTY_VISIBLE
```
public static final java.lang.String PROPERTY_VISIBLE
```
    'visible' if the element is visible.
    
    See Also:
    
    Constant Field Values
  - clickableWebElement
```
protected org.openqa.selenium.WebElement clickableWebElement
```
    clickableWebElement represents the WebElement that is clickable. It may be different than webelement, which contain the element's properties.
  - label
```
protected java.lang.String label
```
    The property label is text that is shown on the component.
    If the text containing leading/ending spaces, then it will be trimmed and stored in this property.
  - iconURL
```
protected java.lang.String iconURL
```
  - disabled
```
protected boolean disabled
```
  - selected
```
protected boolean selected
```
  - visible
```
protected boolean visible
```
- Constructor Detail
  - Element
```
protected Element()
```
  - Element
```
public Element(java.lang.Object object)
```
- Method Detail
  - updateFields
```
public void updateFields()
```
    set/update the class's fields through the underlying WebElement or AbstractMap.
    
    Overrides:
    
    updateFields in class DefaultRefreshable
    
    See Also:
    
    DefaultRefreshable.refresh(boolean)
  - _getLabel
```
protected java.lang.String _getLabel()
```
    It is used to retrieve the text value shown on the web component from the embedded object.
  - parseWebElementText
```
public static java.lang.String parseWebElementText(org.openqa.selenium.WebElement aWebElement)
```
  - getClickableWebElement
```
protected org.openqa.selenium.WebElement getClickableWebElement()
```
    This method tries to return a precise WebElement to click at. Sometimes the WebElement
    containning the informations about 'label', 'disabled', 'selected' etc. may not be suitable
    for clicking, it may occupy a larger area on screen and we need to adjust this method to get
    an appropriate WebElement occupying correct area for clicking.
    Refer to HierarchicalElement.getClickableWebElement() for a detail implementation.
    NOTE:If you need to verify the status of this Element, please call DefaultRefreshable.getWebElement() instead.
    For example:
    For some implementations of tree, the tree node is implemented by <li>, but this tag
    may very probably contain some child-nodes, in this case the area returned by Selenium for
    this tree node will be larger than it looks like, the area will include all its children.
    But for clicking, we will click the center of the tree node (area returned by Selenium), so it
    the center of that larger area that we click(not the center of the tree node itself), it's wrong!
    
    Parameters:
    
    webelement - Element, the element to get WebElement
    
    Returns:
    
    WebElement
    
    See Also:
    
    HierarchicalElement.getClickableWebElement()
  - getIconURL
```
public java.lang.String getIconURL()
```
  - getLabel
```
public java.lang.String getLabel()
```
  - isDisabled
```
public boolean isDisabled()
```
  - setSelected
```
public void setSelected(boolean selected)
```
  - isSelected
```
public boolean isSelected()
```
    Returns:
    
    boolean if the element is selected.
  - isVisible
```
public boolean isVisible()
```
    Returns:
    
    boolean if the element is visible.
  - contentValue
```
public java.lang.String contentValue()
```
    Returns:
    
    String, the content of this Element (the value of label).
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - equals
```
public boolean equals(java.lang.Object node)
```
    Overrides:
    
    equals in class java.lang.Object

Class Element

Field Summary

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

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Field Detail

PROPERTY_ID

PROPERTY_LABEL

PROPERTY_VALUE

PROPERTY_INDEX

PROPERTY_SELECTED

PROPERTY_DISABLED

PROPERTY_EXPANDED

PROPERTY_SELECTABLE

PROPERTY_ICON

PROPERTY_TEXTCONTENT

PROPERTY_CLASS

PROPERTY_VISIBLE

clickableWebElement

label

iconURL

disabled

selected

visible

Constructor Detail

Element

Element

Method Detail

updateFields

_getLabel

parseWebElementText

getClickableWebElement

getIconURL

getLabel

isDisabled

setSelected

isSelected

isVisible

contentValue

toString

equals