net.sf.jasperreports.engine.export
Class JRRtfExporter

java.lang.Object
  net.sf.jasperreports.engine.JRAbstractExporter
      net.sf.jasperreports.engine.export.JRRtfExporter

All Implemented Interfaces:

JRExporter

public class JRRtfExporter
extends JRAbstractExporter

Exports a JasperReports document to RTF format. It has binary output type and exports the document to a free-form layout. It uses the RTF Specification 1.6 (compatible with MS Word 6.0, 2003 and XP).

Version:

$Id: JRRtfExporter.java 5320 2012-04-27 15:37:05Z shertage $

Author:

Flavius Sana (flavius_sana@users.sourceforge.net)

Nested Class Summary

protected class

JRRtfExporter.ExporterContext

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

JRAbstractExporter.BaseExporterContext, JRAbstractExporter.ParameterOverriddenResolver, JRAbstractExporter.ParameterOverrideResolver, JRAbstractExporter.ParameterResolver

Field Summary

protected List<Color>	colors
protected FileBufferedWriter	colorWriter
protected File	destFile
protected JRRtfExporterContext	exporterContext
protected List<String>	fonts
protected FileBufferedWriter	fontWriter
protected static String	JR_PAGE_ANCHOR_PREFIX
protected JRExportProgressMonitor	progressMonitor
protected int	reportIndex
static String	RTF_EXPORTER_KEY The exporter key, as used in GenericElementHandlerEnviroment.getHandler(net.sf.jasperreports.engine.JRGenericElementType, String).
protected Writer	rtfWriter
protected FileBufferedWriter	writer

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

dateFormatCache, endPageIndex, filter, fontMap, globalOffsetX, globalOffsetY, hyperlinkProducerFactory, isModeBatch, jasperPrint, jasperPrintList, jasperReportsContext, numberFormatCache, parameters, PROPERTY_DEFAULT_FILTER_FACTORY, PROPERTY_SUFFIX_DEFAULT_FILTER_FACTORY, startPageIndex

Constructor Summary

JRRtfExporter()

JRRtfExporter(JasperReportsContext jasperReportsContext)

Method Summary

protected void	endHyperlink(boolean startedHyperlink)
protected void	exportElements(Collection<JRPrintElement> elements)
protected void	exportEllipse(JRPrintEllipse ellipse) Draw a ellipse object
protected void	exportFrame(JRPrintFrame frame)
protected void	exportGenericElement(JRGenericPrintElement element)
protected boolean	exportHyperlink(JRPrintHyperlink link)
void	exportImage(JRPrintImage printImage) Export a image object
protected void	exportLine(JRPrintLine line) Draw a line object
protected void	exportPage(JRPrintPage page, boolean lastPage) Exports a report page
protected void	exportRectangle(JRPrintRectangle rectangle) Draw a rectangle
void	exportReport() Export report in .rtf format
protected StringBuffer	exportReportToBuffer() Export report in .rtf format
protected void	exportReportToFile() Export report to a file in the .rtf format
protected void	exportReportToStream() Export report in .rtf format to a stream
void	exportText(JRPrintText text) Draw a text box
protected String	getExporterKey()
protected void	writeAnchor(String anchorName)
protected void	writeShapeHyperlink(JRPrintHyperlink link)

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

createFilter, defaultParseNumber, getBooleanCellValue, getBooleanParameter, getCharacterParameter, getCustomHandler, getDateCellValue, getDateFormat, getFloatParameter, getHyperlinkProducer, getIntegerParameter, getJasperReportsContext, getLocale, getNumberCellValue, getNumberFormat, getOffsetX, getOffsetY, getParameter, getParameterResolver, getParameters, getPropertiesUtil, getReportContext, getStringArrayParameter, getStringParameter, getStringParameterOrDefault, getStyledText, getStyledText, getTextFormatFactoryClass, getTextLocale, getTextTimeZone, getTextValue, getTextValueString, reset, resetClassLoader, resetExportContext, restoreElementOffsets, setClassLoader, setExportContext, setFontMap, setFrameElementsOffset, setHyperlinkProducerFactory, setInput, setJasperPrint, setOffset, setOffset, setOutput, setPageRange, setParameter, setParameters, setReportContext

Methods inherited from class java.lang.Object

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

Field Detail

RTF_EXPORTER_KEY

public static final String RTF_EXPORTER_KEY

The exporter key, as used in GenericElementHandlerEnviroment.getHandler(net.sf.jasperreports.engine.JRGenericElementType, String).

See Also:

Constant Field Values

JR_PAGE_ANCHOR_PREFIX

protected static final String JR_PAGE_ANCHOR_PREFIX

See Also:

Constant Field Values

progressMonitor

protected JRExportProgressMonitor progressMonitor

colorWriter

protected FileBufferedWriter colorWriter

fontWriter

protected FileBufferedWriter fontWriter

writer

protected FileBufferedWriter writer

rtfWriter

protected Writer rtfWriter

destFile

protected File destFile

reportIndex

protected int reportIndex

colors

protected List<Color> colors

fonts

protected List<String> fonts

exporterContext

protected JRRtfExporterContext exporterContext

Constructor Detail

JRRtfExporter

public JRRtfExporter()

See Also:

JRRtfExporter(JasperReportsContext)

JRRtfExporter

public JRRtfExporter(JasperReportsContext jasperReportsContext)

Method Detail

exportReport

public void exportReport()
                  throws JRException

Export report in .rtf format

Specified by:

exportReport in interface JRExporter

Specified by:

exportReport in class JRAbstractExporter

Throws:

JRException

exportReportToBuffer

protected StringBuffer exportReportToBuffer()
                                     throws JRException

Export report in .rtf format

Returns:

report in .rtf format in a StringBuffer object

Throws:

JRException

exportReportToStream

protected void exportReportToStream()
                             throws JRException,
                                    IOException

Export report in .rtf format to a stream

Throws:

JRException

IOException

exportReportToFile

protected void exportReportToFile()
                           throws JRException

Export report to a file in the .rtf format

Throws:

JRException

exportPage

protected void exportPage(JRPrintPage page,
                          boolean lastPage)
                   throws JRException,
                          IOException

Exports a report page

Parameters:

page - Page that will be exported

Throws:

JRException

IOException

exportLine

protected void exportLine(JRPrintLine line)
                   throws IOException

Draw a line object

Parameters:

line - JasperReports line object - JRPrintLine

Throws:

IOException

exportRectangle

protected void exportRectangle(JRPrintRectangle rectangle)
                        throws IOException

Draw a rectangle

Parameters:

rectangle - JasperReports rectangle object (JRPrintRectangle)

Throws:

IOException

exportEllipse

protected void exportEllipse(JRPrintEllipse ellipse)
                      throws IOException

Draw a ellipse object

Parameters:

ellipse - JasperReports ellipse object (JRPrintElipse)

Throws:

IOException

exportText

public void exportText(JRPrintText text)
                throws IOException,
                       JRException

Draw a text box

Parameters:

text - JasperReports text object (JRPrintText)

Throws:

JRException

IOException

exportImage

public void exportImage(JRPrintImage printImage)
                 throws JRException,
                        IOException

Export a image object

Parameters:

printImage - JasperReports image object (JRPrintImage)

Throws:

JRException

IOException

exportFrame

protected void exportFrame(JRPrintFrame frame)
                    throws JRException,
                           IOException

Parameters:

frame -

Throws:

JRException

IOException

exportElements

protected void exportElements(Collection<JRPrintElement> elements)
                       throws JRException,
                              IOException

Throws:

JRException

IOException

exportGenericElement

protected void exportGenericElement(JRGenericPrintElement element)

exportHyperlink

protected boolean exportHyperlink(JRPrintHyperlink link)
                           throws IOException

Throws:

IOException

writeShapeHyperlink

protected void writeShapeHyperlink(JRPrintHyperlink link)
                            throws IOException

Throws:

IOException

endHyperlink

protected void endHyperlink(boolean startedHyperlink)
                     throws IOException

Throws:

IOException

writeAnchor

protected void writeAnchor(String anchorName)
                    throws IOException

Throws:

IOException

getExporterKey

protected String getExporterKey()

Specified by:

getExporterKey in class JRAbstractExporter