net.sf.jasperreports.engine.export

Class JRPdfExporter

java.lang.Object

net.sf.jasperreports.engine.JRAbstractExporter

net.sf.jasperreports.engine.export.JRPdfExporter

All Implemented Interfaces:

JRExporter

public class JRPdfExporter
extends JRAbstractExporter

Exports a JasperReports document to PDF format. It has binary output type and exports the document to a free-form layout.

Version:

$Id: JRPdfExporter.java 5521 2012-07-30 13:25:30Z teodord $

Author:

Teodor Danciu (teodord@users.sourceforge.net)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	JRPdfExporter.Bookmark
protected static class	JRPdfExporter.BookmarkStack
protected class	JRPdfExporter.ExporterContext
static class	JRPdfExporter.NullOutputStream Output stream implementation that discards all the data.

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 com.lowagie.text.Document	document
protected JRPdfExporterContext	exporterContext
protected static boolean	fontsRegistered
protected boolean	forceSvgShapes
protected com.lowagie.text.Document	imageTesterDocument
protected com.lowagie.text.pdf.PdfContentByte	imageTesterPdfContentByte
protected boolean	is128BitKey
protected boolean	isCompressed
protected boolean	isCreatingBatchModeBookmarks
protected boolean	isEncrypted
protected static String	JR_PAGE_ANCHOR_PREFIX
protected Map<Renderable,com.lowagie.text.Image>	loadedImagesMap
protected String	ownerPassword
static String	PDF_EXPORTER_KEY The exporter key, as used in GenericElementHandlerEnviroment.getHandler(net.sf.jasperreports.engine.JRGenericElementType, String).
static String	PDF_EXPORTER_PROPERTIES_PREFIX
static String	PDF_FONT_DIRS_PREFIX Prefix of properties that specify font directories for the PDF exporter.
static String	PDF_FONT_FILES_PREFIX Prefix of properties that specify font files for the PDF exporter.
protected com.lowagie.text.pdf.PdfContentByte	pdfContentByte
protected String	pdfJavaScript
protected Character	pdfVersion
protected com.lowagie.text.pdf.PdfWriter	pdfWriter
protected int	permissions
protected String	printScaling
protected JRExportProgressMonitor	progressMonitor
protected com.lowagie.text.Image	pxImage
protected int	reportIndex
protected JRPdfExporterTagHelper	tagHelper
protected String	userPassword

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
JRPdfExporter()
JRPdfExporter(JasperReportsContext jasperReportsContext)

Method Summary

Methods

Modifier and Type	Method and Description
protected void	addBookmark(int level, String title, int x, int y)
protected void	exportBottomPen(JRPen leftPen, JRPen bottomPen, JRPen rightPen, JRPrintElement element)
protected void	exportBox(JRLineBox box, JRPrintElement element)
protected void	exportElements(Collection<JRPrintElement> elements)
protected void	exportEllipse(JRPrintEllipse ellipse)
protected void	exportFrame(JRPrintFrame frame)
protected void	exportGenericElement(JRGenericPrintElement element)
void	exportImage(JRPrintImage printImage)
protected void	exportLeftPen(JRPen topPen, JRPen leftPen, JRPen bottomPen, JRPrintElement element)
protected void	exportLine(JRPrintLine line)
protected void	exportPage(JRPrintPage page)
protected void	exportPen(JRPen pen, JRPrintElement element)
protected void	exportRectangle(JRPrintRectangle rectangle)
void	exportReport() Actually starts the export process.
protected void	exportReportToStream(OutputStream os)
protected void	exportRightPen(JRPen topPen, JRPen bottomPen, JRPen rightPen, JRPrintElement element)
void	exportText(JRPrintText text)
protected void	exportTopPen(JRPen topPen, JRPen leftPen, JRPen rightPen, JRPrintElement element)
protected com.lowagie.text.Chunk	getChunk(Map<AttributedCharacterIterator.Attribute,Object> attributes, String text, Locale locale)
protected String	getExporterKey()
protected com.lowagie.text.Font	getFont(Map<AttributedCharacterIterator.Attribute,Object> attributes, Locale locale, boolean setFontLines) Creates a PDF font.
protected com.lowagie.text.Phrase	getPhrase(AttributedString as, String text, JRPrintText textElement)
protected com.lowagie.text.Image	getPxImage()
protected boolean	hasStrikethrough(Map<AttributedCharacterIterator.Attribute,Object> textAttributes)
protected boolean	hasUnderline(Map<AttributedCharacterIterator.Attribute,Object> textAttributes)
protected void	initBookmarks()
protected static void	registerFonts()
protected void	setAnchor(com.lowagie.text.Chunk chunk, JRPrintAnchor anchor, JRPrintElement element)
protected void	setFontMap()
protected void	setHyperlinkInfo(com.lowagie.text.Chunk chunk, JRPrintHyperlink link)
protected void	setPageSize(JRPrintPage page)
protected void	setSplitCharacter()
protected void	writePageAnchor(int pageIndex)

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, 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

PDF_EXPORTER_PROPERTIES_PREFIX

public static final String PDF_EXPORTER_PROPERTIES_PREFIX

See Also:

Constant Field Values

PDF_FONT_FILES_PREFIX

public static final String PDF_FONT_FILES_PREFIX

Prefix of properties that specify font files for the PDF exporter.

See Also:

Constant Field Values

PDF_FONT_DIRS_PREFIX

public static final String PDF_FONT_DIRS_PREFIX

Prefix of properties that specify font directories for the PDF exporter.

See Also:

Constant Field Values

PDF_EXPORTER_KEY

public static final String PDF_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

fontsRegistered

protected static boolean fontsRegistered

document

protected com.lowagie.text.Document document

pdfContentByte

protected com.lowagie.text.pdf.PdfContentByte pdfContentByte

pdfWriter

protected com.lowagie.text.pdf.PdfWriter pdfWriter

imageTesterDocument

protected com.lowagie.text.Document imageTesterDocument

imageTesterPdfContentByte

protected com.lowagie.text.pdf.PdfContentByte imageTesterPdfContentByte

tagHelper

protected JRPdfExporterTagHelper tagHelper

progressMonitor

protected JRExportProgressMonitor progressMonitor

reportIndex

protected int reportIndex

forceSvgShapes

protected boolean forceSvgShapes

isCreatingBatchModeBookmarks

protected boolean isCreatingBatchModeBookmarks

isCompressed

protected boolean isCompressed

isEncrypted

protected boolean isEncrypted

is128BitKey

protected boolean is128BitKey

userPassword

protected String userPassword

ownerPassword

protected String ownerPassword

permissions

protected int permissions

pdfVersion

protected Character pdfVersion

pdfJavaScript

protected String pdfJavaScript

printScaling

protected String printScaling

loadedImagesMap

protected Map<Renderable,com.lowagie.text.Image> loadedImagesMap

pxImage

protected com.lowagie.text.Image pxImage

exporterContext

protected JRPdfExporterContext exporterContext

Constructor Detail

JRPdfExporter

public JRPdfExporter()

See Also:

JRPdfExporter(JasperReportsContext)

JRPdfExporter

public JRPdfExporter(JasperReportsContext jasperReportsContext)

Method Detail

getPxImage

protected com.lowagie.text.Image getPxImage()

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

setFontMap

protected void setFontMap()

Overrides:

setFontMap in class JRAbstractExporter

setSplitCharacter

protected void setSplitCharacter()

exportReportToStream

protected void exportReportToStream(OutputStream os)
                             throws JRException

Throws:

JRException

writePageAnchor

protected void writePageAnchor(int pageIndex)
                        throws com.lowagie.text.DocumentException

Throws:

com.lowagie.text.DocumentException

setPageSize

protected void setPageSize(JRPrintPage page)
                    throws JRException,
                           com.lowagie.text.DocumentException,
                           IOException

Throws:

JRException

com.lowagie.text.DocumentException

IOException

exportPage

protected void exportPage(JRPrintPage page)
                   throws JRException,
                          com.lowagie.text.DocumentException,
                          IOException

Throws:

JRException

com.lowagie.text.DocumentException

IOException

exportElements

protected void exportElements(Collection<JRPrintElement> elements)
                       throws com.lowagie.text.DocumentException,
                              IOException,
                              JRException

Throws:

com.lowagie.text.DocumentException

IOException

JRException

exportLine

protected void exportLine(JRPrintLine line)

exportRectangle

protected void exportRectangle(JRPrintRectangle rectangle)

exportEllipse

protected void exportEllipse(JRPrintEllipse ellipse)

exportImage

public void exportImage(JRPrintImage printImage)
                 throws com.lowagie.text.DocumentException,
                        IOException,
                        JRException

Throws:

com.lowagie.text.DocumentException

IOException

JRException

setHyperlinkInfo

protected void setHyperlinkInfo(com.lowagie.text.Chunk chunk,
                    JRPrintHyperlink link)

getPhrase

protected com.lowagie.text.Phrase getPhrase(AttributedString as,
                                String text,
                                JRPrintText textElement)

getChunk

protected com.lowagie.text.Chunk getChunk(Map<AttributedCharacterIterator.Attribute,Object> attributes,
                              String text,
                              Locale locale)

hasUnderline

protected boolean hasUnderline(Map<AttributedCharacterIterator.Attribute,Object> textAttributes)

hasStrikethrough

protected boolean hasStrikethrough(Map<AttributedCharacterIterator.Attribute,Object> textAttributes)

getFont

protected com.lowagie.text.Font getFont(Map<AttributedCharacterIterator.Attribute,Object> attributes,
                            Locale locale,
                            boolean setFontLines)

Creates a PDF font.

Parameters:

attributes - the text attributes of the font

locale - the locale for which to create the font

setFontLines - whether to set underline and strikethrough as font style

Returns:

the PDF font for the specified attributes

exportText

public void exportText(JRPrintText text)
                throws com.lowagie.text.DocumentException

Throws:

com.lowagie.text.DocumentException

exportBox

protected void exportBox(JRLineBox box,
             JRPrintElement element)

exportPen

protected void exportPen(JRPen pen,
             JRPrintElement element)

exportTopPen

protected void exportTopPen(JRPen topPen,
                JRPen leftPen,
                JRPen rightPen,
                JRPrintElement element)

exportLeftPen

protected void exportLeftPen(JRPen topPen,
                 JRPen leftPen,
                 JRPen bottomPen,
                 JRPrintElement element)

exportBottomPen

protected void exportBottomPen(JRPen leftPen,
                   JRPen bottomPen,
                   JRPen rightPen,
                   JRPrintElement element)

exportRightPen

protected void exportRightPen(JRPen topPen,
                  JRPen bottomPen,
                  JRPen rightPen,
                  JRPrintElement element)

registerFonts

protected static void registerFonts()

initBookmarks

protected void initBookmarks()

addBookmark

protected void addBookmark(int level,
               String title,
               int x,
               int y)

setAnchor

protected void setAnchor(com.lowagie.text.Chunk chunk,
             JRPrintAnchor anchor,
             JRPrintElement element)

exportFrame

protected void exportFrame(JRPrintFrame frame)
                    throws com.lowagie.text.DocumentException,
                           IOException,
                           JRException

Throws:

com.lowagie.text.DocumentException

IOException

JRException

exportGenericElement

protected void exportGenericElement(JRGenericPrintElement element)

getExporterKey

protected String getExporterKey()

Specified by:

getExporterKey in class JRAbstractExporter