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

Interface DOMDocument

All Superinterfaces:

DOMEventTarget, DOMNode, DOMNodeSelector

public interface DOMDocument
extends DOMNode, DOMNodeSelector

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

Author:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	DOMDocument.CRITERIA

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

DOMNode.Type

Method Summary

Modifier and Type	Method and Description
DOMElement	createElement(String tagName) Creates an element of the type specified belonging to this document http://www.w3.org/TR/2000/REC-DOM-Level-2-Core-20001113/core.html#ID- 1334481328
DOMRange	createRange(DOMNode startNode, int startOffset, DOMNode endNode, int endOffSet)
DOMElement	elementByPosition(int x, int y) Returns the element from the document whose elementFromPoint method is being called which is the topmost element which lies under the given point.
Dimension	getDimension() Get the current computed dimension for this document
DOMElement	getDocumentElement() Returns the document element
DOMElement	getElementById(String id) Retrieves an element by id
DOMNodeList	getElementsByName(String name) Retrieves the list of elements by name
DOMNodeList	getElementsByTagName(String tagName) Retrieves the list of elements by tagName
DOMWindow	getEnclosingWindow() Returns the DOMWindow object associated with the document or null if none available.
DOMElement	selectElementBy(DOMDocument.CRITERIA critera, String expr) Retrieves an element by CRITERIA.

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

selectElementBy

DOMElement selectElementBy(DOMDocument.CRITERIA critera,
                           String expr)

Retrieves an element by CRITERIA. Note that the expression must select an DOM element. If it selects a DOM node (e.g., by xpath) a runtime exception is raised. For DOMDocument.CRITERIA.xy the expression expected is in the form X:Y (e.g., 200:400), that specifies the point via coordinates, in CSS pixels, relative to the upper-left-most point in the window or frame containing the document. If the expression selects a list of elements, the first is returned.

Parameters:

critera - the type of query to execute

expr - the expression

Returns:

the retrieved DOMElement or null if not found.

getDocumentElement

DOMElement getDocumentElement()

Returns the document element

Returns:

the document element

getElementsByName

DOMNodeList getElementsByName(String name)

Retrieves the list of elements by name

Parameters:

name -

Returns:

the list of elements by name

getElementById

DOMElement getElementById(String id)

Retrieves an element by id

Parameters:

id -

Returns:

an element by id

getElementsByTagName

DOMNodeList getElementsByTagName(String tagName)

Retrieves the list of elements by tagName

Parameters:

tagName -

Returns:

the list of elements by tagName

elementByPosition

DOMElement elementByPosition(int x,
                             int y)

Returns the element from the document whose elementFromPoint method is being called which is the topmost element which lies under the given point. To get an element, specify the point via coordinates, in CSS pixels, relative to the upper-left-most point in the window or frame containing the document.

Parameters:

x -

y -

Returns:

the element in position x,y , or null if

getEnclosingWindow

DOMWindow getEnclosingWindow()

Returns the DOMWindow object associated with the document or null if none available. from https://developer.mozilla.org/en/DOM/document.defaultView

Returns:

the DOMWindow object associated with the document or null if none available.

createElement

DOMElement createElement(String tagName)

Creates an element of the type specified belonging to this document http://www.w3.org/TR/2000/REC-DOM-Level-2-Core-20001113/core.html#ID- 1334481328

Parameters:

tagName -

Returns:

the created element

createRange

DOMRange createRange(DOMNode startNode,
                     int startOffset,
                     DOMNode endNode,
                     int endOffSet)

Returns:

getDimension

Dimension getDimension()

Get the current computed dimension for this document

Returns:

the current computed dimension for this document