uk.ac.ox.cs.diadem.webapi.dom

Interface DOMElement

All Superinterfaces:

DOMEventTarget, DOMNode, DOMNodeSelector

All Known Subinterfaces:

DOmElementOnJS, DOMHTMLForm, DOMHTMLInputElement, DOMHTMLOptionElement, DOMHTMLSelect, DOMHTMLTextAreaElement, DOMTypeableElement

All Known Implementing Classes:

DOMElementDecorator

public interface DOMElement
extends DOMNode, DOMNodeSelector

Wrapping interface for http://www.w3.org/2003/01/dom2-javadoc/org/w3c/dom/Element.html

Author:

Giovanni Grasso (giovannigrasso@gmail.com) Oxford University, Department of Computer Science

Nested Class Summary

Nested classes/interfaces inherited from interface uk.ac.ox.cs.diadem.webapi.dom.DOMNode

DOMNode.Type

Method Summary

Modifier and Type	Method and Description
DOMWindow	click() Simulates a real mouse left click on an element.
boolean	click(boolean waitUntilLoaded) Simulates a real mouse left click on an element.
DOMWindow	fireFocusEvent(String event) Performs the specified focus/blur event (see DOMFocusEvent) on this element element and waits until the document at the new location (if any), is fully loaded.
DOMWindow	fireKeyboardEvent(String event, char printableChar) Performs the specified focus event (see DOMKeyboardEvent) on this element element and waits until the document at the new location (if any), is fully loaded.
DOMWindow	fireMouseEvent(String event) Performs only the specified mouse event (see DOMMouseEvent) on this element element and waits until the document at the new location (if any), is fully loaded.
DOMWindow	focus() Simulates a real focus event (also generates the blur on the current active element if any).
String	getAttribute(String name) Gets an attribute by name
DOMBoundingClientRect	getBoundingClientRect() Gets the DOMBoundingClientRect for the element, relative to the document, i.e., taking into account window scrolling
DOMCSSStyleDeclaration	getComputedStyle() Gets the computed style object
String	getInnerHTML() Inner html
List<DOMElement>	getNeighbourhood(int radius) Returns elements appearing whithin the radius of this target elements.
String	getOuterHTML()
HTMLUtil	htmlUtil() Returns an object that allows to cast down this element to HTML DOM specific implementations
boolean	isEnabled()
DOmElementOnJS	js()
DOMWindow	keypress(DOMKeyboardEvent.Key content)
DOMWindow	mouseover() Simulates a real mouseover event (mousemove and mouseover).
DOMWindow	moveToFrame() When the current DOMElement is either IFrame of Frame, this method navigates to the enclosed page if they have the proerty src set.
DOMWindow	moveToHREF() When the current DOMElement has the href property set, this method navigates to its specified URL.
CSSMutationObserver	observeCSSProperties(DOMCSS2Properties.CssProperty... properties) Puts the given css properties under observation, in particular compares the current state with the one at the moment CSSMutationObserver.takeRecords() is called
void	removeAttribute(String name) remove an attribute by name
DOMWindow	sendClick(float x, float y) Sends a click event on the given coordinates
void	setAttribute(String name, String value) set an attribute on the element.
DOMWindow	type(String content) Enter the given text of characters on the element (usually an input text).
DOMWindow	typeAndEnter(String content) As the method type(String content), it types the given text on the element (usually an input text) and then generates the "VK_RETURN" keypress event at the end.

Methods inherited from interface uk.ac.ox.cs.diadem.webapi.dom.DOMNode

appendChild, compareDocumentPosition, executeJavaScript, getAttributes, getBrowser, getChildNodes, getDOMProperty, getFirstChild, getLastChild, getLocalName, getNextSibling, getNodeName, getNodeType, getNodeValue, getOwnerDocument, getParentNode, getPreviousSibling, getTextContent, getXPathEvaluator, getXPathLocator, insertBefore, isDescendant, isEqualNode, isSameNode, isStale, isTextNode, isVisible, registerMutationObserver, registerMutationObserver, removeChild, replaceChild, setTextContent, toPrettyHTML, toPrettyString

Methods inherited from interface uk.ac.ox.cs.diadem.webapi.dom.event.DOMEventTarget

addEventListener, removeEventListener

Methods inherited from interface uk.ac.ox.cs.diadem.webapi.dom.DOMNodeSelector

querySelector, querySelectorAll

Method Detail

observeCSSProperties

CSSMutationObserver observeCSSProperties(DOMCSS2Properties.CssProperty... properties)

Puts the given css properties under observation, in particular compares the current state with the one at the moment CSSMutationObserver.takeRecords() is called

Parameters:

properties -

Returns:

a CSSMutationObserver as handle for the observed properties

getComputedStyle

DOMCSSStyleDeclaration getComputedStyle()

Gets the computed style object

Returns:

the computed style object

getBoundingClientRect

DOMBoundingClientRect getBoundingClientRect()

Gets the DOMBoundingClientRect for the element, relative to the document, i.e., taking into account window scrolling

Returns:

the DOMBoundingClientRect for the element

setAttribute

void setAttribute(String name,
                  String value)

set an attribute on the element.

Parameters:

name - attribute name

value - the value to set

removeAttribute

void removeAttribute(String name)

remove an attribute by name

Parameters:

name -

getAttribute

String getAttribute(String name)

Gets an attribute by name

Parameters:

name -

Returns:

the attribute or null if not found

click

boolean click(boolean waitUntilLoaded)

Simulates a real mouse left click on an element. It generates mousemove mousedown and mouseup. Also, proper focus and blur events are generatedexecuteJavaScript

Parameters:

waitUntilLoaded - if true, the method is performed synchronously and waits until the document at the new location (if any), is fully loaded.

Returns:

in case the method is performed synchronously, it returns true if a new url navigation has been triggered, false otherwise.

click

DOMWindow click()

Simulates a real mouse left click on an element. It generates mousemove mousedown and mouseup. Also, proper focus and blur events are generated It waits until the document at the new location (if any), is fully loaded. If the click triggers opening a new window, it is returned as result, otherwise the current winndow is returned

Returns:

If a new window has been opened due to the click, the new window is returned, otherwise the current window is returned (which may have a new location).

fireMouseEvent

DOMWindow fireMouseEvent(String event)

Performs only the specified mouse event (see DOMMouseEvent) on this element element and waits until the document at the new location (if any), is fully loaded. If the event triggers opening a new window, it is returned as result, otherwise the current window is returned. Note: this method won't generate related events, e.g., for click it won't simulate the correct sequence, but only the click event.

Parameters:

event - (see DOMMouseEvent)

Returns:

If a window has been opened due to the event, the new window is returned, otherwise the current window is returned (which may have a new location).

fireFocusEvent

DOMWindow fireFocusEvent(String event)

Performs the specified focus/blur event (see DOMFocusEvent) on this element element and waits until the document at the new location (if any), is fully loaded. If the event triggers opening a new window, it is returned as result, otherwise the current window is returned. To simulate the user focus action, use the method focus()

Parameters:

event - (see DOMFocusEvent)

Returns:

If a window has been opened due to the event, the new window is returned, otherwise the current window is returned (which may have a new location).

fireKeyboardEvent

DOMWindow fireKeyboardEvent(String event,
                            char printableChar)

Performs the specified focus event (see DOMKeyboardEvent) on this element element and waits until the document at the new location (if any), is fully loaded. If the event triggers opening a new window, it is returned as result, otherwise the current window is returned

Parameters:

event - (see DOMKeyboardEvent)

printableChar - the char related to the key event.

Returns:

If a window has been opened due to the event, the new window is returned, otherwise the current window is returned (which may have a new location).

type

DOMWindow type(String content)

Enter the given text of characters on the element (usually an input text). This simulates the sequence of acquiring the focus and generating keydown,keypress,keyup for each key of the content. It waits until the document at the new location (if any), is fully loaded. If the event triggers opening a new window, it is returned as result, otherwise the current window is returned

Parameters:

content - the text to enter

Returns:

If a window has been opened due to the event, the new window is returned, otherwise the current window is returned (which may have a new location).

typeAndEnter

DOMWindow typeAndEnter(String content)

As the method type(String content), it types the given text on the element (usually an input text) and then generates the "VK_RETURN" keypress event at the end. It waits until the document at the new location (if any), is fully loaded. If the event triggers opening a new window, it is returned as result, otherwise the current window is returned

Parameters:

content - the text to enter

Returns:

If a window has been opened due to the event, the new window is returned, otherwise the current window is returned (which may have a new location).

getInnerHTML

String getInnerHTML()

Inner html

Returns:

getOuterHTML

String getOuterHTML()

Returns:

htmlUtil

HTMLUtil htmlUtil()

Returns an object that allows to cast down this element to HTML DOM specific implementations

mouseover

DOMWindow mouseover()

Simulates a real mouseover event (mousemove and mouseover). It waits until the document at the new location (if any), is fully loaded. If the event triggers opening a new window, it is returned as result, otherwise the current window is returned

Returns:

If a window has been opened due to the event, the new window is returned, otherwise the current window is returned (which may have a new location).executeJavaScript

focus

DOMWindow focus()

Simulates a real focus event (also generates the blur on the current active element if any). It waits until the document at the new location (if any), is fully loaded. If the event triggers opening a new window, it is returned as result, otherwise the current window is returned

Returns:

If a window has been opened due to the event, the new window is returned, otherwise the current window is returned (which may have a new location).

isEnabled

boolean isEnabled()

sendClick

DOMWindow sendClick(float x,
                    float y)

Sends a click event on the given coordinates

Parameters:

x -

y -

Returns:

If a window has been opened due to theObject executeJavaScript(String script, Object... arg); event, the new window is returned, otherwise the current window is returned (which may have a new location).

keypress

DOMWindow keypress(DOMKeyboardEvent.Key content)

moveToFrame

DOMWindow moveToFrame()

When the current DOMElement is either IFrame of Frame, this method navigates to the enclosed page if they have the proerty src set. Throws a WebAPIRuntimeException if the element is not a IFrame or Frame, and if the src property is not defined

Returns:

moveToHREF

DOMWindow moveToHREF()

When the current DOMElement has the href property set, this method navigates to its specified URL. Throws a WebAPIRuntimeException if the href property is not defined for this node.

Returns:

js

DOmElementOnJS js()

getNeighbourhood

List<DOMElement> getNeighbourhood(int radius)

Returns elements appearing whithin the radius of this target elements. In particular, it returns elements in the following order: north,north-east,east,south-east,south,south-west,west,north-west

Parameters:

radius -

Returns:

a list of DOMElement in the oder: north,north-east,east,south-east,south,south-west,west,north-west