|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
An interface used to share information between the event methods in scripting. Gives access to report parameters and configuration values. Also provides a way for the report developer to register and retrieve custom properties.
Method Summary | |
void |
deleteGlobalVariable(java.lang.String name)
Remove an object from runtime scope. |
void |
deletePersistentGlobalVariable(java.lang.String name)
Remove an object from report document scope. |
java.util.Map |
getAppContext()
Get the application context |
java.lang.Object |
getGlobalVariable(java.lang.String name)
Retireve an object from runtime scope. |
java.lang.Object |
getHttpServletRequest()
Get the http servlet request object |
java.util.Locale |
getLocale()
|
java.lang.String |
getMessage(java.lang.String key)
Finds user-defined messages for the current thread's locale. |
java.lang.String |
getMessage(java.lang.String key,
java.util.Locale locale)
Finds user-defined messages for the given locale. |
java.lang.String |
getMessage(java.lang.String key,
java.util.Locale locale,
java.lang.Object[] params)
Finds user-defined messages for the given locale using parameters |
java.lang.String |
getMessage(java.lang.String key,
java.lang.Object[] params)
Finds user-defined messages for the current thread's locale using parameters |
java.lang.String |
getOutputFormat()
|
java.lang.String |
getParameterDisplayText(java.lang.String name)
|
java.lang.Object |
getParameterValue(java.lang.String name)
|
java.lang.Object |
getPersistentGlobalVariable(java.lang.String name)
Retireve an object from report document scope. |
IRenderOption |
getRenderOption()
get the render options used to render the report. |
IReportRunnable |
getReportRunnable()
return the report runnable used to create/render this report |
int |
getTaskType()
Get the type of the current task. |
void |
setGlobalVariable(java.lang.String name,
java.lang.Object obj)
Add the object to runtime scope. |
void |
setParameterDisplayText(java.lang.String name,
java.lang.String value)
|
void |
setParameterValue(java.lang.String name,
java.lang.Object value)
|
void |
setPersistentGlobalVariable(java.lang.String name,
java.io.Serializable obj)
Add the object to report document scope. |
Method Detail |
public IReportRunnable getReportRunnable()
public java.lang.Object getParameterValue(java.lang.String name)
name
-
public void setParameterValue(java.lang.String name, java.lang.Object value)
name
- value
- public java.lang.String getParameterDisplayText(java.lang.String name)
name
-
public void setParameterDisplayText(java.lang.String name, java.lang.String value)
name
- value
- public java.util.Locale getLocale()
public java.lang.String getOutputFormat()
public IRenderOption getRenderOption()
public java.util.Map getAppContext()
public java.lang.Object getHttpServletRequest()
public void setGlobalVariable(java.lang.String name, java.lang.Object obj)
public void deleteGlobalVariable(java.lang.String name)
public java.lang.Object getGlobalVariable(java.lang.String name)
public void setPersistentGlobalVariable(java.lang.String name, java.io.Serializable obj)
public void deletePersistentGlobalVariable(java.lang.String name)
public java.lang.Object getPersistentGlobalVariable(java.lang.String name)
public java.lang.String getMessage(java.lang.String key)
key
- resource key of the user-defined message.
null
if resoueceKey is blank.public java.lang.String getMessage(java.lang.String key, java.util.Locale locale)
First we look up in the report itself, then look into the referenced message file. Each search uses a reduced form of Java locale-driven search algorithm: Language&Country, language, default.
key
- resource key of the user defined message.locale
- locale of message, if the input locale
is
null
, the locale for the current thread will
be used instead.
null
if resoueceKey is blank.public java.lang.String getMessage(java.lang.String key, java.lang.Object[] params)
key
- resource key of the user-defined message.params
- string arguments used to format error messages
null
if resoueceKey is blank.public java.lang.String getMessage(java.lang.String key, java.util.Locale locale, java.lang.Object[] params)
First we look up in the report itself, then look into the referenced message file. Each search uses a reduced form of Java locale-driven search algorithm: Language&Country, language, default.
key
- resource key of the user defined message.locale
- locale of message, if the input locale
is
null
, the locale for the current thread will
be used instead.params
- string arguments used to format error messages
null
if resoueceKey is blank.public int getTaskType()
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |