|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IRenderTask
An engine task that renders a Report Document to one of the output formats supported by the engine.
Field Summary |
---|
Fields inherited from interface org.eclipse.birt.report.engine.api.IEngineTask |
---|
CANCEL_ON_ERROR, CONTINUE_ON_ERROR, STATUS_CANCELLED, STATUS_FAILED, STATUS_NOT_STARTED, STATUS_RUNNING, STATUS_SUCCEEDED, TASK_DATAEXTRACTION, TASK_GETPARAMETERDEFINITION, TASK_RENDER, TASK_RUN, TASK_RUNANDRENDER, TASK_UNKNOWN |
Method Summary | |
---|---|
long |
getPageCount()
Gets count of the pages that is output. |
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) |
IRenderOption |
getRenderOption()
|
ITOCTree |
getTOCTree()
Get the TOC tree |
long |
getTotalPage()
|
void |
render()
render the whole report document or an output format |
void |
render(InstanceID iid)
Deprecated. A page which contains the instance can be rendered like this: setInstanceID( instanceID ); render( ); |
void |
render(long pageNumber)
Deprecated. A page with speicfic page number can be rendered like this: setPageNumber( pageNumber ); render( ); |
void |
render(java.lang.String pageRange)
Deprecated. A range of pages can be rendered like this: setPageRange( pageRange ); render( ); |
void |
setBookmark(java.lang.String bookmark)
Sets bookmark. |
void |
setEmitterID(java.lang.String id)
sets a specific emitter to use when generate output. |
void |
setInstanceID(InstanceID iid)
Sets id of instance. |
void |
setInstanceID(java.lang.String iid)
Sets id of instance which is a string type. |
void |
setPageNumber(long pageNumber)
Sets number of the page to be rendered. |
void |
setPageRange(java.lang.String pageRange)
Sets range of the pages to be rendered. |
void |
setRenderOption(IRenderOption options)
set the rendering options |
void |
setReportlet(java.lang.String bookmark)
Sets reportlet by bookmark. |
Methods inherited from interface org.eclipse.birt.report.engine.api.IEngineTask |
---|
addScriptableJavaObject, cancel, cancel, close, getAppContext, getCancelFlag, getEngine, getErrors, getID, getLocale, getLogger, getParameterDisplayText, getParameterValue, getParameterValues, getReportRunnable, getStatus, getTaskType, getULocale, setAppContext, setDataSource, setDataSource, setErrorHandlingOption, setLocale, setLocale, setLogger, setParameter, setParameterDisplayText, setParameterValue, setParameterValues, setTimeZone, setUserACL, validateParameters |
Method Detail |
---|
void setRenderOption(IRenderOption options)
settings
- the rendering optionsIRenderOption getRenderOption()
void setEmitterID(java.lang.String id)
id
- the identifier for the emittervoid setPageNumber(long pageNumber) throws EngineException
pageNumber
- number of the page.
EngineException
- if pageNumber
is invalid.void setInstanceID(InstanceID iid) throws EngineException
iid
- id of the instance.
EngineException
- if iid
is invalid.void setInstanceID(java.lang.String iid) throws EngineException
iid
- the string type instance id of the instance.
EngineException
- if iid
is invalid.void setPageRange(java.lang.String pageRange) throws EngineException
pageRange
- range of the pages.
EngineException
- if pageRange
is invalid.void setBookmark(java.lang.String bookmark) throws EngineException
bookmark
- the bookmark.
EngineException
- if bookmark
is invalid.void setReportlet(java.lang.String bookmark) throws EngineException
bookmark
- the bookmark.
EngineException
- if bookmark
is invalid.void render() throws EngineException
EngineException
- if rendering failsvoid render(long pageNumber) throws EngineException
setPageNumber( pageNumber );
render( );
pageNumber
-
EngineException
void render(java.lang.String pageRange) throws EngineException
setPageRange( pageRange );
render( );
EngineException
void render(InstanceID iid) throws EngineException
setInstanceID( instanceID );
render( );
itemInstanceID
- the report iteminstance to be rendered
EngineException
long getPageCount() throws EngineException
EngineException
long getTotalPage() throws EngineException
EngineException
long getPageNumber(java.lang.String bookmark) throws EngineException
bookmarkName
- bookmark name
EngineException
ITOCTree getTOCTree() throws EngineException
format
- the format to generate the reportlocale
- the locale information to generate the report
EngineException
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |