com.gargoylesoftware.htmlunit.javascript.host.html

Class HTMLDocument

java.lang.Object

net.sourceforge.htmlunit.corejs.javascript.ScriptableObject

com.gargoylesoftware.htmlunit.javascript.HtmlUnitScriptable

com.gargoylesoftware.htmlunit.javascript.host.event.EventTarget

com.gargoylesoftware.htmlunit.javascript.host.dom.Node

com.gargoylesoftware.htmlunit.javascript.host.dom.Document

com.gargoylesoftware.htmlunit.javascript.host.html.HTMLDocument

All Implemented Interfaces:

Serializable, Cloneable, net.sourceforge.htmlunit.corejs.javascript.ConstProperties, net.sourceforge.htmlunit.corejs.javascript.debug.DebuggableObject, net.sourceforge.htmlunit.corejs.javascript.Scriptable, net.sourceforge.htmlunit.corejs.javascript.SymbolScriptable

public class HTMLDocument
extends Document

A JavaScript object for HTMLDocument.

Author:

Mike Bowler, David K. Taylor, Chen Jun, Christian Sell, Chris Erskine, Marc Guillemot, Daniel Gredler, Michael Ottati, George Murnock, Ahmed Ashour, Rob Di Marco, Sudhan Moghe, Mike Dirolf, Ronald Brill, Frank Danek

See Also:

MSDN documentation, W3C DOM Level 1, Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class net.sourceforge.htmlunit.corejs.javascript.ScriptableObject

net.sourceforge.htmlunit.corejs.javascript.ScriptableObject.KeyComparator

Field Summary

Fields inherited from class com.gargoylesoftware.htmlunit.javascript.host.dom.Node

ATTRIBUTE_NODE, CDATA_SECTION_NODE, COMMENT_NODE, DOCUMENT_FRAGMENT_NODE, DOCUMENT_NODE, DOCUMENT_POSITION_CONTAINED_BY, DOCUMENT_POSITION_CONTAINS, DOCUMENT_POSITION_DISCONNECTED, DOCUMENT_POSITION_FOLLOWING, DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC, DOCUMENT_POSITION_PRECEDING, DOCUMENT_TYPE_NODE, ELEMENT_NODE, ENTITY_NODE, ENTITY_REFERENCE_NODE, NOTATION_NODE, PROCESSING_INSTRUCTION_NODE, TEXT_NODE

Fields inherited from class net.sourceforge.htmlunit.corejs.javascript.ScriptableObject

CONST, DONTENUM, EMPTY, PERMANENT, READONLY, UNINITIALIZED_CONST

Fields inherited from interface net.sourceforge.htmlunit.corejs.javascript.Scriptable

NOT_FOUND

Constructor Summary

Constructors

Constructor and Description
HTMLDocument() The constructor.

Method Summary

Modifier and Type	Method and Description
Object	appendChild(Object childObject) Adds a DOM node to the node.
void	close() JavaScript function close.
Attr	createAttribute(String attributeName) Creates a new HTML attribute with the specified name.
boolean	dispatchEvent(Event event) Dispatches an event into the event system (standards-conformant browsers only).
Object	elementFromPoint(int x, int y) Returns the element for the specified x coordinate and the specified y coordinate.
HTMLElement	getActiveElement() Returns the value of the activeElement property.
String	getBaseURI() Returns the Base URI as a string.
String	getCookie() Returns the cookie property.
Element	getDocumentElement() Gets the JavaScript property documentElement for the document.
DomNode	getDomNodeOrDie() Returns the DOM node that corresponds to this JavaScript object or throw an exception if one cannot be found.
Object	getElementById(String id) Returns the element with the specified ID, or null if that element could not be found.
HTMLCollection	getElementsByClassName(String className) Returns all the descendant elements with the specified class name.
HTMLCollection	getElementsByName(String elementName) Returns all HTML elements that have a name attribute with the specified value.
HTMLElement	getHead() Returns this document's head element.
HtmlPage	getPage() Returns the HTML page that this document is modeling.
Selection	getSelection() Returns the current selection.
String	getTitle() Returns this document's title.
protected Object	getWithPreemption(String name) Calls to document.XYZ should first look at elements named XYZ before using standard functions.
boolean	hasFocus() Returns false if the active element in the document has no focus; true if the active element in the document has focus.
Object	open(Object url, Object name, Object features, Object replace) JavaScript function "open".
void	setActiveElement(HTMLElement element) Sets the specified element as the document's active element.
void	setCookie(String newCookie) Adds a cookie, as long as cookies are enabled.
void	setExecutingDynamicExternalPosponed(boolean executing) This a hack!!! A cleaner way is welcome.
void	setHead(net.sourceforge.htmlunit.corejs.javascript.ScriptableObject head) Sets the head.
void	setTitle(String title) Sets this document's title.
static void	write(net.sourceforge.htmlunit.corejs.javascript.Context context, net.sourceforge.htmlunit.corejs.javascript.Scriptable thisObj, Object[] args, net.sourceforge.htmlunit.corejs.javascript.Function function) JavaScript function "write" may accept a variable number of arguments.
protected void	write(String content) JavaScript function "write".
static void	writeln(net.sourceforge.htmlunit.corejs.javascript.Context context, net.sourceforge.htmlunit.corejs.javascript.Scriptable thisObj, Object[] args, net.sourceforge.htmlunit.corejs.javascript.Function function) JavaScript function "writeln" may accept a variable number of arguments.

Methods inherited from class com.gargoylesoftware.htmlunit.javascript.host.dom.Document

adoptNode, captureEvents, clear, contains, createCDATASection, createComment, createDocumentFragment, createElement, createElementNS, createEvent, createNodeIterator, createNSResolver, createProcessingInstruction, createRange, createTextNode, createTreeWalker, evaluate, execCommand, forceDocumentMode, get, getAlinkColor, getAll, getAnchors, getApplets, getBgColor, getBody, getCharacterSet, getCharset, getChildElementCount, getChildren, getCompatMode, getContentType, getCurrentScript, getDefaultCharset, getDefaultView, getDesignMode, getDoctype, getDocumentMode, getDocumentURI, getDomain, getElementsByTagName, getElementsByTagNameNS, getEmbeds, getFgColor, getFirstElementChild, getFonts, getForms, getFrames, getHidden, getImages, getImplementation, getInputEncoding, getLastElementChild, getLastModified, getLinkColor, getLinks, getLocation, getOnabort, getOnactivate, getOnafterscriptexecute, getOnauxclick, getOnbeforeactivate, getOnbeforecopy, getOnbeforecut, getOnbeforedeactivate, getOnbeforepaste, getOnbeforescriptexecute, getOnblur, getOncancel, getOncanplay, getOncanplaythrough, getOnchange, getOnclick, getOnclose, getOncontextmenu, getOncopy, getOncuechange, getOncut, getOndblclick, getOndeactivate, getOndrag, getOndragend, getOndragenter, getOndragleave, getOndragover, getOndragstart, getOndrop, getOndurationchange, getOnemptied, getOnended, getOnerror, getOnfocus, getOnfocusin, getOnfocusout, getOngotpointercapture, getOnhelp, getOninput, getOninvalid, getOnkeydown, getOnkeypress, getOnkeyup, getOnload, getOnloadeddata, getOnloadedmetadata, getOnloadstart, getOnlostpointercapture, getOnmousedown, getOnmouseenter, getOnmouseleave, getOnmousemove, getOnmouseout, getOnmouseover, getOnmouseup, getOnmousewheel, getOnmozfullscreenchange, getOnmozfullscreenerror, getOnmscontentzoom, getOnmsfullscreenchange, getOnmsfullscreenerror, getOnmsgesturechange, getOnmsgesturedoubletap, getOnmsgestureend, getOnmsgesturehold, getOnmsgesturestart, getOnmsgesturetap, getOnmsinertiastart, getOnmsmanipulationstatechanged, getOnmspointercancel, getOnmspointerdown, getOnmspointerenter, getOnmspointerleave, getOnmspointermove, getOnmspointerout, getOnmspointerover, getOnmspointerup, getOnmssitemodejumplistitemremoved, getOnmsthumbnailclick, getOnpaste, getOnpause, getOnplay, getOnplaying, getOnpointercancel, getOnpointerdown, getOnpointerenter, getOnpointerleave, getOnpointerlockchange, getOnpointerlockerror, getOnpointermove, getOnpointerout, getOnpointerover, getOnpointerup, getOnprogress, getOnratechange, getOnreadystatechange, getOnreset, getOnresize, getOnscroll, getOnsearch, getOnseeked, getOnseeking, getOnselect, getOnselectionchange, getOnselectstart, getOnstalled, getOnstop, getOnstoragecommit, getOnsubmit, getOnsuspend, getOntimeupdate, getOntoggle, getOnvolumechange, getOnwaiting, getOnwebkitfullscreenchange, getOnwebkitfullscreenerror, getOnwheel, getParentWindow, getPlugins, getReadyState, getReferrer, getRootElement, getScripts, getStyleSheets, getUniqueID, getURL_js, getURLUnencoded_js, getVlinkColor, getXmlEncoding, getXmlVersion, importNode, isXmlStandalone, queryCommandEnabled, queryCommandSupported, querySelector, querySelectorAll, releaseCapture, releaseEvents, setAlinkColor, setBgColor, setBody, setCurrentScript, setDesignMode, setDomain, setFgColor, setLinkColor, setLocation, setOnabort, setOnactivate, setOnafterscriptexecute, setOnauxclick, setOnbeforeactivate, setOnbeforecopy, setOnbeforecut, setOnbeforedeactivate, setOnbeforepaste, setOnbeforescriptexecute, setOnblur, setOncancel, setOncanplay, setOncanplaythrough, setOnchange, setOnclick, setOnclose, setOncontextmenu, setOncopy, setOncuechange, setOncut, setOndblclick, setOndeactivate, setOndrag, setOndragend, setOndragenter, setOndragleave, setOndragover, setOndragstart, setOndrop, setOndurationchange, setOnemptied, setOnended, setOnerror, setOnfocus, setOnfocusin, setOnfocusout, setOngotpointercapture, setOnhelp, setOninput, setOninvalid, setOnkeydown, setOnkeypress, setOnkeyup, setOnload, setOnloadeddata, setOnloadedmetadata, setOnloadstart, setOnlostpointercapture, setOnmousedown, setOnmouseenter, setOnmouseleave, setOnmousemove, setOnmouseout, setOnmouseover, setOnmouseup, setOnmousewheel, setOnmozfullscreenchange, setOnmozfullscreenerror, setOnmscontentzoom, setOnmsfullscreenchange, setOnmsfullscreenerror, setOnmsgesturechange, setOnmsgesturedoubletap, setOnmsgestureend, setOnmsgesturehold, setOnmsgesturestart, setOnmsgesturetap, setOnmsinertiastart, setOnmsmanipulationstatechanged, setOnmspointercancel, setOnmspointerdown, setOnmspointerenter, setOnmspointerleave, setOnmspointermove, setOnmspointerout, setOnmspointerover, setOnmspointerup, setOnmssitemodejumplistitemremoved, setOnmsthumbnailclick, setOnpaste, setOnpause, setOnplay, setOnplaying, setOnpointercancel, setOnpointerdown, setOnpointerenter, setOnpointerleave, setOnpointerlockchange, setOnpointerlockerror, setOnpointermove, setOnpointerout, setOnpointerover, setOnpointerup, setOnprogress, setOnratechange, setOnreadystatechange, setOnreset, setOnresize, setOnscroll, setOnsearch, setOnseeked, setOnseeking, setOnselect, setOnselectionchange, setOnselectstart, setOnstalled, setOnstop, setOnstoragecommit, setOnsubmit, setOnsuspend, setOntimeupdate, setOntoggle, setOnvolumechange, setOnwaiting, setOnwebkitfullscreenchange, setOnwebkitfullscreenerror, setOnwheel, setVlinkColor, setWindow

Methods inherited from class com.gargoylesoftware.htmlunit.javascript.host.dom.Node

after, asJavaScriptException, before, cloneNode, compareDocumentPosition, getAttributes, getChildNodes, getFirstChild, getJavaScriptNode, getLastChild, getLocalName, getNamespaceURI, getNextSibling, getNodeName, getNodeType, getNodeValue, getOwnerDocument, getParent, getParentElement, getParentNode, getPrefix, getPreviousSibling, getRootNode, getTextContent, hasAttributes, hasChildNodes, insertBefore, insertBeforeImpl, isSameNode, normalize, remove, removeChild, replaceChild, replaceWith, setNodeValue, setTextContent

Methods inherited from class com.gargoylesoftware.htmlunit.javascript.host.event.EventTarget

addEventListener, clearEventListenersContainer, executeEventLocally, fireEvent, getEventHandler, getEventListenersContainer, hasEventHandlers, isEventHandlerOnWindow, removeEventListener, setEventHandler

Methods inherited from class com.gargoylesoftware.htmlunit.javascript.HtmlUnitScriptable

clone, equivalentValues, getBrowserVersion, getClassName, getDefaultValue, getDomNodeOrNull, getPrototype, getScriptableFor, getStartingScope, getWindow, getWindow, has, hasInstance, initParentScope, makeScriptableFor, put, setClassName, setDomNode, setDomNode, setParentScope

Methods inherited from class net.sourceforge.htmlunit.corejs.javascript.ScriptableObject

applyDescriptorToAttributeBitset, associateValue, avoidObjectDetection, buildDataDescriptor, callMethod, callMethod, checkPropertyChange, checkPropertyDefinition, defineClass, defineClass, defineClass, defineConst, defineConstProperty, defineFunctionProperties, defineOwnProperties, defineOwnProperty, defineOwnProperty, defineProperty, defineProperty, defineProperty, defineProperty, defineProperty, defineProperty, delete, delete, delete, deleteProperty, deleteProperty, ensureScriptable, ensureScriptableObject, ensureSymbolScriptable, get, get, get, getAllIds, getArrayPrototype, getAssociatedValue, getAttributes, getAttributes, getAttributes, getAttributes, getAttributes, getClassPrototype, getDefaultValue, getExternalArrayData, getExternalArrayLength, getFunctionPrototype, getGeneratorFunctionPrototype, getGetterOrSetter, getGetterOrSetter, getIds, getObjectPrototype, getOwnPropertyDescriptor, getParentScope, getProperty, getProperty, getProperty, getPropertyIds, getPrototype, getTopLevelScope, getTopScopeValue, getTypedProperty, getTypedProperty, getTypeOf, has, has, hasProperty, hasProperty, hasProperty, isAccessorDescriptor, isConst, isDataDescriptor, isEmpty, isExtensible, isFalse, isGenericDescriptor, isGetterOrSetter, isSealed, isTrue, preventExtensions, put, put, putConst, putConstProperty, putProperty, putProperty, putProperty, querySlot, redefineProperty, sameValue, sealObject, setAttributes, setAttributes, setAttributes, setAttributes, setAttributes, setCommonDescriptorProperties, setExternalArrayData, setGetterOrSetter, setPrototype, size

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

HTMLDocument

public HTMLDocument()

The constructor.

Method Detail

getDomNodeOrDie

public DomNode getDomNodeOrDie()

Returns the DOM node that corresponds to this JavaScript object or throw an exception if one cannot be found.

Overrides:

getDomNodeOrDie in class HtmlUnitScriptable

Returns:

the DOM node

getPage

public HtmlPage getPage()

Returns the HTML page that this document is modeling.

Overrides:

getPage in class Document

Returns:

the HTML page that this document is modeling

write

public static void write(net.sourceforge.htmlunit.corejs.javascript.Context context,
                         net.sourceforge.htmlunit.corejs.javascript.Scriptable thisObj,
                         Object[] args,
                         net.sourceforge.htmlunit.corejs.javascript.Function function)

JavaScript function "write" may accept a variable number of arguments.

Parameters:

context - the JavaScript context

thisObj - the scriptable

args - the arguments passed into the method

function - the function

See Also:

MSDN documentation

writeln

public static void writeln(net.sourceforge.htmlunit.corejs.javascript.Context context,
                           net.sourceforge.htmlunit.corejs.javascript.Scriptable thisObj,
                           Object[] args,
                           net.sourceforge.htmlunit.corejs.javascript.Function function)

JavaScript function "writeln" may accept a variable number of arguments.

Parameters:

context - the JavaScript context

thisObj - the scriptable

args - the arguments passed into the method

function - the function

See Also:

MSDN documentation

setExecutingDynamicExternalPosponed

public void setExecutingDynamicExternalPosponed(boolean executing)

This a hack!!! A cleaner way is welcome. Handle a case where document.write is simply ignored. See HTMLDocumentWrite2Test.write_fromScriptAddedWithAppendChild_external.

Parameters:

executing - indicates if executing or not

write

protected void write(String content)

JavaScript function "write".

See http://www.whatwg.org/specs/web-apps/current-work/multipage/section-dynamic.html for a good description of the semantics of open(), write(), writeln() and close().

Parameters:

content - the content to write

getCookie

public String getCookie()

Returns the cookie property.

Overrides:

getCookie in class Document

Returns:

the cookie property

setCookie

public void setCookie(String newCookie)

Adds a cookie, as long as cookies are enabled.

Parameters:

newCookie - in the format "name=value[;expires=date][;domain=domainname][;path=path][;secure]

See Also:

MSDN documentation

open

public Object open(Object url,
                   Object name,
                   Object features,
                   Object replace)

JavaScript function "open".

See http://www.whatwg.org/specs/web-apps/current-work/multipage/section-dynamic.html for a good description of the semantics of open(), write(), writeln() and close().

Parameters:

url - when a new document is opened, url is a String that specifies a MIME type for the document. When a new window is opened, url is a String that specifies the URL to render in the new window

name - the name

features - the features

replace - whether to replace in the history list or no

Returns:

a reference to the new document object.

See Also:

MSDN documentation

close

public void close()
           throws IOException

JavaScript function close.

See http://www.whatwg.org/specs/web-apps/current-work/multipage/section-dynamic.html for a good description of the semantics of open(), write(), writeln() and close().

Overrides:

close in class Document

Throws:

IOException - if an IO problem occurs

getDocumentElement

public Element getDocumentElement()

Gets the JavaScript property documentElement for the document.

Overrides:

getDocumentElement in class Document

Returns:

the root node for the document

appendChild

public Object appendChild(Object childObject)

Adds a DOM node to the node.

Overrides:

appendChild in class Node

Parameters:

childObject - the node to add to this node

Returns:

the newly added child node

getElementById

public Object getElementById(String id)

Returns the element with the specified ID, or null if that element could not be found.

Overrides:

getElementById in class Document

Parameters:

id - the ID to search for

Returns:

the element, or null if it could not be found

getElementsByClassName

public HTMLCollection getElementsByClassName(String className)

Returns all the descendant elements with the specified class name.

Overrides:

getElementsByClassName in class Document

Parameters:

className - the name to search for

Returns:

all the descendant elements with the specified class name

See Also:

Mozilla doc

getElementsByName

public HTMLCollection getElementsByName(String elementName)

Returns all HTML elements that have a name attribute with the specified value.

Refer to The DOM spec for details.

Overrides:

getElementsByName in class Document

Parameters:

elementName - - value of the name attribute to look for

Returns:

all HTML elements that have a name attribute with the specified value

getWithPreemption

protected Object getWithPreemption(String name)

Calls to document.XYZ should first look at elements named XYZ before using standard functions.

Called by HtmlUnitScriptable.get(String, Scriptable) to allow retrieval of the property before the prototype chain is searched.

IMPORTANT: This method is invoked *very* often by Rhino. If you override this method, the implementation needs to be as fast as possible!

Overrides:

getWithPreemption in class HtmlUnitScriptable

Parameters:

name - the property name

Returns:

Scriptable.NOT_FOUND if not found

getHead

public HTMLElement getHead()

Returns this document's head element.

Overrides:

getHead in class Document

Returns:

this document's head element

getTitle

public String getTitle()

Returns this document's title.

Overrides:

getTitle in class Document

Returns:

this document's title

setTitle

public void setTitle(String title)

Sets this document's title.

Overrides:

setTitle in class Document

Parameters:

title - the new title

getActiveElement

public HTMLElement getActiveElement()

Returns the value of the activeElement property.

Overrides:

getActiveElement in class Document

Returns:

the value of the activeElement property

See Also:

MSDN documentation

hasFocus

public boolean hasFocus()

Returns false if the active element in the document has no focus; true if the active element in the document has focus.

Overrides:

hasFocus in class Document

Returns:

whether the active element in the document has focus or not

setActiveElement

public void setActiveElement(HTMLElement element)

Sets the specified element as the document's active element.

Parameters:

element - the new active element for this document

See Also:

HTMLElement.setActive()

dispatchEvent

public boolean dispatchEvent(Event event)

Dispatches an event into the event system (standards-conformant browsers only). See the Gecko DOM reference for more information.

Overrides:

dispatchEvent in class EventTarget

Parameters:

event - the event to be dispatched

Returns:

false if at least one of the event handlers which handled the event called preventDefault; true otherwise

setHead

public void setHead(net.sourceforge.htmlunit.corejs.javascript.ScriptableObject head)

Sets the head.

Parameters:

head - the head

getSelection

public Selection getSelection()

Returns the current selection.

Overrides:

getSelection in class Document

Returns:

the current selection

createAttribute

public Attr createAttribute(String attributeName)

Creates a new HTML attribute with the specified name.

Overrides:

createAttribute in class Document

Parameters:

attributeName - the name of the attribute to create

Returns:

an attribute with the specified name

getBaseURI

public String getBaseURI()

Returns the Base URI as a string.

Overrides:

getBaseURI in class Node

Returns:

the Base URI as a string

elementFromPoint

public Object elementFromPoint(int x,
                               int y)

Returns the element for the specified x coordinate and the specified y coordinate. The current implementation always returns the <body> element.

Overrides:

elementFromPoint in class Document

Parameters:

x - the x offset, in pixels

y - the y offset, in pixels

Returns:

the element for the specified x coordinate and the specified y coordinate