Class AbstractScriptHandler<T>

  • All Implemented Interfaces:
    java.io.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:
    Serialized Form
    • Nested Class Summary

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

        org.mozilla.javascript.ScriptableObject.KeyComparator
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods 
      Modifier and Type Method Description
      static java.lang.Object callFunction​(AbstractScriptHandler<?> sh, java.lang.String sFunction, java.lang.Object oArg1)
      Call JavaScript functions with one argument.
      static java.lang.Object callFunction​(AbstractScriptHandler<?> sh, java.lang.String sFunction, java.lang.Object oArg1, java.lang.Object oArg2)
      Call JavaScript functions with two arguments.
      static java.lang.Object callFunction​(AbstractScriptHandler<?> sh, java.lang.String sFunction, java.lang.Object oArg1, java.lang.Object oArg2, java.lang.Object oArg3)
      Call JavaScript functions with three arguments.
      java.lang.Object evaluate​(java.lang.String sScriptContent)
      Evaluates the given expression and returns the value.
      java.lang.String getClassName()  
      org.mozilla.javascript.Scriptable getScope()  
      void init​(org.mozilla.javascript.Scriptable scPrototype)
      Initialize the JavaScript context using given parent scope.
      void register​(java.lang.String sScriptName, java.lang.String sScriptContent)
      Register the script content for current script handler.
      void registerExistingScriptableObject​(org.mozilla.javascript.ScriptableObject so, java.lang.String sVarName)
      Registers an existing scriptable object into current JavaScript context.
      void registerNewScriptableObject​(java.lang.Class<? extends org.mozilla.javascript.Scriptable> clsScriptable, java.lang.String sVarName)
      Registers a new scriptable object into current JavaScript context.
      void registerVariable​(java.lang.String sVarName, java.lang.Object var)
      Registers a new variable to current JavaScript context.
      void setLocale​(com.ibm.icu.util.ULocale lcl)
      Deprecated.
      Not used anymore.
      void setScriptClassLoader​(IScriptClassLoader value)
      Sets the script class loader.
      void setScriptContext​(IScriptContext csc)
      Sets the context object of current script handler.
      void unregisterVariable​(java.lang.String sVarName)
      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, delete, delete, delete, deleteProperty, deleteProperty, get, get, get, get, getAllIds, getArrayPrototype, getAssociatedValue, getAttributes, getAttributes, getAttributes, getAttributes, getAttributes, getClassPrototype, getDefaultValue, getDefaultValue, getExternalArrayData, getExternalArrayLength, getFunctionPrototype, 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
    • Constructor Detail

      • AbstractScriptHandler

        public AbstractScriptHandler()
        The constructor.
    • Method Detail

      • getClassName

        public final java.lang.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,
                                                           java.lang.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​(java.lang.Class<? extends org.mozilla.javascript.Scriptable> clsScriptable,
                                                      java.lang.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​(java.lang.String sVarName,
                                           java.lang.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​(java.lang.String sVarName)
                                      throws ChartException
        Unregister a variable from current JavaScript context.
        Parameters:
        sVarName -
        Throws:
        ChartException
      • callFunction

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

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

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

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

        public final void register​(java.lang.String sScriptName,
                                   java.lang.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 -