HtmlElement (selenium tests framework 2.0 API)

java.lang.Object
- com.seleniumtests.webelements.HtmlElement

Direct Known Subclasses:

ButtonElement, CheckBoxElement, ImageElement, LabelElement, LinkElement, RadioButtonElement, SelectList, Table, TextFieldElement
```
public class HtmlElement
extends Object
```
Provides methods to interact with a web page. All HTML element (ButtonElement, LinkElement, TextFieldElement, etc.) extends from this class.

Field Summary

Fields
Modifier and Type	Field and Description
`protected org.openqa.selenium.WebDriver`	`driver`
`protected org.openqa.selenium.WebElement`	`element`
`protected static org.apache.log4j.Logger`	`logger`
`protected WebUIDriver`	`webUXDriver`

Constructor Summary

Constructors
Constructor and Description
`HtmlElement(String label, org.openqa.selenium.By by)` Find element using BY locator.
`HtmlElement(String label, String locator, com.seleniumtests.webelements.HtmlElement.LocatorType locatorType)` This constructor locates the element using locator and locator type.

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`captureSnapshot()` Captures snapshot of the current browser window.
`protected void`	`captureSnapshot(String messagePrefix)` Captures snapshot of the current browser window, and prefix the file name with the assigned string.
`void`	`click()`
`void`	`clickAt()` Click element in native way by Actions.
`void`	`clickAt(String value)` Click element in native way by Actions.
`protected void`	`findElement()` Finds the element using By type.
`void`	`fireEvent(String eventName)` Fires a Javascript event on the underlying element.
`List<org.openqa.selenium.WebElement>`	`getAllElements()` Get all elements in the current page with same locator.
`String`	`getAttribute(String name)` Gets an attribute (using standard key-value pair) from the underlying attribute.
`org.openqa.selenium.By`	`getBy()` Returns the BY locator stored in the HtmlElement.
`String`	`getCssValue(String propertyName)` Returns the value for the specified CSS key.
`protected org.openqa.selenium.WebDriver`	`getDriver()` Get and refresh underlying WebDriver.
`org.openqa.selenium.WebElement`	`getElement()` Returns the underlying WebDriver WebElement.
`String`	`getEval(String script)` Executes the given JavaScript against the underlying WebElement.
`int`	`getHeight()` Returns the 'height' property of the underlying WebElement's Dimension.
`String`	`getLabel()` Returns the label used during initialization.
`org.openqa.selenium.Point`	`getLocation()` Gets the Point location of the underlying WebElement.
`String`	`getLocator()` Returns the locator used to find the underlying WebElement.
`org.openqa.selenium.Dimension`	`getSize()` Returns the Dimension property of the underlying WebElement.
`String`	`getTagName()` Returns the HTML Tag for the underlying WebElement (div, a, input, etc).
`String`	`getText()` Returns the text body of the underlying WebElement.
`String`	`getValue()` Returns the 'value' attribute of the underlying WebElement.
`int`	`getWidth()` Returns the 'width' property of the underlying WebElement's Dimension.
`void`	`init()` Refreshes the WebUIDriver before locating the element, to ensure we have the current version (useful for when the state of an element has changed via an AJAX or non-page-turn action).
`boolean`	`isDisplayed()` Indicates whether or not the web element is currently displayed in the browser.
`boolean`	`isElementPresent()` Searches for the element using the BY locator, and indicates whether or not it exists in the page.
`boolean`	`isEnabled()` Indicates whether or not the element is enabled in the browser.
`boolean`	`isSelected()` Indicates whether or not the element is selected in the browser.
`boolean`	`isTextPresent(String text)` Whether or not the indicated text is contained in the element's getText() attribute.
`void`	`mouseDown()` Forces a mouseDown event on the WebElement.
`void`	`mouseOver()` Forces a mouseOver event on the WebElement.
`void`	`mouseUp()` Forces a mouseUp event on the WebElement.
`void`	`sendKeys(CharSequence arg0)` Sends the indicated CharSequence to the WebElement.
`void`	`simulateClick()`
`void`	`simulateMouseOver()` Forces a mouseOver event on the WebElement using simulate by JavaScript way for some dynamic menu.
`void`	`simulateMoveToElement(int x, int y)`
`protected void`	`sleep(int waitTime)` Method, which should never be used.
`String`	`toHTML()` Converts the Type, Locator and LabelElement attributes of the HtmlElement into a readable and report-friendly string.
`String`	`toString()` Returns a friendly string, representing the HtmlElement's Type, LabelElement and Locator.
`void`	`waitForPresent()` Wait element to present using Explicit Waits with default EXPLICIT_WAIT_TIME_OUT = 15 seconds.
`void`	`waitForPresent(int timeout)` Wait element to present using Explicit Waits with timeout in seconds.

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

- Field Detail
  - logger
```
protected static final org.apache.log4j.Logger logger
```
  - driver
```
protected org.openqa.selenium.WebDriver driver
```
  - webUXDriver
```
protected WebUIDriver webUXDriver
```
  - element
```
protected org.openqa.selenium.WebElement element
```
- Constructor Detail
  - HtmlElement
```
public HtmlElement(String label,
           org.openqa.selenium.By by)
```
    Find element using BY locator. Make sure to initialize the driver before calling findElement()
    
    Parameters:
    label - - element name for logging
    by - - By type
  - HtmlElement
```
public HtmlElement(String label,
           String locator,
           com.seleniumtests.webelements.HtmlElement.LocatorType locatorType)
```
    This constructor locates the element using locator and locator type.
    
    Parameters:
    label -
    locator - - locator
- Method Detail
  - captureSnapshot
```
public void captureSnapshot()
```
    Captures snapshot of the current browser window.
  - captureSnapshot
```
protected void captureSnapshot(String messagePrefix)
```
    Captures snapshot of the current browser window, and prefix the file name with the assigned string.
    
    Parameters:
    messagePrefix -
  - click
```
public void click()
```
  - clickAt
```
public void clickAt()
```
    Click element in native way by Actions.
  - clickAt
```
public void clickAt(String value)
```
    Click element in native way by Actions.
```
       clickAt("1, 1");
 
```
    Parameters:
    value -
  - simulateClick
```
public void simulateClick()
```
  - simulateMoveToElement
```
public void simulateMoveToElement(int x,
                         int y)
```
  - findElement
```
protected void findElement()
```
    Finds the element using By type. Implicit Waits is built in createWebDriver() in WebUIDriver to handle dynamic element problem. This method is invoked before all the basic operations like click, sendKeys, getText, etc. Use waitForPresent to use Explicit Waits to deal with special element which needs long time to present.
  - fireEvent
```
public void fireEvent(String eventName)
```
    Fires a Javascript event on the underlying element.
    
    Parameters:
    eventName -
  - getAllElements
```
public List<org.openqa.selenium.WebElement> getAllElements()
```
    Get all elements in the current page with same locator.
    
    Returns:
  - getAttribute
```
public String getAttribute(String name)
```
    Gets an attribute (using standard key-value pair) from the underlying attribute.
    
    Parameters:
    name -
    
    Returns:
  - getBy
```
public org.openqa.selenium.By getBy()
```
    Returns the BY locator stored in the HtmlElement.
    
    Returns:
  - getCssValue
```
public String getCssValue(String propertyName)
```
    Returns the value for the specified CSS key.
    
    Parameters:
    propertyName -
    
    Returns:
  - getDriver
```
protected org.openqa.selenium.WebDriver getDriver()
```
    Get and refresh underlying WebDriver.
  - getElement
```
public org.openqa.selenium.WebElement getElement()
```
    Returns the underlying WebDriver WebElement.
    
    Returns:
  - getEval
```
public String getEval(String script)
```
    Executes the given JavaScript against the underlying WebElement.
    
    Parameters:
    script -
    
    Returns:
  - getHeight
```
public int getHeight()
```
    Returns the 'height' property of the underlying WebElement's Dimension.
    
    Returns:
  - getLabel
```
public String getLabel()
```
    Returns the label used during initialization.
    
    Returns:
  - getLocation
```
public org.openqa.selenium.Point getLocation()
```
    Gets the Point location of the underlying WebElement.
    
    Returns:
  - getLocator
```
public String getLocator()
```
    Returns the locator used to find the underlying WebElement.
    
    Returns:
  - getSize
```
public org.openqa.selenium.Dimension getSize()
```
    Returns the Dimension property of the underlying WebElement.
    
    Returns:
  - getTagName
```
public String getTagName()
```
    Returns the HTML Tag for the underlying WebElement (div, a, input, etc).
    
    Returns:
  - getText
```
public String getText()
```
    Returns the text body of the underlying WebElement.
    
    Returns:
  - getValue
```
public String getValue()
```
    Returns the 'value' attribute of the underlying WebElement.
    
    Returns:
  - getWidth
```
public int getWidth()
```
    Returns the 'width' property of the underlying WebElement's Dimension.
    
    Returns:
  - init
```
public void init()
```
    Refreshes the WebUIDriver before locating the element, to ensure we have the current version (useful for when the state of an element has changed via an AJAX or non-page-turn action).
  - isDisplayed
```
public boolean isDisplayed()
```
    Indicates whether or not the web element is currently displayed in the browser.
    
    Returns:
  - isElementPresent
```
public boolean isElementPresent()
```
    Searches for the element using the BY locator, and indicates whether or not it exists in the page. This can be used to look for hidden objects, whereas isDisplayed() only looks for things that are visible to the user
    
    Returns:
  - isEnabled
```
public boolean isEnabled()
```
    Indicates whether or not the element is enabled in the browser.
    
    Returns:
  - isSelected
```
public boolean isSelected()
```
    Indicates whether or not the element is selected in the browser.
    
    Returns:
  - isTextPresent
```
public boolean isTextPresent(String text)
```
    Whether or not the indicated text is contained in the element's getText() attribute.
    
    Parameters:
    text -
    
    Returns:
  - mouseDown
```
public void mouseDown()
```
    Forces a mouseDown event on the WebElement.
  - mouseOver
```
public void mouseOver()
```
    Forces a mouseOver event on the WebElement.
  - simulateMouseOver
```
public void simulateMouseOver()
```
    Forces a mouseOver event on the WebElement using simulate by JavaScript way for some dynamic menu.
  - mouseUp
```
public void mouseUp()
```
    Forces a mouseUp event on the WebElement.
  - sendKeys
```
public void sendKeys(CharSequence arg0)
```
    Sends the indicated CharSequence to the WebElement.
    
    Parameters:
    arg0 -
  - sleep
```
protected void sleep(int waitTime)
              throws InterruptedException
```
    Method, which should never be used.
    
    Throws:
    
    InterruptedException
  - toHTML
```
public String toHTML()
```
    Converts the Type, Locator and LabelElement attributes of the HtmlElement into a readable and report-friendly string.
    
    Returns:
  - toString
```
public String toString()
```
    Returns a friendly string, representing the HtmlElement's Type, LabelElement and Locator.
    
    Overrides:
    
    toString in class Object
  - waitForPresent
```
public void waitForPresent()
```
    Wait element to present using Explicit Waits with default EXPLICIT_WAIT_TIME_OUT = 15 seconds.
  - waitForPresent
```
public void waitForPresent(int timeout)
```
    Wait element to present using Explicit Waits with timeout in seconds. This method is used for special element which needs long time to present.

Class HtmlElement

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

logger

driver

webUXDriver

element

Constructor Detail

HtmlElement

HtmlElement

Method Detail

captureSnapshot

captureSnapshot

click

clickAt

clickAt

simulateClick

simulateMoveToElement

findElement

fireEvent

getAllElements

getAttribute

getBy

getCssValue

getDriver

getElement

getEval

getHeight

getLabel

getLocation

getLocator

getSize

getTagName

getText

getValue

getWidth

init

isDisplayed

isElementPresent

isEnabled

isSelected

isTextPresent

mouseDown

mouseOver

simulateMouseOver

mouseUp

sendKeys

sleep

toHTML

toString

waitForPresent

waitForPresent