Emitters that Support Report Rendering

org.eclipse.birt.report.engine.emitters

2.0

This extension point allows new output formats to be supported in presentation engine. The plugin registry uses this extension point registration to discover all supported output formats.

<!ELEMENT extension (emitter+)>

<!ATTLIST extension

point CDATA #REQUIRED

id    CDATA #IMPLIED

name  CDATA #IMPLIED>

root element for the emitters extension



<!ELEMENT emitter (reportItem*)>

<!ATTLIST emitter

id       CDATA #IMPLIED

class    CDATA #REQUIRED

format   CDATA #REQUIRED

mimeType CDATA #REQUIRED>

an emitter that exports one or more output formats



<!ELEMENT reportItem EMPTY>

<!ATTLIST reportItem

name  CDATA #REQUIRED

class CDATA #REQUIRED

id    CDATA #IMPLIED>

allows a developer to define emitter for a report item. Used mainly for extended item, but can also be used for standard report items.



The following is a sample usage of the emitterSet extension point:


<extension point=

"org.eclipse.birt.report.engine.emitterSet"

name =

"Engine Emitters"

>

<emitter format=

"HTML"

id=

"org.eclipse.birt.report.engine.emitter.html"

class=

"org.eclipse.birt.report.engine.emitter.html.HTMLReportEmitter"

>

<reportItem name=

"chart"

id=

"org.eclipse.birt.report.engine.emitter.chart.html"

class=

"org.eclipse.birt.report.engine.emitter.html.HTMLChartEmitter"

>

</reportItem>

</emitter>

<emitter format=

"FO"

mimeType=

"text/html"

id=

"org.eclipse.birt.report.engine.emitter.fo"

class=

"org.eclipse.birt.report.engine.emitter.html.FOReportEmitter"

>

<reportItem name=

"chart"

id=

"org.eclipse.birt.report.engine.emitter.chart.fo"

Class=

"org.eclipse.birt.report.engine.emitter.html.FOChartEmitter"

/>

</emitter>

<emitter mimeType=

"application/pdf"

id=

"org.eclipse.birt.report.engine.emitter.pdf"

class=

"org.eclipse.birt.report.engine.emitter.html.FOPReportEmitter"

>

<reportItem name=

"chart"

id=

"org.eclipse.birt.report.engine.emitter.chart.pdf"

emitterClass=

"org.eclipse.birt.report.engine.emitter.html.FOChartEmitter"

/>

</emitter>

</extension>

Notice that in this example, the same class is used for both PDF and FO format. BIRT currently uses FO to generate both FO and PDF output.

The value of the class attribute for the emitter element must be the fully qualified name of a class that implement org.eclipse.birt.engine.emitter.IContentEmitter.

The value of the emitterClass attribute for the reportItem element must be a fully qualified name of a class that implements org.eclipse.birt.engine.extension.IReportItemEmitter.

org.eclipse.birt.report.engine.emitter.html.HTMLReportEmitter ---- An HTML emitter that supports report rendering to HTML format. org.eclipse.birt.report.engine.layout.impl.ReportLayoutEngine ---- An emitter that supports report rendering to PDF format.