|
|||||||||||
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.
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. |
java.util.List |
findTOCByName(java.lang.String tocName)
Gets the TOCNodes with the given name. |
org.eclipse.birt.core.archive.IDocArchiveReader |
getArchive()
|
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)
|
java.io.InputStream |
getDesignStream()
|
java.util.Map |
getGlobalVariables(java.lang.String option)
|
long |
getInstanceOffset(InstanceID iid)
Given a report item instance id, returns the offset of the report content (to support Reportlet). |
java.lang.String |
getName()
|
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()
returns values for all the parameters that are used for generating the current report document. |
java.lang.String |
getProperty(java.lang.String key)
|
IReportRunnable |
getReportRunnable()
The report runnable is used to create the report document while writing. |
ITOCTree |
getTOCTree(java.lang.String format,
com.ibm.icu.util.ULocale locale)
Gets the TOC tree. |
java.lang.String |
getVersion()
|
boolean |
isComplete()
|
void |
refresh()
check the current readed checkpoint and the current writed check point. |
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 getVersion()
public java.lang.String getProperty(java.lang.String key)
public java.lang.String getName()
public java.io.InputStream getDesignStream()
public IReportRunnable getReportRunnable()
public java.util.Map getParameterValues()
public java.util.Map getParameterDisplayTexts()
public long getPageCount()
public long getPageNumber(InstanceID iid)
iid
- report item instance id
public long getInstanceOffset(InstanceID iid)
iid
- report item instance id
public long getBookmarkOffset(java.lang.String bookmark)
bookmark
- bookmark of the report item.
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.List findTOCByName(java.lang.String tocName)
tocName
- the name of the toc.
public java.util.Map getGlobalVariables(java.lang.String option)
public boolean isComplete()
public void refresh()
public ITOCTree getTOCTree(java.lang.String format, com.ibm.icu.util.ULocale locale)
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |