class Document

Event type published when an error occurs during the asynchronous loading of a document.

Event type published when an asynchronous load operation has completed successfully.

Event type published when an asynchronous load times out before loading.

Namespace to use when querying against the namespace axis in firefox

Prefix to use when querying against the namespace axis in firefox

The instance initializer. If an error occurs while instantiating the native browser XML document class, this method sets the error property of this document and returns quietly.

Creates a new node that is an exact clone of this node; returns the newly cloned node wrapped in a jsx3.xml.Entity instance

Creates a new root node on an empty document.

Usage:

var objDoc = new jsx3.xml.Document();
objDoc.createDocumentElement("myRoot");

The Firefox implementation of the XSLT specification does not implement a searchable namespace axis. To overcome this limitation, this method can be called to create a searchable equivalent that is part of the attribute axis. After XML content has been loaded, call this method before calling any other methods on the Document instance in order to ensure proper functioning of subsequent calls. The document can then be queried, using valid XPath syntax to discover the declared namespaces. However, instead of using namespace::xsd, the relevant query would be attribute::jsx_xmlns:xsd, where jsx_xmlns:xsd would resolve to the universal name, {http://xsd.tns.tibco.com/gi/cxf/2006}:xsd. Following this call with getDeclaredNamespaces is useful to resolve the prefix actually used, providing a reverse-lookup to resolve the actual prefix being used. For example, assume objMap is the return object when calling getDeclaredNamespaces. In such a case, the following query can be used to locate the URI for a given namespace prefix, even though Firefox does not support such a construct:

var objMap = someDoc.getDeclaredNamespaces();
var myXpathQuery = "ancestor-or-self::*[attribute::" +
  objMap[jsx3.xml.Document.SEARCHABLE_NAMESPACE] +  ":xsd]/attribute::" +
  objMap[jsx3.xml.Document.SEARCHABLE_NAMESPACE] + ":xsd";
var objNode = someNode.selectSingleNode(myXpathQuery,objMap);

Creates a processing instruction node that containing the target and data information. Note that you cannot specify a namespace with this method.

Usage:

[document].createProcessingInstruction("xml","version=\"1.0\" encoding=\"UTF-8\"");
[document].createDocumentElement("myRoot");

Returns whether this document loads asynchronously.

Returns a map of all implemented namespaces in the following format: {some_uri:"jsx1",some_other_uri,"jsx2",another_uri:"jsx3"}.
The returned object map can then be used to resolve the qualified name (QName) for the nodes in a given query via a reverse lookup. For example:

//open an XML Document (just use one of the sample prototypes that ships with Builder)
var objXML = new jsx3.xml.Document();
objXML.load("GI_Builder/prototypes/Block/Text.xml");
//get an object map of all known selection namespaces
var objMap = objXML.getDeclaredNamespaces();
//construct a qualified query (Note that all nodes in a GI serialization file belong to the namespace, 'urn:tibco.com/v3.0')
var myQualifiedQuery = "//" + objMap["urn:tibco.com/v3.0"] + ":object";
//query the document for the given node.
var objNode = objXML.selectSingleNode(myQualifiedQuery,objMap);
//alert the return
alert(objNode);

Returns the native XML parser

Returns whether or not the parser should resolve externally referenced entities. The default setting is false;

Gets the selection language to use for selection queries (i.e., selectSingleNode/selectNodes); The default is XSLPattern;

Gets a list of namespace prefixes and their associated URIs. This allows any code to generically prefix name-space qualified nodes and still get the correct selection result

Returns whether or not the parser should validate the XML content during the initial parse. The default setting is false;

gets the release/build for the class (i.e., "2.2.00")

Loads an XML document at the URL specified by the strURL parameter. If an error occurs while loading the XML document, this method sets the error property of this document and returns quietly. If this document loads synchronously, the results of the load will be available immediately after the call to this method. Otherwise, this document publishes events through the EventDispatcher interface to notify the client that loading has completed.

Loads an XML document from a string containing the XML source. If an error occurs while loading the XML document, this method sets the error property of this document and returns quietly. Loading an XML document from a string always happens synchronously regardless of the value of the async property of this document.

Sets whether this document loads asynchronously. The default is to load synchronously. If this document loads asynchronously, it publishes the events ON_RESPONSE, ON_ERROR, and ON_TIMEOUT to notify the client that loading has finished.

Sets whether or not the parser should resolve externally referenced entities.

Sets the selection language to use for selection queries (i.e., selectSingleNode/selectNodes); The default is XSLPattern;

Sets a list of namespace prefixes and their associated URIs. This allows any code to generically prefix name-space qualified nodes and still get the correct selection result

Sets whether or not the parser should validate the XML content during the initial parse.