Package net.sf.jasperreports.pdf

Interface PdfExporterConfiguration

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

  • Field Details

  • Method Details

    • isCreatingBatchModeBookmarks

      Boolean isCreatingBatchModeBookmarks()
      Returns a boolean value specifying whether the PDF document should contain an outline section.
      See Also:

    • isCompressed

      Boolean isCompressed()
      Returns a boolean value specifying whether the PDF document should be compressed.
      See Also:

    • isEncrypted

      Boolean isEncrypted()
      Returns a boolean value specifying whether the final PDF document should be encrypted.

      When set to Boolean.TRUE, this parameter instructs the exporter to encrypt the resulting PDF document. By default PDF files are not encrypted.

      See Also:

    • is128BitKey

      Boolean is128BitKey()
      Returns a boolean value specifying whether the encryption key is 128 bits.

      The PDF exporter can encrypt the files using either a 40-bit key or a 128-bit key. By default, it uses a 40-bit key, but if you set this flag to Boolean.TRUE, it can be configured to use a 128-bit key for stronger encryption.

      See Also:

    • getUserPassword

      String getUserPassword()
      The user password needed to open the document, if it is encrypted.
      See Also:

    • getOwnerPassword

      String getOwnerPassword()
      The password belonging to the owner of the document, if it is encrypted. If the password is null, it will be replaced by a random string, so that access is denied to all would-be owners.
      See Also:

    • getPdfVersion

      PdfVersionEnum getPdfVersion()
      Returns a Character instance representing the version of the generated PDF. This class contains predefined constants that can be passed as parameters directly.
      See Also:

    • getPdfJavaScript

      String getPdfJavaScript()
      The user defined JavaScript piece of code to be inserted in the generated PDF document.
      See Also:

    • getPrintScaling

      PdfPrintScalingEnum getPrintScaling()
      Setting specifying the print scaling preference in the PDF print dialog.

    • isTagged

      Boolean isTagged()
      Specifies whether the exporter should put structure tags in the generated PDF.
      See Also:

    • getTagLanguage

      String getTagLanguage()
      Specifies the language that the exporter should put in the language tag of the generated PDF.
      See Also:

    • getPdfaConformance

      PdfaConformanceEnum getPdfaConformance()
      The Conformance level of the PDF/A document.
      See Also:

    • getIccProfilePath

      String getIccProfilePath()
      The path to the ICC profile file needed for CMYK color conversion and/or the PDF/A compliance.
      See Also:

    • isEmbedIccProfile

      Boolean isEmbedIccProfile()
      Specifies whether the ICC profile, which in this case must be provided by getIccProfilePath(), is embedded into the PDF. PDFA compliance requires embedding the ICC profile, which inhibits this setting.
      See Also:

    • isUseCMYKColors

      Boolean isUseCMYKColors()
      Specifies whether the ICC profile, which in this case must be provided by getIccProfilePath(), is used to convert colors from RGB to CMYK color space.
      See Also:

    • getPermissions

      Integer getPermissions()
      An integer value representing the PDF permissions for the generated document. The open permissions for the document can be ALLOW_PRINTING, ALLOW_MODIFY_CONTENTS, ALLOW_COPY, ALLOW_MODIFY_ANNOTATIONS, ALLOW_FILL_IN, ALLOW_SCREENREADERS, ALLOW_ASSEMBLY and ALLOW_DEGRADED_PRINTING (these can all be found in the PdfWriter class of OpenPDF library). The permissions can be combined by applying bitwise OR to them.

    • getAllowedPermissions

      String getAllowedPermissions()
      An exporter hint property representing the allowed permissions for the generated PDF document. Allowed permissions for the document can be PRINTING, MODIFY_CONTENTS, COPY, MODIFY_ANNOTATIONS, FILL_IN,SCREENREADERS, ASSEMBLY, DEGRADED_PRINTING and ALL. Different permissions are separated by a pipe (|) character.

    • getDeniedPermissions

      String getDeniedPermissions()
      An exporter hint property representing the denied permissions for the generated PDF document. Denied permissions for the document can be PRINTING, MODIFY_CONTENTS, COPY, MODIFY_ANNOTATIONS, FILL_IN,SCREENREADERS, ASSEMBLY, DEGRADED_PRINTING and ALL. Different permissions are separated by a pipe (|) character.

    • getMetadataTitle

      String getMetadataTitle()
      The Title of the PDF document.

    • getMetadataAuthor

      String getMetadataAuthor()
      The Author of the PDF document.

    • getMetadataSubject

      String getMetadataSubject()
      The Subject of the PDF document.

    • getMetadataKeywords

      String getMetadataKeywords()
      The Keywords of the PDF document, as comma-separated String.

    • getMetadataCreator

      String getMetadataCreator()
      The Creator or Application for the PDF document. Defaults to "JasperReports Library version x.x.x".

    • getMetadataProducer

      String getMetadataProducer()
      The Producer of the PDF document.

    • isDisplayMetadataTitle

      Boolean isDisplayMetadataTitle()
      Specifies whether the document title should be displayed in the title bar instead of the file name.
      See Also: