org.scalajs.dom.raw

Document

Related Doc: package raw

class Document extends Node with NodeSelector with DocumentEvent with ParentNode

Each web page loaded in the browser has its own document object. The Document interface serves as an entry point to the web page's content (the DOM tree, including elements such as <body> and

) and provides functionality global to the document (such as obtaining the page's URL and creating new elements in the document). MDN

Annotations
@RawJSType()
Linear Supertypes
ParentNode, DocumentEvent, NodeSelector, Node, EventTarget, Object, Any, AnyRef, Any
Known Subclasses
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Document
  2. ParentNode
  3. DocumentEvent
  4. NodeSelector
  5. Node
  6. EventTarget
  7. Object
  8. Any
  9. AnyRef
  10. Any
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Document()

Value Members

  1. final def !=(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any
  4. def addEventListener[T <: Event](type: String, listener: Function1[T, _], useCapture: Boolean = js.native): Unit

    The EventTarget.addEventListener() method registers the specified listener on the EventTarget it's called on.

    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).

    MDN

    Definition Classes
    EventTarget
  5. def adoptNode(source: Node): Node

    Adopts a node from an external 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.

    MDN

  6. def appendChild(newChild: Node): Node

    Adds a node to the end of the list of children of a specified 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.

    MDN

    Definition Classes
    Node
  7. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  8. def attributes: NamedNodeMap

    .attributes is a collection of all attribute nodes registered to the specified node.

    .attributes is a collection of all attribute nodes registered to the specified node. It is a NamedNodeMap,not an Array, so it has no Array methods and the Attr nodes' indexes may differ among browsers. To be more specific, attribute is a key value pair of strings that represents any information regarding that node; it cannot hold Object. Attribute can hold additional data/information that is required while processing custom JavaScript. There are many predefined attributes for different nodes used for binding events, validations, and specifying layout informations that are handled by browser (may vary from browser to browser).  

    MDN

    Definition Classes
    Node
  9. def characterSet: String

    Returns the character encoding of the current document.

    Returns the character encoding of the current document.

    MDN

  10. def childElementCount: Int

    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.

    MDN

    Definition Classes
    ParentNode
  11. def childNodes: NodeList

    Returns a live NodeList containing all the children of this node.

    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.

    MDN

    Definition Classes
    Node
  12. def children: HTMLCollection

    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.

    MDN

    Definition Classes
    ParentNode
  13. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  14. def cloneNode(deep: Boolean = js.native): Node

    Clone a Node, and optionally, all of its contents.

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

    MDN

    Definition Classes
    Node
  15. 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.

    MDN

    Definition Classes
    Node
  16. def createAttribute(name: String): Attr

    createAttribute creates a new attribute node, and returns it.

    createAttribute creates a new attribute node, and returns it.

    MDN

  17. 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.

    MDN

  18. 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.

    MDN

  19. def createComment(data: String): Comment

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

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

    MDN

  20. def createDocumentFragment(): DocumentFragment

    Creates a new empty DocumentFragment.

    Creates a new empty DocumentFragment.

    MDN

  21. def createElement(tagName: String): Element

    In an HTML document creates the specified HTML element or HTMLUnknownElement if the element is not known.

    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.

    MDN

  22. 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.

    MDN

  23. def createEvent(eventInterface: String): Event

    Definition Classes
    DocumentEvent
  24. def createNSResolver(node: Node): XPathNSResolver

    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.

    MDN.

  25. 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+

    MDN

  26. 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.

    MDN

  27. def createRange(): Range

    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.

    MDN

  28. def createStyleSheet(href: String = js.native, index: Int = js.native): CSSStyleSheet

  29. def createTextNode(data: String): Text

  30. 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.

    MDN

  31. def dispatchEvent(evt: Event): Boolean

    Dispatches an Event at the specified EventTarget, invoking the affected EventListeners in the appropriate order.

    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().

    MDN

    Definition Classes
    EventTarget
  32. def doctype: DocumentType

    Returns the Document Type Declaration (DTD) associated with current document.

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

    MDN

  33. def documentElement: Element

    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).

    MDN

  34. def documentURI: String

  35. 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.

    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.

    MDN

  36. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  37. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any
  38. 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.

    MDN

    xpathExpression

    is a string representing the XPath to be evaluated.

    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.

    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.

    result

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

  39. 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.

    MDN

    xpathExpression

    is a string representing the XPath to be evaluated.

    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

    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.

    result

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

  40. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  41. def firstChild: Node

    Returns the node's first child in the tree, or null if the node is childless.

    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.

    MDN

    Definition Classes
    Node
  42. def firstElementChild: Element

    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.

    MDN

    Definition Classes
    ParentNode
  43. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any
  44. def getElementById(elementId: String): Element

    Returns an object reference to the identified element.

    Returns an object reference to the identified element.

    MDN

  45. def getElementsByClassName(classNames: String): NodeList

    Returns a set of elements which have all the given class names.

    Returns a set of elements which have all the given class names. When called on the document object, the complete document is searched, including the root node. You may also call getElementsByClassName on any element; it will return only elements which are descendants of the specified root element with the given class names.

    MDN

  46. def getElementsByName(elementName: String): NodeList

    Returns a list of elements with a given name in the (X)HTML document.

    Returns a list of elements with a given name in the (X)HTML document.

    MDN

  47. def getElementsByTagName(tagname: String): NodeList

    Returns a HTMLCollection of elements with the given tag name.

    Returns a HTMLCollection of elements with the given tag name. The complete document is searched, including the root node. The returned HTMLCollection is live, meaning that it updates itself automatically to stay in sync with the DOM tree without having to call document.getElementsByTagName again.

    MDN

  48. def getElementsByTagNameNS(namespaceURI: String, localName: String): NodeList

    Returns a list of elements with the given tag name belonging to the given namespace.

    Returns a list of elements with the given tag name belonging to the given namespace. The complete document is searched, including the root node.

    MDN

  49. def hasAttributes(): Boolean

    hasAttributes returns a boolean value of true or false, indicating if the current element has any attributes or not.

    hasAttributes returns a boolean value of true or false, indicating if the current element has any attributes or not.

    MDN

    Definition Classes
    Node
  50. def hasChildNodes(): Boolean

    hasChildNodes returns a Boolean value indicating whether the current Node has child nodes or not.

    hasChildNodes returns a Boolean value indicating whether the current Node has child nodes or not.

    MDN

    Definition Classes
    Node
  51. def hasOwnProperty(v: String): Boolean

    Definition Classes
    Object
  52. def hashCode(): Int

    Definition Classes
    AnyRef → Any
  53. def implementation: DOMImplementation

    Returns a DOMImplementation object associated with the current document.

    Returns a DOMImplementation object associated with the current document.

    MDN

  54. def importNode(importedNode: Node, deep: Boolean): Node

    Creates a copy of a node from an external document that can be inserted into the current document.

    Creates a copy of a node from an external document that can be inserted into the current document.

    MDN

  55. def insertBefore(newChild: Node, refChild: Node = js.native): Node

    Inserts the first Node given in a parameter immediately before the second, child of this element, Node.

    Inserts the first Node given in a parameter immediately before the second, child of this element, Node.

    MDN

    Definition Classes
    Node
  56. def isDefaultNamespace(namespaceURI: String): Boolean

    isDefaultNamespace accepts a namespace URI as an argument and returns true if the namespace is the default namespace on the given node or false if not.

    isDefaultNamespace accepts a namespace URI as an argument and returns true if the namespace is the default namespace on the given node or false if not.

    MDN

    Definition Classes
    Node
  57. def isEqualNode(arg: Node): Boolean

    If #targetElm is first div element in document, "true" will be displayed.

    If #targetElm is first div element in document, "true" will be displayed.

    MDN

    Definition Classes
    Node
  58. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  59. def isPrototypeOf(v: Object): Boolean

    Definition Classes
    Object
  60. def isSameNode(other: Node): Boolean

    Tests whether two nodes are the same, that is they reference the same object.

    Tests whether two nodes are the same, that is they reference the same object.

    MDN

    Definition Classes
    Node
  61. def isSupported(feature: String, version: String): Boolean

    The Node.isSupported()returns a Boolean flag containing the result of a test whether the DOM implementation implements a specific feature and this feature is supported by the specific node.

    The Node.isSupported()returns a Boolean flag containing the result of a test whether the DOM implementation implements a specific feature and this feature is supported by the specific node.

    MDN

    Definition Classes
    Node
  62. def lastChild: Node

    Returns a Node representing the last direct child node of the node, or null if the node has no child.

    Returns a Node representing the last direct child node of the node, or null if the node has no child.

    MDN

    Definition Classes
    Node
  63. def lastElementChild: Element

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

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

    MDN

    Definition Classes
    ParentNode
  64. def lastModified: String

    Returns a string containing the date and time on which the current document was last modified.

    Returns a string containing the date and time on which the current document was last modified.

    MDN

  65. def localName: String

    Returns a DOMString representing the local part of the qualified name of an element.

    Returns a DOMString representing the local part of the qualified name of an element. In Firefox 3.5 and earlier, the property upper-cases the local name for HTML elements (but not XHTML elements). In later versions, this does not happen, so the property is in lower case for both HTML and XHTML. Though the specification requires localName to be defined on the Node interface, Gecko-based browsers implement it on the Element interface.

    MDN

    Definition Classes
    Node
  66. def lookupNamespaceURI(prefix: String): String

    Takes a prefix and returns the namespaceURI associated with it on the given node if found (and null if not).

    Takes a prefix and returns the namespaceURI associated with it on the given node if found (and null if not). Supplying null for the prefix will return the default namespace.

    MDN

    Definition Classes
    Node
  67. def lookupPrefix(namespaceURI: String): String

    Returns the prefix for a given namespaceURI if present, and null if not.

    Returns the prefix for a given namespaceURI if present, and null if not. When multiple prefixes are possible, the result is implementation-dependent.

    MDN

    Definition Classes
    Node
  68. def namespaceURI: String

    The namespace URI of this node, or null if it is no namespace.

    The namespace URI of this node, or null if it is no namespace. In Firefox 3.5 and earlier, HTML elements are in no namespace. In later versions, HTML elements are in the http://www.w3.org/1999/xhtml namespace in both HTML and XML trees. Though the specification requires namespaceURI to be defined on the Node interface, Gecko-based browsers implement it on the Element interface.

    MDN

    Definition Classes
    Node
  69. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  70. def nextSibling: Node

    Returns the node immediately following the specified one in its parent's childNodes list, or null if the specified node is the last node in that list.

    Returns the node immediately following the specified one in its parent's childNodes list, or null if the specified node is the last node in that list.

    MDN

    Definition Classes
    Node
  71. def nodeName: String

    Returns a DOMString containing the name of the Node.

    Returns a DOMString containing the name of the Node. The structure of the name will differ with the name type. E.g. An HTMLElement will contain the name of the corresponding tag, like 'audio' for an HTMLAudioElement, a Text node will have the '#text' string, or a Document node will have the '#document' string.

    MDN

    Definition Classes
    Node
  72. def nodeType: Int

    The read-only Node.nodeType property returns an unsigned short integer representing the type of the node.

    The read-only Node.nodeType property returns an unsigned short integer representing the type of the node.

    MDN

    Definition Classes
    Node
  73. def nodeValue: String

    Is a DOMString representing the value of an object.

    Is a DOMString representing the value of an object. For most Node type, this returns null and any set operation is ignored. For nodes of type TEXT_NODE (Text objects), COMMENT_NODE (Comment objects), and PROCESSING_INSTRUCTION_NODE (ProcessingInstruction objects), the value corresponds to the text data contained in the object.

    MDN

    Definition Classes
    Node
  74. def normalize(): Unit

    Puts the specified node and all of its subtree into a "normalized" form.

    Puts the specified node and all of its subtree into a "normalized" form. In a normalized subtree, no text nodes in the subtree are empty and there are no adjacent text nodes.

    MDN

    Definition Classes
    Node
  75. final def notify(): Unit

    Definition Classes
    AnyRef
  76. final def notifyAll(): Unit

    Definition Classes
    AnyRef
  77. def ownerDocument: Document

    Returns the Document that this node belongs to.

    Returns the Document that this node belongs to. If no document is associated with it, returns null.

    MDN

    Definition Classes
    Node
  78. def parentNode: Node

    Returns a Node that is the parent of this node.

    Returns a Node that is the parent of this node. If there is no such node, like if this node is the top of the tree or if doesn't participate in a tree, this property returns null.

    MDN

    Definition Classes
    Node
  79. var prefix: String

    Is a DOMString representing the namespace prefix of the node, or null if no prefix is specified.

    Is a DOMString representing the namespace prefix of the node, or null if no prefix is specified. Though the specification requires localName to be defined on the Node interface, Gecko-based browsers implement it on the Element interface.

    MDN

    Definition Classes
    Node
  80. def previousSibling: Node

    Returns the node immediately preceding the specified one in its parent's childNodes list, null if the specified node is the first in that list.

    Returns the node immediately preceding the specified one in its parent's childNodes list, null if the specified node is the first in that list.

    MDN

    Definition Classes
    Node
  81. def propertyIsEnumerable(v: String): Boolean

    Definition Classes
    Object
  82. def querySelector(selectors: String): Element

    Returns the first element within the document (using depth-first pre-order traversal of the document's nodes) that matches the specified group of selectors.

    Returns the first element within the document (using depth-first pre-order traversal of the document's nodes) that matches the specified group of selectors.

    MDN

    Definition Classes
    NodeSelector
  83. def querySelectorAll(selectors: String): NodeList

    Returns a list of the elements within the document (using depth-first pre-order traversal of the document's nodes) that match the specified group of selectors.

    Returns a list of the elements within the document (using depth-first pre-order traversal of the document's nodes) that match the specified group of selectors.

    MDN

    Definition Classes
    NodeSelector
  84. def removeChild(oldChild: Node): Node

    Removes a child node from the current element, which must be a child of the current node.

    Removes a child node from the current element, which must be a child of the current node.

    MDN

    Definition Classes
    Node
  85. def removeEventListener(type: String, listener: Function1[Event, _], useCapture: Boolean = js.native): Unit

    Removes the event listener previously registered with EventTarget.addEventListener.

    Removes the event listener previously registered with EventTarget.addEventListener.

    MDN

    Definition Classes
    EventTarget
  86. def replaceChild(newChild: Node, oldChild: Node): Node

    Replaces one child Node of the current one with the second one given in parameter.

    Replaces one child Node of the current one with the second one given in parameter.

    MDN

    Definition Classes
    Node
  87. def styleSheets: StyleSheetList

    Returns a list of StyleSheet objects for stylesheets explicitly linked into or embedded in a document.

    Returns a list of StyleSheet objects for stylesheets explicitly linked into or embedded in a document.

    MDN

  88. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  89. var textContent: String

    Is a DOMString representing the textual content of an element and all its descendants.

    Is a DOMString representing the textual content of an element and all its descendants.

    MDN

    Definition Classes
    Node
  90. def toLocaleString(): String

    Definition Classes
    Object
  91. def toString(): String

    Definition Classes
    AnyRef → Any
  92. def valueOf(): Any

    Definition Classes
    Object
  93. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  94. final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  95. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Deprecated Value Members

  1. def releaseCapture(): Unit

    Releases mouse capture if it's currently enabled on an element within this document.

    Releases mouse capture if it's currently enabled on an element within this document. Enabling mouse capture on an element is done by calling element.setCapture().

    MDN

    Annotations
    @deprecated
    Deprecated

    (Since version forever) Non standard.

  2. def xmlStandalone: Boolean

    Returns true if the XML declaration specifies the document is standalone (e.g., An external part of the DTD affects the document's content), else false.

    Returns true if the XML declaration specifies the document is standalone (e.g., An external part of the DTD affects the document's content), else false.

    MDN

    Annotations
    @deprecated
    Deprecated

    (Since version forever) Not supported by all browsers

Inherited from ParentNode

Inherited from DocumentEvent

Inherited from NodeSelector

Inherited from Node

Inherited from EventTarget

Inherited from Object

Inherited from Any

Inherited from AnyRef

Inherited from Any

Ungrouped