net.sf.jasperreports.engine.export.ooxml

Class JRDocxExporter

java.lang.Object

net.sf.jasperreports.engine.JRAbstractExporter

net.sf.jasperreports.engine.export.ooxml.JRDocxExporter

All Implemented Interfaces:

JRExporter

public class JRDocxExporter
extends JRAbstractExporter

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

Version:

$Id: JRDocxExporter.java 6446 2013-08-29 17:34:33Z teodord $

Author:

sanda zaharia (shertage@users.sourceforge.net)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	JRDocxExporter.ExporterContext

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

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

Field Summary

Fields

Modifier and Type	Field and Description
protected Color	backcolor
protected LinkedList<Color>	backcolorStack
protected long	bookmarkIndex
protected boolean	deepGrid
protected DocxDocumentHelper	docHelper
protected Writer	docWriter
static String	DOCX_EXPORTER_KEY The exporter key, as used in GenericElementHandlerEnviroment.getHandler(net.sf.jasperreports.engine.JRGenericElementType, String).
protected static String	DOCX_EXPORTER_PROPERTIES_PREFIX
protected boolean	flexibleRowHeight
static String	IMAGE_LINK_PREFIX
static String	IMAGE_NAME_PREFIX
protected static int	IMAGE_NAME_PREFIX_LEGTH
protected List<JRPrintElementIndex>	imagesToProcess
protected String	invalidCharReplacement
static String	JR_PAGE_ANCHOR_PREFIX
protected JRDocxExporterContext	mainExporterContext
protected ExporterNature	nature
protected String	pageAnchor
protected int	pageIndex
protected JRExportProgressMonitor	progressMonitor
static String	PROPERTY_HIDDEN_TEXT This property is used to mark text elements as being hidden either for printing or on-screen display.
static String	PROPERTY_IGNORE_HYPERLINK
protected DocxRelsHelper	relsHelper
protected Map<String,String>	rendererToImagePathMap
protected int	reportIndex
protected DocxRunHelper	runHelper
protected boolean	startPage
protected int	tableIndex

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

allSelector, dateFormatCache, endPageIndex, filter, fontMap, globalOffsetX, globalOffsetY, hyperlinkProducerFactory, isModeBatch, jasperPrint, jasperPrintList, jasperReportsContext, noBackcolorSelector, noneSelector, numberFormatCache, parameters, propertiesUtil, PROPERTY_DEFAULT_FILTER_FACTORY, PROPERTY_SUFFIX_DEFAULT_FILTER_FACTORY, startPageIndex, styledTextUtil

Constructor Summary

Constructors

Constructor and Description
JRDocxExporter()
JRDocxExporter(JasperReportsContext jasperReportsContext)

Method Summary

Methods

Modifier and Type	Method and Description
protected void	endHyperlink(boolean isText)
protected void	exportEllipse(DocxTableHelper tableHelper, JRPrintEllipse ellipse, JRExporterGridCell gridCell)
protected void	exportFrame(DocxTableHelper tableHelper, JRPrintFrame frame, JRExporterGridCell gridCell) In deep grids, this is called only for empty frames.
protected void	exportGenericElement(DocxTableHelper tableHelper, JRGenericPrintElement element, JRExporterGridCell gridCell)
protected void	exportGrid(JRGridLayout gridLayout, JRPrintElementIndex frameIndex)
void	exportImage(DocxTableHelper tableHelper, JRPrintImage image, JRExporterGridCell gridCell)
protected void	exportLine(DocxTableHelper tableHelper, JRPrintLine line, JRExporterGridCell gridCell)
protected void	exportPage(JRPrintPage page)
protected void	exportRectangle(DocxTableHelper tableHelper, JRPrintRectangle rectangle, JRExporterGridCell gridCell)
void	exportReport() Actually starts the export process.
protected void	exportReportToStream(OutputStream os)
protected void	exportStyledText(JRStyle style, JRStyledText styledText, Locale locale, boolean hiddenText, boolean startedHyperlink)
void	exportText(DocxTableHelper tableHelper, JRPrintText text, JRExporterGridCell gridCell)
protected JRPrintElementIndex	getElementIndex(JRExporterGridCell gridCell)
String	getExporterKey()
protected ExporterNature	getExporterNature(ExporterFilter filter)
protected String	getExporterPropertiesPrefix()
protected String	getHyperlinkTarget(JRPrintHyperlink link)
protected String	getHyperlinkURL(JRPrintHyperlink link)
JRPrintImage	getImage(List<JasperPrint> jasperPrintList, JRPrintElementIndex imageIndex)
JRPrintImage	getImage(List<JasperPrint> jasperPrintList, String imageName)
static String	getImageName(JRPrintElementIndex printElementIndex) protected void writeImageMap(String imageMapName, JRPrintHyperlink mainHyperlink, List imageMapAreas) { writer.write("
String	getImagePath(Renderable renderer, boolean isLazy, JRExporterGridCell gridCell)
static JRPrintElementIndex	getPrintElementIndex(String imageName)
protected void	insertBookmark(String bookmark, BaseHelper helper)
protected void	restoreBackcolor()
protected void	setBackcolor(Color color)
protected void	setExporterHints()
protected void	setInput()
protected boolean	startHyperlink(JRPrintHyperlink link, boolean isText)

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

createFilter, defaultParseNumber, getBooleanCellValue, getBooleanParameter, getCharacterParameter, getCurrentJasperPrint, 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, setJasperPrint, setJasperReportsContext, 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

DOCX_EXPORTER_KEY

public static final String DOCX_EXPORTER_KEY

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

See Also:

Constant Field Values

DOCX_EXPORTER_PROPERTIES_PREFIX

protected static final String DOCX_EXPORTER_PROPERTIES_PREFIX

See Also:

Constant Field Values

PROPERTY_IGNORE_HYPERLINK

public static final String PROPERTY_IGNORE_HYPERLINK

See Also:

Constant Field Values

PROPERTY_HIDDEN_TEXT

public static final String PROPERTY_HIDDEN_TEXT

This property is used to mark text elements as being hidden either for printing or on-screen display.

See Also:

JRPropertiesUtil, Constant Field Values

JR_PAGE_ANCHOR_PREFIX

public static final String JR_PAGE_ANCHOR_PREFIX

See Also:

Constant Field Values

IMAGE_NAME_PREFIX

public static final String IMAGE_NAME_PREFIX

See Also:

Constant Field Values

IMAGE_NAME_PREFIX_LEGTH

protected static final int IMAGE_NAME_PREFIX_LEGTH

IMAGE_LINK_PREFIX

public static final String IMAGE_LINK_PREFIX

See Also:

Constant Field Values

docHelper

protected DocxDocumentHelper docHelper

docWriter

protected Writer docWriter

progressMonitor

protected JRExportProgressMonitor progressMonitor

rendererToImagePathMap

protected Map<String,String> rendererToImagePathMap

imagesToProcess

protected List<JRPrintElementIndex> imagesToProcess

reportIndex

protected int reportIndex

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

runHelper

protected DocxRunHelper runHelper

nature

protected ExporterNature nature

deepGrid

protected boolean deepGrid

flexibleRowHeight

protected boolean flexibleRowHeight

bookmarkIndex

protected long bookmarkIndex

pageAnchor

protected String pageAnchor

mainExporterContext

protected JRDocxExporterContext mainExporterContext

relsHelper

protected DocxRelsHelper relsHelper

Constructor Detail

JRDocxExporter

public JRDocxExporter()

See Also:

JRDocxExporter(JasperReportsContext)

JRDocxExporter

public JRDocxExporter(JasperReportsContext jasperReportsContext)

Method Detail

exportReport

public void exportReport()
                  throws JRException

Description copied from interface: JRExporter

Actually starts the export process.

Specified by:

exportReport in interface JRExporter

Specified by:

exportReport in class JRAbstractExporter

Throws:

JRException

getImage

public JRPrintImage getImage(List<JasperPrint> jasperPrintList,
                    String imageName)
                      throws JRException

Throws:

JRException

getImage

public JRPrintImage getImage(List<JasperPrint> jasperPrintList,
                    JRPrintElementIndex imageIndex)
                      throws JRException

Throws:

JRException

exportReportToStream

protected void exportReportToStream(OutputStream os)
                             throws JRException,
                                    IOException

Throws:

JRException

IOException

exportPage

protected void exportPage(JRPrintPage page)
                   throws JRException

Throws:

JRException

exportGrid

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

Throws:

JRException

exportLine

protected void exportLine(DocxTableHelper tableHelper,
              JRPrintLine line,
              JRExporterGridCell gridCell)

exportRectangle

protected void exportRectangle(DocxTableHelper tableHelper,
                   JRPrintRectangle rectangle,
                   JRExporterGridCell gridCell)

exportEllipse

protected void exportEllipse(DocxTableHelper tableHelper,
                 JRPrintEllipse ellipse,
                 JRExporterGridCell gridCell)

exportText

public void exportText(DocxTableHelper tableHelper,
              JRPrintText text,
              JRExporterGridCell gridCell)

exportStyledText

protected void exportStyledText(JRStyle style,
                    JRStyledText styledText,
                    Locale locale,
                    boolean hiddenText,
                    boolean startedHyperlink)

exportImage

public void exportImage(DocxTableHelper tableHelper,
               JRPrintImage image,
               JRExporterGridCell gridCell)
                 throws JRException

Throws:

JRException

getImagePath

public String getImagePath(Renderable renderer,
                  boolean isLazy,
                  JRExporterGridCell gridCell)

getElementIndex

protected JRPrintElementIndex getElementIndex(JRExporterGridCell gridCell)

getImageName

public static String getImageName(JRPrintElementIndex printElementIndex)

protected void writeImageMap(String imageMapName, JRPrintHyperlink mainHyperlink, List imageMapAreas) { writer.write("\n"); } protected void writeImageAreaCoordinates(JRPrintImageArea area) { int[] coords = area.getCoordinates(); if (coords != null && coords.length > 0) { StringBuffer coordsEnum = new StringBuffer(coords.length * 4); coordsEnum.append(coords[0]); for (int i = 1; i < coords.length; i++) { coordsEnum.append(','); coordsEnum.append(coords[i]); } writer.write(" coords=\"" + coordsEnum + "\""); } } protected void writeImageAreaHyperlink(JRPrintHyperlink hyperlink) { String href = getHyperlinkURL(hyperlink); if (href == null) { writer.write(" nohref=\"nohref\""); } else { writer.write(" href=\"" + href + "\""); String target = getHyperlinkTarget(hyperlink); if (target != null) { writer.write(" target=\""); writer.write(target); writer.write("\""); } } if (hyperlink.getHyperlinkTooltip() != null) { writer.write(" title=\""); writer.write(JRStringUtil.xmlEncode(hyperlink.getHyperlinkTooltip())); writer.write("\""); } } /**

getPrintElementIndex

public static JRPrintElementIndex getPrintElementIndex(String imageName)

exportFrame

protected void exportFrame(DocxTableHelper tableHelper,
               JRPrintFrame frame,
               JRExporterGridCell gridCell)
                    throws JRException

In deep grids, this is called only for empty frames.

Throws:

JRException

exportGenericElement

protected void exportGenericElement(DocxTableHelper tableHelper,
                        JRGenericPrintElement element,
                        JRExporterGridCell gridCell)

setBackcolor

protected void setBackcolor(Color color)

restoreBackcolor

protected void restoreBackcolor()

startHyperlink

protected boolean startHyperlink(JRPrintHyperlink link,
                     boolean isText)

getHyperlinkTarget

protected String getHyperlinkTarget(JRPrintHyperlink link)

getHyperlinkURL

protected String getHyperlinkURL(JRPrintHyperlink link)

endHyperlink

protected void endHyperlink(boolean isText)

insertBookmark

protected void insertBookmark(String bookmark,
                  BaseHelper helper)

setInput

protected void setInput()
                 throws JRException

Overrides:

setInput in class JRAbstractExporter

Throws:

JRException

getExporterNature

protected ExporterNature getExporterNature(ExporterFilter filter)

getExporterPropertiesPrefix

protected String getExporterPropertiesPrefix()

getExporterKey

public String getExporterKey()

Specified by:

getExporterKey in class JRAbstractExporter

setExporterHints

protected void setExporterHints()