|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IReportRunnable
A runnable report design (i.e., not modifiable) that can be run in the BIRT engine
Field Summary | |
---|---|
static java.lang.String |
AUTHOR
|
static java.lang.String |
BASE_PROP
|
static java.lang.String |
COMMENTS
|
static java.lang.String |
CREATEDBY
|
static java.lang.String |
DESCRIPTION
|
static java.lang.String |
HELP_GUIDE
|
static java.lang.String |
REFRESH_RATE
|
static java.lang.String |
TITLE
|
static java.lang.String |
UNITS
|
Method Summary | |
---|---|
org.eclipse.birt.report.model.api.DesignElementHandle |
getDesignHandle()
returns the design element handle that design engine creates when opening the report |
org.eclipse.birt.report.engine.api.script.element.IReportDesign |
getDesignInstance()
Returns the report design |
IImage |
getImage(java.lang.String name)
returns an image stored in a report design file, or null if the image name does not exist |
java.lang.Object |
getProperty(java.lang.String propertyName)
returns the property value for things like report description, title, etc. |
java.lang.Object |
getProperty(java.lang.String path,
java.lang.String propertyName)
returns the property value defined on a components in a report design. |
IReportEngine |
getReportEngine()
returns the report engine |
java.lang.String |
getReportName()
returns report name |
java.util.HashMap |
getTestConfig()
returns test configuration for the report |
void |
setDesignHandle(org.eclipse.birt.report.model.api.ReportDesignHandle handle)
sets a new report design handle before rendering the report |
Field Detail |
---|
static final java.lang.String TITLE
static final java.lang.String AUTHOR
static final java.lang.String DESCRIPTION
static final java.lang.String COMMENTS
static final java.lang.String CREATEDBY
static final java.lang.String HELP_GUIDE
static final java.lang.String BASE_PROP
static final java.lang.String UNITS
static final java.lang.String REFRESH_RATE
Method Detail |
---|
IImage getImage(java.lang.String name)
name
- the image name for the embedded imagejava.lang.Object getProperty(java.lang.String propertyName)
propertyName
- the name of the property
java.lang.Object getProperty(java.lang.String path, java.lang.String propertyName)
propertyName
- the name of the propertypath
- a simplified XPath that allows access to properties for components in a report
design. Only downward path is allowed, i.e., no .. in the path.
org.eclipse.birt.report.model.api.DesignElementHandle getDesignHandle()
void setDesignHandle(org.eclipse.birt.report.model.api.ReportDesignHandle handle)
handle
- a new report design handlejava.lang.String getReportName()
java.util.HashMap getTestConfig()
IReportEngine getReportEngine()
org.eclipse.birt.report.engine.api.script.element.IReportDesign getDesignInstance()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |