|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.eclipse.birt.chart.factory.RunTimeContext
public final class 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. |
org.eclipse.birt.chart.render.IActionRenderer |
getActionRenderer()
Returns the IActionRenderer of current runtime context. |
org.eclipse.birt.chart.factory.IExternalizer |
getExternalizer()
|
org.eclipse.birt.chart.computation.LegendLayoutHints |
getLegendLayoutHints()
Returns the LegendItemLayoutHints for current context. |
java.util.Locale |
getLocale()
Deprecated. use getULocale() instead. |
org.eclipse.birt.chart.factory.IResourceFinder |
getResourceFinder()
|
org.eclipse.birt.core.i18n.ResourceHandle |
getResourceHandle()
Returns an instance of the resource handle for which chart specific messages are externalized. |
org.eclipse.birt.chart.computation.withaxes.ScaleContext |
getScale()
Returns the shared scale |
org.eclipse.birt.chart.script.IScriptClassLoader |
getScriptClassLoader()
Returns the script classLoader if available. |
org.eclipse.birt.chart.script.IChartScriptContext |
getScriptContext()
Returns an instance of a script context associated with the chart being generated. |
org.eclipse.birt.chart.script.ScriptHandler |
getScriptHandler()
Returns an instance of a transient script handler associated with the chart being generated. |
java.util.Map |
getSeriesRenderers()
Returns the series renderers for current context. |
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. |
com.ibm.icu.util.ULocale |
getULocale()
Returns the locale associated with this runtime context. |
boolean |
isRightToLeft()
Returns if current context is in a right-left platform. |
boolean |
isRightToLeftText()
Returns true if current text reading order is Right To Left |
boolean |
isScriptingEnabled()
Returns if scriting is enabled in current context. |
boolean |
isSharingQuery()
|
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(org.eclipse.birt.chart.render.IActionRenderer iar)
Sets an IActionRenderer instance to current runtime context. |
void |
setExternalizer(org.eclipse.birt.chart.factory.IExternalizer externalizer)
|
void |
setLegendLayoutHints(org.eclipse.birt.chart.computation.LegendLayoutHints lilh)
Sets the LegendItemLayoutHints for current context. |
void |
setLocale(java.util.Locale lcl)
Deprecated. use setULocale(ULocale) instead. |
void |
setMessageLookup(IMessageLookup iml)
Defines an externalized message lookup implementation per chart model being executed. |
void |
setResourceFinder(org.eclipse.birt.chart.factory.IResourceFinder resourceFinder)
|
void |
setResourceHandle(org.eclipse.birt.core.i18n.ResourceHandle rh)
Specifies a resource handle that facilitates retrieval of chart specific externalized messages. |
void |
setRightToLeft(boolean value)
Sets the right-left mode for current context mandatorily. |
void |
setRightToLeftText(boolean value)
Sets the bidi text mode of the current chart object . |
void |
setScale(org.eclipse.birt.chart.computation.withaxes.ScaleContext scale)
Sets the shared scale |
void |
setScriptClassLoader(org.eclipse.birt.chart.script.IScriptClassLoader value)
Sets the script classLoader. |
void |
setScriptContext(org.eclipse.birt.chart.script.IChartScriptContext csc)
Sets an instance of a chart script context associated with the chart being generated. |
void |
setScriptHandler(org.eclipse.birt.chart.script.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 |
setSeriesRenderers(java.util.Map msr)
Sets the series renderers for current context. |
void |
setSharingQuery(boolean isSharingQuery)
|
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. |
void |
setULocale(com.ibm.icu.util.ULocale lcl)
Sets the locale associated with this runtime context. |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public RunTimeContext()
Method Detail |
---|
public void putState(java.lang.Object key, java.lang.Object state)
key
- state
- public java.lang.Object getState(java.lang.Object key)
key
-
public java.lang.Object removeState(java.lang.Object key)
key
-
public void clearState()
public boolean isScriptingEnabled()
public void setScriptingEnabled(boolean value)
value
- public org.eclipse.birt.chart.script.IScriptClassLoader getScriptClassLoader()
public void setScriptClassLoader(org.eclipse.birt.chart.script.IScriptClassLoader value)
value
- public void setStructureDefinitionListener(IStructureDefinitionListener isdl)
isdl
- The structure definition listener associated with the runtime
context.public IStructureDefinitionListener getStructureDefinitionListener()
public void setActionRenderer(org.eclipse.birt.chart.render.IActionRenderer iar)
iar
- public org.eclipse.birt.chart.render.IActionRenderer getActionRenderer()
public void setLegendLayoutHints(org.eclipse.birt.chart.computation.LegendLayoutHints lilh)
lilh
- public org.eclipse.birt.chart.computation.LegendLayoutHints getLegendLayoutHints()
public void setSeriesRenderers(java.util.Map msr)
msr
- public java.util.Map getSeriesRenderers()
public 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 java.util.Locale getLocale()
getULocale()
instead.
public void setLocale(java.util.Locale lcl)
setULocale(ULocale)
instead.
lcl
- The locale associated with the runtime context.public com.ibm.icu.util.ULocale getULocale()
public void setULocale(com.ibm.icu.util.ULocale lcl)
lcl
- The locale associated with the runtime context.public boolean isRightToLeft()
public void setRightToLeft(boolean value)
value
- public org.eclipse.birt.core.i18n.ResourceHandle getResourceHandle()
public void setResourceHandle(org.eclipse.birt.core.i18n.ResourceHandle rh)
rh
- The resource handle.public org.eclipse.birt.chart.script.ScriptHandler getScriptHandler()
public void setScriptHandler(org.eclipse.birt.chart.script.ScriptHandler sh)
sh
- An instance of the script handler.public org.eclipse.birt.chart.script.IChartScriptContext getScriptContext()
public void setScriptContext(org.eclipse.birt.chart.script.IChartScriptContext csc)
csc
- An instance of the chart script context.public void setMessageLookup(IMessageLookup iml)
iml
- The externalized message lookup implementation.public java.lang.String externalizedMessage(java.lang.String sChartKey)
sChartKey
- The key using which an externalized message is being looked
up.
public void setScale(org.eclipse.birt.chart.computation.withaxes.ScaleContext scale)
scale
- shared scale contextpublic org.eclipse.birt.chart.computation.withaxes.ScaleContext getScale()
public boolean isSharingQuery()
public void setSharingQuery(boolean isSharingQuery)
public boolean isRightToLeftText()
public void setRightToLeftText(boolean value)
value
- public org.eclipse.birt.chart.factory.IResourceFinder getResourceFinder()
public void setResourceFinder(org.eclipse.birt.chart.factory.IResourceFinder resourceFinder)
resourceFinder
- The resourceFinder to set.public org.eclipse.birt.chart.factory.IExternalizer getExternalizer()
public void setExternalizer(org.eclipse.birt.chart.factory.IExternalizer externalizer)
externalizer
- The externalizer to set.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |