Package org.eclipse.birt.chart.script
Class ScriptHandler
- java.lang.Object
-
- org.mozilla.javascript.ScriptableObject
-
- org.eclipse.birt.chart.script.AbstractScriptHandler<IChartEventHandler>
-
- org.eclipse.birt.chart.script.ScriptHandler
-
- All Implemented Interfaces:
java.io.Serializable
,org.mozilla.javascript.ConstProperties
,org.mozilla.javascript.debug.DebuggableObject
,org.mozilla.javascript.Scriptable
,org.mozilla.javascript.SymbolScriptable
public final class ScriptHandler extends AbstractScriptHandler<IChartEventHandler>
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.- See Also:
IChartEventHandler
, Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
AFTER_COMPUTATIONS
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_LAYOUT
Deprecated.This is kept for backward compatibility only.static java.lang.String
BASE_VALUE
The pre-defined chart variable name to access base category data.static java.lang.String
BEFORE_COMPUTATIONS
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_LAYOUT
Deprecated.This is kept for backward compatibility only.static java.lang.String
COMP_LIST
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
ID
The variable names for highlight and toggle visibility functions.static java.lang.String
LABEL_LIST
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 name.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.static java.lang.String
VARIABLE_CATEGORY
The pre-defined chart variable name to access base category data.static java.lang.String
VARIABLE_SERIES
The pre-defined chart variable name to access series name.static java.lang.String
VARIABLE_VALUE
The pre-defined chart variable name to access orthogonal value data.-
Fields inherited from class org.eclipse.birt.chart.script.AbstractScriptHandler
AFTER_DATA_SET_FILLED, AFTER_GENERATION, AFTER_RENDERING, BEFORE_DATA_SET_FILLED, BEFORE_GENERATION, BEFORE_RENDERING
-
-
Constructor Summary
Constructors Constructor Description ScriptHandler()
The constructor.
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description java.lang.Object
jsFunction_clone(java.lang.Object eo)
Deprecated.Note used anymore.java.lang.Object
jsFunction_getDesignTimeModel()
Deprecated.Not used anymore.java.lang.Object
jsFunction_getGeneratedChartState()
Deprecated.Not used anymore.java.lang.Object
jsFunction_getLocale()
Deprecated.Call IChartScriptContext.getLocale() instead.java.lang.Object
jsFunction_getRunTimeModel()
Deprecated.Call IChartScriptContext.getChartInstance() instead.void
setDesignTimeModel(Chart cmDesignTime)
Deprecated.Not used anymore.void
setGeneratedChartState(GeneratedChartState gcs)
Deprecated.Not used anymore.void
setRunTimeModel(Chart cmRunTime)
Deprecated.Not used anymore.-
Methods inherited from class org.eclipse.birt.chart.script.AbstractScriptHandler
callFunction, callFunction, callFunction, evaluate, getClassName, getScope, init, register, registerExistingScriptableObject, registerNewScriptableObject, registerVariable, setLocale, setScriptClassLoader, setScriptContext, unregisterVariable
-
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
-
-
-
-
Field Detail
-
START_GENERATION
@Deprecated public static final java.lang.String START_GENERATION
Deprecated.This is kept for backward compatibility only.- See Also:
- Constant Field Values
-
FINISH_GENERATION
@Deprecated public static final java.lang.String FINISH_GENERATION
Deprecated.This is kept for backward compatibility only.- See Also:
- Constant Field Values
-
BEFORE_LAYOUT
@Deprecated public static final java.lang.String BEFORE_LAYOUT
Deprecated.This is kept for backward compatibility only.- See Also:
- Constant Field Values
-
AFTER_LAYOUT
@Deprecated public static final java.lang.String AFTER_LAYOUT
Deprecated.This is kept for backward compatibility only.- See Also:
- Constant Field Values
-
BEFORE_COMPUTATIONS
public static final java.lang.String BEFORE_COMPUTATIONS
- See Also:
- Constant Field Values
-
AFTER_COMPUTATIONS
public static final java.lang.String AFTER_COMPUTATIONS
- See Also:
- Constant Field Values
-
START_RENDERING
@Deprecated public static final java.lang.String START_RENDERING
Deprecated.This is kept for backward compatibility only.- See Also:
- Constant Field Values
-
FINISH_RENDERING
@Deprecated public static final java.lang.String FINISH_RENDERING
Deprecated.This is kept for backward compatibility only.- See Also:
- Constant Field Values
-
START_COMPUTE_SERIES
@Deprecated public static final java.lang.String START_COMPUTE_SERIES
Deprecated.This is kept for backward compatibility only.- See Also:
- Constant Field Values
-
FINISH_COMPUTE_SERIES
@Deprecated public static final java.lang.String FINISH_COMPUTE_SERIES
Deprecated.This is kept for backward compatibility only.- See Also:
- Constant Field Values
-
BEFORE_DRAW_ELEMENT
@Deprecated public static final java.lang.String BEFORE_DRAW_ELEMENT
Deprecated.This is kept for backward compatibility only.- See Also:
- Constant Field Values
-
AFTER_DRAW_ELEMENT
@Deprecated public static final java.lang.String AFTER_DRAW_ELEMENT
Deprecated.This is kept for backward compatibility only.- See Also:
- Constant Field Values
-
BEFORE_DRAW_BLOCK
public static final java.lang.String BEFORE_DRAW_BLOCK
- See Also:
- Constant Field Values
-
AFTER_DRAW_BLOCK
public static final java.lang.String AFTER_DRAW_BLOCK
- See Also:
- Constant Field Values
-
BEFORE_DRAW_LEGEND_ENTRY
@Deprecated public static final java.lang.String BEFORE_DRAW_LEGEND_ENTRY
Deprecated.This is kept for backward compatibility only.- See Also:
- Constant Field Values
-
AFTER_DRAW_LEGEND_ENTRY
@Deprecated public static final java.lang.String AFTER_DRAW_LEGEND_ENTRY
Deprecated.This is kept for backward compatibility only.- See Also:
- Constant Field Values
-
BEFORE_DRAW_LEGEND_ITEM
public static final java.lang.String BEFORE_DRAW_LEGEND_ITEM
- See Also:
- Constant Field Values
-
AFTER_DRAW_LEGEND_ITEM
public static final java.lang.String AFTER_DRAW_LEGEND_ITEM
- See Also:
- Constant Field Values
-
BEFORE_DRAW_SERIES
public static final java.lang.String BEFORE_DRAW_SERIES
- See Also:
- Constant Field Values
-
AFTER_DRAW_SERIES
public static final java.lang.String AFTER_DRAW_SERIES
- See Also:
- Constant Field Values
-
BEFORE_DRAW_SERIES_TITLE
public static final java.lang.String BEFORE_DRAW_SERIES_TITLE
- See Also:
- Constant Field Values
-
AFTER_DRAW_SERIES_TITLE
public static final java.lang.String AFTER_DRAW_SERIES_TITLE
- See Also:
- Constant Field Values
-
BEFORE_DRAW_MARKER
public static final java.lang.String BEFORE_DRAW_MARKER
- See Also:
- Constant Field Values
-
AFTER_DRAW_MARKER
public static final java.lang.String AFTER_DRAW_MARKER
- See Also:
- Constant Field Values
-
BEFORE_DRAW_MARKER_LINE
public static final java.lang.String BEFORE_DRAW_MARKER_LINE
- See Also:
- Constant Field Values
-
AFTER_DRAW_MARKER_LINE
public static final java.lang.String AFTER_DRAW_MARKER_LINE
- See Also:
- Constant Field Values
-
BEFORE_DRAW_MARKER_RANGE
public static final java.lang.String BEFORE_DRAW_MARKER_RANGE
- See Also:
- Constant Field Values
-
AFTER_DRAW_MARKER_RANGE
public static final java.lang.String AFTER_DRAW_MARKER_RANGE
- See Also:
- Constant Field Values
-
BEFORE_DRAW_DATA_POINT
public static final java.lang.String BEFORE_DRAW_DATA_POINT
- See Also:
- Constant Field Values
-
AFTER_DRAW_DATA_POINT
public static final java.lang.String AFTER_DRAW_DATA_POINT
- See Also:
- Constant Field Values
-
BEFORE_DRAW_DATA_POINT_LABEL
public static final java.lang.String BEFORE_DRAW_DATA_POINT_LABEL
- See Also:
- Constant Field Values
-
AFTER_DRAW_DATA_POINT_LABEL
public static final java.lang.String AFTER_DRAW_DATA_POINT_LABEL
- See Also:
- Constant Field Values
-
BEFORE_DRAW_FITTING_CURVE
public static final java.lang.String BEFORE_DRAW_FITTING_CURVE
- See Also:
- Constant Field Values
-
AFTER_DRAW_FITTING_CURVE
public static final java.lang.String AFTER_DRAW_FITTING_CURVE
- See Also:
- Constant Field Values
-
BEFORE_DRAW_AXIS_LABEL
public static final java.lang.String BEFORE_DRAW_AXIS_LABEL
- See Also:
- Constant Field Values
-
AFTER_DRAW_AXIS_LABEL
public static final java.lang.String AFTER_DRAW_AXIS_LABEL
- See Also:
- Constant Field Values
-
BEFORE_DRAW_AXIS_TITLE
public static final java.lang.String BEFORE_DRAW_AXIS_TITLE
- See Also:
- Constant Field Values
-
AFTER_DRAW_AXIS_TITLE
public static final java.lang.String AFTER_DRAW_AXIS_TITLE
- See Also:
- Constant Field Values
-
BASE_VALUE
public static final java.lang.String BASE_VALUE
The pre-defined chart variable name to access base category data.- See Also:
- Constant Field Values
-
VARIABLE_CATEGORY
public static final java.lang.String VARIABLE_CATEGORY
The pre-defined chart variable name to access base category data.- See Also:
- Constant Field Values
-
ORTHOGONAL_VALUE
public static final java.lang.String ORTHOGONAL_VALUE
The pre-defined chart variable name to access orthogonal value data.- See Also:
- Constant Field Values
-
VARIABLE_VALUE
public static final java.lang.String VARIABLE_VALUE
The pre-defined chart variable name to access orthogonal value data.- See Also:
- Constant Field Values
-
SERIES_VALUE
public static final java.lang.String SERIES_VALUE
The pre-defined chart variable name to access series name.- See Also:
- Constant Field Values
-
VARIABLE_SERIES
public static final java.lang.String VARIABLE_SERIES
The pre-defined chart variable name to access series name.- See Also:
- Constant Field Values
-
ID
public static final java.lang.String ID
The variable names for highlight and toggle visibility functions.- See Also:
- Constant Field Values
-
COMP_LIST
public static final java.lang.String COMP_LIST
- See Also:
- Constant Field Values
-
LABEL_LIST
public static final java.lang.String LABEL_LIST
- See Also:
- Constant Field Values
-
-
Method Detail
-
jsFunction_getDesignTimeModel
@Deprecated public java.lang.Object jsFunction_getDesignTimeModel()
Deprecated.Not used anymore. This is kept for backward compatibility only.- Returns:
- An instance of the chart model used at design time
-
jsFunction_getRunTimeModel
@Deprecated public java.lang.Object jsFunction_getRunTimeModel()
Deprecated.Call IChartScriptContext.getChartInstance() instead. This is kept for backward compatibility only.- Returns:
- An instance of the chart model used at run time
-
jsFunction_getGeneratedChartState
@Deprecated public java.lang.Object jsFunction_getGeneratedChartState()
Deprecated.Not used anymore. This is kept for backward compatibility only.- Returns:
- An instance of the run time model coupled with a computations and series filled with datasets
-
jsFunction_getLocale
@Deprecated public java.lang.Object jsFunction_getLocale()
Deprecated.Call IChartScriptContext.getLocale() instead. This is kept for backward compatibility only.- Returns:
- The locale associated with the generation request
-
jsFunction_clone
@Deprecated public java.lang.Object jsFunction_clone(java.lang.Object eo)
Deprecated.Note used anymore. This is kept for backward compatibility only.- Parameters:
eo
- An EMF generated model object to be cloned- Returns:
- A cloned instance of the specified EMF generated model object
-
setDesignTimeModel
@Deprecated public void setDesignTimeModel(Chart cmDesignTime)
Deprecated.Not used anymore. This is kept for backward compatibility only.- Parameters:
cm
-
-
setRunTimeModel
@Deprecated public void setRunTimeModel(Chart cmRunTime)
Deprecated.Not used anymore. Use IChartScriptContext to store the run-time model now. This is kept for backward compatibility only.- Parameters:
cm
-
-
setGeneratedChartState
@Deprecated public void setGeneratedChartState(GeneratedChartState gcs)
Deprecated.Not used anymore. This is kept for backward compatibility only.- Parameters:
gcs
-
-
-