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:
JRPdfExporter
-
-
Field Summary
Fields Modifier and Type Field Description static Integer
ALL_PERMISSIONS
Integer property that contains all permissions for the generated PDF documentstatic String
PROPERTY_128_BIT_KEY
Property whose value is used as default state of theis128BitKey()
export configuration flag.static String
PROPERTY_COMPRESSED
Property whose value is used as default state of theisCompressed()
export configuration flag.static String
PROPERTY_CREATE_BATCH_MODE_BOOKMARKS
Property whose value is used as default state of theisCreatingBatchModeBookmarks()
export configuration flag.static String
PROPERTY_DISPLAY_METADATA_TITLE
Property whose value is used as default for theisDisplayMetadataTitle()
export configuration setting.static String
PROPERTY_EMBED_ICC_PROFILE
Property whose value is used as default for theisEmbedIccProfile()
export configuration setting.static String
PROPERTY_ENCRYPTED
Property whose value is used as default state of theisEncrypted()
export configuration flag.static String
PROPERTY_JUSTIFIED_LETTER_SPACING
Property that determines whether justified text alignment can modify letter spacing in words.static String
PROPERTY_METADATA_AUTHOR
Property whose value is used as default for thegetMetadataAuthor()
export configuration setting.static String
PROPERTY_METADATA_CREATOR
Property whose value is used as default for thegetMetadataCreator()
export configuration setting.static String
PROPERTY_METADATA_KEYWORDS
Property whose value is used as default for thegetMetadataKeywords()
export configuration setting.static String
PROPERTY_METADATA_PRODUCER
Property whose value is used as default for thegetMetadataProducer()
export configuration setting.static String
PROPERTY_METADATA_SUBJECT
Property whose value is used as default for thegetMetadataSubject()
export configuration setting.static String
PROPERTY_METADATA_TITLE
Property whose value is used as default for thegetMetadataTitle()
export configuration setting.static String
PROPERTY_OWNER_PASSWORD
Property whose value is used as default for thegetOwnerPassword()
export configuration setting.static String
PROPERTY_PDF_JAVASCRIPT
Property whose value is used as default for thegetPdfJavaScript()
export configuration setting.static String
PROPERTY_PDF_VERSION
Property whose value is used as default for thegetPdfVersion()
export configuration setting.static String
PROPERTY_PDFA_CONFORMANCE
Property whose value is used as default for thegetPdfaConformance()
export configuration setting.static String
PROPERTY_PDFA_ICC_PROFILE_PATH
Property whose value is used as default for thegetIccProfilePath()
export configuration setting.static String
PROPERTY_PERMISSIONS_ALLOWED
Property whose value is used as default for thegetAllowedPermissions()
export configuration setting.static String
PROPERTY_PERMISSIONS_DENIED
Property whose value is used as default for thegetDeniedPermissions()
export configuration setting.static String
PROPERTY_PRINT_SCALING
Property whose value is used as default state of thegetPrintScaling()
export configuration setting.static String
PROPERTY_TAG_LANGUAGE
Property whose value is used as default for thegetTagLanguage()
export configuration setting.static String
PROPERTY_TAGGED
Property whose value is used as default for theisTagged()
export configuration flag.static String
PROPERTY_USE_CMYK_COLORS
Property whose value is used as default for theisUseCMYKColors()
export configuration setting.static String
PROPERTY_USER_PASSWORD
Property whose value is used as default for thegetUserPassword()
export configuration setting.-
Fields inherited from interface net.sf.jasperreports.export.CommonExportConfiguration
PROPERTY_EXPORT_CONFIGURATION_OVERRIDE_REPORT_HINTS
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description String
getAllowedPermissions()
An exporter hint property representing the allowed permissions for the generated PDF document.String
getDeniedPermissions()
An exporter hint property representing the denied permissions for the generated PDF document.String
getIccProfilePath()
The path to the ICC profile file needed for CMYK color conversion and/or the PDF/A compliance.String
getMetadataAuthor()
The Author of the PDF document.String
getMetadataCreator()
The Creator or Application for the PDF document.String
getMetadataKeywords()
The Keywords of the PDF document, as comma-separated String.String
getMetadataProducer()
The Producer of the PDF document.String
getMetadataSubject()
The Subject of the PDF document.String
getMetadataTitle()
The Title of the PDF document.String
getOwnerPassword()
The password belonging to the owner of the document, if it is encrypted.PdfaConformanceEnum
getPdfaConformance()
The Conformance level of the PDF/A document.String
getPdfJavaScript()
The user defined JavaScript piece of code to be inserted in the generated PDF document.PdfVersionEnum
getPdfVersion()
Returns a Character instance representing the version of the generated PDF.Integer
getPermissions()
An integer value representing the PDF permissions for the generated document.PdfPrintScalingEnum
getPrintScaling()
Setting specifying the print scaling preference in the PDF print dialog.String
getTagLanguage()
Specifies the language that the exporter should put in the language tag of the generated PDF.String
getUserPassword()
The user password needed to open the document, if it is encrypted.Boolean
is128BitKey()
Returns a boolean value specifying whether the encryption key is 128 bits.Boolean
isCompressed()
Returns a boolean value specifying whether the PDF document should be compressed.Boolean
isCreatingBatchModeBookmarks()
Returns a boolean value specifying whether the PDF document should contain an outline section.Boolean
isDisplayMetadataTitle()
Specifies whether the document title should be displayed in the title bar instead of the file name.Boolean
isEmbedIccProfile()
Specifies whether the ICC profile, which in this case must be provided bygetIccProfilePath()
, is embedded into the PDF.Boolean
isEncrypted()
Returns a boolean value specifying whether the final PDF document should be encrypted.Boolean
isTagged()
Specifies whether the exporter should put structure tags in the generated PDF.Boolean
isUseCMYKColors()
Specifies whether the ICC profile, which in this case must be provided bygetIccProfilePath()
, is used to convert colors from RGB to CMYK color space.-
Methods inherited from interface net.sf.jasperreports.export.CommonExportConfiguration
isOverrideHints
-
-
-
-
Field Detail
-
ALL_PERMISSIONS
static final Integer ALL_PERMISSIONS
Integer property that contains all permissions for the generated PDF document
-
PROPERTY_CREATE_BATCH_MODE_BOOKMARKS
static final String PROPERTY_CREATE_BATCH_MODE_BOOKMARKS
Property whose value is used as default state of theisCreatingBatchModeBookmarks()
export configuration flag. This property is by default not set (false
).- See Also:
JRPropertiesUtil
, Constant Field Values
-
PROPERTY_COMPRESSED
static final String PROPERTY_COMPRESSED
Property whose value is used as default state of theisCompressed()
export configuration flag. This property is by default not set (false
).- See Also:
JRPropertiesUtil
, Constant Field Values
-
PROPERTY_ENCRYPTED
static final String PROPERTY_ENCRYPTED
Property whose value is used as default state of theisEncrypted()
export configuration flag. This property is by default not set (false
).- See Also:
JRPropertiesUtil
, Constant Field Values
-
PROPERTY_128_BIT_KEY
static final String PROPERTY_128_BIT_KEY
Property whose value is used as default state of theis128BitKey()
export configuration flag. This property is by default not set (false
).- See Also:
JRPropertiesUtil
, Constant Field Values
-
PROPERTY_USER_PASSWORD
static final String PROPERTY_USER_PASSWORD
Property whose value is used as default for thegetUserPassword()
export configuration setting.- See Also:
JRPropertiesUtil
, Constant Field Values
-
PROPERTY_OWNER_PASSWORD
static final String PROPERTY_OWNER_PASSWORD
Property whose value is used as default for thegetOwnerPassword()
export configuration setting.- See Also:
JRPropertiesUtil
, Constant Field Values
-
PROPERTY_PERMISSIONS_ALLOWED
static final String PROPERTY_PERMISSIONS_ALLOWED
Property whose value is used as default for thegetAllowedPermissions()
export configuration setting.- See Also:
JRPropertiesUtil
, Constant Field Values
-
PROPERTY_PERMISSIONS_DENIED
static final String PROPERTY_PERMISSIONS_DENIED
Property whose value is used as default for thegetDeniedPermissions()
export configuration setting.- See Also:
JRPropertiesUtil
, Constant Field Values
-
PROPERTY_PDF_VERSION
static final String PROPERTY_PDF_VERSION
Property whose value is used as default for thegetPdfVersion()
export configuration setting. Possible values of the this property are 2, 3, 4, 5, 6 and 7.- See Also:
JRPropertiesUtil
, Constant Field Values
-
PROPERTY_PDF_JAVASCRIPT
static final String PROPERTY_PDF_JAVASCRIPT
Property whose value is used as default for thegetPdfJavaScript()
export configuration setting.- See Also:
JRPropertiesUtil
, Constant Field Values
-
PROPERTY_PRINT_SCALING
static final String PROPERTY_PRINT_SCALING
Property whose value is used as default state of thegetPrintScaling()
export configuration setting. By default, this property is set toPdfPrintScalingEnum.DEFAULT
.- See Also:
JRPropertiesUtil
, Constant Field Values
-
PROPERTY_TAGGED
static final String PROPERTY_TAGGED
Property whose value is used as default for theisTagged()
export configuration flag.- See Also:
JRPropertiesUtil
, Constant Field Values
-
PROPERTY_TAG_LANGUAGE
static final String PROPERTY_TAG_LANGUAGE
Property whose value is used as default for thegetTagLanguage()
export configuration setting.- See Also:
JRPropertiesUtil
, Constant Field Values
-
PROPERTY_PDFA_CONFORMANCE
static final String PROPERTY_PDFA_CONFORMANCE
Property whose value is used as default for thegetPdfaConformance()
export configuration setting. By default, this property is set toPdfaConformanceEnum.NONE
.- See Also:
JRPropertiesUtil
, Constant Field Values
-
PROPERTY_PDFA_ICC_PROFILE_PATH
static final String PROPERTY_PDFA_ICC_PROFILE_PATH
Property whose value is used as default for thegetIccProfilePath()
export configuration setting.- See Also:
- Constant Field Values
-
PROPERTY_EMBED_ICC_PROFILE
static final String PROPERTY_EMBED_ICC_PROFILE
Property whose value is used as default for theisEmbedIccProfile()
export configuration setting.- See Also:
- Constant Field Values
-
PROPERTY_USE_CMYK_COLORS
static final String PROPERTY_USE_CMYK_COLORS
Property whose value is used as default for theisUseCMYKColors()
export configuration setting.- See Also:
- Constant Field Values
-
PROPERTY_METADATA_TITLE
static final String PROPERTY_METADATA_TITLE
Property whose value is used as default for thegetMetadataTitle()
export configuration setting.- See Also:
- Constant Field Values
-
PROPERTY_METADATA_AUTHOR
static final String PROPERTY_METADATA_AUTHOR
Property whose value is used as default for thegetMetadataAuthor()
export configuration setting.- See Also:
- Constant Field Values
-
PROPERTY_METADATA_SUBJECT
static final String PROPERTY_METADATA_SUBJECT
Property whose value is used as default for thegetMetadataSubject()
export configuration setting.- See Also:
- Constant Field Values
-
PROPERTY_METADATA_KEYWORDS
static final String PROPERTY_METADATA_KEYWORDS
Property whose value is used as default for thegetMetadataKeywords()
export configuration setting.- See Also:
- Constant Field Values
-
PROPERTY_METADATA_CREATOR
static final String PROPERTY_METADATA_CREATOR
Property whose value is used as default for thegetMetadataCreator()
export configuration setting.- See Also:
- Constant Field Values
-
PROPERTY_METADATA_PRODUCER
static final String PROPERTY_METADATA_PRODUCER
Property whose value is used as default for thegetMetadataProducer()
export configuration setting.- See Also:
- Constant Field Values
-
PROPERTY_DISPLAY_METADATA_TITLE
static final String PROPERTY_DISPLAY_METADATA_TITLE
Property whose value is used as default for theisDisplayMetadataTitle()
export configuration setting.- See Also:
- Constant Field Values
-
PROPERTY_JUSTIFIED_LETTER_SPACING
static final String PROPERTY_JUSTIFIED_LETTER_SPACING
Property that determines whether justified text alignment can modify letter spacing in words.By default the property is set to
false
.- See Also:
- Constant Field Values
-
-
Method Detail
-
isCreatingBatchModeBookmarks
Boolean isCreatingBatchModeBookmarks()
Returns a boolean value specifying whether the PDF document should contain an outline section.- See Also:
PROPERTY_CREATE_BATCH_MODE_BOOKMARKS
-
isCompressed
Boolean isCompressed()
Returns a boolean value specifying whether the PDF document should be compressed.- See Also:
PROPERTY_COMPRESSED
-
isEncrypted
Boolean isEncrypted()
Returns a boolean value specifying whether the final PDF document should be encrypted. When set toBoolean.TRUE
, this parameter instructs the exporter to encrypt the resulting PDF document. By default PDF files are not encrypted.- See Also:
PROPERTY_ENCRYPTED
-
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 toBoolean.TRUE
, it can be configured to use a 128-bit key for stronger encryption.- See Also:
PROPERTY_128_BIT_KEY
-
getUserPassword
String getUserPassword()
The user password needed to open the document, if it is encrypted.- See Also:
PROPERTY_USER_PASSWORD
-
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:
PROPERTY_OWNER_PASSWORD
-
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:
PROPERTY_PDF_VERSION
-
getPdfJavaScript
String getPdfJavaScript()
The user defined JavaScript piece of code to be inserted in the generated PDF document.- See Also:
PROPERTY_PDF_JAVASCRIPT
-
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:
PROPERTY_TAGGED
-
getTagLanguage
String getTagLanguage()
Specifies the language that the exporter should put in the language tag of the generated PDF.- See Also:
PROPERTY_TAG_LANGUAGE
-
getPdfaConformance
PdfaConformanceEnum getPdfaConformance()
The Conformance level of the PDF/A document.- See Also:
PROPERTY_PDFA_CONFORMANCE
-
getIccProfilePath
String getIccProfilePath()
The path to the ICC profile file needed for CMYK color conversion and/or the PDF/A compliance.- See Also:
PROPERTY_PDFA_ICC_PROFILE_PATH
-
isEmbedIccProfile
Boolean isEmbedIccProfile()
Specifies whether the ICC profile, which in this case must be provided bygetIccProfilePath()
, is embedded into the PDF. PDFA compliance requires embedding the ICC profile, which inhibits this setting.- See Also:
PROPERTY_USE_CMYK_COLORS
-
isUseCMYKColors
Boolean isUseCMYKColors()
Specifies whether the ICC profile, which in this case must be provided bygetIccProfilePath()
, is used to convert colors from RGB to CMYK color space.- See Also:
PROPERTY_USE_CMYK_COLORS
-
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:
PROPERTY_DISPLAY_METADATA_TITLE
-
-