Package org.web3d.vrml.scripting.ecmascript

Class ECMAScriptEngine

java.lang.Object

org.web3d.vrml.scripting.ecmascript.ECMAScriptEngine

All Implemented Interfaces:

ScriptEngine

public class ECMAScriptEngine
extends Object
implements ScriptEngine

A scripting engine that provides capabilities for X3D ECMAScript.

The setup process uses delayed loading of the Javascript interpreter. It won't actually initialise Rhino until the first script wrapper needs to be built.

Version:

$Revision: 1.17 $

Author:

Justin Couch

Constructor Summary

Constructors

Constructor	Description
ECMAScriptEngine(BrowserCore browser, ViewpointManager vpm, RouteManager rm, FrameStateManager fsm, WorldLoaderManager wlm)	Construct a new script engine with a reference to the enclosing browser.

Method Summary

Modifier and Type	Method	Description
ScriptWrapper	buildWrapper(VRMLExecutionSpace space, String contentType, Object content)	Create a wrapper for the given script content.
String[]	getSupportedContentTypes()	Get a listing of the content types that this engine implementation can handle.
int	getSupportedSpecificationVersion()	Get the version of the specification that this engine implementation supports.
void	setErrorReporter(org.j3d.util.ErrorReporter reporter)	Register an error reporter with the engine so that any errors generated by the script code can be reported in a nice, pretty fashion.

Methods inherited from class java.lang.Object

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

Constructor Details

ECMAScriptEngine

public ECMAScriptEngine(BrowserCore browser,
 ViewpointManager vpm,
 RouteManager rm,
 FrameStateManager fsm,
 WorldLoaderManager wlm)

Construct a new script engine with a reference to the enclosing browser.

Parameters:

browser - The core representation of the browser

vpm - The manager for viewpoints

rm - A route manager for users creating/removing routes

fsm - The per-frame state manager

wlm - Loader for full files

Throws:

IllegalArgumentException - The browser reference is null

Method Details

getSupportedSpecificationVersion

public int getSupportedSpecificationVersion()

Get the version of the specification that this engine implementation supports. A script engine only supports a single major version of any given spec.

Specified by:

getSupportedSpecificationVersion in interface ScriptEngine

Returns:

A number greater than one indicating the supported spec.

getSupportedContentTypes

public String[] getSupportedContentTypes()

Get a listing of the content types that this engine implementation can handle.

Specified by:

getSupportedContentTypes in interface ScriptEngine

Returns:

A non-empty list of content types

buildWrapper

public ScriptWrapper buildWrapper(VRMLExecutionSpace space,
 String contentType,
 Object content)
                           throws InvalidScriptContentException

Create a wrapper for the given script content. The wrapper will be built based on the details from the mime type.

Specified by:

buildWrapper in interface ScriptEngine

Parameters:

space - The execution space this script belongs to

contentType - The MIME type of the engine

content - The actual content loaded from a stream

Returns:

An appropriate wrapper instance

Throws:

InvalidScriptContentException - The form of the content does not match the requirements of the engine.

setErrorReporter

public void setErrorReporter(org.j3d.util.ErrorReporter reporter)

Register an error reporter with the engine so that any errors generated by the script code can be reported in a nice, pretty fashion. Setting a value of null will clear the currently set reporter. If one is already set, the new value replaces the old.

Specified by:

setErrorReporter in interface ScriptEngine

Parameters:

reporter - The instance to use or null