HTMLDocument

@native @JSGlobal @JSType
abstract class HTMLDocument extends Document
class Document
class Node
class Object
trait Any
class Object
trait Matchable
class Any

Value members

Concrete methods

def URL: String

Returns a string containing the URL of the current document.

Returns a string containing the URL of the current document.

Returns the currently focused element, that is, the element that will get keystroke events if the user types any. This attribute is read only.

Returns the currently focused element, that is, the element that will get keystroke events if the user types any. This attribute is read only.

anchors returns a list of all of the anchors in the document.

anchors returns a list of all of the anchors in the document.

def close(): Unit

The document.close() method finishes writing to a document, opened with document.open().

The document.close() method finishes writing to a document, opened with document.open().

def compatMode: String

Indicates whether the document is rendered in Quirks mode or Strict mode.

Indicates whether the document is rendered in Quirks mode or Strict mode.

In browsers returns the window object associated with the document or null if none available.

In browsers returns the window object associated with the document or null if none available.

Returns a list of the embedded <embed> elements within the current document.

Returns a list of the embedded <embed> elements within the current document.

def execCommand(commandId: String, showUI: Boolean, value: Any): Boolean

When an HTML document has been switched to designMode, the document object exposes the execCommand method which allows one to run commands to manipulate the contents of the editable region. Most commands affect the document's selection (bold, italics, etc), while others insert new elements (adding a link) or affect an entire line (indenting). When using contentEditable, calling execCommand will affect the currently active editable element.

When an HTML document has been switched to designMode, the document object exposes the execCommand method which allows one to run commands to manipulate the contents of the editable region. Most commands affect the document's selection (bold, italics, etc), while others insert new elements (adding a link) or affect an entire line (indenting). When using contentEditable, calling execCommand will affect the currently active editable element.

def execCommandShowHelp(commandId: String): Boolean

This method never did anything and always threw an exception, so it was removed in Gecko 14.0 (Firefox 14.0 / Thunderbird 14.0 / SeaMonkey 2.11).

This method never did anything and always threw an exception, so it was removed in Gecko 14.0 (Firefox 14.0 / Thunderbird 14.0 / SeaMonkey 2.11).

def fireEvent(eventName: String, eventObj: Any): Boolean
def focus(): Unit

forms returns a collection (an HTMLCollection) of the form elements within the current document.

forms returns a collection (an HTMLCollection) of the form elements within the current document.

The DOM getSelection() method is available on the Window and Document interfaces. See window.getSelection() for details.

The DOM getSelection() method is available on the Window and Document interfaces. See window.getSelection() for details.

def hasFocus(): Boolean

Returns a Boolean value indicating whether the document or any element inside the document has focus. This method can be used to determine whether the active element in a document has focus.

Returns a Boolean value indicating whether the document or any element inside the document has focus. This method can be used to determine whether the active element in a document has focus.

Returns the <head> element of the current document. If there are more than one <head> elements, the first one is returned.

Returns the <head> element of the current document. If there are more than one <head> elements, the first one is returned.

document.images returns a collection of the images in the current HTML document.

document.images returns a collection of the images in the current HTML document.

def open(url: String, name: String, features: String, replace: Boolean): Dynamic

The document.open() method opens a document for writing.

The document.open() method opens a document for writing.

Returns an HTMLCollection object containing one or more HTMLEmbedElements or null which represent the <embed> elements in the current document.

Returns an HTMLCollection object containing one or more HTMLEmbedElements or null which represent the <embed> elements in the current document.

def queryCommandEnabled(commandId: String): Boolean

Returns true if the formatting command can be executed on the current range.

Returns true if the formatting command can be executed on the current range.

def queryCommandIndeterm(commandId: String): Boolean

Returns true if the formatting command is in an indeterminate state on the current range.

Returns true if the formatting command is in an indeterminate state on the current range.

def queryCommandState(commandId: String): Boolean

Returns true if the formatting command has been executed on the current range.

Returns true if the formatting command has been executed on the current range.

def queryCommandSupported(commandId: String): Boolean

Reports whether or not the specified editor query command is supported by the browser.

Reports whether or not the specified editor query command is supported by the browser.

def queryCommandText(commandId: String): String

This method never did anything but throw an exception, and was removed in Gecko 14.0 (Firefox 14.0 / Thunderbird 14.0 / SeaMonkey 2.11).

This method never did anything but throw an exception, and was removed in Gecko 14.0 (Firefox 14.0 / Thunderbird 14.0 / SeaMonkey 2.11).

def queryCommandValue(commandId: String): String

Returns the current value of the current range for a formatting command.

Returns the current value of the current range for a formatting command.

Returns "loading" while the document is loading, "interactive" once it is finished parsing but still loading sub-resources, and "complete" once it has loaded.

Returns "loading" while the document is loading, "interactive" once it is finished parsing but still loading sub-resources, and "complete" once it has loaded.

def referrer: String

Returns the URI of the page that linked to this page.

Returns the URI of the page that linked to this page.

def updateSettings(): Unit
def write(content: String*): Unit

Writes a string of text to a document stream opened by document.open().

Writes a string of text to a document stream opened by document.open().

def writeln(content: String*): Unit

Writes a string of text followed by a newline character to a document.

Writes a string of text followed by a newline character to a document.

Inherited methods

def addEventListener[T <: Event](`type`: String, listener: Function1[T, _], options: EventListenerOptions): Unit

The EventTarget.addEventListener() method registers the specified listener on the EventTarget it's called on. The event target may be an Element in a document, the Document itself, a Window, or any other object that supports events (such as XMLHttpRequest).

The EventTarget.addEventListener() method registers the specified listener on the EventTarget it's called on. The event target may be an Element in a document, the Document itself, a Window, or any other object that supports events (such as XMLHttpRequest).

This implementation accepts a settings object of type EventListenerOptions.

Inherited from:
EventTarget
def addEventListener[T <: Event](`type`: String, listener: Function1[T, _], useCapture: Boolean): Unit

The EventTarget.addEventListener() method registers the specified listener on the EventTarget it's called on. The event target may be an Element in a document, the Document itself, a Window, or any other object that supports events (such as XMLHttpRequest).

The EventTarget.addEventListener() method registers the specified listener on the EventTarget it's called on. The event target may be an Element in a document, the Document itself, a Window, or any other object that supports events (such as XMLHttpRequest).

Inherited from:
EventTarget
def adoptNode(source: Node): Node

Adopts a node from an external document. The node and its subtree is removed from the document it's in (if any), and its ownerDocument is changed to the current document. The node can then be inserted into the current document.

Adopts a node from an external document. The node and its subtree is removed from the document it's in (if any), and its ownerDocument is changed to the current document. The node can then be inserted into the current document.

Inherited from:
Document
def appendChild(newChild: Node): Node

Adds a node to the end of the list of children of a specified parent node. If the node already exists it is removed from current parent node, then added to new parent node.

Adds a node to the end of the list of children of a specified parent node. If the node already exists it is removed from current parent node, then added to new parent node.

Inherited from:
Node
def baseURI: String

Returns the absolute base URL of this Node.

Returns the absolute base URL of this Node.

Inherited from:
Node
def characterSet: String

Returns the character encoding of the current document.

Returns the character encoding of the current document.

Inherited from:
Document

Returns an unsigned long giving the amount of children that the object has.

Returns an unsigned long giving the amount of children that the object has.

Inherited from:
ParentNode

Returns a live NodeList containing all the children of this node. NodeList being live means that if the children of the Node change, the NodeList object is automatically updated.

Returns a live NodeList containing all the children of this node. NodeList being live means that if the children of the Node change, the NodeList object is automatically updated.

Inherited from:
Node

Returns a live HTMLCollection containing all objects of type Element that are children of the object.

Returns a live HTMLCollection containing all objects of type Element that are children of the object.

Inherited from:
ParentNode
def cloneNode(deep: Boolean): Node

Clone a Node, and optionally, all of its contents. By default, it clones the content of the node.

Clone a Node, and optionally, all of its contents. By default, it clones the content of the node.

Inherited from:
Node
def compareDocumentPosition(other: Node): Int

Compares the position of the current node against another node in any other document.

Compares the position of the current node against another node in any other document.

Inherited from:
Node
def contains(otherNode: Node): Boolean

Returns a Boolean value indicating whether a node is a descendant of a given node, i.e. the node itself, one of its direct children (childNodes), one of the children's direct children, and so on.

Returns a Boolean value indicating whether a node is a descendant of a given node, i.e. the node itself, one of its direct children (childNodes), one of the children's direct children, and so on.

Inherited from:
Node
def createAttribute(name: String): Attr

createAttribute creates a new attribute node, and returns it.

createAttribute creates a new attribute node, and returns it.

Inherited from:
Document
def createAttributeNS(namespaceURI: String, qualifiedName: String): Attr

Creates a new attribute node in a given namespace and returns it.

Creates a new attribute node in a given namespace and returns it.

Inherited from:
Document
def createCDATASection(data: String): CDATASection

createCDATASection() creates a new CDATA section node, and returns it.

createCDATASection() creates a new CDATA section node, and returns it.

Inherited from:
Document
def createComment(data: String): Comment

createComment() creates a new comment node, and returns it.

createComment() creates a new comment node, and returns it.

Inherited from:
Document

Creates a new empty DocumentFragment.

Creates a new empty DocumentFragment.

Inherited from:
Document
def createElement(tagName: String, options: ElementCreationOptions): Element
Inherited from:
Document
def createElement(tagName: String, options: String): Element
Inherited from:
Document
def createElement(tagName: String): Element

In an HTML document creates the specified HTML element or HTMLUnknownElement if the element is not known. In a XUL document creates the specified XUL element. In other documents creates an element with a null namespaceURI.

In an HTML document creates the specified HTML element or HTMLUnknownElement if the element is not known. In a XUL document creates the specified XUL element. In other documents creates an element with a null namespaceURI.

Inherited from:
Document
def createElementNS(namespaceURI: String, qualifiedName: String, options: ElementCreationOptions): Element
Inherited from:
Document
def createElementNS(namespaceURI: String, qualifiedName: String, options: String): Element
Inherited from:
Document
def createElementNS(namespaceURI: String, qualifiedName: String): Element

Creates an element with the specified namespace URI and qualified name.

Creates an element with the specified namespace URI and qualified name.

Inherited from:
Document
def createEvent(eventInterface: String): Event
Inherited from:
DocumentEvent

Creates an XPathNSResolver which resolves namespaces with respect to the definitions in scope for a specified node.

Creates an XPathNSResolver which resolves namespaces with respect to the definitions in scope for a specified node.

Inherited from:
Document
def createNodeIterator(root: Node, whatToShow: Int, filter: NodeFilter, entityReferenceExpansion: Boolean): NodeIterator

Supported in FF 3.5+, Chrome 1+, Opera 9+, Safari 3+, IE9+

Supported in FF 3.5+, Chrome 1+, Opera 9+, Safari 3+, IE9+

Inherited from:
Document
def createProcessingInstruction(target: String, data: String): ProcessingInstruction

createProcessingInstruction() creates a new processing instruction node, and returns it.

createProcessingInstruction() creates a new processing instruction node, and returns it.

Inherited from:
Document

Once a Range is created, you need to set its boundary points before you can make use of most of its methods.

Once a Range is created, you need to set its boundary points before you can make use of most of its methods.

Inherited from:
Document
def createStyleSheet(href: String, index: Int): CSSStyleSheet
Inherited from:
Document
def createTextNode(data: String): Text
Inherited from:
Document
def createTreeWalker(root: Node, whatToShow: Int, filter: NodeFilter, entityReferenceExpansion: Boolean): TreeWalker

The Document.createTreeWalker() creator method returns a newly created TreeWalker object.

The Document.createTreeWalker() creator method returns a newly created TreeWalker object.

Inherited from:
Document
def dispatchEvent(evt: Event): Boolean

Dispatches an Event at the specified EventTarget, invoking the affected EventListeners in the appropriate order. The normal event processing rules (including the capturing and optional bubbling phase) apply to events dispatched manually with dispatchEvent().

Dispatches an Event at the specified EventTarget, invoking the affected EventListeners in the appropriate order. The normal event processing rules (including the capturing and optional bubbling phase) apply to events dispatched manually with dispatchEvent().

Inherited from:
EventTarget

Returns the Document Type Declaration (DTD) associated with current document. The returned object implements the DocumentType interface. Use DOMImplementation.createDocumentType() to create a DocumentType.

Returns the Document Type Declaration (DTD) associated with current document. The returned object implements the DocumentType interface. Use DOMImplementation.createDocumentType() to create a DocumentType.

Inherited from:
Document

Returns the Element that is the root element of the document (for example, the <html> element for HTML documents).

Returns the Element that is the root element of the document (for example, the <html> element for HTML documents).

Inherited from:
Document
def documentURI: String
Inherited from:
Document
def elementFromPoint(x: Double, y: Double): Element

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.

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.

Inherited from:
Document
def evaluate(xpathExpression: String, contextNode: Node, namespaceResolver: Function1[String, String], resultType: Int, result: XPathResult): XPathResult

Returns an XPathResult based on an XPath expression and other given parameters.

Returns an XPathResult based on an XPath expression and other given parameters.

Value parameters:
contextNode

specifies the context node for the query (see the [http://www.w3.org/TR/xpath XPath specification). It's common to pass document as the context node.

namespaceResolver

is a function that will be passed any namespace prefixes and should return a string representing the namespace URI associated with that prefix. It will be used to resolve prefixes within the XPath itself, so that they can be matched with the document. null is common for HTML documents or when no namespace prefixes are used.

result

is an existing XPathResult to use for the results. null is the most common and will create a new XPathResult

resultType

is an integer that corresponds to the type of result XPathResult to return. Use named constant properties, such as XPathResult.ANY_TYPE, of the XPathResult constructor, which correspond to integers from 0 to 9.

xpathExpression

is a string representing the XPath to be evaluated.

Inherited from:
Document
def evaluate(xpathExpression: String, contextNode: Node, namespaceResolver: XPathNSResolver, resultType: Int, result: XPathResult): XPathResult

Returns an XPathResult based on an XPath expression and other given parameters.

Returns an XPathResult based on an XPath expression and other given parameters.

Value parameters:
contextNode

specifies the context node for the query (see the http://www.w3.org/TR/xpath XPath specification). It's common to pass document as the context node.

namespaceResolver

an XPathNSResolver

result

is an existing XPathResult to use for the results. null is the most common and will create a new XPathResult

resultType

is an integer that corresponds to the type of result XPathResult to return. Use named constant properties, such as XPathResult.ANY_TYPE, of the XPathResult constructor, which correspond to integers from 0 to 9.

xpathExpression

is a string representing the XPath to be evaluated.

Inherited from:
Document
def exitFullscreen(): Promise[Unit]

The Document method exitFullscreen() requests that the element on this document which is currently being presented in full-screen mode be taken out of full-screen mode, restoring the previous state of the screen. This usually reverses the effects of a previous call to Element.requestFullscreen().

The Document method exitFullscreen() requests that the element on this document which is currently being presented in full-screen mode be taken out of full-screen mode, restoring the previous state of the screen. This usually reverses the effects of a previous call to Element.requestFullscreen().

The exception is if another element was already in full-screen mode when the current element was placed into full-screen mode using requestFullscreen(). In that case, the previous full-screen element is restored to full-screen status instead. In essence, a stack of full-screen elements is maintained.

Inherited from:
Document
def exitPointerLock(): Unit

The exitPointerLock asynchronously releases a pointer lock previously requested through Element.requestPointerLock.

The exitPointerLock asynchronously releases a pointer lock previously requested through Element.requestPointerLock.

To track the success or failure of the request, it is necessary to listen for the pointerlockchange and pointerlockerror events.

Inherited from:
Document

Returns the node's first child in the tree, or null if the node is childless. If the node is a Document, it returns the first node in the list of its direct children.

Returns the node's first child in the tree, or null if the node is childless. If the node is a Document, it returns the first node in the list of its direct children.

Inherited from:
Node

Returns the Element that is the first child of the object, or null if there is none.

Returns the Element that is the first child of the object, or null if there is none.

Inherited from:
ParentNode

The DocumentOrShadowRoot.fullscreenElement read-only property returns the Element that is currently being presented in full-screen mode in this document, or null if full-screen mode is not currently in use.

The DocumentOrShadowRoot.fullscreenElement read-only property returns the Element that is currently being presented in full-screen mode in this document, or null if full-screen mode is not currently in use.

Although this property is read-only, it will not throw if it is modified (even in strict mode); the setter is a no-operation and it will be ignored.

Inherited from:
Document
def fullscreenEnabled: Boolean

The read-only fullscreenEnabled property on the Document interface indicates whether or not full-screen mode is available. Full-screen mode is available only for a page that has no windowed plug-ins in any of its documents, and if all