Package net.sf.jasperreports.pdf

Interface PdfReportConfiguration

All Superinterfaces:
CommonExportConfiguration, ReportExportConfiguration
All Known Implementing Classes:
SimplePdfReportConfiguration
public interface PdfReportConfiguration extends ReportExportConfiguration
Interface containing settings used by the PDF exporter.
Author:
Teodor Danciu (teodord@users.sourceforge.net)
See Also:

  • Field Details

    • PROPERTY_FORCE_SVG_SHAPES

      static final String PROPERTY_FORCE_SVG_SHAPES
      Property that provides a default value for the isForceSvgShapes() PDF exporter configuration flag.
      See Also:

    • PROPERTY_BOOKMARKS_ENABLED

      static final String PROPERTY_BOOKMARKS_ENABLED
      Property that provides a default for the isBookmarksEnabled() export configuration flag.

      The property can be set globally and at report level. By default, the property is set to true.

      See Also:

    • PROPERTY_COLLAPSE_MISSING_BOOKMARK_LEVELS

      static final String PROPERTY_COLLAPSE_MISSING_BOOKMARK_LEVELS
      Property that provides a default for the isCollapseMissingBookmarkLevels() export configuration flag.

      The property can be set globally and at report level. By default, the property is set to false.

      Since:
      3.7.3
      See Also:

    • PROPERTY_SIZE_PAGE_TO_CONTENT

      static final String PROPERTY_SIZE_PAGE_TO_CONTENT
      Property which specifies a default for the isSizePageToContent() export configuration flag.
      See Also:

    • PROPERTY_FORCE_LINEBREAK_POLICY

      static final String PROPERTY_FORCE_LINEBREAK_POLICY
      Property that provides a default value for the isForceLineBreakPolicy() exporter configuration flag.
      See Also:

    • PROPERTY_ODD_PAGE_OFFSET_X

      static final String PROPERTY_ODD_PAGE_OFFSET_X
      Property that provides a default value for the getOddPageOffsetX() export configuration setting.
      See Also:

    • PROPERTY_ODD_PAGE_OFFSET_Y

      static final String PROPERTY_ODD_PAGE_OFFSET_Y
      Property that provides a default value for the getOddPageOffsetY() export configuration setting.
      See Also:

    • PROPERTY_EVEN_PAGE_OFFSET_X

      static final String PROPERTY_EVEN_PAGE_OFFSET_X
      Property that provides a default value for the getEvenPageOffsetX() export configuration setting.
      See Also:

    • PROPERTY_EVEN_PAGE_OFFSET_Y

      static final String PROPERTY_EVEN_PAGE_OFFSET_Y
      Property that provides a default value for the getEvenPageOffsetY() export configuration setting.
      See Also:

    • PROPERTY_PREFIX_GLYPH_RENDERER_BLOCKS

      static final String PROPERTY_PREFIX_GLYPH_RENDERER_BLOCKS
      Property prefix for specifying the Unicode blocks for which the glyph rendering mode should be used during PDF export. The glyph rendering mode writes text as GlyphVector directly to the PDF content, which allows correct rendering of complex scripts such as Indic languages (Devanagari, Bengali, Telugu, Tamil, etc.) that require advanced text shaping.

      Properties with this prefix should have an arbitrary suffix as name and a comma-separated list of Character.UnicodeBlock names as value. If the text of a report element contains characters belonging to any of the specified Unicode blocks, the glyph renderer will be used for the entire text element.

      See Also:

    • PROPERTY_GLYPH_RENDERER_ADD_ACTUAL_TEXT

      static final String PROPERTY_GLYPH_RENDERER_ADD_ACTUAL_TEXT
      Property that specifies whether the glyph renderer should add actual text to the PDF content when rendering text via GlyphVector. Adding actual text enables text selection, copy-paste, and searchability in the resulting PDF document for text that is rendered using the glyph rendering mode.

      When this property is set to true, the generated PDF will require at least PDF version 1.5. By default, this property is set to true.

      See Also:

  • Method Details

    • isForceSvgShapes

      Boolean isForceSvgShapes()
      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.
      See Also:

    • isBookmarksEnabled

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

      See Also:

    • isCollapseMissingBookmarkLevels

      Boolean isCollapseMissingBookmarkLevels()
      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.

      See Also:

    • isSizePageToContent

      Boolean isSizePageToContent()
      Flag which specifies if the size of each page should be increased to accommodate its content.
      See Also:

    • isIgnoreHyperlink

      Boolean isIgnoreHyperlink()
      See Also:

    • isForceLineBreakPolicy

      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.

      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.

      See Also:

    • getOddPageOffsetX

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

    • getOddPageOffsetY

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

    • getEvenPageOffsetX

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

    • getEvenPageOffsetY

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