|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.mozilla.javascript.ScriptableObject
org.eclipse.birt.chart.script.ScriptHandler
public final class ScriptHandler
This class forms the basis of script handling in the charting library. It creates a default scope and/or subclasses from a predefined scope. It also provides convenience methods for execution of functions defined in the scope.
IChartEventHandler
,
Serialized FormField Summary | |
---|---|
static java.lang.String |
AFTER_COMPUTATIONS
Deprecated. This is kept for backward compatibility only. |
static java.lang.String |
AFTER_DATA_SET_FILLED
|
static java.lang.String |
AFTER_DRAW_AXIS_LABEL
|
static java.lang.String |
AFTER_DRAW_AXIS_TITLE
|
static java.lang.String |
AFTER_DRAW_BLOCK
|
static java.lang.String |
AFTER_DRAW_DATA_POINT
|
static java.lang.String |
AFTER_DRAW_DATA_POINT_LABEL
|
static java.lang.String |
AFTER_DRAW_ELEMENT
Deprecated. This is kept for backward compatibility only. |
static java.lang.String |
AFTER_DRAW_FITTING_CURVE
|
static java.lang.String |
AFTER_DRAW_LEGEND_ENTRY
Deprecated. This is kept for backward compatibility only. |
static java.lang.String |
AFTER_DRAW_LEGEND_ITEM
|
static java.lang.String |
AFTER_DRAW_MARKER
|
static java.lang.String |
AFTER_DRAW_MARKER_LINE
|
static java.lang.String |
AFTER_DRAW_MARKER_RANGE
|
static java.lang.String |
AFTER_DRAW_SERIES
|
static java.lang.String |
AFTER_DRAW_SERIES_TITLE
|
static java.lang.String |
AFTER_GENERATION
|
static java.lang.String |
AFTER_LAYOUT
Deprecated. This is kept for backward compatibility only. |
static java.lang.String |
AFTER_RENDERING
|
static java.lang.String |
BASE_VALUE
The pre-defined chart variable name to access base category data. |
static java.lang.String |
BEFORE_COMPUTATIONS
Deprecated. This is kept for backward compatibility only. |
static java.lang.String |
BEFORE_DATA_SET_FILLED
|
static java.lang.String |
BEFORE_DRAW_AXIS_LABEL
|
static java.lang.String |
BEFORE_DRAW_AXIS_TITLE
|
static java.lang.String |
BEFORE_DRAW_BLOCK
|
static java.lang.String |
BEFORE_DRAW_DATA_POINT
|
static java.lang.String |
BEFORE_DRAW_DATA_POINT_LABEL
|
static java.lang.String |
BEFORE_DRAW_ELEMENT
Deprecated. This is kept for backward compatibility only. |
static java.lang.String |
BEFORE_DRAW_FITTING_CURVE
|
static java.lang.String |
BEFORE_DRAW_LEGEND_ENTRY
Deprecated. This is kept for backward compatibility only. |
static java.lang.String |
BEFORE_DRAW_LEGEND_ITEM
|
static java.lang.String |
BEFORE_DRAW_MARKER
|
static java.lang.String |
BEFORE_DRAW_MARKER_LINE
|
static java.lang.String |
BEFORE_DRAW_MARKER_RANGE
|
static java.lang.String |
BEFORE_DRAW_SERIES
|
static java.lang.String |
BEFORE_DRAW_SERIES_TITLE
|
static java.lang.String |
BEFORE_GENERATION
|
static java.lang.String |
BEFORE_LAYOUT
Deprecated. This is kept for backward compatibility only. |
static java.lang.String |
BEFORE_RENDERING
|
static java.lang.String |
FINISH_COMPUTE_SERIES
Deprecated. This is kept for backward compatibility only. |
static java.lang.String |
FINISH_GENERATION
Deprecated. This is kept for backward compatibility only. |
static java.lang.String |
FINISH_RENDERING
Deprecated. This is kept for backward compatibility only. |
static java.lang.String |
ORTHOGONAL_VALUE
The pre-defined chart variable name to access orthogonal value data. |
static java.lang.String |
SERIES_VALUE
The pre-defined chart variable name to access series value data. |
static java.lang.String |
START_COMPUTE_SERIES
Deprecated. This is kept for backward compatibility only. |
static java.lang.String |
START_GENERATION
Deprecated. This is kept for backward compatibility only. |
static java.lang.String |
START_RENDERING
Deprecated. This is kept for backward compatibility only. |
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 | |
---|---|
ScriptHandler()
The constructor. |
Method Summary | |
---|---|
static java.lang.Object |
callFunction(ScriptHandler sh,
java.lang.String sFunction,
java.lang.Object oArg1)
Call JavaScript functions with one argument. |
static java.lang.Object |
callFunction(ScriptHandler sh,
java.lang.String sFunction,
java.lang.Object oArg1,
java.lang.Object oArg2)
Call JavaScript functions with two arguments. |
static java.lang.Object |
callFunction(ScriptHandler 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. |
java.lang.Object |
jsFunction_clone(java.lang.Object eo)
Deprecated. Note used anymore. This is kept for backward compatibility only. |
java.lang.Object |
jsFunction_getDesignTimeModel()
Deprecated. Not used anymore. This is kept for backward compatibility only. |
java.lang.Object |
jsFunction_getGeneratedChartState()
Deprecated. Not used anymore. This is kept for backward compatibility only. |
java.lang.Object |
jsFunction_getLocale()
Deprecated. Call IChartScriptContext.getLocale() instead. This is kept for backward compatibility only. |
java.lang.Object |
jsFunction_getRunTimeModel()
Deprecated. Call IChartScriptContext.getChartInstance() instead. This is kept for backward compatibility only. |
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 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 |
setDesignTimeModel(Chart cmDesignTime)
Deprecated. Not used anymore. This is kept for backward compatibility only. |
void |
setGeneratedChartState(GeneratedChartState gcs)
Deprecated. Not used anymore. This is kept for backward compatibility only. |
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. |
void |
setRunTimeModel(Chart cmRunTime)
Deprecated. Not used anymore. Use IChartScriptContext to store the run-time model now. This is kept for backward compatibility only. |
void |
setScriptClassLoader(IScriptClassLoader value)
Sets the script class loader. |
void |
setScriptContext(IChartScriptContext 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, callMethod, callMethod, defineClass, defineClass, defineClass, defineConst, defineConstProperty, defineFunctionProperties, defineProperty, defineProperty, defineProperty, defineProperty, delete, delete, deleteProperty, deleteProperty, get, get, getAllIds, getAssociatedValue, getAttributes, getAttributes, getAttributes, getAttributes, getClassPrototype, getDefaultValue, getDefaultValue, getFunctionPrototype, getGetterOrSetter, getIds, getObjectPrototype, getParentScope, getProperty, getProperty, getPropertyIds, getPrototype, getTopLevelScope, getTopScopeValue, has, has, hasInstance, hasProperty, hasProperty, isConst, isSealed, put, put, putConst, putConstProperty, putProperty, putProperty, redefineProperty, sealObject, setAttributes, setAttributes, setAttributes, setAttributes, setGetterOrSetter, setParentScope, setPrototype |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String START_GENERATION
public static final java.lang.String FINISH_GENERATION
public static final java.lang.String BEFORE_LAYOUT
public static final java.lang.String AFTER_LAYOUT
public static final java.lang.String BEFORE_COMPUTATIONS
public static final java.lang.String AFTER_COMPUTATIONS
public static final java.lang.String START_RENDERING
public static final java.lang.String FINISH_RENDERING
public static final java.lang.String START_COMPUTE_SERIES
public static final java.lang.String FINISH_COMPUTE_SERIES
public static final java.lang.String BEFORE_DRAW_ELEMENT
public static final java.lang.String AFTER_DRAW_ELEMENT
public static final java.lang.String BEFORE_DATA_SET_FILLED
public static final java.lang.String AFTER_DATA_SET_FILLED
public static final java.lang.String BEFORE_GENERATION
public static final java.lang.String AFTER_GENERATION
public static final java.lang.String BEFORE_RENDERING
public static final java.lang.String AFTER_RENDERING
public static final java.lang.String BEFORE_DRAW_BLOCK
public static final java.lang.String AFTER_DRAW_BLOCK
public static final java.lang.String BEFORE_DRAW_LEGEND_ENTRY
public static final java.lang.String AFTER_DRAW_LEGEND_ENTRY
public static final java.lang.String BEFORE_DRAW_LEGEND_ITEM
public static final java.lang.String AFTER_DRAW_LEGEND_ITEM
public static final java.lang.String BEFORE_DRAW_SERIES
public static final java.lang.String AFTER_DRAW_SERIES
public static final java.lang.String BEFORE_DRAW_SERIES_TITLE
public static final java.lang.String AFTER_DRAW_SERIES_TITLE
public static final java.lang.String BEFORE_DRAW_MARKER
public static final java.lang.String AFTER_DRAW_MARKER
public static final java.lang.String BEFORE_DRAW_MARKER_LINE
public static final java.lang.String AFTER_DRAW_MARKER_LINE
public static final java.lang.String BEFORE_DRAW_MARKER_RANGE
public static final java.lang.String AFTER_DRAW_MARKER_RANGE
public static final java.lang.String BEFORE_DRAW_DATA_POINT
public static final java.lang.String AFTER_DRAW_DATA_POINT
public static final java.lang.String BEFORE_DRAW_DATA_POINT_LABEL
public static final java.lang.String AFTER_DRAW_DATA_POINT_LABEL
public static final java.lang.String BEFORE_DRAW_FITTING_CURVE
public static final java.lang.String AFTER_DRAW_FITTING_CURVE
public static final java.lang.String BEFORE_DRAW_AXIS_LABEL
public static final java.lang.String AFTER_DRAW_AXIS_LABEL
public static final java.lang.String BEFORE_DRAW_AXIS_TITLE
public static final java.lang.String AFTER_DRAW_AXIS_TITLE
public static final java.lang.String BASE_VALUE
public static final java.lang.String ORTHOGONAL_VALUE
public static final java.lang.String SERIES_VALUE
Constructor Detail |
---|
public ScriptHandler()
Method Detail |
---|
public final java.lang.String getClassName()
getClassName
in interface org.mozilla.javascript.Scriptable
getClassName
in class org.mozilla.javascript.ScriptableObject
public final org.mozilla.javascript.Scriptable getScope()
public java.lang.Object jsFunction_getDesignTimeModel()
public java.lang.Object jsFunction_getRunTimeModel()
public java.lang.Object jsFunction_getGeneratedChartState()
public final java.lang.Object jsFunction_getLocale()
public final java.lang.Object jsFunction_clone(java.lang.Object eo)
eo
- An EMF generated model object to be cloned
public final void setDesignTimeModel(Chart cmDesignTime)
cm
- public final void setRunTimeModel(Chart cmRunTime)
cm
- public final void setGeneratedChartState(GeneratedChartState gcs)
gcs
- public final void setLocale(com.ibm.icu.util.ULocale lcl)
lcl
- public final void setScriptClassLoader(IScriptClassLoader value)
value
- public final void init(org.mozilla.javascript.Scriptable scPrototype) throws ChartException
scPrototype
- Parent scope object. If it's null, use default scope.
ChartException
public final void registerExistingScriptableObject(org.mozilla.javascript.ScriptableObject so, java.lang.String sVarName) throws ChartException
so
- The existing scriptable object to be registeredsVarName
- The name of the javascript variable associated with the new
scriptable object that will be added to the scope
ChartException
public final void registerNewScriptableObject(java.lang.Class clsScriptable, java.lang.String sVarName) throws ChartException
clsScriptable
- The class representing the new scriptable object to be
registeredsVarName
- The name of the javascript variable associated with the new
scriptable object that will be added to the scope
ChartException
public final void registerVariable(java.lang.String sVarName, java.lang.Object var) throws ChartException
sVarName
-
ChartException
public final void unregisterVariable(java.lang.String sVarName) throws ChartException
sVarName
-
ChartException
public static final java.lang.Object callFunction(ScriptHandler sh, java.lang.String sFunction, java.lang.Object oArg1) throws ChartException
sh
- sFunction
- oArg1
-
ChartException
public static final java.lang.Object callFunction(ScriptHandler sh, java.lang.String sFunction, java.lang.Object oArg1, java.lang.Object oArg2) throws ChartException
sh
- sFunction
- oArg1
- oArg2
-
ChartException
public static final java.lang.Object callFunction(ScriptHandler sh, java.lang.String sFunction, java.lang.Object oArg1, java.lang.Object oArg2, java.lang.Object oArg3) throws ChartException
sh
- sFunction
- oArg1
- oArg2
- oArg3
-
ChartException
public final java.lang.Object evaluate(java.lang.String sScriptContent) throws ChartException
sScriptContent
-
ChartException
public final void register(java.lang.String sScriptName, java.lang.String sScriptContent) throws ChartException
sScriptContent
- This is either the JavaSciprt code content or a full class
name which has implemented
IChartItemScriptHandler
ChartException
public void setScriptContext(IChartScriptContext csc)
csc
-
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |