Object AMLDocument

Represents the document in a given browser window.

Extends

AMLNode

Implements

Object AMLDocument implements following functionality: mHistory.

Members Table

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

Show inherited members (marked with *)

Show: Properties Methods Events

Attribute Readonly Description Property Type Readonly Description $model XSModel true Retrieves a reference to the XML Schema model. $time SMILTimeContainer true Retrieves a reference to the SMIL document time container. activeElement AMLElement true Retrieves a reference to an element in the document that currently has focus. attributes * AMLNamedNodeMap true A collection containing the attributes of this node (if it is an AMLElement) 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 * AMLNodeList true A NodeList that contains all direct children of this node. doctype AMLDocumentType true The Document Type Declaration associated with this document. documentElement AMLElement true Retrieves a reference to the root node of the document. domConfig AMLConfiguration true The AMLConfiguration associated with this document. firstChild * AMLNode true Retrieves a reference to the first child for the object. implementation AMLImplementation true The DOMImplementation object that handles this document. lastChild * AMLNode 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 * AMLNode 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 * AMLDocument true Retrieves the AMLDocument object associated with the node. parentNode * AMLNode true Retrieves the parent object in the object hierarchy. prefix * String true Retrieves the namespace prefix specifief for the node. previousSibling * AMLNode true Retrieves a reference to the previous child of the parent for the object. readyState String true Retrieves a value that indicates the current state of the object. Possible values: "uninitialized" - Object is not initialized with data, "loading" - Object is loading its data, "loaded" - Object has finished loading its data, "interactive" - User can interact with the object even though it is not fully loaded, "complete" - Object is completely initialized. Method Returns Description $instance AMLElement Finds corresponding to the HTML DOM element in the Ample SDK DOM. Sytaxis: object.$instance(oElement) Arguments: Name Type O/R Description oElement HTMLElement Required DOM HTML element 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(sType, fListener, bUseCapture) Arguments: Name Type O/R Description sType String Required Specifies the Event.type associated with the event for which the user is registering. fListener Function Required Function to be called when the event occurs. bUseCapture Boolean Required If true, user wishes to add the event listener for the capture phase only, if false - for target and bubbling phases. appendChild * AMLNode Appends a child element to the object. Sytaxis: object.appendChild(oElement) Arguments: Name Type O/R Description oElement AMLNode Required The node to add. canDispatch * Void Tests wether event of the specified namespace and type can be dispatched. Sytaxis: object.canDispatch(sNameSpaceURI, sType) Arguments: Name Type O/R Description sNameSpaceURI String Required NamespaceURI of the event to be tested. sType String Required Event type. cloneNode * AMLNode Creates a copy of node and returns it. Sytaxis: object.cloneNode(bDeep) Arguments: Name Type O/R Description bDeep Boolean Required Indicates wether the childnodes are also to be cloned. close Void Closes Ample SDK fragment. This method can only be called while page is loading. Sytaxis: object.close() 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(oNode) Arguments: Name Type O/R Description oNode AMLNode Required The node to compare against the reference node. createAttribute AMLAttr Creates an Attr of the given name. Sytaxis: object.createAttribute(sName) Arguments: Name Type O/R Description sName String Required The name of the attribute. createAttributeNS AMLAttr Creates an attribute of the given qualified name and namespace URI. Sytaxis: object.createAttributeNS(sNameSpaceURI, sQualifiedName) Arguments: Name Type O/R Description sNameSpaceURI String Required Namespace of the attribute to be created. sQualifiedName String Required Attr's qualified name to be created. createCDATASection AMLCDATASection Creates a AMLCDATASection node whose value is the specified string. Sytaxis: object.createCDATASection(sData) Arguments: Name Type O/R Description sData String Required The data for the node. createComment AMLComment Creates a Comment node given the specified string. Sytaxis: object.createComment(sData) Arguments: Name Type O/R Description sData String Required The data for the node. createDocumentFragment AMLDocumentFragment Creates an empty DocumentFragment object. Sytaxis: object.createDocumentFragment() createElement AMLElement Creates an element of the type specified. Sytaxis: object.createElement(sTagName) Arguments: Name Type O/R Description sTagName String Required The name of the element type to instantiate createElementNS AMLElement Creates an element of the given qualified name and namespace URI. Sytaxis: object.createElementNS(sNameSpaceURI, sQualifiedName) Arguments: Name Type O/R Description sNameSpaceURI String Required Namespace of the element to be created. sQualifiedName String Required Element's qualified name to be created. createEntityReference AMLEntityReference Creates an EntityReference object. Sytaxis: object.createEntityReference(sName) Arguments: Name Type O/R Description sName String Required The name of the entity to reference. createEvent AMLEvent Creates an instance of the AMLEvent. Sytaxis: object.createEvent(sEventType) Arguments: Name Type O/R Description sEventType String Required Type of event. createProcessingInstruction AMLProcessingInstruction Creates a ProcessingInstruction node given the specified name and data strings. Sytaxis: object.createProcessingInstruction(sTarget, sData) Arguments: Name Type O/R Description sTarget String Required The target part of the processing instruction. sData String Required The data for the node. createTextNode AMLText Creates a Text node given the specified string. Sytaxis: object.createTextNode(sData) Arguments: Name Type O/R Description sData 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(oEvent) Arguments: Name Type O/R Description oEvent AMLEvent Required The event to be dispatched. getElementById AMLElement Returns the Element that has an ID attribute with the given value. Sytaxis: object.getElementById(sId) Arguments: Name Type O/R Description sId String Required Element identifier getElementsByTagName AMLNodeList Returns a AMLNodeList of all the AMLElements in document order with a given tag name and are contained in the document. Sytaxis: object.getElementsByTagName(sTagName) Arguments: Name Type O/R Description sTagName String Required Element tag name. getElementsByTagNameNS AMLNodeList Returns a AMLNodeList of all the AMLElements with a given local name and namespace URI in document order. Sytaxis: object.getElementsByTagNameNS(sNameSpaceURI, sLocalName) Arguments: Name Type O/R Description sNameSpaceURI String Required Namespace URI. sLocalName 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 AMLNode Imports a node from another document to this document, without altering or removing the source node from the original document. Sytaxis: object.importNode(oNode, bDeep) Arguments: Name Type O/R Description oNode AMLNode Required The node to import. bDeep Boolean Required If true, recursively import the subtree under the specified node; if false, import only the node itself insertBefore * AMLNode Inserts a chlid element after the specifyed element to the object. Sytaxis: object.insertBefore(oElement, oBefore) Arguments: Name Type O/R Description oElement AMLNode Required The node to insert. oBefore AMLNode 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(sNameSpaceURI) Arguments: Name Type O/R Description sNameSpaceURI 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(sPrefix) Arguments: Name Type O/R Description sPrefix 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(sNameSpaceURI) Arguments: Name Type O/R Description sNameSpaceURI 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() open Void Opens Ample SDK fragment. This method can only be called while page is loading. Sytaxis: object.open() querySelector AMLElement Returns AMLElement that matches CSS query. Sytaxis: object.querySelector(sQuery, [fResolver]) Arguments: Name Type O/R Description sQuery String Required CSS query. fResolver Function Optional Resolver function used to resolve namespace prefixes used in query. querySelectorAll AMLNodeList Returns AMLNodeList of AMLElement that match CSS query. Sytaxis: object.querySelectorAll(sQuery, [fResolver]) Arguments: Name Type O/R Description sQuery String Required CSS query. fResolver Function Optional Resolver function used to resolve namespace prefixes used in query. removeChild * AMLNode Removes a child node from the object. Sytaxis: object.removeChild(oChild) Arguments: Name Type O/R Description oChild AMLNode Required The node being removed. removeEventListener * Void This method allows the removal of event listeners from the default group. Sytaxis: object.removeEventListener(sType, fListener, bUseCapture) Arguments: Name Type O/R Description sType String Required Specifies the Event.type for which the user registered the event listener. fListener Function Required Listener to be removed. bUseCapture Boolean Required Specifies whether the EventListener being removed was registered for the capture phase or not. replaceChild * AMLNode Replaces the given child node by another node. Sytaxis: object.replaceChild(oNew, oChild) Arguments: Name Type O/R Description oNew AMLNode Required The new node to put in the child list. oChild AMLNode 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. readystatechange - - Event Fires when the state of the object has changed. You can use the readyState property to query the current state of the element when the readystatechange event fires. 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