iText 9.0.0  Overview   Package   Class  Text Changes  Statistics  Help 
Generated by
JDiff
PREV PACKAGE    NEXT PACKAGE          FRAMES    NO FRAMES  

com.itextpdf.kernel.pdf Documentation Differences

This file contains all the changes in documentation in the package com.itextpdf.kernel.pdf as colored differences. Deletions are shown like this , and additions are shown like this.
If no deletions or additions are shown in an entry, the HTML tags will be what has changed. The new HTML tags are shown in the differences. If no documentation existed, and then some was added in a later version, this change is noted in the appropriate class pages of differences, but the change is not shown on this page. Only changes in existing text are shown here. Similarly, documentation which was inherited from another class or interface is not shown here.
Note that an HTML error in the new documentation may cause the display of other documentation changes to be presented incorrectly. For instance, failure to close a tag will cause all subsequent paragraphs to be displayed differently.
Class EncryptionProperties, EncryptionProperties setPublicKeyEncryption(Certificate[], int[], int, MacProperties)

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. @param certs the public certificates to be used for the encryption @param permissions the user permissions for each of the certificates The open permissions for the document can be EncryptionConstants.ALLOW_PRINTING, EncryptionConstants.ALLOW_MODIFY_CONTENTS, EncryptionConstants.ALLOW_COPY, EncryptionConstants.ALLOW_MODIFY_ANNOTATIONS, EncryptionConstants.ALLOW_FILL_IN, EncryptionConstants.ALLOW_SCREENREADERS, EncryptionConstants.ALLOW_ASSEMBLY and EncryptionConstants.ALLOW_DEGRADED_PRINTING. The permissions can be combined by ORing them @param encryptionAlgorithm the type of encryption. It can be one of EncryptionConstants.STANDARD_ENCRYPTION_40, EncryptionConstants.STANDARD_ENCRYPTION_128, EncryptionConstants.ENCRYPTION_AES_128 or EncryptionConstants.ENCRYPTION_AES_256. Optionally EncryptionConstants.DO_NOT_ENCRYPT_METADATA can be ORed to output the metadata in cleartext. EncryptionConstants.EMBEDDED_FILES_ONLY can be ORed as well. Please be aware that the passed encryption types may override permissions: EncryptionConstants.STANDARD_ENCRYPTION_40 implicitly sets EncryptionConstants.DO_NOT_ENCRYPT_METADATA and EncryptionConstants.EMBEDDED_FILES_ONLY as false; EncryptionConstants.STANDARD_ENCRYPTION_128 implicitly sets EncryptionConstants.EMBEDDED_FILES_ONLY as false; @param macProperties MacProperties class to configure MAC integrity protection properties. Pass {@code null} if you want to disable MAC protection for any reason @return this EncryptionProperties

Class FingerPrint

Data container for debugging information. This class keeps a record of every registered product that was involved in the creation of a certain PDF file. This information can then be used to log to the logger or to the file.
Class PdfCatalog, void addDeveloperExtension(PdfDeveloperExtension)

Add Adds an extensions dictionary containing developer prefix identification and version numbers for developer extensions that occur in this document. See ISO 32000-1, Table 28 # Entries in the catalog dictionary. @param extension enables developers to identify their own extension relative to a base version of PDF
Class PdfDocument, void addEventHandler(String, AbstractPdfDocumentEventHandler)

{ Adds new event handler. @ inheritDoc} param type a type of event to be handled @param handler event handler
Class PdfDocument, PdfDocumentInfo getDocumentInfo()

Gets document information dictionary.

PdfDocument.info is lazy initialized. It will be initialized during the first call of this method.

The information dictionary values are synchronized with document XMP Metadata. @return document information dictionary.

Class PdfDocument, PdfString getOriginalDocumentId()

Gets original document id

In order to set originalDocumentId WriterProperties.setInitialDocumentId should be used @return original dccument document id

Class PdfDocument, XMPMeta getXmpMetadata()

Gets XMPMetadata XMP Metadata.

XMP Metadata is lazy initialized. It will be initialized during the first call of this method.

To update XMP Metadata of the document, use PdfDocument.setXmpMetadata(XMPMeta) method. @return the existed XMP Metadata @throws XMPException on serialization XMPMetadata errors
Class PdfDocument, XMPMeta getXmpMetadata(boolean)

Gets XMPMetadata XMP Metadata or create a new one.

XMP Metadata is lazy initialized. It will be initialized during the first call of this method.

To update XMP Metadata of the document, use PdfDocument.setXmpMetadata(XMPMeta) method. @param createNew if true, create a new empty XMPMetadata XMP Metadata if it did not present. present @return existed or newly created XMPMetadata byte XMP Metadata array. @throws XMPException on serialization errors
Class PdfDocument, boolean hasEventHandler(AbstractPdfDocumentEventHandler)

Checks if provided event handler assigned for this document. @param handler the AbstractPdfDocumentEventHandler to check @return {@code true} if event handler is assigned for this document, {@ inheritDoc code false} otherwise
Class PdfDocument, void removeAllHandlers()

{@inheritDoc} Removes all event handlers for this document.
Class PdfDocument, void removeEventHandler(AbstractPdfDocumentEventHandler)

{ Removes event handler. @ inheritDoc} param handler AbstractPdfDocumentEventHandler event handler to remove for this document
Class PdfDocument, void setXmpMetadata(XMPMeta)

Sets the XMP Metadata.

The XMP Metadata values are synchronized with information dictionary.

PdfDocument.serializeOptions will be used for serialization, they can be changed by PdfDocument.setSerializeOptions(SerializeOptions). @param xmpMeta the xmpMetadata to set @throws XMPException on serialization errors
Class PdfDocument, void setXmpMetadata(XMPMeta, SerializeOptions)

Sets the XMP Metadata. @param

xmpMeta The XMP Metadata values are synchronized with information dictionary. @param xmpMeta the xmpMetadata to set @param serializeOptions serialization options @throws XMPException on serialization errors

Class PdfDocument, void setXmpMetadata(byte[])

Use this method Sets the XMP to Metadata. set

the The XMP Metadata values are synchronized with information dictionary. @param xmpMetadata The the xmpMetadata bytes to set .

Class PdfEncryption, PdfObject createInfoId(byte[], boolean)

Creates a PdfLiteral that contains an array of two id entries. These entries are both hexadecimal strings containing 16 hex characters. The first entry is the original id, the second entry should be different from the first one if the document has changed. @param id the first id @param modified whether the document has been changed or not not @return PdfObject containing the two entries .
Class PdfObject, short MUST_BE_FLUSHED

For internal usage only. Marks objects that shall be written to the output document. Shouldn't be used on Option purpose since this flag is handled internally: option is needed to build the correct PDF objects objects tree when closing the document. As a result it avoids writing unused (removed) objects.
Class PdfPage, PdfStream newContentStreamAfter()

Creates new PdfStream object and puts it at the end of {@code Contents} array (if Contents object is PdfStream it will be replaced with one-element array). @return Created PdfStream object.
Class PdfReader, int getPermissions()

Gets the encryption permissions. It can be used directly in WriterProperties.setStandardEncryption(byte[], byte[], int, int). See ISO 32000-1, Table 22 for more details. @return the encryption permissions , an unsigned 32-bit quantity . @throws PdfException if the method has been invoked before the PDF document was read.
Class PdfResources, PdfName addShading(AbstractPdfShading)

Adds PdfShading AbstractPdfShading object to the resources. @param shading the PdfShading AbstractPdfShading to add. @return added shading resource name.
Class StampingProperties, StampingProperties preserveEncryption()

Defines if the encryption of the original document (if it was encrypted) will be preserved. By default, the resultant document doesn't preserve the original encryption. @return this StampingProperties instance
Class StampingProperties, StampingProperties useAppendMode()

Defines if the document will be edited in append mode. @return this StampingProperties instance
Class WriterProperties, WriterProperties setInitialDocumentId(PdfString)

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 recommended 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. @param initialDocumentId the new initial document id @return this WriterProperties instance
Class WriterProperties, WriterProperties setPublicKeyEncryption(Certificate[], int[], int)

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. @param certs the public certificates to be used for the encryption @param permissions the user permissions for each of the certificates The open permissions for the document can be EncryptionConstants.ALLOW_PRINTING, EncryptionConstants.ALLOW_MODIFY_CONTENTS, EncryptionConstants.ALLOW_COPY, EncryptionConstants.ALLOW_MODIFY_ANNOTATIONS, EncryptionConstants.ALLOW_FILL_IN, EncryptionConstants.ALLOW_SCREENREADERS, EncryptionConstants.ALLOW_ASSEMBLY and EncryptionConstants.ALLOW_DEGRADED_PRINTING. The permissions can be combined by ORing them @param encryptionAlgorithm the type of encryption. It can be one of EncryptionConstants.STANDARD_ENCRYPTION_40, EncryptionConstants.STANDARD_ENCRYPTION_128, EncryptionConstants.ENCRYPTION_AES_128 or EncryptionConstants.ENCRYPTION_AES_256. Optionally EncryptionConstants.DO_NOT_ENCRYPT_METADATA can be ORed to output the metadata in cleartext. EncryptionConstants.EMBEDDED_FILES_ONLY can be ORed as well. Please be aware that the passed encryption types may override permissions: EncryptionConstants.STANDARD_ENCRYPTION_40 implicitly sets EncryptionConstants.DO_NOT_ENCRYPT_METADATA and EncryptionConstants.EMBEDDED_FILES_ONLY as false; EncryptionConstants.STANDARD_ENCRYPTION_128 implicitly sets EncryptionConstants.EMBEDDED_FILES_ONLY as false; @return this WriterProperties instance
Class WriterProperties, WriterProperties setStandardEncryption(byte[], byte[], int, int)

Sets the encryption options for the document. @param userPassword the user password. Can be null or of zero length, which is equal to omitting the user password @param ownerPassword the owner password. If it's null or empty, iText will generate a random string to be used as the owner password @param permissions the user permissions The open permissions for the document can be EncryptionConstants.ALLOW_PRINTING, EncryptionConstants.ALLOW_MODIFY_CONTENTS, EncryptionConstants.ALLOW_COPY, EncryptionConstants.ALLOW_MODIFY_ANNOTATIONS, EncryptionConstants.ALLOW_FILL_IN, EncryptionConstants.ALLOW_SCREENREADERS, EncryptionConstants.ALLOW_ASSEMBLY and EncryptionConstants.ALLOW_DEGRADED_PRINTING. The permissions can be combined by ORing them @param encryptionAlgorithm the type of encryption. It can be one of EncryptionConstants.STANDARD_ENCRYPTION_40, EncryptionConstants.STANDARD_ENCRYPTION_128, EncryptionConstants.ENCRYPTION_AES_128 or EncryptionConstants.ENCRYPTION_AES_256. Optionally EncryptionConstants.DO_NOT_ENCRYPT_METADATA can be ORed to output the metadata in cleartext. EncryptionConstants.EMBEDDED_FILES_ONLY can be ORed as well. Please be aware that the passed encryption types may override permissions: EncryptionConstants.STANDARD_ENCRYPTION_40 implicitly sets EncryptionConstants.DO_NOT_ENCRYPT_METADATA and EncryptionConstants.EMBEDDED_FILES_ONLY as false; EncryptionConstants.STANDARD_ENCRYPTION_128 implicitly sets EncryptionConstants.EMBEDDED_FILES_ONLY as false; @return this WriterProperties instance