Generated by
JDiff

com.itextpdf.signatures Documentation Differences

This file contains all the changes in documentation in the package com.itextpdf.signatures 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 CrlClientOffline

An implementation of the CrlClient that handles offline Certificate Revocation Lists. @author Paulo Soares

Class CrlClientOnline

An implementation of the CrlClient that fetches the CRL bytes from an URL. @author Paulo Soares

Class ExternalBlankSignatureContainer

Produces a blank (or empty) signature. Useful for deferred signing with MakeSignature.signExternalContainer(). @author Paulo Soares

Class ICrlClient

Interface that needs to be implemented if you want to embed Certificate Revocation Lists (CRL) into your PDF. @author Paulo Soares

Class IExternalSignature

Interface that needs to be implemented to do the actual signing. For instance: you'll have to implement this interface if you want to sign a PDF using a smart card. @author Paulo Soares

Class IExternalSignatureContainer

Interface to sign a document. The signing is fully done externally, including the container composition. @author Paulo Soares

Class LtvVerification

Add verification according to PAdES-LTV (part 4). @author Paulo Soares

Class OcspClientBouncyCastle

OcspClient implementation using BouncyCastle. @author Paulo Soarees

Class PdfSignature

Represents the signature dictionary. @author Paulo Soares

Class PdfSignatureAppearance, PdfFormXObject getAppearance()

Constructs appearance (top-level) for a signature. @return a top-level signature appearance appearance. @throws IOException if font cannot be created created. @see Adobe Pdf Digital Signature Appearances @deprecated in favour of SignatureFieldAppearance. Shouldn't be used.
Class PdfSignatureAppearance, Certificate getCertificate()

Get the signing certificate. @return the signing certificate. @deprecated in favour of SignedAppearanceText that should be used for SignatureFieldAppearance.
Class PdfSignatureAppearance, String getContact()

Returns the signing contact. @return The signing contact. @deprecated Use PdfSigner.getContact() instead.
Class PdfSignatureAppearance, ImageData getImage()

Gets the background image for the layer 2. @return the background image for the layer 2. @deprecated in favour of SignatureFieldAppearance.setBackgroundImage(BackgroundImage).
Class PdfSignatureAppearance, float getImageScale()

Gets the scaling to be applied to the background image. @return the scaling to be applied to the background image. @deprecated in favour of SignatureFieldAppearance.setBackgroundImage(BackgroundImage).
Class PdfSignatureAppearance, PdfFormXObject getLayer0()

Get Layer 0 of the appearance.

The size of the layer is determined by the rectangle set via PdfSignatureAppearance.setPageRect(Rectangle) @return layer 0. @deprecated will be deleted in the next major release. See PdfSignatureFormField.setBackgroundLayer(PdfFormXObject).

Class PdfSignatureAppearance, PdfFormXObject getLayer2()

Get Layer 2 of the appearance.

The size of the layer is determined by the rectangle set via PdfSignatureAppearance.setPageRect(Rectangle) @return layer 2. @deprecated will be deleted in the next major release. See PdfSignatureFormField.setSignatureAppearanceLayer(PdfFormXObject).

Class PdfSignatureAppearance, PdfFont getLayer2Font()

Gets the n2 and n4 layer font. @return the n2 and n4 layer font. @deprecated in favour of SignatureFieldAppearance.
Class PdfSignatureAppearance, Color getLayer2FontColor()

Gets the n2 and n4 layer font color. @return the n2 and n4 layer font color. @deprecated in favour of SignatureFieldAppearance.
Class PdfSignatureAppearance, float getLayer2FontSize()

Gets the n2 and n4 layer font size. @return the n2 and n4 layer font size. @deprecated in favour of SignatureFieldAppearance.
Class PdfSignatureAppearance, String getLayer2Text()

Gets the signature text identifying the signer if set by setLayer2Text(). @return the signature text identifying the signer. @deprecated in favour of SignatureFieldAppearance.
Class PdfSignatureAppearance, String getLocation()

Returns the signing location. @return signing location. @deprecated in favour of SignedAppearanceText that should be used for SignatureFieldAppearance.
Class PdfSignatureAppearance, int getPageNumber()

Provides the page number of the signature field which this signature appearance is associated with. @return The page number of the signature field which this signature appearance is associated with. @deprecated won't be public in the next major release. Use PdfSigner.getPageNumber() instead.
Class PdfSignatureAppearance, Rectangle getPageRect()

Provides the rectangle that represent the position and dimension of the signature field in the page. @return the rectangle that represent the position and dimension of the signature field in the page. @deprecated won't be public in the next major release. Use PdfSigner.getPageRect() instead.
Class PdfSignatureAppearance, String getReason()

Returns the signing reason. @return reason for signing. @deprecated in favour of SignedAppearanceText that should be used for SignatureFieldAppearance.
Class PdfSignatureAppearance, RenderingMode getRenderingMode()

Gets the rendering mode for this signature. @return the rendering mode for this signature. @deprecated in favour of SignatureFieldAppearance, rendering mode will be detected depending on specified {@code setContent} method parameters.
Class PdfSignatureAppearance, Calendar getSignDate()

Returns the signature date. @return the signature date. @deprecated in favour of SignedAppearanceText that should be used for SignatureFieldAppearance.
Class PdfSignatureAppearance, String getSignatureCreator()

Returns the signature creator. @return The signature creator. @deprecated Use PdfSigner.getSignatureCreator() instead.
Class PdfSignatureAppearance, ImageData getSignatureGraphic()

Gets the Image object to render. @return the image. @deprecated in favour of SignatureFieldAppearance.
Class PdfSignatureAppearance, boolean isInvisible()

Gets the visibility status of the signature. @return the visibility status of the signature. @deprecated won't be public in the next major release.
Class PdfSignatureAppearance, PdfSignatureAppearance setCertificate(Certificate)

Sets the certificate used to provide the text in the appearance. This certificate doesn't take part in the actual signing process. @param signCertificate the certificate certificate. @return this instance to support fluent interface. @deprecated in favour of SignedAppearanceText that should be used for SignatureFieldAppearance. Specified certificate provides signer name.
Class PdfSignatureAppearance, PdfSignatureAppearance setContact(String)

Sets the signing contact. @param contact A new signing contact contact. @return this instance to support fluent interface. @deprecated Use PdfSigner.setContact(String) instead.
Class PdfSignatureAppearance, PdfSignatureAppearance setFieldName(String)

Set the field name of the appearance. Field name indicates the field to be signed if it is already presented in the document (signing existing field). Required for reuseAppearance option. @param fieldName name of the field @return this instance to support fluent interface
Class PdfSignatureAppearance, PdfSignatureAppearance setImage(ImageData)

Sets the background image for the text in the layer 2. @param image the background image for the layer 2 2. @return this instance to support fluent interface. @deprecated in favour of SignatureFieldAppearance.setBackgroundImage(BackgroundImage).
Class PdfSignatureAppearance, PdfSignatureAppearance setImageScale(float)

Sets the scaling to be applied to the background image. If it's zero the image will fully fill the rectangle. If it's less than zero the image will fill the rectangle but will keep the proportions. If it's greater than zero that scaling will be applied. In any of the cases the image will always be centered. It's zero by default. @param imageScale the scaling to be applied to the background image image. @return this instance to support fluent interface. @deprecated in favour of SignatureFieldAppearance.setBackgroundImage(BackgroundImage).
Class PdfSignatureAppearance, PdfSignatureAppearance setLayer2Font(PdfFont)

Sets the n2 and n4 layer font. If the font size is zero, auto-fit will be used. @param layer2Font font the n2 and n4 font font. @return this instance to support fluent interface. @deprecated in favour of SignatureFieldAppearance.setFont(PdfFont).
Class PdfSignatureAppearance, PdfSignatureAppearance setLayer2FontColor(Color)

Sets the n2 and n4 layer font color. @param color font color color. @return this instance to support fluent interface. @deprecated in favour of SignatureFieldAppearance.setFontColor(Color).
Class PdfSignatureAppearance, PdfSignatureAppearance setLayer2FontSize(float)

Sets the n2 and n4 layer font size. @param fontSize font size size. @return this instance to support fluent interface. @deprecated in favour of SignatureFieldAppearance.setFontSize(float).
Class PdfSignatureAppearance, PdfSignatureAppearance setLayer2Text(String)

Sets the signature text identifying the signer. @param text the signature text identifying the signer. If null or not set a standard description will be used used. @return this instance to support fluent interface. @deprecated in favour of SignatureFieldAppearance.
Class PdfSignatureAppearance, PdfSignatureAppearance setLocation(String)

Sets the signing location. @param location A new signing location location. @return this instance to support fluent interface. @deprecated in favour of SignedAppearanceText that should be used for SignatureFieldAppearance.
Class PdfSignatureAppearance, PdfSignatureAppearance setLocationCaption(String)

Sets the caption for the signing location. @param locationCaption A new signing location caption caption. @return this instance to support fluent interface. @deprecated in favour of SignedAppearanceText that should be used for SignatureFieldAppearance.
Class PdfSignatureAppearance, PdfSignatureAppearance setPageNumber(int)

Sets the page number of the signature field which this signature appearance is associated with. Implicitly calls PdfSignatureAppearance.setPageRect which considers page number to process the rectangle correctly. @param pageNumber The page number of the signature field which this signature appearance is associated with. @return this instance to support fluent interface. @deprecated won't be public in the next major release. Use PdfSigner.setPageNumber(int) instead.
Class PdfSignatureAppearance, PdfSignatureAppearance setPageRect(Rectangle)

Sets the rectangle that represent the position and dimension of the signature field in the page. @param pageRect The rectangle that represents the position and dimension of the signature field in the page. @return this instance to support fluent interface. @deprecated won't be public in the next major release. Use PdfSigner.setPageRect(Rectangle) instead.
Class PdfSignatureAppearance, PdfSignatureAppearance setReason(String)

Sets the signing reason. @param reason signing reason. @return this instance to support fluent interface. @deprecated in favour of SignedAppearanceText that should be used for SignatureFieldAppearance.
Class PdfSignatureAppearance, PdfSignatureAppearance setReasonCaption(String)

Sets the caption for the signing reason. @param reasonCaption A new signing reason caption caption. @return this instance to support fluent interface. @deprecated in favour of SignedAppearanceText that should be used for SignatureFieldAppearance.
Class PdfSignatureAppearance, PdfSignatureAppearance setRenderingMode(RenderingMode)

Sets the rendering mode for this signature. @param renderingMode the rendering mode mode. @return this instance to support fluent interface. @deprecated in favour of SignatureFieldAppearance, rendering mode will be detected depending on specified {@code setContent} method parameters.
Class PdfSignatureAppearance, PdfSignatureAppearance setReuseAppearance(boolean)

Indicates that the existing appearances needs to be reused as layer a background 0 layer. @param reuseAppearance is an appearances reusing flag value to set set. @return this instance to support fluent interface. @deprecated in favour of PdfSignatureFormField.setReuseAppearance(boolean).
Class PdfSignatureAppearance, PdfSignatureAppearance setSignDate(Calendar)

Sets the signature date. @param signDate A new signature date date. @return this instance to support fluent interface. @deprecated in favour of SignedAppearanceText that should be used for SignatureFieldAppearance.
Class PdfSignatureAppearance, PdfSignatureAppearance setSignatureCreator(String)

Sets the name of the application used to create the signature. @param signatureCreator A new name of the application signing a document document. @return this instance to support fluent interface. @deprecated Use PdfSigner.setSignatureCreator(String) instead.
Class PdfSignatureAppearance, PdfSignatureAppearance setSignatureGraphic(ImageData)

Sets the Image object to render when Render is set to RenderingMode.GRAPHIC or RenderingMode.GRAPHIC_AND_DESCRIPTION. @param signatureGraphic image rendered. If null the mode is defaulted to RenderingMode.DESCRIPTION @return this instance to support fluent interface. @deprecated in favour of SignatureFieldAppearance.setContent(ImageData) or SignatureFieldAppearance.setContent(String, ImageData).

Class PdfSignatureBuildProperties

Dictionary that stores signature build properties. @author Kwinten Pisman

Class PrivateKeySignature

Implementation of the IExternalSignature interface that can be used when you have a PrivateKey object. @author Paulo Soares

Class ProviderDigest

This class will return the java.security.MessageDigest associated with a certain hashing algorithm returned by the specified provider. @author psoares