|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.eclipse.birt.chart.factory.RunTimeContext
Encapsulates runtime information associated with each chart generation and rendering session. It contains global objects that are defined per request.
Constructor Summary | |
RunTimeContext()
A default zero-arg public constructor used for object creation. |
Method Summary | |
void |
clearState()
Clears all the stored states. |
java.lang.String |
externalizedMessage(java.lang.String sChartKey)
A convenience method provided to lookup externalized messages associated with a given message key. |
IActionRenderer |
getActionRenderer()
Returns the IActionRenderer of current runtime context. |
java.util.Locale |
getLocale()
Returns the locale associated with this runtime context. |
org.eclipse.birt.core.i18n.ResourceHandle |
getResourceHandle()
Returns an instance of the resource handle for which chart specific messages are externalized. |
IScriptClassLoader |
getScriptClassLoader()
Returns the script classLoader if available. |
IChartScriptContext |
getScriptContext()
Returns an instance of a script context associated with the chart being generated. |
ScriptHandler |
getScriptHandler()
Returns an instance of a transient script handler associated with the chart being generated. |
java.lang.Object |
getState(java.lang.Object key)
Returns the state object from store by the key. |
IStructureDefinitionListener |
getStructureDefinitionListener()
Returns an instance of the structure definition listner for device renderers that need a structure definition notification when rendering primitives. |
boolean |
isScriptingEnabled()
Returns if scriting is enabled in current context. |
boolean |
notifyStructureChange(java.lang.String sEventName,
java.lang.Object oSource)
Notifies the structure definition listener of a change in the current running structure that defines a group of primitives being rendered and puts them into context with reference to the source object. |
void |
putState(java.lang.Object key,
java.lang.Object state)
Puts a state object to the store. |
java.lang.Object |
removeState(java.lang.Object key)
Removes the state object by the key. |
void |
setActionRenderer(IActionRenderer iar)
Sets an IActionRenderer instance to current runtime context. |
void |
setLocale(java.util.Locale lcl)
Sets the locale associated with this runtime context. |
void |
setMessageLookup(IMessageLookup iml)
Defines an externalized message lookup implementation per chart model being executed. |
void |
setResourceHandle(org.eclipse.birt.core.i18n.ResourceHandle rh)
Specifies a resource handle that facilitates retrieval of chart specific externalized messages. |
void |
setScriptClassLoader(IScriptClassLoader value)
Sets the script classLoader. |
void |
setScriptContext(IChartScriptContext csc)
Sets an instance of a chart script context associated with the chart being generated. |
void |
setScriptHandler(ScriptHandler sh)
Sets an instance of a transient script handler associated with the chart being generated. |
void |
setScriptingEnabled(boolean value)
Sepcifies if to enable scripting in current context. |
void |
setStructureDefinitionListener(IStructureDefinitionListener isdl)
Internally sets an instance of the structure definition listener for device renderers that need a structure definition notification when rendering primitives. |
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public RunTimeContext()
Method Detail |
public final void putState(java.lang.Object key, java.lang.Object state)
key
- state
- public final java.lang.Object getState(java.lang.Object key)
key
-
public final java.lang.Object removeState(java.lang.Object key)
key
-
public final void clearState()
public final boolean isScriptingEnabled()
public final void setScriptingEnabled(boolean value)
value
- public final IScriptClassLoader getScriptClassLoader()
public final void setScriptClassLoader(IScriptClassLoader value)
value
- public void setStructureDefinitionListener(IStructureDefinitionListener isdl)
isdl
- The structure definition listener associated with the runtime
context.public IStructureDefinitionListener getStructureDefinitionListener()
public void setActionRenderer(IActionRenderer iar)
iar
- public IActionRenderer getActionRenderer()
public final boolean notifyStructureChange(java.lang.String sEventName, java.lang.Object oSource)
sEventName
- Defines the structure being defined along with the event typeoSource
- The source object on which the structure is being defined
public final java.util.Locale getLocale()
public final void setLocale(java.util.Locale lcl)
lcl
- The locale associated with the runtime context.public final org.eclipse.birt.core.i18n.ResourceHandle getResourceHandle()
public final void setResourceHandle(org.eclipse.birt.core.i18n.ResourceHandle rh)
rh
- The resource handle.public final ScriptHandler getScriptHandler()
public final void setScriptHandler(ScriptHandler sh)
sh
- An instance of the script handler.public final IChartScriptContext getScriptContext()
public final void setScriptContext(IChartScriptContext csc)
csc
- An instance of the chart script context.public void setMessageLookup(IMessageLookup iml)
iml
- The externalized message lookup implementation.public final java.lang.String externalizedMessage(java.lang.String sChartKey)
sChartKey
- The key using which an externalized message is being looked
up.
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |