Class Document

Represents the Ample SDK document created out of all Ample SDK fragments found on the page.

Extends

Node

Members Table

The following table lists the members exposed by the Document object.

Show inherited members (marked with *)

Show: Properties Methods Events

Attribute Description Property Type Readonly Description attributes * Object true A collection containing the attributes of this node (if it is an Element) or null otherwise. baseURI * String true The absolute base URI of this node or null if the implementation wasn't able to obtain an absolute URI. childNodes * NodeList true A NodeList that contains all direct children of this node. doctype DocumentType true The Document Type Declaration associated with this document. documentElement Element true Retrieves a reference to the root node of the document. domConfig DOMConfiguration true The DOMConfiguration associated with this document. firstChild * Node true Retrieves a reference to the first child for the object. implementation DOMImplementation true The DOMImplementation object that handles this document. lastChild * Node true Retrieves a reference to the last child for the object. localName * String true Retrieves the local name of node. namespaceURI * String true Retrieves the namespace URI. nextSibling * Node true Retrieves a reference to the next child of the parent for the object. nodeName * String true Retrieves the name of a particular type of node. nodeType * Number true Retrieves the type of the requested node. nodeValue * String true Retrieves the value of a node. ownerDocument * Document true Retrieves the Document object associated with the node. parentNode * Node true Retrieves the parent object in the object hierarchy. prefix * String true Retrieves the namespace prefix specifief for the node. previousSibling * Node true Retrieves a reference to the previous child of the parent for the object. Method Returns Description addEventListener * Void This method allows the registration of an event listener in the default group and, depending on the useCapture parameter, on the capture phase of the DOM event flow or its target and bubbling phases. Sytaxis: object.addEventListener(type, listener, useCapture) Arguments: Name Type O/R Description type String Required Specifies the Event.type associated with the event for which the user is registering. listener Function Required Function to be called when the event occurs. useCapture Boolean Required If true, user wishes to add the event listener for the capture phase only, if false - for target and bubbling phases. appendChild * Node Appends a child element to the object. Sytaxis: object.appendChild(node) Arguments: Name Type O/R Description node Node Required The node to add. canDispatch * Void Tests wether event of the specified namespace and type can be dispatched. Sytaxis: object.canDispatch(namespaceURI, type) Arguments: Name Type O/R Description namespaceURI String Required NamespaceURI of the event to be tested. type String Required Event type. cloneNode * Node Creates a copy of node and returns it. Sytaxis: object.cloneNode(deep) Arguments: Name Type O/R Description deep Boolean Required Indicates wether the childnodes are also to be cloned. compareDocumentPosition * Number Compares the reference node, i.e. the node on which this method is being called, with a node, i.e. the one passed as a parameter, with regard to their position in the document and according to the document order. Sytaxis: object.compareDocumentPosition(node) Arguments: Name Type O/R Description node Node Required The node to compare against the reference node. createAttribute Attr Creates an Attr of the given name. Sytaxis: object.createAttribute(name) Arguments: Name Type O/R Description name String Required The name of the attribute. createAttributeNS Attr Creates an attribute of the given qualified name and namespace URI. Sytaxis: object.createAttributeNS(namespaceURI, QName) Arguments: Name Type O/R Description namespaceURI String Required Namespace of the attribute to be created. QName String Required Attr's qualified name to be created. createCDATASection CDATASection Creates a CDATASection node whose value is the specified string. Sytaxis: object.createCDATASection(data) Arguments: Name Type O/R Description data String Required The data for the node. createComment Comment Creates a Comment node given the specified string. Sytaxis: object.createComment(data) Arguments: Name Type O/R Description data String Required The data for the node. createDocumentFragment DocumentFragment Creates an empty DocumentFragment object. Sytaxis: object.createDocumentFragment() createElement Element Creates an element of the type specified. Sytaxis: object.createElement(name) Arguments: Name Type O/R Description name String Required The name of the element type to instantiate createElementNS Element Creates an element of the given qualified name and namespace URI. Sytaxis: object.createElementNS(namespaceURI, QName) Arguments: Name Type O/R Description namespaceURI String Required Namespace of the element to be created. QName String Required Element's qualified name to be created. createEntityReference EntityReference Creates an EntityReference object. Sytaxis: object.createEntityReference(name) Arguments: Name Type O/R Description name String Required The name of the entity to reference. createEvent Event Creates an event object with the interface name specified. Creates an event object with the interface name specified. Sytaxis: object.createEvent(eventInterface) Arguments: Name Type O/R Description eventInterface String Required The name of the interface to be supported by the created event object. The name of the interface to be supported by the created event object. createProcessingInstruction ProcessingInstruction Creates a ProcessingInstruction node given the specified name and data strings. Sytaxis: object.createProcessingInstruction(target, data) Arguments: Name Type O/R Description target String Required The target part of the processing instruction. data String Required The data for the node. createTextNode Text Creates a Text node given the specified string. Sytaxis: object.createTextNode(data) Arguments: Name Type O/R Description data String Required The data for the node. dispatchEvent * Boolean This method allows the dispatch of events into the implementation's event model. Return value indicates whether any of the listeners which handled the event called preventDefault method on Event object. Sytaxis: object.dispatchEvent(event) Arguments: Name Type O/R Description event Event Required The event to be dispatched. getElementById Element Returns the Element that has an ID attribute with the given value. Sytaxis: object.getElementById(id) Arguments: Name Type O/R Description id String Required Element identifier getElementsByTagName NodeList Returns a NodeList of all the Elements in document order with a given tag name and are contained in the document. Sytaxis: object.getElementsByTagName(name) Arguments: Name Type O/R Description name String Required Element tag name. getElementsByTagNameNS NodeList Returns a NodeList of all the Elements with a given local name and namespace URI in document order. Sytaxis: object.getElementsByTagNameNS(namespaceURI, localName) Arguments: Name Type O/R Description namespaceURI String Required Namespace URI. localName String Required Local name. hasAttributes * Boolean Retrieves true if the node has any attributes. Sytaxis: object.hasAttributes() hasChildNodes * Boolean Returns a value that indicates whether the object has children. Sytaxis: object.hasChildNodes() importNode Node Imports a node from another document to this document, without altering or removing the source node from the original document. Sytaxis: object.importNode(node, deep) Arguments: Name Type O/R Description node Node Required The node to import. deep Boolean Required If true, recursively import the subtree under the specified node; if false, import only the node itself insertBefore * Node Inserts a chlid element after the specifyed element to the object. Sytaxis: object.insertBefore(node, before) Arguments: Name Type O/R Description node Node Required The node to insert. before Node Required The reference node, i.e., the node before which the new node must be inserted. isDefaultNamespace * String This method checks if the specified namespaceURI is the default namespace or not. Sytaxis: object.isDefaultNamespace(namespaceURI) Arguments: Name Type O/R Description namespaceURI String Required The namespace URI to look for. lookupNamespaceURI * String Look up the namespace URI associated to the given prefix, starting from this node. Sytaxis: object.lookupNamespaceURI(prefix) Arguments: Name Type O/R Description prefix String Required The prefix to look for. If this parameter is null, the method will return the default namespace URI if any. lookupPrefix * String Look up the prefix associated to the given namespace URI, starting from this node. Sytaxis: object.lookupPrefix(namespaceURI) Arguments: Name Type O/R Description namespaceURI String Required The namespace URI to look for. normalize * Void Puts all Text nodes in the full depth of the sub-tree underneath this Node, including attribute nodes, into a "normal" form Sytaxis: object.normalize() querySelector Element Returns Element that matches CSS query. Sytaxis: object.querySelector(selector, [NSResolver]) Arguments: Name Type O/R Description selector String Required CSS query. NSResolver Function Optional Resolver function used to resolve namespace prefixes used in query. querySelectorAll NodeList Returns NodeList of Element that match CSS query. Sytaxis: object.querySelectorAll(selector, [NSResolver]) Arguments: Name Type O/R Description selector String Required CSS query. NSResolver Function Optional Resolver function used to resolve namespace prefixes used in query. removeChild * Node Removes a child node from the object. Sytaxis: object.removeChild(child) Arguments: Name Type O/R Description child Node Required The node being removed. removeEventListener * Void This method allows the removal of event listeners from the default group. Sytaxis: object.removeEventListener(type, listener, useCapture) Arguments: Name Type O/R Description type String Required Specifies the Event.type for which the user registered the event listener. listener Function Required Listener to be removed. useCapture Boolean Required Specifies whether the EventListener being removed was registered for the capture phase or not. replaceChild * Node Replaces the given child node by another node. Sytaxis: object.replaceChild(new, child) Arguments: Name Type O/R Description new Node Required The new node to put in the child list. child Node Required The node being replaced in the list. toXML * String Serializes Node to string. Sytaxis: object.toXML() Event B C Interface Description DOMNodeInserted * + - MutationEvent A node has been added as a child of another node or, in case of Attr nodes, has been added to an Element. DOMNodeInsertedIntoDocument * - - MutationEvent A node has been inserted into a document. DOMNodeRemoved * + - MutationEvent A node is being removed from its parent node or, in case of Attr nodes, removed from its ownerElement. DOMNodeRemovedFromDocument * - - MutationEvent A node is being removed from a document. abort + - Event The loading of the document, or a resource linked from it, is stopped before being entirely loaded. error + - Event A resource failed to load, or has been loaded but cannot be interpreted according to its semantics such as an invalid image, a script execution error, or non-well-formed XML. load - - Event Fires immediately after the engine loads the object. resize + - UIEvent A document view has been resized. scroll + - UIEvent A document view has been scrolled. unload - - Event Fires immediately before the object is unloaded. Pseudo-class Description Constant Value Description