Uses of Package
org.eclipse.birt.report.engine.api

Packages that use org.eclipse.birt.report.engine.api

org.eclipse.birt.report.engine.api	This is an application-writer's interface for using the BIRT report engine.
org.eclipse.birt.report.engine.content	Defines interfaces of BIRT report items for Engine to pass from executors to emitters.
org.eclipse.birt.report.engine.emitter	Defines the interfaces of report emitters, and also provides serval general classes for emitters to output XML document, process hyperline, etc.
org.eclipse.birt.report.engine.extension	This package defines 3 key interfaces ---- IReportItemQuery, IReportItemGeneration, and IReportItemPresentation ---- that are used to process an extended item at query preparation, report generation and report rendering times.

Classes in org.eclipse.birt.report.engine.api used by org.eclipse.birt.report.engine.api

CachedImage
Cached Image Created by the IHTMLImageHandler.

DataExtractionFormatInfo

DataID
the data id of the data used by an instance.

DataSetID
ID represent the data set.

EmitterInfo
The descriptor of the plugin emitter.

EngineConfig
Wraps around configuration settings for report engine.

EngineException
Define an engine exception that clients of the engine need to handle.

HTMLImageHandler

HTMLRenderOption
output settings for HTML output format

IAction
Defines an interface that allows engine to pass hyperlink information to an emitter, if the emitter determines to customize the hyperlinks calculated in engine, or it wants to use a totally different hyperlink string

IDataExtractionOption

IDataExtractionTask
an engine task that extracts data from a report.

IDataIterator
An iterator on a result set from a prepared and executed query.

IDocumentWriter

IEngineConfig

IEngineTask
defines common features for an engine task.

IExcelRenderOption

IExtractionResults
A handle used to retrieve data stored in a report.

IGetParameterDefinitionTask
an engine task that retrieves parameter definitions from a report.

IHTMLActionHandler
Defines an interface for action handler used in HTML format

IHTMLImageHandler
Defines the image handler interface for use in HTML format

IHTMLRenderOption
Interface of constants of the HTML Render Opitons.

IImage
Defines an interface to communicate info about an image to image handler

ImageSize

InstanceID
a class that wraps around an identifier for a report element instance

IPageHandler
An interface implemented by app developer to provide handler after each page is generated in factoery.

IParameterDefn
base interface for a BIRT report parameter

IParameterDefnBase
Captures properties shared by all types of parameters and parameter group, i.e., name, display name, help text and custom-defined properties.

IParameterGroupDefn
The interface for objects which visually groups report parameters.

IParameterSelectionChoice
defines one choice in a parameter selction value list

IPDFRenderOption
Defines render options for PDF emitter.

IRenderOption
Defines render options for emitters

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

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.

IReportDocumentInfo
the interface used to access the traisent informations of a report document.

IReportDocumentLock
lock used to lock the report document.

IReportDocumentLockManager

IReportEngine
A report engine provides an entry point for reporting functionalities.

IReportPart
Base interface that provides accessible information for a report part

IReportRunnable
A runnable report design (i.e., not modifiable) that can be run in the BIRT engine

IResultMetaData
Describes the metadata of a detail row in an IResultIterator.

IRunAndRenderTask
an engine task that runs a report and renders it to one of the output formats supported by the engine.

IRunTask
An engine task that runs a report and generates a report document.

IStatusHandler
Interface that defines several status handler callback functions.

ITaskOption

ITOCTree
Represents a whole TOC tree.

RenderOption
Settings for rendering a report to an output format.

TaskOption

TOCNode
A node that wraps around a TOC entry.

Classes in org.eclipse.birt.report.engine.api used by org.eclipse.birt.report.engine.content

InstanceID
a class that wraps around an identifier for a report element instance

ITOCTree
Represents a whole TOC tree.

TOCNode
A node that wraps around a TOC entry.

Classes in org.eclipse.birt.report.engine.api used by org.eclipse.birt.report.engine.emitter

IRenderOption
Defines render options for emitters

IReportRunnable
A runnable report design (i.e., not modifiable) that can be run in the BIRT engine

Classes in org.eclipse.birt.report.engine.api used by org.eclipse.birt.report.engine.extension

DataSetID
ID represent the data set.

IDataExtractionOption

IExtractionResults
A handle used to retrieve data stored in a report.

IHTMLActionHandler
Defines an interface for action handler used in HTML format