Class AbstractScriptHandler<T>

java.lang.Object
org.mozilla.javascript.ScriptableObject
org.eclipse.birt.chart.script.AbstractScriptHandler<T>
All Implemented Interfaces:
Serializable, org.mozilla.javascript.ConstProperties, org.mozilla.javascript.debug.DebuggableObject, org.mozilla.javascript.Scriptable, org.mozilla.javascript.SymbolScriptable
Direct Known Subclasses:
ScriptHandler

public abstract class AbstractScriptHandler<T> extends org.mozilla.javascript.ScriptableObject
The abstract class defines methods to execute java function and java script functions, it makes the sub-class can execute own regular java functions and java script functions.
Since:
2.5
See Also:
  • 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
    Description
    static final String
     
    static final String
     
    static final String
     
    static final String
     
    static final String
     
    static final String
     

    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
    Description
    The constructor.
  • Method Summary

    Modifier and Type
    Method
    Description
    static final Object
    callFunction(AbstractScriptHandler<?> sh, String sFunction, Object oArg1)
    Call JavaScript functions with one argument.
    static final Object
    callFunction(AbstractScriptHandler<?> sh, String sFunction, Object oArg1, Object oArg2)
    Call JavaScript functions with two arguments.
    static final Object
    callFunction(AbstractScriptHandler<?> sh, String sFunction, Object oArg1, Object oArg2, Object oArg3)
    Call JavaScript functions with three arguments.
    final Object
    evaluate(String sScriptContent)
    Evaluates the given expression and returns the value.
    final String
     
    final org.mozilla.javascript.Scriptable
     
    final void
    init(org.mozilla.javascript.Scriptable scPrototype)
    Initialize the JavaScript context using given parent scope.
    final void
    register(String sScriptName, String sScriptContent)
    Register the script content for current script handler.
    final void
    registerExistingScriptableObject(org.mozilla.javascript.ScriptableObject so, String sVarName)
    Registers an existing scriptable object into current JavaScript context.
    final void
    registerNewScriptableObject(Class<? extends org.mozilla.javascript.Scriptable> clsScriptable, String sVarName)
    Registers a new scriptable object into current JavaScript context.
    final void
    registerVariable(String sVarName, Object var)
    Registers a new variable to current JavaScript context.
    final void
    setLocale(com.ibm.icu.util.ULocale lcl)
    Deprecated.
    Not used anymore.
    final void
    Sets the script class loader.
    void
    Sets the context object of current script handler.
    final void
    Unregister a variable from current JavaScript context.

    Methods inherited from class org.mozilla.javascript.ScriptableObject

    associateValue, avoidObjectDetection, callMethod, callMethod, defineClass, defineClass, defineClass, defineConst, defineConstProperty, defineFunctionProperties, defineOwnProperties, defineOwnProperty, defineProperty, defineProperty, defineProperty, defineProperty, defineProperty, defineProperty, delete, delete, delete, deleteProperty, deleteProperty, get, get, get, get, getAllIds, getArrayPrototype, getAssociatedValue, getAttributes, getAttributes, getAttributes, getAttributes, getAttributes, getClassPrototype, getDefaultValue, getDefaultValue, getExternalArrayData, getExternalArrayLength, getFunctionPrototype, getGeneratorFunctionPrototype, getGetterOrSetter, getGetterOrSetter, getIds, getObjectPrototype, getParentScope, getProperty, getProperty, getProperty, getPropertyIds, getPrototype, getTopLevelScope, getTopScopeValue, getTypedProperty, getTypedProperty, getTypeOf, has, has, has, hasInstance, hasProperty, hasProperty, hasProperty, isConst, isEmpty, isExtensible, isSealed, preventExtensions, put, put, put, putConst, putConstProperty, putProperty, putProperty, putProperty, redefineProperty, sealObject, setAttributes, setAttributes, setAttributes, setAttributes, setAttributes, setExternalArrayData, setGetterOrSetter, setParentScope, setPrototype, size

    Methods inherited from class java.lang.Object

    equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
  • Field Details

  • Constructor Details

    • AbstractScriptHandler

      public AbstractScriptHandler()
      The constructor.
  • Method Details

    • getClassName

      public final String getClassName()
      Specified by:
      getClassName in interface org.mozilla.javascript.Scriptable
      Specified by:
      getClassName in class org.mozilla.javascript.ScriptableObject
    • getScope

      public final org.mozilla.javascript.Scriptable getScope()
      Returns:
      returns the scope of current JavaScript context.
    • setLocale

      @Deprecated public final void setLocale(com.ibm.icu.util.ULocale lcl)
      Deprecated.
      Not used anymore. Use IChartScriptContext to store the locale now. This is kept for backward compatibility only.
      Parameters:
      lcl -
    • setScriptClassLoader

      public final void setScriptClassLoader(IScriptClassLoader value)
      Sets the script class loader. This loader is responsible to load all user defined script class.
      Parameters:
      value -
    • init

      public final void init(org.mozilla.javascript.Scriptable scPrototype) throws ChartException
      Initialize the JavaScript context using given parent scope.
      Parameters:
      scPrototype - Parent scope object. If it's null, use default scope.
      Throws:
      ChartException
    • registerExistingScriptableObject

      public final void registerExistingScriptableObject(org.mozilla.javascript.ScriptableObject so, String sVarName) throws ChartException
      Registers an existing scriptable object into current JavaScript context.
      Parameters:
      so - The existing scriptable object to be registered
      sVarName - The name of the javascript variable associated with the new scriptable object that will be added to the scope
      Throws:
      ChartException
    • registerNewScriptableObject

      public final void registerNewScriptableObject(Class<? extends org.mozilla.javascript.Scriptable> clsScriptable, String sVarName) throws ChartException
      Registers a new scriptable object into current JavaScript context.
      Parameters:
      clsScriptable - The class representing the new scriptable object to be registered
      sVarName - The name of the javascript variable associated with the new scriptable object that will be added to the scope
      Throws:
      ChartException
    • registerVariable

      public final void registerVariable(String sVarName, Object var) throws ChartException
      Registers a new variable to current JavaScript context. If the name already exists, it'll be overwritten.
      Parameters:
      sVarName -
      Throws:
      ChartException
    • unregisterVariable

      public final void unregisterVariable(String sVarName) throws ChartException
      Unregister a variable from current JavaScript context.
      Parameters:
      sVarName -
      Throws:
      ChartException
    • callFunction

      public static final Object callFunction(AbstractScriptHandler<?> sh, String sFunction, Object oArg1) throws ChartException
      Call JavaScript functions with one argument.
      Parameters:
      sh -
      sFunction -
      oArg1 -
      Throws:
      ChartException
    • callFunction

      public static final Object callFunction(AbstractScriptHandler<?> sh, String sFunction, Object oArg1, Object oArg2) throws ChartException
      Call JavaScript functions with two arguments.
      Parameters:
      sh -
      sFunction -
      oArg1 -
      oArg2 -
      Throws:
      ChartException
    • callFunction

      public static final Object callFunction(AbstractScriptHandler<?> sh, String sFunction, Object oArg1, Object oArg2, Object oArg3) throws ChartException
      Call JavaScript functions with three arguments.
      Parameters:
      sh -
      sFunction -
      oArg1 -
      oArg2 -
      oArg3 -
      Throws:
      ChartException
    • evaluate

      public final Object evaluate(String sScriptContent) throws ChartException
      Evaluates the given expression and returns the value.
      Parameters:
      sScriptContent -
      Throws:
      ChartException
    • register

      public final void register(String sScriptName, String sScriptContent) throws ChartException
      Register the script content for current script handler.
      Parameters:
      sScriptContent - This is either the JavaSciprt code content or a full class name which has implemented IChartItemScriptHandler
      Throws:
      ChartException
    • setScriptContext

      public void setScriptContext(IScriptContext csc)
      Sets the context object of current script handler.
      Parameters:
      csc -