Package net.sf.jasperreports.engine.export.ooxml

Class JRPptxExporter

java.lang.Object

net.sf.jasperreports.engine.JRAbstractExporter<PptxReportConfiguration,PptxExporterConfiguration,OutputStreamExporterOutput,JRPptxExporterContext>

net.sf.jasperreports.engine.export.ooxml.JRPptxExporter

All Implemented Interfaces:

Exporter<ExporterInput,PptxReportConfiguration,PptxExporterConfiguration,OutputStreamExporterOutput>

public class JRPptxExporter
extends JRAbstractExporter<PptxReportConfiguration,PptxExporterConfiguration,OutputStreamExporterOutput,JRPptxExporterContext>

Exports a JasperReports document to Microsoft PowerPoint 2007 format (PPTX).

This exporter uses an absolute positioned layout and currently there is a single special configuration that can be applied to a PPTX exporter instance (see PptxReportConfiguration) to configure its behavior: one can ignore hyperlinks in generated documents if they are not intended for the PPTX output format. This can be customized using either the isIgnoreHyperlink() exporter configuration flag, or its corresponding exporter hint called net.sf.jasperreports.export.pptx.ignore.hyperlink.

It supports font mappings, batch mode exporting, and filtering out content using exporter filters.

Documents produced using this exporter can be generated in the great majority of the samples shipped with the JasperReports project source files, where the pptx Ant task is defined.

Author:

Teodor Danciu (teodord@users.sourceforge.net)

See Also:

• PptxReportConfiguration

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected class	JRPptxExporter.ExporterContext

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

JRAbstractExporter.BaseExporterContext, JRAbstractExporter.PageRange

Field Summary

Fields

Modifier and Type	Field	Description
protected PropsAppHelper	appHelper
protected PropsCoreHelper	coreHelper
protected PptxContentTypesHelper	ctHelper
protected boolean	defaultFrameAsTable
protected int	elementIndex
static final String	EXCEPTION_MESSAGE_KEY_COLUMN_COUNT_OUT_OF_RANGE
static final String	FIELD_TYPE_DATETIME
static final String	FIELD_TYPE_SLIDENUM
protected PptxFontHelper	fontHelper
protected List<Integer>	frameIndexStack
static final String	IMAGE_NAME_PREFIX
protected static final int	IMAGE_NAME_PREFIX_LEGTH
protected String	invalidCharReplacement
protected static final String	JR_PAGE_ANCHOR_PREFIX
protected int	pageIndex
static final String	PPTX_EXPORTER_KEY	The exporter key, as used in GenericElementHandlerEnviroment.getElementHandler(JRGenericElementType, String).
static final String	PPTX_EXPORTER_PROPERTIES_PREFIX
protected PptxZip	pptxZip
protected PptxPresentationHelper	presentationHelper
protected PptxPresentationRelsHelper	presentationRelsHelper
protected Writer	presentationRelsWriter
protected Writer	presentationWriter
static final String	PROPERTY_FIELD_TYPE	Property that specifies the field type associated with this element in the PPTX export.
static final String	PROPERTY_TO_SLIDE_MASTER	Property that specifies if this element, when found on the first page of the document, should be exported into the slide master, and then ignored on all pages/slides.
protected RenderersCache	renderersCache
protected Map<String,Pair<String,ExifOrientationEnum>>	rendererToImagePathMap
protected int	reportIndex
protected PptxSlideHelper	slideHelper
protected int	slideIndex	used for counting the total number of sheets
protected PptxSlideRelsHelper	slideRelsHelper

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

allSelector, crtCompositeConfiguration, crtCompositeItemConfiguration, crtItem, dateFormatCache, EXCEPTION_MESSAGE_KEY_EMPTY_INPUT_SOURCE_IN_BATCH_MODE, EXCEPTION_MESSAGE_KEY_END_PAGE_INDEX_OUT_OF_RANGE, EXCEPTION_MESSAGE_KEY_INVALID_IMAGE_NAME, EXCEPTION_MESSAGE_KEY_INVALID_ZOOM_RATIO, EXCEPTION_MESSAGE_KEY_NO_INPUT_SOURCE, EXCEPTION_MESSAGE_KEY_NO_OUTPUT_SPECIFIED, EXCEPTION_MESSAGE_KEY_OUTPUT_WRITER_ERROR, EXCEPTION_MESSAGE_KEY_PAGE_INDEX_OUT_OF_RANGE, EXCEPTION_MESSAGE_KEY_START_PAGE_INDEX_OUT_OF_RANGE, 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
JRPptxExporter()
JRPptxExporter(JasperReportsContext jasperReportsContext)

Method Summary

Modifier and Type	Method	Description
protected void	closeSlide()
protected void	closeSlideMaster()
protected void	createSlide(boolean hideSlideMaster)
protected void	createSlideMaster()
protected void	exportElement(JRPrintElement element)
protected void	exportEllipse(JRPrintEllipse ellipse)
protected void	exportFrame(PptxTableHelper tableHelper, JRPrintFrame frame, JRExporterGridCell gridCell, JRExporterGridCell topGridCell, JRExporterGridCell leftGridCell, JRExporterGridCell rightGridCell, JRExporterGridCell bottomGridCell)	Since in PPTX we only have deep grids, this is called only for empty frames.
void	exportFrame(JRPrintFrame frame)
protected void	exportGenericElement(JRGenericPrintElement element)
protected void	exportGrid(JRGridLayout gridLayout)
void	exportImage(PptxTableHelper tableHelper, JRPrintImage image, JRExporterGridCell gridCell, JRExporterGridCell topGridCell, JRExporterGridCell leftGridCell, JRExporterGridCell rightGridCell, JRExporterGridCell bottomGridCell)
void	exportImage(JRPrintImage image)
protected void	exportLine(PptxTableHelper tableHelper, JRPrintLine line, JRExporterGridCell gridCell, JRExporterGridCell topGridCell, JRExporterGridCell leftGridCell, JRExporterGridCell rightGridCell, JRExporterGridCell bottomGridCell)
protected void	exportLine(JRPrintLine line)
protected void	exportPage(JRPrintPage page, boolean isBackgroundAsSlideMaster, boolean hasToSlideMasterElements)
protected boolean	exportPageToSlideMaster(JRPrintPage page, boolean isBackgroundAsSlideMaster)
protected void	exportPen(JRLineBox lineBox)
protected void	exportPen(JRPen pen)
protected void	exportRectangle(PptxTableHelper tableHelper, JRPrintGraphicElement rectangle, JRExporterGridCell gridCell, JRExporterGridCell topGridCell, JRExporterGridCell leftGridCell, JRExporterGridCell rightGridCell, JRExporterGridCell bottomGridCell)
protected void	exportRectangle(JRPrintElement rectangle, JRPen pen, int radius)
protected void	exportRectangle(JRPrintRectangle rectangle)
void	exportReport()	Performs the export.
protected void	exportReportToStream(OutputStream os)
protected void	exportStyledText(JRStyle style, JRStyledText styledText, Locale locale, String fieldType, String uuid)
void	exportText(PptxTableHelper tableHelper, JRPrintText text, JRExporterGridCell gridCell, JRExporterGridCell topGridCell, JRExporterGridCell leftGridCell, JRExporterGridCell rightGridCell, JRExporterGridCell bottomGridCell)
void	exportText(JRPrintText text)
protected Class<PptxExporterConfiguration>	getConfigurationInterface()
protected JRPrintElementIndex	getElementIndex()
protected JRPrintElementIndex	getElementIndex(JRExporterGridCell gridCell)
String	getExporterKey()
String	getExporterPropertiesPrefix()	Returns the properties prefix for the current exporter.
protected String	getHyperlinkTarget(JRPrintHyperlink link)
protected String	getHyperlinkURL(JRPrintHyperlink link)
protected Class<PptxReportConfiguration>	getItemConfigurationInterface()
protected JRPen	getPptxPen(JRLineBox box)
static JRPrintElementIndex	getPrintElementIndex(String imageName)
protected JRStyledText	getStyledText(JRPrintText textElement, boolean setBackcolor)
protected void	initExport()
protected void	initReport()
protected boolean	isFrameAsTable(JRPrintFrame frame)
protected void	setBox4Cell(JRExporterGridCell gridCell)
protected void	setBox4Line(JRPrintLine line, JRExporterGridCell gridCell)
protected void	setBox4Rectangle(JRPrintGraphicElement rectangle, JRExporterGridCell gridCell)
protected String	toOOXMLId(JRPrintElement element)

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

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, getTextFormatFactoryClass, getTextLocale, getTextTimeZone, getTextValue, getTextValueString, insideFrame, 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

PPTX_EXPORTER_KEY

public static final String PPTX_EXPORTER_KEY

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

See Also:

• Constant Field Values

EXCEPTION_MESSAGE_KEY_COLUMN_COUNT_OUT_OF_RANGE

public static final String EXCEPTION_MESSAGE_KEY_COLUMN_COUNT_OUT_OF_RANGE

See Also:

• Constant Field Values

PPTX_EXPORTER_PROPERTIES_PREFIX

public static final String PPTX_EXPORTER_PROPERTIES_PREFIX

See Also:

• Constant Field Values

PROPERTY_TO_SLIDE_MASTER

public static final String PROPERTY_TO_SLIDE_MASTER

Property that specifies if this element, when found on the first page of the document, should be exported into the slide master, and then ignored on all pages/slides.

See Also:

• Constant Field Values

PROPERTY_FIELD_TYPE

public static final String PROPERTY_FIELD_TYPE

Property that specifies the field type associated with this element in the PPTX export. When this property is set, the element value will be automatically updated when the presentation is open.

• slidenum - the current slide number will be displayed in this field
• datetime - the current date/time will be displayed in this field, according to some predefined patterns:
  1. MM/dd/yyyy
  2. EEEE, MMMM dd, yyyy
  3. dd MMMM yyyy
  4. MMMM dd, yyyy
  5. dd-MMM-yy
  6. MMMM yy
  7. MMM-yy
  8. MM/dd/yyyy hh:mm a
  9. MM/dd/yyyy hh:mm:ss a
  10. HH:mm
  11. HH:mm:ss
  12. hh:mm a
  13. hh:mm:ss a
  If none of the above patterns are set for the element, the date/time will be displayed using the default pattern of the PPTX viewer.

See Also:

• Constant Field Values

FIELD_TYPE_SLIDENUM

public static final String FIELD_TYPE_SLIDENUM

See Also:

• Constant Field Values

FIELD_TYPE_DATETIME

public static final String FIELD_TYPE_DATETIME

See Also:

• Constant Field Values

JR_PAGE_ANCHOR_PREFIX

protected 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

pptxZip

protected PptxZip pptxZip

fontHelper

protected PptxFontHelper fontHelper

presentationHelper

protected PptxPresentationHelper presentationHelper

presentationRelsHelper

protected PptxPresentationRelsHelper presentationRelsHelper

ctHelper

protected PptxContentTypesHelper ctHelper

appHelper

protected PropsAppHelper appHelper

coreHelper

protected PropsCoreHelper coreHelper

slideHelper

protected PptxSlideHelper slideHelper

slideRelsHelper

protected PptxSlideRelsHelper slideRelsHelper

presentationWriter

protected Writer presentationWriter

presentationRelsWriter

protected Writer presentationRelsWriter

rendererToImagePathMap

protected Map<String,Pair<String,ExifOrientationEnum>> rendererToImagePathMap

renderersCache

protected RenderersCache renderersCache

reportIndex

protected int reportIndex

pageIndex

protected int pageIndex

frameIndexStack

protected List<Integer> frameIndexStack

elementIndex

protected int elementIndex

invalidCharReplacement

protected String invalidCharReplacement

defaultFrameAsTable

protected boolean defaultFrameAsTable

slideIndex

protected int slideIndex

used for counting the total number of sheets

Constructor Details

JRPptxExporter

public JRPptxExporter()

See Also:

• JRPptxExporter(JasperReportsContext)

JRPptxExporter

public JRPptxExporter(JasperReportsContext jasperReportsContext)

Method Details

getConfigurationInterface

protected Class<PptxExporterConfiguration> getConfigurationInterface()

Specified by:

getConfigurationInterface in class JRAbstractExporter<PptxReportConfiguration,PptxExporterConfiguration,OutputStreamExporterOutput,JRPptxExporterContext>

getItemConfigurationInterface

protected Class<PptxReportConfiguration> getItemConfigurationInterface()

Specified by:

getItemConfigurationInterface in class JRAbstractExporter<PptxReportConfiguration,PptxExporterConfiguration,OutputStreamExporterOutput,JRPptxExporterContext>

exportReport

public void exportReport()
                  throws JRException

Description copied from interface: Exporter

Performs the export.

Specified by:

exportReport in interface Exporter<ExporterInput,PptxReportConfiguration,PptxExporterConfiguration,OutputStreamExporterOutput>

Specified by:

exportReport in class JRAbstractExporter<PptxReportConfiguration,PptxExporterConfiguration,OutputStreamExporterOutput,JRPptxExporterContext>

Throws:

JRException

initExport

protected void initExport()

Overrides:

initExport in class JRAbstractExporter<PptxReportConfiguration,PptxExporterConfiguration,OutputStreamExporterOutput,JRPptxExporterContext>

initReport

protected void initReport()

Overrides:

initReport in class JRAbstractExporter<PptxReportConfiguration,PptxExporterConfiguration,OutputStreamExporterOutput,JRPptxExporterContext>

exportReportToStream

protected void exportReportToStream(OutputStream os)
                             throws JRException,
IOException

Throws:

JRException

IOException

exportPageToSlideMaster

protected boolean exportPageToSlideMaster(JRPrintPage page,
 boolean isBackgroundAsSlideMaster)
                                   throws JRException

Throws:

JRException

exportPage

protected void exportPage(JRPrintPage page,
 boolean isBackgroundAsSlideMaster,
 boolean hasToSlideMasterElements)
                   throws JRException

Throws:

JRException

createSlideMaster

protected void createSlideMaster()

createSlide

protected void createSlide(boolean hideSlideMaster)

closeSlideMaster

protected void closeSlideMaster()

closeSlide

protected void closeSlide()

exportElement

protected void exportElement(JRPrintElement element)
                      throws JRException

Throws:

JRException

exportLine

protected void exportLine(JRPrintLine line)

exportPen

protected void exportPen(JRPen pen)

exportRectangle

protected void exportRectangle(JRPrintRectangle rectangle)

exportRectangle

protected void exportRectangle(JRPrintElement rectangle,
 JRPen pen,
 int radius)

exportEllipse

protected void exportEllipse(JRPrintEllipse ellipse)

exportText

public void exportText(JRPrintText text)

exportPen

protected void exportPen(JRLineBox lineBox)

exportStyledText

protected void exportStyledText(JRStyle style,
 JRStyledText styledText,
 Locale locale,
 String fieldType,
 String uuid)

exportImage

public void exportImage(JRPrintImage image)
                 throws JRException

Throws:

JRException

getElementIndex

protected JRPrintElementIndex getElementIndex()

getElementIndex

protected JRPrintElementIndex getElementIndex(JRExporterGridCell gridCell)

getPrintElementIndex

public static JRPrintElementIndex getPrintElementIndex(String imageName)

exportFrame

public void exportFrame(JRPrintFrame frame)
                 throws JRException

Throws:

JRException

exportFrame

protected void exportFrame(PptxTableHelper tableHelper,
 JRPrintFrame frame,
 JRExporterGridCell gridCell,
 JRExporterGridCell topGridCell,
 JRExporterGridCell leftGridCell,
 JRExporterGridCell rightGridCell,
 JRExporterGridCell bottomGridCell)
                    throws JRException

Since in PPTX we only have deep grids, this is called only for empty frames.

Throws:

JRException

exportGrid

protected void exportGrid(JRGridLayout gridLayout)
                   throws JRException

Throws:

JRException

exportLine

protected void exportLine(PptxTableHelper tableHelper,
 JRPrintLine line,
 JRExporterGridCell gridCell,
 JRExporterGridCell topGridCell,
 JRExporterGridCell leftGridCell,
 JRExporterGridCell rightGridCell,
 JRExporterGridCell bottomGridCell)

setBox4Line

protected void setBox4Line(JRPrintLine line,
 JRExporterGridCell gridCell)

exportRectangle

protected void exportRectangle(PptxTableHelper tableHelper,
 JRPrintGraphicElement rectangle,
 JRExporterGridCell gridCell,
 JRExporterGridCell topGridCell,
 JRExporterGridCell leftGridCell,
 JRExporterGridCell rightGridCell,
 JRExporterGridCell bottomGridCell)

setBox4Rectangle

protected void setBox4Rectangle(JRPrintGraphicElement rectangle,
 JRExporterGridCell gridCell)

setBox4Cell

protected void setBox4Cell(JRExporterGridCell gridCell)

exportImage

public void exportImage(PptxTableHelper tableHelper,
 JRPrintImage image,
 JRExporterGridCell gridCell,
 JRExporterGridCell topGridCell,
 JRExporterGridCell leftGridCell,
 JRExporterGridCell rightGridCell,
 JRExporterGridCell bottomGridCell)
                 throws JRException

Throws:

JRException

exportText

public void exportText(PptxTableHelper tableHelper,
 JRPrintText text,
 JRExporterGridCell gridCell,
 JRExporterGridCell topGridCell,
 JRExporterGridCell leftGridCell,
 JRExporterGridCell rightGridCell,
 JRExporterGridCell bottomGridCell)

exportGenericElement

protected void exportGenericElement(JRGenericPrintElement element)

getHyperlinkTarget

protected String getHyperlinkTarget(JRPrintHyperlink link)

getHyperlinkURL

protected String getHyperlinkURL(JRPrintHyperlink link)

getStyledText

protected JRStyledText getStyledText(JRPrintText textElement,
 boolean setBackcolor)

Overrides:

getStyledText in class JRAbstractExporter<PptxReportConfiguration,PptxExporterConfiguration,OutputStreamExporterOutput,JRPptxExporterContext>

getExporterKey

public String getExporterKey()

Specified by:

getExporterKey in class JRAbstractExporter<PptxReportConfiguration,PptxExporterConfiguration,OutputStreamExporterOutput,JRPptxExporterContext>

getExporterPropertiesPrefix

public String getExporterPropertiesPrefix()

Description copied from class: JRAbstractExporter

Returns the properties prefix for the current exporter.

Specified by:

getExporterPropertiesPrefix in class JRAbstractExporter<PptxReportConfiguration,PptxExporterConfiguration,OutputStreamExporterOutput,JRPptxExporterContext>

Returns:

the properties prefix for the current exporter

toOOXMLId

protected String toOOXMLId(JRPrintElement element)

getPptxPen

protected JRPen getPptxPen(JRLineBox box)

isFrameAsTable

protected boolean isFrameAsTable(JRPrintFrame frame)