Package net.sf.jasperreports.pdf

Class SimplePdfReportConfiguration

java.lang.Object

net.sf.jasperreports.export.SimpleCommonExportConfiguration

net.sf.jasperreports.export.SimpleReportExportConfiguration

net.sf.jasperreports.pdf.SimplePdfReportConfiguration

All Implemented Interfaces:

CommonExportConfiguration, ReportExportConfiguration, PdfReportConfiguration

public class SimplePdfReportConfiguration
extends SimpleReportExportConfiguration
implements PdfReportConfiguration

Author:

Teodor Danciu (teodord@users.sourceforge.net)

Field Summary

Fields inherited from interface net.sf.jasperreports.export.CommonExportConfiguration

PROPERTY_EXPORT_CONFIGURATION_OVERRIDE_REPORT_HINTS

Fields inherited from interface net.sf.jasperreports.pdf.PdfReportConfiguration

PROPERTY_BOOKMARKS_ENABLED, PROPERTY_COLLAPSE_MISSING_BOOKMARK_LEVELS, PROPERTY_EVEN_PAGE_OFFSET_X, PROPERTY_EVEN_PAGE_OFFSET_Y, PROPERTY_FORCE_LINEBREAK_POLICY, PROPERTY_FORCE_SVG_SHAPES, PROPERTY_GLYPH_RENDERER_ADD_ACTUAL_TEXT, PROPERTY_IGNORE_HYPERLINK, PROPERTY_ODD_PAGE_OFFSET_X, PROPERTY_ODD_PAGE_OFFSET_Y, PROPERTY_PREFIX_GLYPH_RENDERER_BLOCKS, PROPERTY_SIZE_PAGE_TO_CONTENT

Fields inherited from interface net.sf.jasperreports.export.ReportExportConfiguration

PROPERTY_IGNORE_PAGE_MARGINS

Constructor Summary

Constructors

Constructor	Description
SimplePdfReportConfiguration()

Method Summary

Modifier and Type	Method	Description
Integer	getEvenPageOffsetX()	Specifies the X offset for moving elements in even page number pages, to simulate gutter margins.
Integer	getEvenPageOffsetY()	Specifies the Y offset for moving elements in even page number pages, to simulate gutter margins.
Integer	getOddPageOffsetX()	Specifies the X offset for moving elements in odd page number pages, to simulate gutter margins.
Integer	getOddPageOffsetY()	Specifies the Y offset for moving elements in odd page number pages, to simulate gutter margins.
Boolean	isBookmarksEnabled()	Flag that determines if the bookmarks are to be created or not in the resulting PDF document.
Boolean	isCollapseMissingBookmarkLevels()	Flag that determines if missing bookmark levels are collapsed, or if empty bookmarks are created for the missing levels.
Boolean	isForceLineBreakPolicy()	Flag that decides whether the PDF exporter should use a SplitCharacter implementation which ensures that report texts are broken into lines by OpenPDF in the same manner as done by the fill process.
Boolean	isForceSvgShapes()	Flag to force the rendering of SVG images using shapes, on the PDF Graphics2D context.
Boolean	isIgnoreHyperlink()
Boolean	isSizePageToContent()	Flag which specifies if the size of each page should be increased to accommodate its content.
void	setBookmarksEnabled(Boolean isBookmarksEnabled)
void	setCollapseMissingBookmarkLevels(Boolean isCollapseMissingBookmarkLevels)
void	setEvenPageOffsetX(Integer evenPageOffsetX)
void	setEvenPageOffsetY(Integer evenPageOffsetY)
void	setForceLineBreakPolicy(Boolean isForceLineBreakPolicy)
void	setForceSvgShapes(Boolean isForceSvgShapes)
void	setIgnoreHyperlink(Boolean isIgnoreHyperlink)
void	setOddPageOffsetX(Integer oddPageOffsetX)
void	setOddPageOffsetY(Integer oddPageOffsetY)
void	setSizePageToContent(Boolean isSizePageToContent)

Methods inherited from class net.sf.jasperreports.export.SimpleReportExportConfiguration

getEndPageIndex, getExporterFilter, getHyperlinkProducerFactory, getOffsetX, getOffsetY, getPageIndex, getProgressMonitor, getStartPageIndex, setEndPageIndex, setExporterFilter, setHyperlinkProducerFactory, setOffsetX, setOffsetY, setPageIndex, setProgressMonitor, setStartPageIndex

Methods inherited from class net.sf.jasperreports.export.SimpleCommonExportConfiguration

isOverrideHints, setOverrideHints

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.sf.jasperreports.export.CommonExportConfiguration

isOverrideHints

Methods inherited from interface net.sf.jasperreports.export.ReportExportConfiguration

getEndPageIndex, getExporterFilter, getHyperlinkProducerFactory, getOffsetX, getOffsetY, getPageIndex, getProgressMonitor, getStartPageIndex

Constructor Details

SimplePdfReportConfiguration

public SimplePdfReportConfiguration()

Method Details

isForceSvgShapes

public Boolean isForceSvgShapes()

Description copied from interface: PdfReportConfiguration

Flag to force the rendering of SVG images using shapes, on the PDF Graphics2D context. This allows rendering fonts as shapes and avoid font mapping issues that might cause Unicode text not to show up properly, but has the disadvantage of producing larger PDF files. By default, the flag is set to true, mainly due to backward compatibility reasons. To reduce PDF file size for documents containing SVG images such as charts, the flag should be turned to false, and the PDF exporter font mappings should be correctly configured using the font extension support, to ensure proper rendering of text in the SVG. This flag can be set system-wide using the PROPERTY_FORCE_SVG_SHAPES property.

Specified by:

isForceSvgShapes in interface PdfReportConfiguration

See Also:

• PdfReportConfiguration.PROPERTY_FORCE_SVG_SHAPES

setForceSvgShapes

public void setForceSvgShapes(Boolean isForceSvgShapes)

isBookmarksEnabled

public Boolean isBookmarksEnabled()

Description copied from interface: PdfReportConfiguration

Flag that determines if the bookmarks are to be created or not in the resulting PDF document.

Specified by:

isBookmarksEnabled in interface PdfReportConfiguration

See Also:

• PdfReportConfiguration.PROPERTY_BOOKMARKS_ENABLED

setBookmarksEnabled

public void setBookmarksEnabled(Boolean isBookmarksEnabled)

isCollapseMissingBookmarkLevels

public Boolean isCollapseMissingBookmarkLevels()

Description copied from interface: PdfReportConfiguration

Flag that determines if missing bookmark levels are collapsed, or if empty bookmarks are created for the missing levels.

The flag dictates what happens when a filled report contains an anchor having a bookmark level that is not the immediate successor of its parent (e.g. an anchor with bookmark level 3 follows immediately after a bookmark of level 1). If the flag is not set, an empty bookmark is created for the missing level(s) in order to preserve the original level of the bookmark. When the property is set, the level of the bookmark will be collapsed and the bookmark will be created as a direct descendant of its nearest parent.

Specified by:

isCollapseMissingBookmarkLevels in interface PdfReportConfiguration

See Also:

• PdfReportConfiguration.PROPERTY_COLLAPSE_MISSING_BOOKMARK_LEVELS

setCollapseMissingBookmarkLevels

public void setCollapseMissingBookmarkLevels(Boolean isCollapseMissingBookmarkLevels)

isSizePageToContent

public Boolean isSizePageToContent()

Description copied from interface: PdfReportConfiguration

Flag which specifies if the size of each page should be increased to accommodate its content.

Specified by:

isSizePageToContent in interface PdfReportConfiguration

See Also:

• PdfReportConfiguration.PROPERTY_SIZE_PAGE_TO_CONTENT

setSizePageToContent

public void setSizePageToContent(Boolean isSizePageToContent)

isIgnoreHyperlink

public Boolean isIgnoreHyperlink()

Specified by:

isIgnoreHyperlink in interface PdfReportConfiguration

See Also:

• PdfReportConfiguration.PROPERTY_IGNORE_HYPERLINK

setIgnoreHyperlink

public void setIgnoreHyperlink(Boolean isIgnoreHyperlink)

isForceLineBreakPolicy

public Boolean isForceLineBreakPolicy()

Description copied from interface: PdfReportConfiguration

Flag that decides whether the PDF exporter should use a SplitCharacter implementation which ensures that report texts are broken into lines by OpenPDF in the same manner as done by the fill process.

The default line-breaking logic differs from AWT (which is used during the report fill) to OpenPDF (used by the PDF exporter). By setting this flag, the logic used by AWT is imposed to OpenPDF. The drawback is that the PDF export performance would drop. Because of this, the flag is not set by default.

This flag can be set system-wide using the PROPERTY_FORCE_LINEBREAK_POLICY property.

Specified by:

isForceLineBreakPolicy in interface PdfReportConfiguration

See Also:

• PdfReportConfiguration.PROPERTY_FORCE_LINEBREAK_POLICY
• BreakIteratorSplitCharacter

setForceLineBreakPolicy

public void setForceLineBreakPolicy(Boolean isForceLineBreakPolicy)

getOddPageOffsetX

public Integer getOddPageOffsetX()

Description copied from interface: PdfReportConfiguration

Specifies the X offset for moving elements in odd page number pages, to simulate gutter margins.

Specified by:

getOddPageOffsetX in interface PdfReportConfiguration

setOddPageOffsetX

public void setOddPageOffsetX(Integer oddPageOffsetX)

getOddPageOffsetY

public Integer getOddPageOffsetY()

Description copied from interface: PdfReportConfiguration

Specifies the Y offset for moving elements in odd page number pages, to simulate gutter margins.

Specified by:

getOddPageOffsetY in interface PdfReportConfiguration

setOddPageOffsetY

public void setOddPageOffsetY(Integer oddPageOffsetY)

getEvenPageOffsetX

public Integer getEvenPageOffsetX()

Description copied from interface: PdfReportConfiguration

Specifies the X offset for moving elements in even page number pages, to simulate gutter margins.

Specified by:

getEvenPageOffsetX in interface PdfReportConfiguration

setEvenPageOffsetX

public void setEvenPageOffsetX(Integer evenPageOffsetX)

getEvenPageOffsetY

public Integer getEvenPageOffsetY()

Description copied from interface: PdfReportConfiguration

Specifies the Y offset for moving elements in even page number pages, to simulate gutter margins.

Specified by:

getEvenPageOffsetY in interface PdfReportConfiguration

setEvenPageOffsetY

public void setEvenPageOffsetY(Integer evenPageOffsetY)