Public Member Functions

nsIDOMParser Interface Reference

The nsIDOMParser interface is a non-SAX interface that can be used to parse a string or byte stream containing XML or HTML content to a DOM document. More...

import "nsIDOMParser.idl";

List of all members.

Public Member Functions

nsIDOMDocument parseFromString (in wstring str, in string contentType)
 The string passed in is parsed into a DOM document.
nsIDOMDocument parseFromBuffer ([const, array, size_is(bufLen)] in octet buf, in PRUint32 bufLen, in string contentType)
 The buffer is parsed into a DOM document.
nsIDOMDocument parseFromStream (in nsIInputStream stream, in string charset, in long contentLength, in string contentType)
 The byte stream passed in is parsed into a DOM document.
void init (in nsIPrincipal principal, in nsIURI documentURI, in nsIURI baseURI, in nsIScriptGlobalObject scriptObject)
 Initialize the principal and document and base URIs that the parser should use for documents it creates.

Detailed Description

The nsIDOMParser interface is a non-SAX interface that can be used to parse a string or byte stream containing XML or HTML content to a DOM document.

Parsing is always synchronous - a document is always returned from the parsing methods. This is as opposed to loading and parsing with the XMLHttpRequest interface, which can be used for asynchronous (callback-based) loading.


Member Function Documentation

void nsIDOMParser::init ( in nsIPrincipal  principal,
in nsIURI  documentURI,
in nsIURI  baseURI,
in nsIScriptGlobalObject  scriptObject 
)

Initialize the principal and document and base URIs that the parser should use for documents it creates.

If this is not called, then a null principal and its URI will be used. When creating a DOMParser via the JS constructor, this will be called automatically. This method may only be called once. If this method fails, all following parse attempts will fail.

Parameters:
principal The principal to use for documents we create. If this is null, a codebase principal will be created based on documentURI; in that case the documentURI must be non-null.
documentURI The documentURI to use for the documents we create. If null, the principal's URI will be used; in that case, the principal must be non-null and its URI must be non-null.
baseURI The baseURI to use for the documents we create. If null, the documentURI will be used.
scriptObject The object from which the context for event handling can be got.
nsIDOMDocument nsIDOMParser::parseFromBuffer ( [const, array, size_is(bufLen)] in octet  buf,
in PRUint32  bufLen,
in string  contentType 
)

The buffer is parsed into a DOM document.

The charset is determined from the xml entity decl.

Parameters:
buf The octet array data to be parsed
bufLen Length (in bytes) of the data
contentType The content type of the data (see parseFromStream)
Returns:
The DOM document created as a result of parsing the string
nsIDOMDocument nsIDOMParser::parseFromStream ( in nsIInputStream  stream,
in string  charset,
in long  contentLength,
in string  contentType 
)

The byte stream passed in is parsed into a DOM document.

Not accessible from web content.

Parameters:
stream The byte stream whose contents are parsed
charset The character set that was used to encode the byte stream. NULL if not specified.
contentLength The number of bytes in the input stream.
contentType The content type of the string - either text/xml, application/xml, or application/xhtml+xml. Must not be NULL.
Returns:
The DOM document created as a result of parsing the stream
nsIDOMDocument nsIDOMParser::parseFromString ( in wstring  str,
in string  contentType 
)

The string passed in is parsed into a DOM document.

Parameters:
str The UTF16 string to be parsed
contentType The content type of the string (see parseFromStream)
Returns:
The DOM document created as a result of parsing the string

The documentation for this interface was generated from the following file: