HtmlUnitWebElement

java.lang.Object
- org.openqa.selenium.htmlunit.HtmlUnitWebElement

All Implemented Interfaces:: FindsByCssSelector, FindsById, FindsByLinkText, FindsByTagName, FindsByXPath, Locatable, WrapsDriver, SearchContext, TakesScreenshot, WebElement

public class HtmlUnitWebElement
extends java.lang.Object
implements WrapsDriver, FindsById, FindsByLinkText, FindsByXPath, FindsByTagName, FindsByCssSelector, Locatable, WebElement

Field Summary

Fields
Modifier and Type Field and Description

protected com.gargoylesoftware.htmlunit.html.DomElement element

protected HtmlUnitDriver parent

Fields
Modifier and Type	Field and Description
`protected com.gargoylesoftware.htmlunit.html.DomElement`	`element`
`protected HtmlUnitDriver`	`parent`

Constructor Summary

Constructors
Constructor and Description

HtmlUnitWebElement(HtmlUnitDriver parent, com.gargoylesoftware.htmlunit.html.DomElement element)

Constructors
Constructor and Description
`HtmlUnitWebElement(HtmlUnitDriver parent, com.gargoylesoftware.htmlunit.html.DomElement element)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`assertElementNotStale()`
`void`	`clear()` If this element is a text entry element, this will clear the value.
`void`	`click()` Click this element.
`boolean`	`equals(java.lang.Object obj)`
`WebElement`	`findElement(By by)` Find the first `WebElement` using the given method.
`WebElement`	`findElementByCssSelector(java.lang.String using)`
`WebElement`	`findElementById(java.lang.String id)`
`WebElement`	`findElementByLinkText(java.lang.String linkText)`
`WebElement`	`findElementByPartialLinkText(java.lang.String linkText)`
`WebElement`	`findElementByTagName(java.lang.String name)`
`WebElement`	`findElementByXPath(java.lang.String xpathExpr)`
`java.util.List<WebElement>`	`findElements(By by)` Find all elements within the current context using the given mechanism.
`java.util.List<WebElement>`	`findElementsByCssSelector(java.lang.String using)`
`java.util.List<WebElement>`	`findElementsById(java.lang.String id)`
`java.util.List<WebElement>`	`findElementsByLinkText(java.lang.String linkText)`
`java.util.List<WebElement>`	`findElementsByPartialLinkText(java.lang.String linkText)`
`java.util.List<WebElement>`	`findElementsByTagName(java.lang.String name)`
`java.util.List<WebElement>`	`findElementsByXPath(java.lang.String xpathExpr)`
`java.lang.String`	`getAttribute(java.lang.String name)` Get the value of a the given attribute of the element.
`Coordinates`	`getCoordinates()`
`java.lang.String`	`getCssValue(java.lang.String propertyName)` Get the value of a given CSS property.
`protected com.gargoylesoftware.htmlunit.html.DomElement`	`getElement()`
`java.util.List<WebElement>`	`getElementsByTagName(java.lang.String tagName)`
`Point`	`getLocation()` Where on the page is the top left-hand corner of the rendered element?
`protected HtmlUnitDriver`	`getParent()`
`Rectangle`	`getRect()`
`<X> X`	`getScreenshotAs(OutputType<X> outputType)` Capture the screenshot and store it in the specified location.
`Dimension`	`getSize()` What is the width and height of the rendered element?
`java.lang.String`	`getTagName()` Get the tag name of this element.
`java.lang.String`	`getText()` Get the visible (i.e.
`WebDriver`	`getWrappedDriver()`
`int`	`hashCode()`
`boolean`	`isDisplayed()` Is this element displayed or not? This method avoids the problem of having to parse an element's "style" attribute.
`boolean`	`isEnabled()` Is the element currently enabled or not? This will generally return true for everything but disabled input elements.
`boolean`	`isSelected()` Determine whether or not this element is selected or not.
`void`	`sendKeys(java.lang.CharSequence... value)` Use this method to simulate typing into an element, which may set its value.
`void`	`submit()` If this current element is a form, or an element within a form, then this will be submitted to the remote server.
`java.lang.String`	`toString()`

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

- Field Detail
  - parent
```
protected final HtmlUnitDriver parent
```
  - element
```
protected final com.gargoylesoftware.htmlunit.html.DomElement element
```
- Constructor Detail
  - HtmlUnitWebElement
```
public HtmlUnitWebElement(HtmlUnitDriver parent,
                          com.gargoylesoftware.htmlunit.html.DomElement element)
```
- Method Detail
  - click
```
public void click()
```
    Description copied from interface: WebElement
    
    Click this element. If this causes a new page to load, you should discard all references to this element and any further operations performed on this element will throw a StaleElementReferenceException. Note that if click() is done by sending a native event (which is the default on most browsers/platforms) then the method will _not_ wait for the next page to load and the caller should verify that themselves. There are some preconditions for an element to be clicked. The element must be visible and it must have a height and width greater then 0.
    
    Specified by:
    
    click in interface WebElement
  - submit
```
public void submit()
```
    Description copied from interface: WebElement
    
    If this current element is a form, or an element within a form, then this will be submitted to the remote server. If this causes the current page to change, then this method will block until the new page is loaded.
    
    Specified by:
    
    submit in interface WebElement
  - clear
```
public void clear()
```
    Description copied from interface: WebElement
    
    If this element is a text entry element, this will clear the value. Has no effect on other elements. Text entry elements are INPUT and TEXTAREA elements. Note that the events fired by this event may not be as you'd expect. In particular, we don't fire any keyboard or mouse events. If you want to ensure keyboard events are fired, consider using something like WebElement.sendKeys(CharSequence...) with the backspace key. To ensure you get a change event, consider following with a call to WebElement.sendKeys(CharSequence...) with the tab key.
    
    Specified by:
    
    clear in interface WebElement
  - sendKeys
```
public void sendKeys(java.lang.CharSequence... value)
```
    Description copied from interface: WebElement
    
    Use this method to simulate typing into an element, which may set its value.
    
    Specified by:
    
    sendKeys in interface WebElement
    
    Parameters:
    
    value - character sequence to send to the element
  - getTagName
```
public java.lang.String getTagName()
```
    Description copied from interface: WebElement
    
    Get the tag name of this element. Not the value of the name attribute: will return "input" for the element <input name="foo" />.
    
    Specified by:
    
    getTagName in interface WebElement
    
    Returns:
    
    The tag name of this element.
  - getAttribute
```
public java.lang.String getAttribute(java.lang.String name)
```
    Description copied from interface: WebElement
    Get the value of a the given attribute of the element. Will return the current value, even if this has been modified after the page has been loaded. More exactly, this method will return the value of the given attribute, unless that attribute is not present, in which case the value of the property with the same name is returned (for example for the "value" property of a textarea element). If neither value is set, null is returned. The "style" attribute is converted as best can be to a text representation with a trailing semi-colon. The following are deemed to be "boolean" attributes, and will return either "true" or null: async, autofocus, autoplay, checked, compact, complete, controls, declare, defaultchecked, defaultselected, defer, disabled, draggable, ended, formnovalidate, hidden, indeterminate, iscontenteditable, ismap, itemscope, loop, multiple, muted, nohref, noresize, noshade, novalidate, nowrap, open, paused, pubdate, readonly, required, reversed, scoped, seamless, seeking, selected, spellcheck, truespeed, willvalidate Finally, the following commonly mis-capitalized attribute/property names are evaluated as expected:
    - "class"
    - "readonly"
    Specified by:
    
    getAttribute in interface WebElement
    
    Parameters:
    
    name - The name of the attribute.
    
    Returns:
    
    The attribute/property's current value or null if the value is not set.
  - isSelected
```
public boolean isSelected()
```
    Description copied from interface: WebElement
    
    Determine whether or not this element is selected or not. This operation only applies to input elements such as checkboxes, options in a select and radio buttons.
    
    Specified by:
    
    isSelected in interface WebElement
    
    Returns:
    
    True if the element is currently selected or checked, false otherwise.
  - isEnabled
```
public boolean isEnabled()
```
    Description copied from interface: WebElement
    
    Is the element currently enabled or not? This will generally return true for everything but disabled input elements.
    
    Specified by:
    
    isEnabled in interface WebElement
    
    Returns:
    
    True if the element is enabled, false otherwise.
  - isDisplayed
```
public boolean isDisplayed()
```
    Description copied from interface: WebElement
    
    Is this element displayed or not? This method avoids the problem of having to parse an element's "style" attribute.
    
    Specified by:
    
    isDisplayed in interface WebElement
    
    Returns:
    
    Whether or not the element is displayed
  - getLocation
```
public Point getLocation()
```
    Description copied from interface: WebElement
    
    Where on the page is the top left-hand corner of the rendered element?
    
    Specified by:
    
    getLocation in interface WebElement
    
    Returns:
    
    A point, containing the location of the top left-hand corner of the element
  - getSize
```
public Dimension getSize()
```
    Description copied from interface: WebElement
    
    What is the width and height of the rendered element?
    
    Specified by:
    
    getSize in interface WebElement
    
    Returns:
    
    The size of the element on the page.
  - getRect
```
public Rectangle getRect()
```
    Specified by:
    
    getRect in interface WebElement
    
    Returns:
    
    The location and size of the rendered element
  - getText
```
public java.lang.String getText()
```
    Description copied from interface: WebElement
    
    Get the visible (i.e. not hidden by CSS) innerText of this element, including sub-elements, without any leading or trailing whitespace.
    
    Specified by:
    
    getText in interface WebElement
    
    Returns:
    
    The innerText of this element.
  - getParent
```
protected HtmlUnitDriver getParent()
```
  - getElement
```
protected com.gargoylesoftware.htmlunit.html.DomElement getElement()
```
  - getElementsByTagName
```
public java.util.List<WebElement> getElementsByTagName(java.lang.String tagName)
```
  - findElement
```
public WebElement findElement(By by)
```
    Description copied from interface: WebElement
    
    Find the first WebElement using the given method. See the note in WebElement.findElements(By) about finding via XPath. This method is affected by the 'implicit wait' times in force at the time of execution. The findElement(..) invocation will return a matching row, or try again repeatedly until the configured timeout is reached. findElement should not be used to look for non-present elements, use WebElement.findElements(By) and assert zero length response instead.
    
    Specified by:
    
    findElement in interface SearchContext
    
    Specified by:
    
    findElement in interface WebElement
    
    Parameters:
    
    by - The locating mechanism
    
    Returns:
    
    The first matching element on the current context.
    
    See Also:
    
    By, WebDriver.Timeouts
  - findElements
```
public java.util.List<WebElement> findElements(By by)
```
    Description copied from interface: WebElement
    
    Find all elements within the current context using the given mechanism. When using xpath be aware that webdriver follows standard conventions: a search prefixed with "//" will search the entire document, not just the children of this current node. Use ".//" to limit your search to the children of this WebElement. This method is affected by the 'implicit wait' times in force at the time of execution. When implicitly waiting, this method will return as soon as there are more than 0 items in the found collection, or will return an empty list if the timeout is reached.
    
    Specified by:
    
    findElements in interface SearchContext
    
    Specified by:
    
    findElements in interface WebElement
    
    Parameters:
    
    by - The locating mechanism to use
    
    Returns:
    
    A list of all WebElements, or an empty list if nothing matches.
    
    See Also:
    
    By, WebDriver.Timeouts
  - findElementById
```
public WebElement findElementById(java.lang.String id)
```
    Specified by:
    
    findElementById in interface FindsById
  - findElementsById
```
public java.util.List<WebElement> findElementsById(java.lang.String id)
```
    Specified by:
    
    findElementsById in interface FindsById
  - findElementsByCssSelector
```
public java.util.List<WebElement> findElementsByCssSelector(java.lang.String using)
```
    Specified by:
    
    findElementsByCssSelector in interface FindsByCssSelector
  - findElementByCssSelector
```
public WebElement findElementByCssSelector(java.lang.String using)
```
    Specified by:
    
    findElementByCssSelector in interface FindsByCssSelector
  - findElementByXPath
```
public WebElement findElementByXPath(java.lang.String xpathExpr)
```
    Specified by:
    
    findElementByXPath in interface FindsByXPath
  - findElementsByXPath
```
public java.util.List<WebElement> findElementsByXPath(java.lang.String xpathExpr)
```
    Specified by:
    
    findElementsByXPath in interface FindsByXPath
  - findElementByLinkText
```
public WebElement findElementByLinkText(java.lang.String linkText)
```
    Specified by:
    
    findElementByLinkText in interface FindsByLinkText
  - findElementsByLinkText
```
public java.util.List<WebElement> findElementsByLinkText(java.lang.String linkText)
```
    Specified by:
    
    findElementsByLinkText in interface FindsByLinkText
  - findElementByPartialLinkText
```
public WebElement findElementByPartialLinkText(java.lang.String linkText)
```
    Specified by:
    
    findElementByPartialLinkText in interface FindsByLinkText
  - findElementsByPartialLinkText
```
public java.util.List<WebElement> findElementsByPartialLinkText(java.lang.String linkText)
```
    Specified by:
    
    findElementsByPartialLinkText in interface FindsByLinkText
  - findElementByTagName
```
public WebElement findElementByTagName(java.lang.String name)
```
    Specified by:
    
    findElementByTagName in interface FindsByTagName
  - findElementsByTagName
```
public java.util.List<WebElement> findElementsByTagName(java.lang.String name)
```
    Specified by:
    
    findElementsByTagName in interface FindsByTagName
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - assertElementNotStale
```
protected void assertElementNotStale()
```
  - getCssValue
```
public java.lang.String getCssValue(java.lang.String propertyName)
```
    Description copied from interface: WebElement
    
    Get the value of a given CSS property. Color values should be returned as rgba strings, so, for example if the "background-color" property is set as "green" in the HTML source, the returned value will be "rgba(0, 255, 0, 1)". Note that shorthand CSS properties (e.g. background, font, border, border-top, margin, margin-top, padding, padding-top, list-style, outline, pause, cue) are not returned, in accordance with the DOM CSS2 specification - you should directly access the longhand properties (e.g. background-color) to access the desired values.
    
    Specified by:
    
    getCssValue in interface WebElement
    
    Parameters:
    
    propertyName - the css property name of the element
    
    Returns:
    
    The current, computed value of the property.
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Overrides:
    
    equals in class java.lang.Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - getWrappedDriver
```
public WebDriver getWrappedDriver()
```
    Specified by:
    
    getWrappedDriver in interface WrapsDriver
    
    Returns:
    
    The driver that contains this element.
  - getCoordinates
```
public Coordinates getCoordinates()
```
    Specified by:
    
    getCoordinates in interface Locatable
  - getScreenshotAs
```
public <X> X getScreenshotAs(OutputType<X> outputType)
                      throws WebDriverException
```
    Description copied from interface: TakesScreenshot
    Capture the screenshot and store it in the specified location.
    For WebDriver extending TakesScreenshot, this makes a best effort depending on the browser to return the following in order of preference:
    - Entire page
    - Current window
    - Visible portion of the current frame
    - The screenshot of the entire display containing the browser
    For WebElement extending TakesScreenshot, this makes a best effort depending on the browser to return the following in order of preference: - The entire content of the HTML element - The visisble portion of the HTML element
    Specified by:
    
    getScreenshotAs in interface TakesScreenshot
    
    Type Parameters:
    
    X - Return type for getScreenshotAs.
    
    Parameters:
    
    outputType - target type, @see OutputType
    
    Returns:
    
    Object in which is stored information about the screenshot.
    
    Throws:
    
    WebDriverException - on failure.

Class HtmlUnitWebElement

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

parent

element

Constructor Detail

HtmlUnitWebElement

Method Detail

click

submit

clear

sendKeys

getTagName

getAttribute

isSelected

isEnabled

isDisplayed

getLocation

getSize

getRect

getText

getParent

getElement

getElementsByTagName

findElement

findElements

findElementById

findElementsById

findElementsByCssSelector

findElementByCssSelector

findElementByXPath

findElementsByXPath

findElementByLinkText

findElementsByLinkText

findElementByPartialLinkText

findElementsByPartialLinkText

findElementByTagName

findElementsByTagName

toString

assertElementNotStale

getCssValue

equals

hashCode

getWrappedDriver

getCoordinates

getScreenshotAs