|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IReportDocument
A report document (i.e., not modifiable) that can be rendered to other formats in the BIRT presentation engine This is the high-level report document interface.
Field Summary | |
---|---|
static int |
GLOBAL_VARIABLE_OPTION_ALL
|
static int |
GLOBAL_VARIABLE_OPTION_JAVA_ONLY
|
static int |
GLOBAL_VARIABLE_OPTION_JS_ONLY
|
Method Summary | |
---|---|
TOCNode |
findTOC(java.lang.String tocNodeId)
Deprecated. Invoke following code instead:
|
java.util.List |
findTOCByName(java.lang.String tocName)
Deprecated. Invoke following code instead:
|
org.eclipse.birt.core.archive.IDocArchiveReader |
getArchive()
|
InstanceID |
getBookmarkInstance(java.lang.String bookmark)
Return the instance id of report item with the specified bookmark |
long |
getBookmarkOffset(java.lang.String bookmark)
Given a report item bookmark, returns the offset of the report content (to support Reportlet). |
java.util.List |
getBookmarks()
|
java.util.List |
getChildren(java.lang.String tocNodeId)
Deprecated. Invoke following code instead:
|
java.io.InputStream |
getDesignStream()
|
java.util.Map |
getGlobalVariables(java.lang.String option)
Deprecated. |
long |
getInstanceOffset(InstanceID iid)
Given a report item instance id, returns the offset of the report content (to support Reportlet). |
long |
getPageCount()
|
long |
getPageNumber(InstanceID iid)
Given a report item instance idD, returns the page number that the instance starts on (to support Reportlet). |
long |
getPageNumber(java.lang.String bookmark)
Given a bookmark in a report, find the (first) page that the bookmark appears in (for hyperlinks to a bookmark) |
java.util.Map |
getParameterDisplayTexts()
returns display texts for all the parameters that are used for generating the current report document. |
java.util.Map |
getParameterValues()
Deprecated. Invoke RenderTask.getParameterValues( ) instead. |
IReportRunnable |
getPreparedRunnable()
The report runnable is used to create the report document while writing. |
java.lang.String |
getProperty(java.lang.String key)
Get report document property. |
org.eclipse.birt.report.model.api.ReportDesignHandle |
getReportDesign()
|
IReportRunnable |
getReportRunnable()
The report runnable is used to create the report document while writing. |
java.lang.String |
getSystemId()
return the system id assigned to the document |
ITOCTree |
getTOCTree(java.lang.String format,
com.ibm.icu.util.ULocale locale)
Deprecated. Invoke following code instead:
|
ITOCTree |
getTOCTree(java.lang.String format,
com.ibm.icu.util.ULocale locale,
com.ibm.icu.util.TimeZone timeZone)
Deprecated. Invoke following code instead:
|
java.lang.String |
getVersion()
Get report document version. |
boolean |
isComplete()
|
void |
refresh()
check the current readed checkpoint and the current writed check point. |
Methods inherited from interface org.eclipse.birt.report.engine.api.IDocument |
---|
close, getName |
Field Detail |
---|
static final int GLOBAL_VARIABLE_OPTION_ALL
static final int GLOBAL_VARIABLE_OPTION_JAVA_ONLY
static final int GLOBAL_VARIABLE_OPTION_JS_ONLY
Method Detail |
---|
org.eclipse.birt.core.archive.IDocArchiveReader getArchive()
java.lang.String getVersion()
java.lang.String getProperty(java.lang.String key)
key
-
java.io.InputStream getDesignStream()
org.eclipse.birt.report.model.api.ReportDesignHandle getReportDesign()
IReportRunnable getReportRunnable()
IReportRunnable getPreparedRunnable()
java.util.Map getParameterValues()
java.util.Map getParameterDisplayTexts()
long getPageCount()
long getPageNumber(InstanceID iid)
iid
- report item instance id
long getInstanceOffset(InstanceID iid)
iid
- report item instance id
long getBookmarkOffset(java.lang.String bookmark)
bookmark
- bookmark of the report item.
long getPageNumber(java.lang.String bookmark)
bookmarkName
- bookmark name
java.util.List getBookmarks()
java.util.List getChildren(java.lang.String tocNodeId)
IReportDocument document = ...
RenderTask renderTask = engine.createRenderTask( document );
ITOCTree tocTree = renderTask.getTOCTree( );
TOCNode node = tocTree.findTOC(tocNodeId);
List result = node.getChildren( );
tocNodeId
- the id of the parent TOC node. Pass null as the root TOC node
TOCNode findTOC(java.lang.String tocNodeId)
IReportDocument document = ...
RenderTask renderTask = engine.createRenderTask( document );
ITOCTree tocTree = renderTask.getTOCTree( );
TOCNode result = tocTree.findTOC(tocNodeId);
tocNodeId
- the id of the toc.
java.util.List findTOCByName(java.lang.String tocName)
IReportDocument document = ...
RenderTask renderTask = engine.createRenderTask( document );
ITOCTree tocTree = renderTask.getTOCTree( );
List result = tocTree.findTOCByValue(tocName);
tocName
- the name of the toc.
java.util.Map getGlobalVariables(java.lang.String option)
boolean isComplete()
void refresh()
ITOCTree getTOCTree(java.lang.String format, com.ibm.icu.util.ULocale locale)
IReportDocument document = ...
RenderTask renderTask = engine.createRenderTask( document );
ITOCTree tocTree = renderTask.getTOCTree( );
ITOCTree result = new TOCView( tocTree.getRoot( ), document.getReportDesgin( ), locale,
TimeZone.getDefault( ), format );
format
- the format to generate the reportlocale
- the locale information to generate the reportITOCTree getTOCTree(java.lang.String format, com.ibm.icu.util.ULocale locale, com.ibm.icu.util.TimeZone timeZone)
IReportDocument document = ...
RenderTask renderTask = engine.createRenderTask( document );
ITOCTree tocTree = renderTask.getTOCTree( );
ITOCTree result = new TOCView( tocTree.getRoot( ), document.getReportDesgin( ), locale,
timeZone, format );
format
- the format to generate the reportlocale
- the locale information to generate the reporttimeZone
- the time zone information to generate the reportInstanceID getBookmarkInstance(java.lang.String bookmark)
bookmark
- the bookmark of the report item
java.lang.String getSystemId()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |