org.scripthelper.js

Class AbstractJSScriptable

java.lang.Object

org.mozilla.javascript.ScriptableObject

org.scripthelper.js.AbstractJSScriptable

All Implemented Interfaces:

java.io.Serializable, org.mozilla.javascript.ConstProperties, org.mozilla.javascript.debug.DebuggableObject, org.mozilla.javascript.Scriptable, org.mozilla.javascript.SymbolScriptable, JSScriptable

public abstract class AbstractJSScriptable
extends org.mozilla.javascript.ScriptableObject
implements JSScriptable

A class allowing to define built-in function properties which can be called in the Javascript script.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.mozilla.javascript.ScriptableObject

org.mozilla.javascript.ScriptableObject.KeyComparator

Field Summary

Fields

Modifier and Type	Field and Description
protected ScriptContext	context The context of the script wrapper.
protected org.mozilla.javascript.Context	ctx The Rhino Javascript context.
protected java.util.Map<CachedMethodKey,java.lang.reflect.Method>	functions The declared functions.

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
AbstractJSScriptable()

Method Summary

Modifier and Type	Method and Description
boolean	addExternalFunction(CachedMethodKey key, java.lang.String methodName, ScriptWrapper wrapper) Add an external function.
org.mozilla.javascript.Context	createJSContext(java.lang.ClassLoader loader) Create the Javascript context associated with this Scriptable.
void	defineBuiltIntFunctions() Define the BuiltIntFunctions.
void	defineExternalFunctions() Define the custom functions.
void	defineFunctionProperties() Define the Function Properties.
java.lang.String	getClassName()
java.lang.Class<?>[]	getDefinedClasses() Return the array of classes to be defined in the context of the wrapper.
ScriptableExecutor	getExecutorInstance() Return the executor.
java.util.Map<java.lang.String,ScriptableExecutor>	getExecutorInstancesMap() Return the executors Map.
org.mozilla.javascript.Context	getJSContext() Return Javascript context.
void	jsFunction_call(java.lang.Object o)
java.lang.Object	runScriptMethod(java.lang.String name, java.lang.Object arg) Execute a custom method originating from another Script.
void	setContext(ScriptContext context) Set the context of the script wrapper.
void	setDefinedClasses(java.lang.Class<?>... classes) Set an array of classes to be defined in the context of the wrapper.

Methods inherited from class org.mozilla.javascript.ScriptableObject

applyDescriptorToAttributeBitset, associateValue, avoidObjectDetection, buildDataDescriptor, callMethod, callMethod, checkPropertyChange, checkPropertyDefinition, defineClass, defineClass, defineClass, defineConst, defineConstProperty, defineFunctionProperties, defineOwnProperties, defineOwnProperty, defineOwnProperty, defineProperty, defineProperty, defineProperty, defineProperty, defineProperty, defineProperty, defineProperty, delete, delete, delete, deleteProperty, deleteProperty, ensureScriptable, ensureScriptableObject, ensureSymbolScriptable, equivalentValues, get, get, get, get, getAllIds, getArrayPrototype, getAssociatedValue, getAttributes, getAttributes, getAttributes, getAttributes, getAttributes, getClassPrototype, getDefaultValue, getDefaultValue, getExternalArrayData, getExternalArrayLength, getFunctionPrototype, getGeneratorFunctionPrototype, getGetterOrSetter, getGetterOrSetter, getIds, getObjectPrototype, getOwnPropertyDescriptor, getParentScope, getProperty, getProperty, getProperty, getPropertyIds, getPrototype, getTopLevelScope, getTopScopeValue, getTypedProperty, getTypedProperty, getTypeOf, has, has, has, hasInstance, hasProperty, hasProperty, hasProperty, isAccessorDescriptor, isConst, isDataDescriptor, isEmpty, isExtensible, isFalse, isGenericDescriptor, isGetterOrSetter, isSealed, isTrue, preventExtensions, put, put, put, putConst, putConstProperty, putProperty, putProperty, putProperty, querySlot, redefineProperty, sameValue, sealObject, setAttributes, setAttributes, setAttributes, setAttributes, setAttributes, setCommonDescriptorProperties, setExternalArrayData, setGetterOrSetter, setParentScope, setPrototype, size

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.scripthelper.js.JSScriptable

execute, getExecutorClass, getExecutorsMap, getFunctionProperties, getObjectNames, jsConstructor

Methods inherited from interface org.mozilla.javascript.Scriptable

delete, delete, get, get, getDefaultValue, getIds, getParentScope, getPrototype, has, has, hasInstance, put, put, setParentScope, setPrototype

Field Detail

functions

protected java.util.Map<CachedMethodKey,java.lang.reflect.Method> functions

The declared functions.

context

protected ScriptContext context

The context of the script wrapper.

ctx

protected org.mozilla.javascript.Context ctx

The Rhino Javascript context.

Constructor Detail

AbstractJSScriptable

public AbstractJSScriptable()

Method Detail

setContext

public void setContext(ScriptContext context)

Set the context of the script wrapper.

Specified by:

setContext in interface JSScriptable

Parameters:

context -

getJSContext

public org.mozilla.javascript.Context getJSContext()

Return Javascript context.

Specified by:

getJSContext in interface JSScriptable

Returns:

the Javascript context

createJSContext

public org.mozilla.javascript.Context createJSContext(java.lang.ClassLoader loader)

Create the Javascript context associated with this Scriptable.

Specified by:

createJSContext in interface JSScriptable

Parameters:

loader - the ClassLoader

Returns:

the Javascript context

setDefinedClasses

public void setDefinedClasses(java.lang.Class<?>... classes)

Set an array of classes to be defined in the context of the wrapper.

Specified by:

setDefinedClasses in interface JSScriptable

Parameters:

classes - the classes

getDefinedClasses

public java.lang.Class<?>[] getDefinedClasses()

Return the array of classes to be defined in the context of the wrapper.

Specified by:

getDefinedClasses in interface JSScriptable

Returns:

the classes

addExternalFunction

public boolean addExternalFunction(CachedMethodKey key,
                                   java.lang.String methodName,
                                   ScriptWrapper wrapper)

Add an external function.

Specified by:

addExternalFunction in interface JSScriptable

Parameters:

key - the function key

methodName - the method name to call in the ScriptWrapper

wrapper - the associated ScriptWrapper

Returns:

true if the method could be found in the ScriptWrapper

getClassName

public java.lang.String getClassName()

Specified by:

getClassName in interface org.mozilla.javascript.Scriptable

Specified by:

getClassName in class org.mozilla.javascript.ScriptableObject

getExecutorInstance

public ScriptableExecutor getExecutorInstance()

Return the executor. Return null by default.

Specified by:

getExecutorInstance in interface JSScriptable

Returns:

the executor

getExecutorInstancesMap

public java.util.Map<java.lang.String,ScriptableExecutor> getExecutorInstancesMap()

Return the executors Map. Return null by default.

Specified by:

getExecutorInstancesMap in interface JSScriptable

Returns:

the executor Map

defineExternalFunctions

public void defineExternalFunctions()

Define the custom functions.

Specified by:

defineExternalFunctions in interface JSScriptable

defineFunctionProperties

public void defineFunctionProperties()

Description copied from interface: JSScriptable

Define the Function Properties. Do nothing by default.

Specified by:

defineFunctionProperties in interface JSScriptable

jsFunction_call

public void jsFunction_call(java.lang.Object o)

defineBuiltIntFunctions

public void defineBuiltIntFunctions()

Define the BuiltIntFunctions.

Specified by:

defineBuiltIntFunctions in interface JSScriptable

runScriptMethod

public java.lang.Object runScriptMethod(java.lang.String name,
                                        java.lang.Object arg)

Execute a custom method originating from another Script.

Parameters:

name - the name of the method to call

arg - the argument of the call.

Returns:

the result of the method call