com.itextpdf.kernel.pdf

Class WriterProperties

java.lang.Object

com.itextpdf.kernel.pdf.WriterProperties

All Implemented Interfaces:

Serializable

public class WriterProperties
extends Object
implements Serializable

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	addXmpMetadata
protected int	compressionLevel
protected boolean	debugMode
protected EncryptionProperties	encryptionProperties
protected PdfString	initialDocumentId The ID entry that represents the initial identifier.
protected Boolean	isFullCompression Indicates if to use full compression (using object streams).
protected PdfString	modifiedDocumentId The ID entry that represents a change in a document.
protected PdfVersion	pdfVersion
protected boolean	smartMode Indicates if the writer copy objects in a smart mode.

Constructor Summary

Constructors

Constructor and Description
WriterProperties()

Method Summary

Modifier and Type	Method and Description
WriterProperties	addXmpMetadata() If true, default XMPMetadata based on PdfDocumentInfo will be added.
WriterProperties	setCompressionLevel(int compressionLevel) Defines the level of compression for the document.
WriterProperties	setFullCompressionMode(boolean fullCompressionMode) Defines if full compression mode is enabled.
WriterProperties	setInitialDocumentId(PdfString initialDocumentId) The /ID entry of a document contains an array with two entries.
WriterProperties	setModifiedDocumentId(PdfString modifiedDocumentId) The /ID entry of a document contains an array with two entries.
WriterProperties	setPdfVersion(PdfVersion version) Defines pdf version for the created document.
WriterProperties	setPublicKeyEncryption(Certificate[] certs, int[] permissions, int encryptionAlgorithm) Sets the certificate encryption options for the document.
WriterProperties	setStandardEncryption(byte[] userPassword, byte[] ownerPassword, int permissions, int encryptionAlgorithm) Sets the encryption options for the document.
WriterProperties	useDebugMode() This activates debug mode with pdfDebug tool.
WriterProperties	useSmartMode() Enables smart mode.

Methods inherited from class java.lang.Object

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

Field Detail

compressionLevel

protected int compressionLevel

isFullCompression

protected Boolean isFullCompression

Indicates if to use full compression (using object streams).

smartMode

protected boolean smartMode

Indicates if the writer copy objects in a smart mode. If so PdfDictionary and PdfStream will be hashed and reused if there's an object with the same content later.

debugMode

protected boolean debugMode

addXmpMetadata

protected boolean addXmpMetadata

pdfVersion

protected PdfVersion pdfVersion

encryptionProperties

protected EncryptionProperties encryptionProperties

initialDocumentId

protected PdfString initialDocumentId

The ID entry that represents the initial identifier.

modifiedDocumentId

protected PdfString modifiedDocumentId

The ID entry that represents a change in a document.

Constructor Detail

WriterProperties

public WriterProperties()

Method Detail

setPdfVersion

public WriterProperties setPdfVersion(PdfVersion version)

Defines pdf version for the created document. Default value is PDF_1_7.

Parameters:

version - version for the document.

Returns:

this WriterProperties instance

useSmartMode

public WriterProperties useSmartMode()

Enables smart mode.
In smart mode when resources (such as fonts, images,...) are encountered, a reference to these resources is saved in a cache, so that they can be reused. This requires more memory, but reduces the file size of the resulting PDF document.

Returns:

this WriterProperties instance

addXmpMetadata

public WriterProperties addXmpMetadata()

If true, default XMPMetadata based on PdfDocumentInfo will be added.

Returns:

this WriterProperties instance

setCompressionLevel

public WriterProperties setCompressionLevel(int compressionLevel)

Defines the level of compression for the document. See CompressionConstants

Parameters:

compressionLevel -

Returns:

this WriterProperties instance

setFullCompressionMode

public WriterProperties setFullCompressionMode(boolean fullCompressionMode)

Defines if full compression mode is enabled. If enabled, not only the content of the pdf document will be compressed, but also the pdf document inner structure.

Parameters:

fullCompressionMode - true - to enable full compression mode, false to disable it

Returns:

this WriterProperties instance

setStandardEncryption

public WriterProperties setStandardEncryption(byte[] userPassword,
                                              byte[] ownerPassword,
                                              int permissions,
                                              int encryptionAlgorithm)

Sets the encryption options for the document. The userPassword and the ownerPassword can be null or have zero length. In this case the ownerPassword is replaced by a random string. The open permissions for the document can be AllowPrinting, AllowModifyContents, AllowCopy, AllowModifyAnnotations, AllowFillIn, AllowScreenReaders, AllowAssembly and AllowDegradedPrinting. The permissions can be combined by ORing them.

See EncryptionConstants.

Parameters:

userPassword - the user password. Can be null or empty

ownerPassword - the owner password. Can be null or empty

permissions - the user permissions

encryptionAlgorithm - the type of encryption. It can be one of STANDARD_ENCRYPTION_40, STANDARD_ENCRYPTION_128, ENCRYPTION_AES128 or ENCRYPTION_AES256 Optionally DO_NOT_ENCRYPT_METADATA can be ored to output the metadata in cleartext

Returns:

this WriterProperties instance

setPublicKeyEncryption

public WriterProperties setPublicKeyEncryption(Certificate[] certs,
                                               int[] permissions,
                                               int encryptionAlgorithm)

Sets the certificate encryption options for the document. An array of one or more public certificates must be provided together with an array of the same size for the permissions for each certificate. The open permissions for the document can be AllowPrinting, AllowModifyContents, AllowCopy, AllowModifyAnnotations, AllowFillIn, AllowScreenReaders, AllowAssembly and AllowDegradedPrinting. The permissions can be combined by ORing them. Optionally DO_NOT_ENCRYPT_METADATA can be ored to output the metadata in cleartext

See EncryptionConstants.

Parameters:

certs - the public certificates to be used for the encryption

permissions - the user permissions for each of the certificates

encryptionAlgorithm - the type of encryption. It can be one of STANDARD_ENCRYPTION_40, STANDARD_ENCRYPTION_128, ENCRYPTION_AES128 or ENCRYPTION_AES256.

Returns:

this WriterProperties instance

setInitialDocumentId

public WriterProperties setInitialDocumentId(PdfString initialDocumentId)

The /ID entry of a document contains an array with two entries. The first one (initial id) represents the initial document id. It's a permanent identifier based on the contents of the file at the time it was originally created and does not change when the file is incrementally updated. To help ensure the uniqueness of file identifiers, it is recommend to be computed by means of a message digest algorithm such as MD5. iText will by default keep the existing initial id. But if you'd like you can set this id yourself using this setter.

Parameters:

initialDocumentId - the new initial document id

Returns:

this WriterProperties instance

setModifiedDocumentId

public WriterProperties setModifiedDocumentId(PdfString modifiedDocumentId)

The /ID entry of a document contains an array with two entries. The second one (modified id) should be the same entry, unless the document has been modified. iText will by default generate a modified id. But if you'd like you can set this id yourself using this setter.

Parameters:

modifiedDocumentId - the new modified document id

Returns:

this WriterProperties instance

useDebugMode

public WriterProperties useDebugMode()

This activates debug mode with pdfDebug tool. It causes additional overhead of duplicating document bytes into memory, so use it careful. NEVER use it in production or in any other cases except pdfDebug.

Returns:

this WriterProperties instance