Haxe API Documentation
Back | Index
extern class js.html.Document
extends Node
Available in js

Each web page loaded in the browser has its own document object. This object serves as an entry point to the web page's content (the DOM tree, including elements such as <body> and <table> ) and provides functionality global to the document (such as obtaining the page's URL and creating new elements in the document).

A document object can be obtained from various APIs:

Depending on the kind of the document (e.g. HTML or XML) different APIs may be available on the document object. This theoretical availability of APIs is usually described in terms of implementing interfaces defined in the relevant W3C DOM specifications:

Methods or properties listed here that are part of a more specialized interface have an asterisk (*) next to them and have additional information in the  Availability column.

Note that some APIs listed below are not available in all browsers for various reasons:

Detailed browser compatibility tables are located at the pages describing each property or method.



Documentation for this class was provided by MDN.
var URL(default,null) : String
Returns a string containing the URL of the current document.
var activeElement(default,null) : Element
Returns the currently focused element
var alinkColor : String
Returns or sets the color of active links in the document body.
var all : HTMLAllCollection
var anchors(default,null) : HTMLCollection
Returns a list of all of the anchors in the document.
var applets(default,null) : HTMLCollection
Returns an ordered list of the applets within a document.
var bgColor : String
Gets/sets the background color of the current document.
var body : Element
Returns the BODY node of the current document. Setter throws DOMException.
var characterSet(default,null) : String
Returns the character set being used by the document.
var charset : String
var compatMode(default,null) : String
Indicates whether the document is rendered in Quirks or Strict mode.
var cookie : String
Returns a semicolon-separated list of the cookies for that document or sets a single cookie. Getter throws DOMException. Setter throws DOMException.
var currentFullScreenElement(default,null) : Element
var defaultCharset(default,null) : String
var defaultView(default,null) : DOMWindow
Returns a reference to the window object.
var designMode : String
Gets/sets WYSYWIG editing capability of Midas. It can only be used for HTML documents.
var dir : String
Gets/sets directionality (rtl/ltr) of the document
var doctype(default,null) : DocumentType
Returns the Document Type Definition (DTD) of the current document.
var documentElement(default,null) : Element
Returns the Element that is a direct child of document. For HTML documents, this is normally the HTML element.
var documentURI(default,null) : String
Returns the document location.
var domain : String
Returns the domain of the current document. Setter throws DOMException.
var embeds(default,null) : HTMLCollection
Returns a list of the embedded OBJECTS within the current document.
var fgColor : String
Gets/sets the foreground color, or text color, of the current document.
var forms(default,null) : HTMLCollection
Returns a list of the FORM elements within the current document.
var fullScreenKeyboardInputAllowed(default,null) : Bool
var fullscreenElement(default,null) : Element
var fullscreenEnabled(default,null) : Bool
var head(default,null) : HeadElement
Returns the HEAD node of the current document.
var height(default,null) : Int
Gets/sets the height of the current document.
var hidden(default,null) : Bool
var images(default,null) : HTMLCollection
Returns a list of the images in the current document.
var implementation(default,null) : DOMImplementation
Returns the DOM implementation associated with the current document.
var inputEncoding(default,null) : String
Returns the encoding used when the document was parsed.
var isFullScreen(default,null) : Bool
var lastModified(default,null) : String
Returns the date on which the document was last modified.
var linkColor : String
Gets/sets the color of hyperlinks in the document.
var links(default,null) : HTMLCollection
Returns a list of all the hyperlinks in the document.
var location : Location
Returns the URI of the current document.
var onabort : EventListener
var onbeforecopy : EventListener
var onbeforecut : EventListener
var onbeforepaste : EventListener
var onblur : EventListener
var onchange : EventListener
var onclick : EventListener
var oncontextmenu : EventListener
var oncopy : EventListener
var oncut : EventListener
var ondblclick : EventListener
var ondrag : EventListener
var ondragend : EventListener
var ondragenter : EventListener
var ondragleave : EventListener
var ondragover : EventListener
var ondragstart : EventListener
var ondrop : EventListener
var onerror : EventListener
var onfocus : EventListener
var onfullscreenchange : EventListener
var onfullscreenerror : EventListener
var oninput : EventListener
var oninvalid : EventListener
var onkeydown : EventListener
var onkeypress : EventListener
var onkeyup : EventListener
var onload : EventListener
var onmousedown : EventListener
var onmousemove : EventListener
var onmouseout : EventListener
var onmouseover : EventListener
var onmouseup : EventListener
var onmousewheel : EventListener
var onpaste : EventListener
var onpointerlockchange : EventListener
var onpointerlockerror : EventListener
var onreadystatechange : EventListener
Returns the event handling code for the readystatechange event.

Gecko 9.0 note
(Firefox 9.0 / Thunderbird 9.0 / SeaMonkey 2.6)

Starting in Gecko 9.0 (Firefox 9.0 / Thunderbird 9.0 / SeaMonkey 2.6) , you can now use the syntax if ("onabort" in document) to determine whether or not a given event handler property exists. This is because event handler interfaces have been updated to be proper web IDL interfaces. See DOM event handlers for details.

var onreset : EventListener
var onscroll : EventListener
var onsearch : EventListener
var onselect : EventListener
var onselectionchange : EventListener
var onselectstart : EventListener
var onsubmit : EventListener
var ontouchcancel : EventListener
var ontouchend : EventListener
var ontouchmove : EventListener
var ontouchstart : EventListener
var plugins(default,null) : HTMLCollection
Returns a list of the available plugins.
var pointerLockElement(default,null) : Element
var preferredStylesheetSet(default,null) : String
var readyState(default,null) : String
Returns loading status of the document
var referrer(default,null) : String
Returns the URI of the page that linked to this page.
var scripts(default,null) : HTMLCollection
Returns all the <script> elements on the document.
var selectedStylesheetSet : String
var styleSheets(default,null) : StyleSheetList
Returns a list of the stylesheet objects on the current document.
var title : String
Returns the title of the current document.
var visibilityState(default,null) : String
var vlinkColor : String
Gets/sets the color of visited hyperlinks.
var width(default,null) : Int
Returns the width of the current document.
var xmlEncoding(default,null) : String
Returns the encoding as determined by the XML declaration.
Firefox 10 and later don't implement it anymore.
var xmlStandalone : Bool
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. Setter throws DOMException.
var xmlVersion : String
Returns the version number as specified in the XML declaration or "1.0" if the declaration is absent. Setter throws DOMException.
function adoptNode(source : Node) : Node
function cancelFullScreen() : Void
function captureEvents() : Void
function caretRangeFromPoint(x : Int, y : Int) : Range
function clear() : Void
function close() : Void
inline function createAnchorElement() : AnchorElement
A typed shortcut for createElement("a").
inline function createAppletElement() : AppletElement
A typed shortcut for createElement("applet").
inline function createAreaElement() : AreaElement
A typed shortcut for createElement("area").
function createAttribute(name : String) : Attr
function createAttributeNS(?namespaceURI : String, ?qualifiedName : String) : Attr
inline function createAudioElement() : AudioElement
A typed shortcut for createElement("audio").
inline function createBRElement() : BRElement
A typed shortcut for createElement("br").
inline function createBaseElement() : BaseElement
A typed shortcut for createElement("base").
inline function createBaseFontElement() : BaseFontElement
A typed shortcut for createElement("basefont").
inline function createBodyElement() : BodyElement
A typed shortcut for createElement("body").
inline function createButtonElement() : ButtonElement
A typed shortcut for createElement("button").
function createCDATASection(data : String) : CDATASection
inline function createCanvasElement() : CanvasElement
A typed shortcut for createElement("canvas").
function createComment(data : String) : Comment
inline function createContentElement() : ContentElement
A typed shortcut for createElement("content").
inline function createDListElement() : DListElement
A typed shortcut for createElement("dl").
inline function createDataListElement() : DataListElement
A typed shortcut for createElement("datalist").
inline function createDetailsElement() : DetailsElement
A typed shortcut for createElement("details").
inline function createDirectoryElement() : DirectoryElement
A typed shortcut for createElement("dir").
inline function createDivElement() : DivElement
A typed shortcut for createElement("div").
function createDocumentFragment() : DocumentFragment
function createElement(?tagName : String) : Element
function createElementNS(?namespaceURI : String, ?qualifiedName : String) : Element
inline function createEmbedElement() : EmbedElement
A typed shortcut for createElement("embed").
function createEntityReference(name : String) : EntityReference
function createEvent(eventType : String) : Event
function createExpression(expression : String, resolver : XPathNSResolver) : XPathExpression
inline function createFieldSetElement() : FieldSetElement
A typed shortcut for createElement("fieldset").
inline function createFontElement() : FontElement
A typed shortcut for createElement("font").
inline function createFormElement() : FormElement
A typed shortcut for createElement("form").
inline function createFrameElement() : FrameElement
A typed shortcut for createElement("frame").
inline function createFrameSetElement() : FrameSetElement
A typed shortcut for createElement("frameset").
inline function createHRElement() : HRElement
A typed shortcut for createElement("hr").
inline function createHeadElement() : HeadElement
A typed shortcut for createElement("head").
inline function createHtmlElement() : HtmlElement
A typed shortcut for createElement("html").
inline function createIFrameElement() : IFrameElement
A typed shortcut for createElement("iframe").
inline function createImageElement() : ImageElement
A typed shortcut for createElement("img").
inline function createInputElement() : InputElement
A typed shortcut for createElement("input").
inline function createKeygenElement() : KeygenElement
A typed shortcut for createElement("keygen").
inline function createLIElement() : LIElement
A typed shortcut for createElement("li").
inline function createLabelElement() : LabelElement
A typed shortcut for createElement("label").
inline function createLegendElement() : LegendElement
A typed shortcut for createElement("legend").
inline function createLinkElement() : LinkElement
A typed shortcut for createElement("link").
inline function createMapElement() : MapElement
A typed shortcut for createElement("map").
inline function createMarqueeElement() : MarqueeElement
A typed shortcut for createElement("marquee").
inline function createMediaElement() : MediaElement
A typed shortcut for createElement("media").
inline function createMenuElement() : MenuElement
A typed shortcut for createElement("menu").
inline function createMetaElement() : MetaElement
A typed shortcut for createElement("meta").
inline function createMeterElement() : MeterElement
A typed shortcut for createElement("meter").
inline function createModElement() : ModElement
A typed shortcut for createElement("mod").
function createNSResolver(nodeResolver : Node) : XPathNSResolver
function createNodeIterator(root : Node, whatToShow : Int, filter : NodeFilter, expandEntityReferences : Bool) : NodeIterator
inline function createOListElement() : OListElement
A typed shortcut for createElement("ol").
inline function createObjectElement() : ObjectElement
A typed shortcut for createElement("object").
inline function createOptGroupElement() : OptGroupElement
A typed shortcut for createElement("optgroup").
inline function createOptionElement() : OptionElement
A typed shortcut for createElement("option").
inline function createOutputElement() : OutputElement
A typed shortcut for createElement("output").
inline function createParagraphElement() : ParagraphElement
A typed shortcut for createElement("p").
inline function createParamElement() : ParamElement
A typed shortcut for createElement("param").
inline function createPreElement() : PreElement
A typed shortcut for createElement("pre").
function createProcessingInstruction(target : String, data : String) : ProcessingInstruction
inline function createProgressElement() : ProgressElement
A typed shortcut for createElement("progress").
inline function createQuoteElement() : QuoteElement
A typed shortcut for createElement("quote").
function createRange() : Range
inline function createScriptElement() : ScriptElement
A typed shortcut for createElement("script").
inline function createSelectElement() : SelectElement
A typed shortcut for createElement("select").
inline function createShadowElement() : ShadowElement
A typed shortcut for createElement("shadow").
inline function createSourceElement() : SourceElement
A typed shortcut for createElement("source").
inline function createSpanElement() : SpanElement
A typed shortcut for createElement("span").
inline function createStyleElement() : StyleElement
A typed shortcut for createElement("style").
inline function createTableCaptionElement() : TableCaptionElement
A typed shortcut for createElement("caption").
inline function createTableCellElement() : TableCellElement
A typed shortcut for createElement("td").
inline function createTableColElement() : TableColElement
A typed shortcut for createElement("col").
inline function createTableElement() : TableElement
A typed shortcut for createElement("table").
inline function createTableRowElement() : TableRowElement
A typed shortcut for createElement("tr").
inline function createTableSectionElement() : TableSectionElement
A typed shortcut for createElement("thead").
inline function createTextAreaElement() : TextAreaElement
A typed shortcut for createElement("textarea").
function createTextNode(data : String) : Text
inline function createTitleElement() : TitleElement
A typed shortcut for createElement("title").
function createTouch(window : DOMWindow, target : EventTarget, identifier : Int, pageX : Int, pageY : Int, screenX : Int, screenY : Int, radiusX : Int, radiusY : Int, rotationAngle : Float, force : Float) : Touch
function createTouchList() : TouchList
inline function createTrackElement() : TrackElement
A typed shortcut for createElement("track").
function createTreeWalker(root : Node, whatToShow : Int, filter : NodeFilter, expandEntityReferences : Bool) : TreeWalker
inline function createUListElement() : UListElement
A typed shortcut for createElement("ul").
inline function createVideoElement() : VideoElement
A typed shortcut for createElement("video").
function elementFromPoint(x : Int, y : Int) : Element
function evaluate(expression : String, contextNode : Node, resolver : XPathNSResolver, type : Int, inResult : XPathResult) : XPathResult
function execCommand(command : String, userInterface : Bool, ?value : String) : Bool
function exitFullscreen() : Void
function exitPointerLock() : Void
function getCSSCanvasContext(contextId : String, name : String, width : Int, height : Int) : CanvasRenderingContext
function getElementById(elementId : String) : Element
function getElementsByClassName(tagname : String) : NodeList
function getElementsByName(elementName : String) : NodeList
function getElementsByTagName(tagname : String) : NodeList
function getElementsByTagNameNS(?namespaceURI : String, localName : String) : NodeList
function getOverrideStyle(element : Element, pseudoElement : String) : CSSStyleDeclaration
function getSelection() : DOMSelection
function hasFocus() : Bool
function importNode(importedNode : Node, ?deep : Bool) : Node
function open() : Void
function queryCommandEnabled(command : String) : Bool
function queryCommandIndeterm(command : String) : Bool
function queryCommandState(command : String) : Bool
function queryCommandSupported(command : String) : Bool
function queryCommandValue(command : String) : String
function querySelector(selectors : String) : Element
function querySelectorAll(selectors : String) : NodeList
function releaseEvents() : Void
function write(text : String) : Void
function writeln(text : String) : Void
Back | Index