1.14.0.5
Hummingbird
A modern user interface library for games
Document Interface Reference

The document of the view. More...

+ Inheritance diagram for Document:

Public Member Functions

Comment createComment (DOMString data)
 Creates a new comment node. More...
 
NodeIterator createNodeIterator (Node root, optional unsigned long whatToShow=0xFFFFFFFF, optional NodeFilter? filter=null)
 
Attr createAttribute (DOMString localName)
 
Attr createAttributeNS (DOMString? namespace, DOMString qualifiedName)
 Create new attribute node with an associated namespace. More...
 
Node importNode (Node node, optional boolean deep=false)
 Creates a new copy of the specified Node or DocumentFragment from another document so that it can be inserted into the current Document. More...
 
Node createElement (CSSString tagName)
 Create a new node. More...
 
DocumentFragment createDocumentFragment ()
 Create new DocumentFragment. More...
 
CustomElementConstructor registerElement (DOMString type, optional ElementRegistrationOptions options)
 Registers a custom element with the Custom Elements V0 API (deprecated) More...
 
Node createTextNode ([Default=Undefined] optional DOMString data)
 Creates a new Text node. More...
 
Event createEvent (CSSString eventType)
 Create a new event. More...
 
NodeList getElementsByName ([Default=Undefined] optional DOMString elementName)
 Get all nodes with a certain name. More...
 
NodeList getElementsByTagName (DOMString localName)
 Get all nodes with a certain tag. More...
 
Element getElementById (DOMString elementId)
 Get a element by its Id. More...
 
boolean hasFocus ()
 Indicating whether the document or any element inside the document has focus. More...
 
NodeList getElementsByClassName (DOMString classNames)
 Get all nodes with a certain class. More...
 
- Public Member Functions inherited from Node
Node removeChild (Node oldChild)
 remove a child node More...
 
Node appendChild (Node newChild)
 append a node as a child More...
 
Node replaceChild (Node newChild, Node oldChild)
 replace oldChild with newChild More...
 
Node insertBefore (Node node, Node? referenceNode)
 insert a node before the reference node, as a child of the current node More...
 
Node cloneNode (optional boolean deep=false)
 

Public Attributes

readonly attribute USVString URL
 Returns the document location as a string.
 
readonly attribute USVString documentURI
 Returns the document location as a string.
 
readonly attribute USVString origin
 Returns the document's origin.
 
readonly attribute DOMString compatMode
 Indicates whether the document is rendered in Quirks mode or Standards mode.
 
readonly attribute DOMString characterSet
 Returns the character encoding of the current document. The character encoding is the character set used for rendering the document, which may be different from the encoding specified by the page.
 
readonly attribute DOMString charset
 historical alias of .characterSet
 
readonly attribute DOMString inputEncoding
 historical alias of .characterSet
 
readonly attribute DOMString contentType
 Returns the MIME type that the document is being rendered as.
 
readonly attribute DocumentType doctype
 Returns the Document Type Declaration (DTD) associated with current document.
 
readonly attribute Element body
 The document body.
 
readonly attribute Element documentElement
 The root element of the document.
 
readonly attribute Window defaultView
 The window object associated with the document.
 
readonly attribute Element head
 The document head element.
 
readonly attribute DOMString readyState
 Describes the loading state of the document (loading/interactive/complete)
 
readonly attribute Element activeElement
 The deepest element in the document through which or to which key events are being routed. This is, roughly speaking, the focused element in the document.
 
- Public Attributes inherited from Node
readonly attribute unsigned short nodeType
 type of the node
 
readonly attribute Node parentNode
 parent of the node
 
readonly attribute Element parentElement
 parent element of the node. If parent is not an Element, returns null.
 
readonly attribute NodeList childNodes
 list of the children of this node
 
readonly attribute Node firstChild
 the node's first child in the tree, or null if the node is childless
 
readonly attribute Node lastChild
 last child of the node, or null if there are no child elements
 
readonly attribute Node previousSibling
 the node immediately preceding the specified one in its parent's children, or null if the specified node is the first in that list
 
readonly attribute Node nextSibling
 the node immediately following the specified one in its parent's children, or null if the specified node is the last node in that list
 
readonly attribute Document ownerDocument
 The Document object associated with this node. This is also the Document object used to create new nodes. When this node is a Document or a DocumentType which is not used with any Document yet, this is null.
 
const unsigned short ELEMENT_NODE = 1
 
const unsigned short ATTRIBUTE_NODE = 2
 
const unsigned short TEXT_NODE = 3
 
const unsigned short CDATA_SECTION_NODE = 4
 
const unsigned short ENTITY_REFERENCE_NODE = 5
 
const unsigned short ENTITY_NODE = 6
 
const unsigned short PROCESSING_INSTRUCTION_NODE = 7
 
const unsigned short COMMENT_NODE = 8
 
const unsigned short DOCUMENT_NODE = 9
 
const unsigned short DOCUMENT_TYPE_NODE = 10
 
const unsigned short DOCUMENT_FRAGMENT_NODE = 11
 
const unsigned short NOTATION_NODE = 12
 
const unsigned short DOCUMENT_POSITION_DISCONNECTED = 0x01
 
const unsigned short DOCUMENT_POSITION_PRECEDING = 0x02
 
const unsigned short DOCUMENT_POSITION_FOLLOWING = 0x04
 
const unsigned short DOCUMENT_POSITION_CONTAINS = 0x08
 
const unsigned short DOCUMENT_POSITION_CONTAINED_BY = 0x10
 
const unsigned short DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC = 0x20
 

Detailed Description

The document of the view.

Member Function Documentation

◆ createAttribute()

Attr Document::createAttribute ( DOMString  localName)
Parameters
localNameis a string containing the name of the attribute.
Returns
new attribute node

◆ createAttributeNS()

Attr Document::createAttributeNS ( DOMString?  namespace,
DOMString  qualifiedName 
)

Create new attribute node with an associated namespace.

Parameters
namespacethe URI of the namespace.
qualifiedNamethe tag name and prefix of the attribute
Returns
new attribute node

◆ createComment()

Comment Document::createComment ( DOMString  data)

Creates a new comment node.

Returns
the newly created node, not attached

◆ createDocumentFragment()

DocumentFragment Document::createDocumentFragment ( )

Create new DocumentFragment.

Returns
the newly created DocumentFragment

◆ createElement()

Node Document::createElement ( CSSString  tagName)

Create a new node.

Parameters
tagNamethe type of the new node
Returns
the newly created node, not attached

◆ createEvent()

Event Document::createEvent ( CSSString  eventType)

Create a new event.

Parameters
eventTypespecified the type of Event interface to be created
Returns
the newly created Event

◆ createNodeIterator()

NodeIterator Document::createNodeIterator ( Node  root,
optional unsigned long  whatToShow = 0xFFFFFFFF,
optional NodeFilter?  filter = null 
)
Returns
a new NodeIterator object.

◆ createTextNode()

Node Document::createTextNode ( [Default=Undefined] optional DOMString  data)

Creates a new Text node.

Parameters
datathe text content of the node
Returns
the created node

◆ getElementById()

Element Document::getElementById ( DOMString  elementId)

Get a element by its Id.

Parameters
elementIdthe element id to search for
Returns
the element or null

◆ getElementsByClassName()

NodeList Document::getElementsByClassName ( DOMString  classNames)

Get all nodes with a certain class.

Parameters
classNamesthe classes to search for
Returns
NodeList of all the elements with the classes

◆ getElementsByName()

NodeList Document::getElementsByName ( [Default=Undefined] optional DOMString  elementName)

Get all nodes with a certain name.

Parameters
elementNamethe name to search for
Returns
NodeList of all the elements with the name

◆ getElementsByTagName()

NodeList Document::getElementsByTagName ( DOMString  localName)

Get all nodes with a certain tag.

Parameters
localNamethe tag to search for
Returns
NodeList of all the elements with the tag

◆ hasFocus()

boolean Document::hasFocus ( )

Indicating whether the document or any element inside the document has focus.

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

◆ importNode()

Node Document::importNode ( Node  node,
optional boolean  deep = false 
)

Creates a new copy of the specified Node or DocumentFragment from another document so that it can be inserted into the current Document.

Returns
the newly created node, not attached

◆ registerElement()

CustomElementConstructor Document::registerElement ( DOMString  type,
optional ElementRegistrationOptions  options 
)

Registers a custom element with the Custom Elements V0 API (deprecated)

Parameters
typethe name of the newly registered type
optionsthe options for registering. Must include a "prototype" property with the element prototype, and an optional "extends" property for extending existing classes
Returns
the prototype object for the newly registered element