Package net.sf.jasperreports.engine.export.oasis

Class JROdtExporter

java.lang.Object

net.sf.jasperreports.engine.JRAbstractExporter<OdtReportConfiguration,OdtExporterConfiguration,OutputStreamExporterOutput,JROdtExporterContext>

net.sf.jasperreports.engine.export.oasis.JROdtExporter

All Implemented Interfaces:

Exporter<ExporterInput,OdtReportConfiguration,OdtExporterConfiguration,OutputStreamExporterOutput>

public class JROdtExporter
extends JRAbstractExporter<OdtReportConfiguration,OdtExporterConfiguration,OutputStreamExporterOutput,JROdtExporterContext>

Exports a JasperReports document to ODF format. It has character output type and exports the document to a grid-based layout.

Open Document Format (short for OASIS Open Document Format for Office Applications) describes electronic documents such as memos, spreadsheets, books, charts, presentations, and word processing documents. .odt is the file extension used for the word processing documents in the Open Document Format, and such files can be obtained in JasperReports using the JROdtExporter class.

Currently, there are the following special configurations that can be applied to an ODT exporter instance (see DocxReportConfiguration) to customize its behavior:

• Allowing table rows to adjust their height if more text is typed into their cells using the ODT editor. This is controlled using either the isFlexibleRowHeight() exporter configuration flag, or its corresponding exporter hint called net.sf.jasperreports.export.odt.flexible.row.height.
• Ignoring hyperlinks in generated documents if they are not intended for the ODT output format. This can be customized using either the isIgnoreHyperlink() exporter configuration flag, or its corresponding exporter hint called net.sf.jasperreports.export.odt.ignore.hyperlink

So far, the ODT exporter has the known limitations of grid exporters. It can work in batch mode and supports all types of exporter input and output as well as font mappings.

Author:

Teodor Danciu (teodord@users.sourceforge.net)

See Also:

• OdtReportConfiguration

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected class	JROdtExporter.ExporterContext
protected class	JROdtExporter.OdtDocumentBuilder

Nested classes/interfaces inherited from class net.sf.jasperreports.engine.JRAbstractExporter

JRAbstractExporter.BaseExporterContext, JRAbstractExporter.PageRange

Field Summary

Fields

Modifier and Type	Field	Description
protected Color	backcolor
protected LinkedList<Color>	backcolorStack
protected Map<Integer,String>	columnStyles
protected DocumentBuilder	documentBuilder
protected String	invalidCharReplacement
protected ExporterNature	nature
static final String	ODT_EXPORTER_KEY	The exporter key, as used in GenericElementHandlerEnviroment.getElementHandler(JRGenericElementType, String).
static final String	ODT_EXPORTER_PROPERTIES_PREFIX
protected PrintPageFormat	pageFormat
protected int	pageFormatIndex
protected int	pageIndex
protected int	reportDpi
protected int	reportIndex
protected Map<Integer,String>	rowStyles
protected boolean	startPage
protected StyleBuilder	styleBuilder
protected StyleCache	styleCache
protected int	tableIndex
protected WriterHelper	tempBodyWriter
protected WriterHelper	tempStyleWriter

Fields inherited from class net.sf.jasperreports.engine.JRAbstractExporter

allSelector, crtCompositeConfiguration, crtCompositeItemConfiguration, crtItem, dateFormatCache, EXCEPTION_MESSAGE_KEY_INVALID_IMAGE_NAME, EXCEPTION_MESSAGE_KEY_INVALID_ZOOM_RATIO, EXCEPTION_MESSAGE_KEY_OUTPUT_WRITER_ERROR, exporterConfiguration, exporterContext, exporterInput, exporterOutput, filter, fontUtil, hyperlinkProducerFactory, itemConfiguration, jasperPrint, jasperReportsContext, noBackcolorSelector, noneSelector, numberFormatCache, propertiesUtil, PROPERTY_DEFAULT_FILTER_FACTORY, PROPERTY_SUFFIX_DEFAULT_FILTER_FACTORY, rendererUtil, styledTextUtil, textValueClasses

Constructor Summary

Constructors

Constructor	Description
JROdtExporter()
JROdtExporter(JasperReportsContext jasperReportsContext)

Method Summary

Modifier and Type	Method	Description
protected void	exportEllipse(TableBuilder tableBuilder, JRPrintEllipse ellipse, JRExporterGridCell gridCell)
protected void	exportFrame(TableBuilder tableBuilder, JRPrintFrame frame, JRExporterGridCell gridCell)
protected void	exportGenericElement(TableBuilder tableBuilder, JRGenericPrintElement element, JRExporterGridCell gridCell)
protected void	exportGrid(JRGridLayout gridLayout, JRPrintElementIndex frameIndex)
void	exportImage(TableBuilder tableBuilder, JRPrintImage image, JRExporterGridCell gridCell)
protected void	exportLine(TableBuilder tableBuilder, JRPrintLine line, JRExporterGridCell gridCell)
protected void	exportPage(JRPrintPage page)
protected void	exportRectangle(TableBuilder tableBuilder, JRPrintRectangle rectangle, JRExporterGridCell gridCell)
void	exportReport()	Performs the export.
protected void	exportReportToOasisZip(OutputStream os)
void	exportText(TableBuilder tableBuilder, JRPrintText text, JRExporterGridCell gridCell)
protected Class<OdtExporterConfiguration>	getConfigurationInterface()
PrintPageFormat	getCurrentPageFormat()	Returns the page format of the page which is currently exported.
String	getExporterKey()
String	getExporterPropertiesPrefix()	Returns the properties prefix for the current exporter.
protected Class<OdtReportConfiguration>	getItemConfigurationInterface()
protected void	initExport()
protected void	initReport()
protected void	insertPageAnchor(TableBuilder tableBuilder)
protected void	restoreBackcolor()
protected void	setBackcolor(Color color)
protected void	setPageFormat(PrintPageFormat pageFormat)	Switches to the given page format, whose resolution the page layout and the element sizes are expressed in, as parts can have a resolution of their own.
protected void	setReportDpi(int reportDpi)

Methods inherited from class net.sf.jasperreports.engine.JRAbstractExporter

cancelExport, checkInterrupted, createFilter, defaultParseNumber, ensureInput, ensureJasperReportsContext, ensureOutput, getBooleanCellValue, getCurrentConfiguration, getCurrentItemConfiguration, getCurrentJasperPrint, getDateCellValue, getDateFormat, getExporterConfiguration, getExporterContext, getExporterInput, getExporterOutput, getHyperlinkProducer, getJasperReportsContext, getLocale, getNumberCellValue, getNumberFormat, getOffsetX, getOffsetY, getPageRange, getPropertiesUtil, getRendererUtil, getReportContext, getReportExportConfiguration, getRepository, getStyledText, getStyledText, getTextFormatFactoryClass, getTextLocale, getTextTimeZone, getTextValue, getTextValueString, insideFrame, isExportCancelled, reset, resetExportContext, restoreElementOffsets, setConfiguration, setConfiguration, setCurrentExporterInputItem, setExporterInput, setExporterOutput, setFrameElementsOffset, setJasperReportsContext, setOffset, setOffset, setReportContext

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

ODT_EXPORTER_KEY

public static final String ODT_EXPORTER_KEY

The exporter key, as used in GenericElementHandlerEnviroment.getElementHandler(JRGenericElementType, String).

See Also:

• Constant Field Values

ODT_EXPORTER_PROPERTIES_PREFIX

public static final String ODT_EXPORTER_PROPERTIES_PREFIX

See Also:

• Constant Field Values

tempBodyWriter

protected WriterHelper tempBodyWriter

tempStyleWriter

protected WriterHelper tempStyleWriter

reportIndex

protected int reportIndex

pageFormatIndex

protected int pageFormatIndex

pageIndex

protected int pageIndex

tableIndex

protected int tableIndex

startPage

protected boolean startPage

invalidCharReplacement

protected String invalidCharReplacement

backcolorStack

protected LinkedList<Color> backcolorStack

backcolor

protected Color backcolor

documentBuilder

protected DocumentBuilder documentBuilder

styleCache

protected StyleCache styleCache

styleBuilder

protected StyleBuilder styleBuilder

reportDpi

protected int reportDpi

pageFormat

protected PrintPageFormat pageFormat

nature

protected ExporterNature nature

rowStyles

protected Map<Integer,String> rowStyles

columnStyles

protected Map<Integer,String> columnStyles

Constructor Details

JROdtExporter

public JROdtExporter()

See Also:

• JROdtExporter(JasperReportsContext)

JROdtExporter

public JROdtExporter(JasperReportsContext jasperReportsContext)

Method Details

getConfigurationInterface

protected Class<OdtExporterConfiguration> getConfigurationInterface()

Specified by:

getConfigurationInterface in class JRAbstractExporter<OdtReportConfiguration,OdtExporterConfiguration,OutputStreamExporterOutput,JROdtExporterContext>

getItemConfigurationInterface

protected Class<OdtReportConfiguration> getItemConfigurationInterface()

Specified by:

getItemConfigurationInterface in class JRAbstractExporter<OdtReportConfiguration,OdtExporterConfiguration,OutputStreamExporterOutput,JROdtExporterContext>

exportReport

public void exportReport()
                  throws JRException

Description copied from interface: Exporter

Performs the export.

Specified by:

exportReport in interface Exporter<ExporterInput,OdtReportConfiguration,OdtExporterConfiguration,OutputStreamExporterOutput>

Specified by:

exportReport in class JRAbstractExporter<OdtReportConfiguration,OdtExporterConfiguration,OutputStreamExporterOutput,JROdtExporterContext>

Throws:

JRException

initExport

protected void initExport()

Overrides:

initExport in class JRAbstractExporter<OdtReportConfiguration,OdtExporterConfiguration,OutputStreamExporterOutput,JROdtExporterContext>

initReport

protected void initReport()

Overrides:

initReport in class JRAbstractExporter<OdtReportConfiguration,OdtExporterConfiguration,OutputStreamExporterOutput,JROdtExporterContext>

getCurrentPageFormat

public PrintPageFormat getCurrentPageFormat()

Description copied from class: JRAbstractExporter

Returns the page format of the page which is currently exported.

The implementation here returns the page format of the document, which is the correct one for pages that do not belong to a part. Exporters that iterate the pages of a document made of parts override this method in order to return the format of the page being exported, as parts can have page formats of their own.

Overrides:

getCurrentPageFormat in class JRAbstractExporter<OdtReportConfiguration,OdtExporterConfiguration,OutputStreamExporterOutput,JROdtExporterContext>

Returns:

the page format of the page currently exported

setPageFormat

protected void setPageFormat(PrintPageFormat pageFormat)

Switches to the given page format, whose resolution the page layout and the element sizes are expressed in, as parts can have a resolution of their own.

setReportDpi

protected void setReportDpi(int reportDpi)

exportReportToOasisZip

protected void exportReportToOasisZip(OutputStream os)
                               throws JRException,
IOException

Throws:

JRException

IOException

exportPage

protected void exportPage(JRPrintPage page)
                   throws JRException,
IOException

Throws:

JRException

IOException

exportGrid

protected void exportGrid(JRGridLayout gridLayout,
 JRPrintElementIndex frameIndex)
                   throws IOException,
JRException

Throws:

IOException

JRException

exportFrame

protected void exportFrame(TableBuilder tableBuilder,
 JRPrintFrame frame,
 JRExporterGridCell gridCell)
                    throws IOException,
JRException

Throws:

IOException

JRException

setBackcolor

protected void setBackcolor(Color color)

restoreBackcolor

protected void restoreBackcolor()

exportRectangle

protected void exportRectangle(TableBuilder tableBuilder,
 JRPrintRectangle rectangle,
 JRExporterGridCell gridCell)

exportLine

protected void exportLine(TableBuilder tableBuilder,
 JRPrintLine line,
 JRExporterGridCell gridCell)

exportEllipse

protected void exportEllipse(TableBuilder tableBuilder,
 JRPrintEllipse ellipse,
 JRExporterGridCell gridCell)

exportText

public void exportText(TableBuilder tableBuilder,
 JRPrintText text,
 JRExporterGridCell gridCell)

exportImage

public void exportImage(TableBuilder tableBuilder,
 JRPrintImage image,
 JRExporterGridCell gridCell)
                 throws JRException

Throws:

JRException

insertPageAnchor

protected void insertPageAnchor(TableBuilder tableBuilder)

exportGenericElement

protected void exportGenericElement(TableBuilder tableBuilder,
 JRGenericPrintElement element,
 JRExporterGridCell gridCell)
                             throws IOException,
JRException

Throws:

IOException

JRException

getExporterKey

public String getExporterKey()

Specified by:

getExporterKey in class JRAbstractExporter<OdtReportConfiguration,OdtExporterConfiguration,OutputStreamExporterOutput,JROdtExporterContext>

getExporterPropertiesPrefix

public String getExporterPropertiesPrefix()

Description copied from class: JRAbstractExporter

Returns the properties prefix for the current exporter.

Specified by:

getExporterPropertiesPrefix in class JRAbstractExporter<OdtReportConfiguration,OdtExporterConfiguration,OutputStreamExporterOutput,JROdtExporterContext>

Returns:

the properties prefix for the current exporter