|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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. Low-level report document interface that supports file-level operations is in a separate 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 | |
void |
close()
close the report document, rlease all resources. |
TOCNode |
findTOC(java.lang.String tocNodeId)
get the TOCNode have the id. |
org.eclipse.birt.core.archive.IDocArchiveReader |
getArchive()
|
java.util.List |
getBookmarks()
|
java.util.List |
getChildren(java.lang.String tocNodeId)
|
java.io.InputStream |
getDesignStream()
|
java.util.Map |
getGlobalVariables(java.lang.String option)
|
java.lang.String |
getName()
|
long |
getPageCount()
|
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 |
getParameterValues()
returns values for all the parameters that are used for generating the current report document. |
IReportRunnable |
getReportRunnable()
The report runnable is used to create the report document while writing. |
Field Detail |
public static final int GLOBAL_VARIABLE_OPTION_ALL
public static final int GLOBAL_VARIABLE_OPTION_JAVA_ONLY
public static final int GLOBAL_VARIABLE_OPTION_JS_ONLY
Method Detail |
public org.eclipse.birt.core.archive.IDocArchiveReader getArchive()
public void close()
public java.lang.String getName()
public java.io.InputStream getDesignStream()
public IReportRunnable getReportRunnable()
public java.util.Map getParameterValues()
public long getPageCount()
public long getPageNumber(java.lang.String bookmark)
public java.util.List getBookmarks()
public java.util.List getChildren(java.lang.String tocNodeId)
tocNodeId
- the id of the parent TOC node. Pass null as the root TOC node
public TOCNode findTOC(java.lang.String tocNodeId)
tocNodeId
- the id of the toc.
public java.util.Map getGlobalVariables(java.lang.String option)
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |