org.scripthelper.js

Interface JSScriptable

All Superinterfaces:

org.mozilla.javascript.Scriptable

All Known Implementing Classes:

AbstractJSScriptable

public interface JSScriptable
extends org.mozilla.javascript.Scriptable

An interface allowing to define built-in function properties which can be called in the Javascript script. A scriptable is mandatory if you want to use:

• built-in properties (such as "document" for a script working on an HTML document), and methods on these properties
• built-in functions (such as "print" or "alert" for a script working on an HTML document)

Field Summary

Fields inherited from interface org.mozilla.javascript.Scriptable

NOT_FOUND

Method Summary

Modifier and Type	Method and Description
default 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.
default void	defineBuiltIntFunctions() Define the BuiltIntFunctions.
default void	defineExternalFunctions() Define the external functions.
default void	defineFunctionProperties() Define the Function Properties.
default java.lang.Object	execute(java.lang.String methodName, java.lang.Object... args) Execute a method, used for methods applied on a property in the script.
default java.lang.Class<?>[]	getDefinedClasses() Return the array of classes to be defined in the context of the wrapper.
default java.lang.Class<? extends org.mozilla.javascript.ScriptableObject>	getExecutorClass() Return the executor class, used for methods applied on properties in the script.
default ScriptableExecutor	getExecutorInstance() Return the executor.
default java.util.Map<java.lang.String,ScriptableExecutor>	getExecutorInstancesMap() Return the executors Map.
default java.util.Map<java.lang.String,java.lang.Class<? extends org.mozilla.javascript.ScriptableObject>>	getExecutorsMap() Return the executors map, used for methods applied on properties in the script.
default java.lang.String[]	getFunctionProperties() Return the array of function properties which can be called by the Javascript script.
org.mozilla.javascript.Context	getJSContext() Return Javascript context.
default java.lang.String[]	getObjectNames() Return the object properties names as it will be found in the Javascript source.
default void	jsConstructor() This Method jsConstructor is mandatory to be able to construct the Object as a javascript object.
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 contxt of the wrapper.

Methods inherited from interface org.mozilla.javascript.Scriptable

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

Method Detail

jsConstructor

default void jsConstructor()

This Method jsConstructor is mandatory to be able to construct the Object as a javascript object. However, it does nothing, and you don't have to override it.

setContext

void setContext(ScriptContext context)

Set the context of the script wrapper.

Parameters:

context -

getJSContext

org.mozilla.javascript.Context getJSContext()

Return Javascript context.

Returns:

the Javascript context

createJSContext

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

Create the Javascript context associated with this Scriptable.

Parameters:

loader - the ClassLoader

Returns:

the Javascript context

setDefinedClasses

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

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

Parameters:

classes - the classes

getDefinedClasses

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

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

Returns:

the classes

getFunctionProperties

default java.lang.String[] getFunctionProperties()

Return the array of function properties which can be called by the Javascript script. Each property must correspond to a public method defined in your class. For example, if you have the following method:

 public String[] getFunctionProperties() {
   String[] array = {"print};
   return array;
 }
 

Then you should have an associated "print " method in your JSScriptable class, for example:

 public void print(String arg) {
   context.echo(arg);
 }
 

And for example the following script will trigger the "echo" method of the context:

 execute: function() {
   print("toto");
 }
 

Returns:

the array of function properties which can be called by the Javascript script

defineBuiltIntFunctions

default void defineBuiltIntFunctions()

Define the BuiltIntFunctions. Do nothing by default.

defineFunctionProperties

default void defineFunctionProperties()

Define the Function Properties. Do nothing by default.

defineExternalFunctions

default void defineExternalFunctions()

Define the external functions. Do nothing by default.

addExternalFunction

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

Add an external function. Return false by default.

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

getObjectNames

default java.lang.String[] getObjectNames()

Return the object properties names as it will be found in the Javascript source.

Returns:

the object properties names

getExecutorClass

default java.lang.Class<? extends org.mozilla.javascript.ScriptableObject> getExecutorClass()

Return the executor class, used for methods applied on properties in the script. Return null by default. This method should be implemented if you want to provide an unique executor for all properties on the script.

Returns:

the executor class

getExecutorsMap

default java.util.Map<java.lang.String,java.lang.Class<? extends org.mozilla.javascript.ScriptableObject>> getExecutorsMap()

Return the executors map, used for methods applied on properties in the script. Return null by default. This method should be implemented if you want to provide one specific executor for each property on the script.

Returns:

the executors map

getExecutorInstance

default ScriptableExecutor getExecutorInstance()

Return the executor. Return null by default.

Returns:

the executor

getExecutorInstancesMap

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

Return the executors Map. Return null by default.

Returns:

the executor Map

execute

default java.lang.Object execute(java.lang.String methodName,
                                 java.lang.Object... args)

Execute a method, used for methods applied on a property in the script. Return null by default.

Parameters:

methodName - the methodName method name

args - the arguments

Returns:

the result