public interface PdfExporterConfiguration extends ExporterConfiguration
JRPdfExporter
Modifier and Type | Field and Description |
---|---|
static Integer |
ALL_PERMISSIONS
Integer property that contains all permissions for the generated PDF document
|
static String |
PROPERTY_128_BIT_KEY
Property whose value is used as default state of the
is128BitKey() export configuration flag. |
static String |
PROPERTY_COMPRESSED
Property whose value is used as default state of the
isCompressed() export configuration flag. |
static String |
PROPERTY_CREATE_BATCH_MODE_BOOKMARKS
Property whose value is used as default state of the
isCreatingBatchModeBookmarks() export configuration flag. |
static String |
PROPERTY_DISPLAY_METADATA_TITLE
Property whose value is used as default for the
isDisplayMetadataTitle() export configuration setting. |
static String |
PROPERTY_ENCRYPTED
Property whose value is used as default state of the
isEncrypted() 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 the
getMetadataAuthor() export configuration setting. |
static String |
PROPERTY_METADATA_CREATOR
Property whose value is used as default for the
getMetadataCreator() export configuration setting. |
static String |
PROPERTY_METADATA_KEYWORDS
Property whose value is used as default for the
getMetadataKeywords() export configuration setting. |
static String |
PROPERTY_METADATA_SUBJECT
Property whose value is used as default for the
getMetadataSubject() export configuration setting. |
static String |
PROPERTY_METADATA_TITLE
Property whose value is used as default for the
getMetadataTitle() export configuration setting. |
static String |
PROPERTY_OWNER_PASSWORD
Property whose value is used as default for the
getOwnerPassword() export configuration setting. |
static String |
PROPERTY_PDF_JAVASCRIPT
Property whose value is used as default for the
getPdfJavaScript() export configuration setting. |
static String |
PROPERTY_PDF_VERSION
Property whose value is used as default for the
getPdfVersion() export configuration setting. |
static String |
PROPERTY_PDFA_CONFORMANCE
Property whose value is used as default for the
getPdfaConformance() export configuration setting. |
static String |
PROPERTY_PDFA_ICC_PROFILE_PATH
Property whose value is used as default for the
getIccProfilePath() export configuration setting. |
static String |
PROPERTY_PERMISSIONS_ALLOWED
Property whose value is used as default for the
getAllowedPermissions() export configuration setting. |
static String |
PROPERTY_PERMISSIONS_DENIED
Property whose value is used as default for the
getDeniedPermissions() export configuration setting. |
static String |
PROPERTY_PRINT_SCALING
Property whose value is used as default state of the
getPrintScaling() export configuration setting. |
static String |
PROPERTY_TAG_LANGUAGE
Property whose value is used as default for the
getTagLanguage() export configuration setting. |
static String |
PROPERTY_TAGGED
Property whose value is used as default for the
isTagged() export configuration flag. |
static String |
PROPERTY_USER_PASSWORD
Property whose value is used as default for the
getUserPassword() export configuration setting. |
PROPERTY_EXPORT_CONFIGURATION_OVERRIDE_REPORT_HINTS
Modifier and Type | Method and 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 for the PDF/A compliant document.
|
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 |
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 |
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.
|
isOverrideHints
static final Integer ALL_PERMISSIONS
static final String PROPERTY_CREATE_BATCH_MODE_BOOKMARKS
isCreatingBatchModeBookmarks()
export configuration flag.
This property is by default not set (false
).JRPropertiesUtil
,
Constant Field Valuesstatic final String PROPERTY_COMPRESSED
isCompressed()
export configuration flag.
This property is by default not set (false
).JRPropertiesUtil
,
Constant Field Valuesstatic final String PROPERTY_ENCRYPTED
isEncrypted()
export configuration flag.
This property is by default not set (false
).JRPropertiesUtil
,
Constant Field Valuesstatic final String PROPERTY_128_BIT_KEY
is128BitKey()
export configuration flag.
This property is by default not set (false
).JRPropertiesUtil
,
Constant Field Valuesstatic final String PROPERTY_USER_PASSWORD
getUserPassword()
export configuration setting.JRPropertiesUtil
,
Constant Field Valuesstatic final String PROPERTY_OWNER_PASSWORD
getOwnerPassword()
export configuration setting.JRPropertiesUtil
,
Constant Field Valuesstatic final String PROPERTY_PERMISSIONS_ALLOWED
getAllowedPermissions()
export configuration setting.JRPropertiesUtil
,
Constant Field Valuesstatic final String PROPERTY_PERMISSIONS_DENIED
getDeniedPermissions()
export configuration setting.JRPropertiesUtil
,
Constant Field Valuesstatic final String PROPERTY_PDF_VERSION
getPdfVersion()
export configuration setting.
Possible values of the this property are 2, 3, 4, 5, 6 and 7.JRPropertiesUtil
,
Constant Field Valuesstatic final String PROPERTY_PDF_JAVASCRIPT
getPdfJavaScript()
export configuration setting.JRPropertiesUtil
,
Constant Field Valuesstatic final String PROPERTY_PRINT_SCALING
getPrintScaling()
export configuration setting.
By default, this property is set to PdfPrintScalingEnum.DEFAULT
.JRPropertiesUtil
,
Constant Field Valuesstatic final String PROPERTY_TAGGED
isTagged()
export configuration flag.JRPropertiesUtil
,
Constant Field Valuesstatic final String PROPERTY_TAG_LANGUAGE
getTagLanguage()
export configuration setting.JRPropertiesUtil
,
Constant Field Valuesstatic final String PROPERTY_PDFA_CONFORMANCE
getPdfaConformance()
export configuration setting.
By default, this property is set to PdfaConformanceEnum.NONE
.JRPropertiesUtil
,
Constant Field Valuesstatic final String PROPERTY_PDFA_ICC_PROFILE_PATH
getIccProfilePath()
export configuration setting.static final String PROPERTY_METADATA_TITLE
getMetadataTitle()
export configuration setting.static final String PROPERTY_METADATA_AUTHOR
getMetadataAuthor()
export configuration setting.static final String PROPERTY_METADATA_SUBJECT
getMetadataSubject()
export configuration setting.static final String PROPERTY_METADATA_KEYWORDS
getMetadataKeywords()
export configuration setting.static final String PROPERTY_METADATA_CREATOR
getMetadataCreator()
export configuration setting.static final String PROPERTY_DISPLAY_METADATA_TITLE
isDisplayMetadataTitle()
export configuration setting.static final String PROPERTY_JUSTIFIED_LETTER_SPACING
By default the property is set to false
.
Boolean isCreatingBatchModeBookmarks()
PROPERTY_CREATE_BATCH_MODE_BOOKMARKS
Boolean isCompressed()
PROPERTY_COMPRESSED
Boolean isEncrypted()
Boolean.TRUE
, this parameter instructs the exporter to
encrypt the resulting PDF document. By default PDF files are not encrypted.PROPERTY_ENCRYPTED
Boolean is128BitKey()
Boolean.TRUE
, it
can be configured to use a 128-bit key for stronger encryption.PROPERTY_128_BIT_KEY
String getUserPassword()
PROPERTY_USER_PASSWORD
String getOwnerPassword()
PROPERTY_OWNER_PASSWORD
PdfVersionEnum getPdfVersion()
PROPERTY_PDF_VERSION
String getPdfJavaScript()
PROPERTY_PDF_JAVASCRIPT
PdfPrintScalingEnum getPrintScaling()
Boolean isTagged()
PROPERTY_TAGGED
String getTagLanguage()
PROPERTY_TAG_LANGUAGE
PdfaConformanceEnum getPdfaConformance()
PROPERTY_PDFA_CONFORMANCE
String getIccProfilePath()
PROPERTY_PDFA_ICC_PROFILE_PATH
Integer getPermissions()
String getAllowedPermissions()
String getDeniedPermissions()
String getMetadataTitle()
String getMetadataAuthor()
String getMetadataSubject()
String getMetadataKeywords()
String getMetadataCreator()
Boolean isDisplayMetadataTitle()
PROPERTY_DISPLAY_METADATA_TITLE
Copyright © 2017. All rights reserved.