com.teamdev.jxbrowser.chromium.dom

Interface DOMDocument

All Superinterfaces:

SearchContext

public interface DOMDocument
extends SearchContext

Represents DOM HTML document of the web page.

Method Summary

Modifier and Type	Method and Description
DOMElement	createElement(java.lang.String tagName) Creates and returns a new DOM element with the specified tag name.
DOMEvent	createEvent(DOMEventType eventType, DOMEventParams params) Creates a new DOMEvent object with the given eventType and params.
DOMKeyEvent	createKeyEvent(DOMEventType eventType, DOMKeyEventParams params) Creates a new DOMKeyEvent object with the given eventType and params.
DOMMouseEvent	createMouseEvent(DOMEventType eventType, DOMMouseEventParams params) Creates a new DOMMouseEvent object with the given eventType and params.
DOMNode	createTextNode() Creates and returns a new Text DOM node with DOMNodeType.TextNode type.
DOMNode	createTextNode(java.lang.String text) Returns a new Text DOM node with DOMNodeType.TextNode type.
DOMUIEvent	createUIEvent(DOMEventType eventType, DOMUIEventParams params) Creates a new DOMUIEvent object with the given eventType and params.
java.lang.String	getBaseURI() Returns the absolute base URL of the document
DOMElement	getDocumentElement() Returns the document HTML element that usually represents HTML tag.

Methods inherited from interface com.teamdev.jxbrowser.chromium.dom.SearchContext

evaluate, evaluate, findElement, findElements

Method Detail

getDocumentElement

DOMElement getDocumentElement()

Returns the document HTML element that usually represents HTML tag. This method can return null if document element is not available (e.g. the web page of this document was disposed).

Returns:

the document HTML element that usually represents HTML tag or null if document element is not available.

createElement

DOMElement createElement(java.lang.String tagName)

Creates and returns a new DOM element with the specified tag name.

Parameters:

tagName - the tag name (e.g. "A", "P", "DIV") of the new DOM element.

Returns:

the new DOMElement or null if tagName is wrong.

Throws:

java.lang.IllegalArgumentException - when tagName parameter is empty or null.

createTextNode

DOMNode createTextNode()

Creates and returns a new Text DOM node with DOMNodeType.TextNode type.

Returns:

the new Text DOM node with DOMNodeType.TextNode type.

createTextNode

DOMNode createTextNode(java.lang.String text)

Returns a new Text DOM node with DOMNodeType.TextNode type.

Parameters:

text - the string, which will be used to initialize node value.

Returns:

the new Text DOM node with DOMNodeType.TextNode type.

Throws:

java.lang.IllegalArgumentException - when text parameter is empty or null.

createEvent

DOMEvent createEvent(DOMEventType eventType,
                     DOMEventParams params)

Creates a new DOMEvent object with the given eventType and params. The event object can be dispatched at specific DOMEventTarget using the DOMEventTarget.dispatchEvent(DOMEvent) method.

Parameters:

eventType - the DOM event type. Cannot be null.

params - the parameters of the event. Cannot be null.

Returns:

a new DOMEvent object.

Throws:

DOMException - when document fails to create DOM event.

Since:

6.13

createUIEvent

DOMUIEvent createUIEvent(DOMEventType eventType,
                         DOMUIEventParams params)

Creates a new DOMUIEvent object with the given eventType and params. The event object can be dispatched at specific DOMEventTarget using the DOMEventTarget.dispatchEvent(DOMEvent) method.

Parameters:

eventType - the DOM event type. Cannot be null.

params - the parameters of the event. Cannot be null.

Returns:

a new DOMUIEvent object.

Throws:

DOMException - when document fails to create DOM event.

Since:

6.13

createMouseEvent

DOMMouseEvent createMouseEvent(DOMEventType eventType,
                               DOMMouseEventParams params)

Creates a new DOMMouseEvent object with the given eventType and params. The event object can be dispatched at specific DOMEventTarget using the DOMEventTarget.dispatchEvent(DOMEvent) method.

Parameters:

eventType - the DOM event type. Cannot be null.

params - the parameters of the event. Cannot be null.

Returns:

a new DOMMouseEvent object.

Throws:

DOMException - when document fails to create DOM event.

Since:

6.13

createKeyEvent

DOMKeyEvent createKeyEvent(DOMEventType eventType,
                           DOMKeyEventParams params)

Creates a new DOMKeyEvent object with the given eventType and params. The event object can be dispatched at specific DOMEventTarget using the DOMEventTarget.dispatchEvent(DOMEvent) method.

Important: it's strongly recommended that the OnKeyDown, OnKeyUp, and OnKeyPress event types are used when creating DOM key event. With other event types, Chromium engine might fail to create DOM key event and throw DOMException.

Parameters:

eventType - the DOM event type. Cannot be null.

params - the parameters of the event. Cannot be null.

Returns:

a new DOMKeyEvent object.

Throws:

DOMException - when document fails to create DOM event.

Since:

6.13

getBaseURI

java.lang.String getBaseURI()

Returns the absolute base URL of the document

Returns:

value of <base> element's href attribute if one is present

otherwise, currently loaded location (including "about:blank" value for the case when nothing is loaded)