WARNING: Most of this content (with the exception of the Mozilla 1.9 XPCOM reference) is very old, and can be expected to be out of date and possibly obsolete. For better XUL documentation, please visit the XUL hub at the Mozilla Developer Center.

XSLTProcessor

This object is available to unprivileged JavaScript. It implements the following interfaces:

Methods

void clearParameters ( ) nsIVariant getParameter ( String namespaceURI , String localName ) void importStylesheet ( Node style ) void removeParameter ( String namespaceURI , String localName ) void reset ( ) void setParameter ( String namespaceURI , String localName , nsIVariant value ) Document transformToDocument ( Node source ) DocumentFragment transformToFragment ( Node source , Document output )

void clearParameters ( )

Removes all set parameters from this nsIXSLTProcessor. This will make the processor use the default-value for all parameters as specified in the stylesheet.


nsIVariant getParameter ( String namespaceURI , String localName )

Gets a parameter if previously set by setParameter. Returns null otherwise.

Arguments:
namespaceURI: The namespaceURI of the XSLT parameter
localName: The local name of the XSLT parameter
Returns:
nsIVariant The value of the XSLT parameter

void importStylesheet ( Node style )

Import the stylesheet into this XSLTProcessor for transformations.

Arguments:
style: The root-node of a XSLT stylesheet. This can be either a document node or an element node. If a document node then the document can contain either a XSLT stylesheet or a LRE stylesheet. If the argument is an element node it must be the xsl:stylesheet (or xsl:transform) element of an XSLT stylesheet.

void removeParameter ( String namespaceURI , String localName )

Removes a parameter, if set. This will make the processor use the default-value for the parameter as specified in the stylesheet.

Arguments:
namespaceURI: The namespaceURI of the XSLT parameter
localName: The local name of the XSLT parameter

void reset ( )

Remove all parameters and stylesheets from this nsIXSLTProcessor.


void setParameter ( String namespaceURI , String localName , nsIVariant value )

Sets a parameter to be used in subsequent transformations with this nsIXSLTProcessor. If the parameter doesn't exist in the stylesheet the parameter will be ignored.

Arguments:
namespaceURI: The namespaceURI of the XSLT parameter
localName: The local name of the XSLT parameter
value: The new value of the XSLT parameter

Document transformToDocument ( Node source )

Transforms the node source applying the stylesheet given by the importStylesheet() function.

Arguments:
source: The node to be transformed
Returns:
Document The result of the transformation

DocumentFragment transformToFragment ( Node source , Document output )

Transforms the node source applying the stylesheet given by the importStylesheet() function. The owner document of the output node owns the returned document fragment.

Arguments:
source: The node to be transformed
output: This document is used to generate the output
Returns:
DocumentFragment The result of the transformation

Reference documentation is generated from Mozilla's source.