org.eclipse.birt.report.engine.api
Interface IRenderTask

All Superinterfaces:
IEngineTask

public interface IRenderTask
extends IEngineTask

An engine task that renders a Report Document to one of the output formats supported by the engine.


Method Summary
 IRenderOption getRenderOption()
           
 void render(long pageNumber)
           
 void render(java.lang.String pageRange)
          Render the page from startPageNumber to endPageNumber in the Report Doucment to an output format.
 void setEmitterID(java.lang.String id)
          sets a specific emitter to use when generate output.
 void setRenderOption(IRenderOption options)
          set the rendering options
 
Methods inherited from interface org.eclipse.birt.report.engine.api.IEngineTask
addScriptableJavaObject, close, getAppContext, getEngine, getID, getLocale, getParameterValue, getParameterValues, getReportRunnable, setAppContext, setLocale, setParameterValue, setParameterValues, validateParameters
 

Method Detail

setRenderOption

public void setRenderOption(IRenderOption options)
set the rendering options


getRenderOption

public IRenderOption getRenderOption()
Returns:
the render option

setEmitterID

public void setEmitterID(java.lang.String id)
sets a specific emitter to use when generate output. Used when there are more than one emitters that support a single format. One example is the FO-based PDF emitter and the new PDF emitter added in BIRT2.0. If this function is not called when there are more than 1 emitters that support a format, engine may arbitrarily pick one.

Parameters:
id - the identifier for the emitter

render

public void render(long pageNumber)
            throws EngineException
Parameters:
pageNumber -
Throws:
EngineException

render

public void render(java.lang.String pageRange)
            throws EngineException
Render the page from startPageNumber to endPageNumber in the Report Doucment to an output format.

Throws:
EngineException


Copyright © 2005 Actuate Corp. All rights reserved.