JRPptxExporter (JasperReports 5.5.1 API)

java.lang.Object
- net.sf.jasperreports.engine.JRAbstractExporter
- - net.sf.jasperreports.engine.export.ooxml.JRPptxExporter

All Implemented Interfaces:

JRExporter
```
public class JRPptxExporter
extends JRAbstractExporter
```
Exports a JasperReports document to PPTX format.

Version:

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

Author:

Teodor Danciu (teodord@users.sourceforge.net)

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

protected class JRPptxExporter.ExporterContext
- Nested classes/interfaces inherited from class net.sf.jasperreports.engine.JRAbstractExporter
  JRAbstractExporter.BaseExporterContext, JRAbstractExporter.ParameterOverriddenResolver, JRAbstractExporter.ParameterOverrideResolver, JRAbstractExporter.ParameterResolver

Nested Classes
Modifier and Type	Class and Description
`protected class`	`JRPptxExporter.ExporterContext`

Field Summary

Fields
Modifier and Type	Field and Description
`protected PptxContentTypesHelper`	`ctHelper`
`protected int`	`elementIndex`
`protected JRPptxExporterContext`	`exporterContext`
`protected List<Integer>`	`frameIndexStack`
`static String`	`IMAGE_NAME_PREFIX`
`protected static int`	`IMAGE_NAME_PREFIX_LEGTH`
`protected List<JRPrintElementIndex>`	`imagesToProcess`
`protected String`	`invalidCharReplacement`
`protected static String`	`JR_PAGE_ANCHOR_PREFIX`
`protected int`	`pageIndex`
`static String`	`PPTX_EXPORTER_KEY` The exporter key, as used in `GenericElementHandlerEnviroment.getHandler(net.sf.jasperreports.engine.JRGenericElementType, String)`.
`protected static String`	`PPTX_EXPORTER_PROPERTIES_PREFIX`
`protected PptxZip`	`pptxZip`
`protected PptxPresentationHelper`	`presentationHelper`
`protected PptxPresentationRelsHelper`	`presentationRelsHelper`
`protected Writer`	`presentationWriter`
`protected JRExportProgressMonitor`	`progressMonitor`
`static String`	`PROPERTY_IGNORE_HYPERLINK`
`protected Map<String,String>`	`rendererToImagePathMap`
`protected int`	`reportIndex`
`protected PptxSlideHelper`	`slideHelper`
`protected int`	`slideIndex` used for counting the total number of sheets
`protected PptxSlideRelsHelper`	`slideRelsHelper`
`protected boolean`	`startPage`

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

JRPptxExporter()

JRPptxExporter(JasperReportsContext jasperReportsContext)

Constructors
Constructor and Description
`JRPptxExporter()`
`JRPptxExporter(JasperReportsContext jasperReportsContext)`

Method Summary

Methods
Modifier and Type	Method and Description
`protected void`	`closeSlide()`
`protected void`	`createSlide(String name)`
`protected void`	`exportElements(List<JRPrintElement> elements)`
`protected void`	`exportEllipse(JRPrintEllipse ellipse)`
`void`	`exportFrame(JRPrintFrame frame)`
`protected void`	`exportGenericElement(JRGenericPrintElement element)`
`void`	`exportImage(JRPrintImage image)`
`protected void`	`exportLine(JRPrintLine line)`
`protected void`	`exportPage(JRPrintPage page)`
`protected void`	`exportRectangle(JRPrintRectangle rectangle)`
`void`	`exportReport()` Actually starts the export process.
`protected void`	`exportReportToStream(OutputStream os)`
`protected void`	`exportStyledText(JRStyle style, JRStyledText styledText, Locale locale)`
`void`	`exportText(JRPrintText text)`
`protected JRPrintElementIndex`	`getElementIndex()`
`String`	`getExporterKey()`
`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)`
`protected String`	`getImagePath(Renderable renderer, boolean isLazy)`
`static JRPrintElementIndex`	`getPrintElementIndex(String imageName)` protected void writeImageMap(String imageMapName, JRPrintHyperlink mainHyperlink, List imageMapAreas) { writer.write("\n"); for (Iterator it = imageMapAreas.iterator(); it.hasNext();) { JRPrintImageAreaHyperlink areaHyperlink = (JRPrintImageAreaHyperlink) it.next(); JRPrintImageArea area = areaHyperlink.getArea(); writer.write(" \n"); } if (mainHyperlink.getHyperlinkTypeValue() !
`protected void`	`setExporterHints()`

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, setInput, 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
  - PPTX_EXPORTER_KEY
```
public static final String PPTX_EXPORTER_KEY
```
    The exporter key, as used in GenericElementHandlerEnviroment.getHandler(net.sf.jasperreports.engine.JRGenericElementType, String).
    
    See Also:
    Constant Field Values
  - PPTX_EXPORTER_PROPERTIES_PREFIX
```
protected static final String PPTX_EXPORTER_PROPERTIES_PREFIX
```
    See Also:
    Constant Field Values
  - PROPERTY_IGNORE_HYPERLINK
```
public static final String PROPERTY_IGNORE_HYPERLINK
```
    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
```
  - presentationHelper
```
protected PptxPresentationHelper presentationHelper
```
  - presentationRelsHelper
```
protected PptxPresentationRelsHelper presentationRelsHelper
```
  - ctHelper
```
protected PptxContentTypesHelper ctHelper
```
  - slideHelper
```
protected PptxSlideHelper slideHelper
```
  - slideRelsHelper
```
protected PptxSlideRelsHelper slideRelsHelper
```
  - presentationWriter
```
protected Writer presentationWriter
```
  - progressMonitor
```
protected JRExportProgressMonitor progressMonitor
```
  - rendererToImagePathMap
```
protected Map<String,String> rendererToImagePathMap
```
  - imagesToProcess
```
protected List<JRPrintElementIndex> imagesToProcess
```
  - reportIndex
```
protected int reportIndex
```
  - pageIndex
```
protected int pageIndex
```
  - frameIndexStack
```
protected List<Integer> frameIndexStack
```
  - elementIndex
```
protected int elementIndex
```
  - startPage
```
protected boolean startPage
```
  - invalidCharReplacement
```
protected String invalidCharReplacement
```
  - slideIndex
```
protected int slideIndex
```
    used for counting the total number of sheets
  - exporterContext
```
protected JRPptxExporterContext exporterContext
```
- Constructor Detail
  - JRPptxExporter
```
public JRPptxExporter()
```
    See Also:
    JRPptxExporter(JasperReportsContext)
  - JRPptxExporter
```
public JRPptxExporter(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
  - createSlide
```
protected void createSlide(String name)
```
  - closeSlide
```
protected void closeSlide()
```
  - exportElements
```
protected void exportElements(List<JRPrintElement> elements)
                       throws JRException
```
    Throws:
    
    JRException
  - exportLine
```
protected void exportLine(JRPrintLine line)
```
  - exportRectangle
```
protected void exportRectangle(JRPrintRectangle rectangle)
```
  - exportEllipse
```
protected void exportEllipse(JRPrintEllipse ellipse)
```
  - exportText
```
public void exportText(JRPrintText text)
```
  - exportStyledText
```
protected void exportStyledText(JRStyle style,
                    JRStyledText styledText,
                    Locale locale)
```
  - exportImage
```
public void exportImage(JRPrintImage image)
                 throws JRException
```
    Throws:
    
    JRException
  - getImagePath
```
protected String getImagePath(Renderable renderer,
                  boolean isLazy)
```
  - getElementIndex
```
protected JRPrintElementIndex getElementIndex()
```
  - getPrintElementIndex
```
public static JRPrintElementIndex getPrintElementIndex(String imageName)
```
    protected void writeImageMap(String imageMapName, JRPrintHyperlink mainHyperlink, List imageMapAreas) { writer.write("\n"); for (Iterator it = imageMapAreas.iterator(); it.hasNext();) { JRPrintImageAreaHyperlink areaHyperlink = (JRPrintImageAreaHyperlink) it.next(); JRPrintImageArea area = areaHyperlink.getArea(); writer.write(" \n"); } if (mainHyperlink.getHyperlinkTypeValue() != NONE) { writer.write(" \n"); } 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("\""); } } /**
  - exportFrame
```
public void exportFrame(JRPrintFrame frame)
                 throws JRException
```
    Throws:
    
    JRException
  - exportGenericElement
```
protected void exportGenericElement(JRGenericPrintElement element)
```
  - getHyperlinkTarget
```
protected String getHyperlinkTarget(JRPrintHyperlink link)
```
  - getHyperlinkURL
```
protected String getHyperlinkURL(JRPrintHyperlink link)
```
  - getExporterPropertiesPrefix
```
protected String getExporterPropertiesPrefix()
```
  - getExporterKey
```
public String getExporterKey()
```
    Specified by:
    
    getExporterKey in class JRAbstractExporter
  - setExporterHints
```
protected void setExporterHints()
```

Class JRPptxExporter

Nested Class Summary

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

Field Summary

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

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Field Detail

PPTX_EXPORTER_KEY

PPTX_EXPORTER_PROPERTIES_PREFIX

PROPERTY_IGNORE_HYPERLINK

JR_PAGE_ANCHOR_PREFIX

IMAGE_NAME_PREFIX

IMAGE_NAME_PREFIX_LEGTH

pptxZip

presentationHelper

presentationRelsHelper

ctHelper

slideHelper

slideRelsHelper

presentationWriter

progressMonitor

rendererToImagePathMap

imagesToProcess

reportIndex

pageIndex

frameIndexStack

elementIndex

startPage

invalidCharReplacement

slideIndex

exporterContext

Constructor Detail

JRPptxExporter

JRPptxExporter

Method Detail

exportReport

getImage

getImage

exportReportToStream

exportPage

createSlide

closeSlide

exportElements

exportLine

exportRectangle

exportEllipse

exportText

exportStyledText

exportImage

getImagePath

getElementIndex

getPrintElementIndex

exportFrame

exportGenericElement

getHyperlinkTarget

getHyperlinkURL

getExporterPropertiesPrefix

getExporterKey

setExporterHints