com.gargoylesoftware.htmlunit.javascript.host

Class XSLTProcessor

java.lang.Object

org.mozilla.javascript.ScriptableObject

com.gargoylesoftware.htmlunit.javascript.SimpleScriptable

com.gargoylesoftware.htmlunit.javascript.host.XSLTProcessor

All Implemented Interfaces:

Serializable, org.mozilla.javascript.ConstProperties, org.mozilla.javascript.debug.DebuggableObject, org.mozilla.javascript.Scriptable

public class XSLTProcessor
extends SimpleScriptable

A JavaScript object for XSLTProcessor.

Version:

$Revision: 2156 $

Author:

Ahmed Ashour

See Also:

Serialized Form

Field Summary

Fields inherited from class org.mozilla.javascript.ScriptableObject

CONST, DONTENUM, EMPTY, PERMANENT, READONLY, UNINITIALIZED_CONST

Fields inherited from interface org.mozilla.javascript.Scriptable

NOT_FOUND

Constructor Summary

Constructors

Constructor and Description
XSLTProcessor()

Method Summary

Methods

Modifier and Type	Method and Description
void	jsConstructor() Javascript constructor.
void	jsxFunction_addParameter(String baseName, Object parameter, Object namespaceURI) Adds parameters into an XSL Transformations (XSLT) style sheet.
Object	jsxFunction_getParameter(String namespaceURI, String localName) Gets a parameter if previously set by setParameter.
void	jsxFunction_importStylesheet(Node style) Import the stylesheet into this XSLTProcessor for transformations.
void	jsxFunction_setParameter(String namespaceURI, String localName, Object value) Sets a parameter to be used in subsequent transformations with this nsIXSLTProcessor.
void	jsxFunction_transform() Starts the transformation process or resumes a previously failed transformation.
XMLDocument	jsxFunction_transformToDocument(Node source) Transforms the node source applying the stylesheet given by the importStylesheet() function.
DocumentFragment	jsxFunction_transformToFragment(Node source, Object output) Transforms the node source applying the stylesheet given by the importStylesheet() function.
Node	jsxGet_input() Returns which XML input tree to transform.
Object	jsxGet_output() Gets a custom output to write the result of the transformation.
void	jsxSet_input(Node input) Specifies which XML input tree to transform.
void	jsxSet_output(Object output) Sets the object to which to write the output of the transformation.

Methods inherited from class com.gargoylesoftware.htmlunit.javascript.SimpleScriptable

get, getBooleanArg, getClassName, getDefaultValue, getDomNodeOrDie, getDomNodeOrNull, getIntArg, getLog, getObjectArg, getPrototype, getScriptableFor, getStartingScope, getStringArg, getTransformerScriptableFor, getWindow, getWindow, getWithPreemption, makeScriptableFor, setDomNode, setDomNode, setHtmlElement

Methods inherited from class org.mozilla.javascript.ScriptableObject

associateValue, callMethod, callMethod, defineClass, defineClass, defineClass, defineConst, defineConstProperty, defineFunctionProperties, defineProperty, defineProperty, defineProperty, defineProperty, delete, delete, deleteProperty, deleteProperty, equivalentValues, get, getAllIds, getAssociatedValue, getAttributes, getAttributes, getAttributes, getAttributes, getClassPrototype, getDefaultValue, getFunctionPrototype, getGetterOrSetter, getIds, getObjectPrototype, getParentScope, getProperty, getProperty, getPropertyIds, getPrototype, getTopLevelScope, getTopScopeValue, has, has, hasInstance, hasProperty, hasProperty, isConst, isSealed, put, put, putConst, putConstProperty, putProperty, putProperty, redefineProperty, sealObject, setAttributes, setAttributes, setAttributes, setAttributes, setGetterOrSetter, setParentScope, setPrototype

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

XSLTProcessor

public XSLTProcessor()

Method Detail

jsConstructor

public void jsConstructor()

Javascript constructor.

jsxFunction_importStylesheet

public void jsxFunction_importStylesheet(Node style)

Import the stylesheet into this XSLTProcessor for transformations.

Parameters:

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.

jsxFunction_transformToDocument

public XMLDocument jsxFunction_transformToDocument(Node source)

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

Parameters:

source - The node to be transformed.

Returns:

The result of the transformation.

jsxFunction_transformToFragment

public DocumentFragment jsxFunction_transformToFragment(Node source,
                                               Object 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.

Parameters:

source - The node to be transformed.

output - This document is used to generate the output.

Returns:

The result of the transformation.

jsxFunction_setParameter

public void jsxFunction_setParameter(String namespaceURI,
                            String localName,
                            Object 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.

Parameters:

namespaceURI - The namespaceURI of the XSLT parameter.

localName - The local name of the XSLT parameter.

value - The new value of the XSLT parameter.

jsxFunction_getParameter

public Object jsxFunction_getParameter(String namespaceURI,
                              String localName)

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

Parameters:

namespaceURI - The namespaceURI of the XSLT parameter.

localName - The local name of the XSLT parameter.

Returns:

The value of the XSLT parameter.

jsxSet_input

public void jsxSet_input(Node input)

Specifies which XML input tree to transform.

Parameters:

input - the input tree.

jsxGet_input

public Node jsxGet_input()

Returns which XML input tree to transform.

Returns:

which XML input tree to transform.

jsxSet_output

public void jsxSet_output(Object output)

Sets the object to which to write the output of the transformation.

Parameters:

output - The object to which to write the output of the transformation.

jsxGet_output

public Object jsxGet_output()

Gets a custom output to write the result of the transformation.

Returns:

the output of the transformation.

jsxFunction_addParameter

public void jsxFunction_addParameter(String baseName,
                            Object parameter,
                            Object namespaceURI)

Adds parameters into an XSL Transformations (XSLT) style sheet.

Parameters:

baseName - The name that will be used inside the style sheet to identify the parameter context.

parameter - The parameter value. To remove a parameter previously added to the processor, provide a value of Empty or Null instead.

namespaceURI - An optional namespace.

jsxFunction_transform

public void jsxFunction_transform()

Starts the transformation process or resumes a previously failed transformation.