Package com.itextpdf.signatures

Class PdfSignatureAppearance

java.lang.Object

com.itextpdf.signatures.PdfSignatureAppearance

       public class PdfSignatureAppearance extends Object
      

Provides convenient methods to make a signature appearance. Use it in conjunction with PdfSigner.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	PdfSignatureAppearance.RenderingMode	Deprecated.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	PdfSignatureAppearance(PdfDocument document, Rectangle pageRect, int pageNumber)	Creates a PdfSignatureAppearance.

Method Summary

Modifier and Type	Method	Description
protected PdfFormXObject	getAppearance()	Deprecated. in favour of SignatureFieldAppearance.
Certificate	getCertificate()	Deprecated. in favour of SignedAppearanceText that should be used for SignatureFieldAppearance.
String	getContact()	Deprecated. Use PdfSigner.getContact() instead.
ImageData	getImage()	Deprecated. in favour of ElementPropertyContainer.setBackgroundImage(BackgroundImage).
float	getImageScale()	Deprecated. in favour of ElementPropertyContainer.setBackgroundImage(BackgroundImage).
PdfFormXObject	getLayer0()	Deprecated. will be deleted in the next major release.
PdfFormXObject	getLayer2()	Deprecated. will be deleted in the next major release.
PdfFont	getLayer2Font()	Deprecated. in favour of SignatureFieldAppearance.
Color	getLayer2FontColor()	Deprecated. in favour of SignatureFieldAppearance.
float	getLayer2FontSize()	Deprecated. in favour of SignatureFieldAppearance.
String	getLayer2Text()	Deprecated. in favour of SignatureFieldAppearance.
String	getLocation()	Deprecated. won't be public in the next major release.
int	getPageNumber()	Deprecated. won't be public in the next major release.
Rectangle	getPageRect()	Deprecated. won't be public in the next major release.
String	getReason()	Deprecated. won't be public in the next major release.
PdfSignatureAppearance.RenderingMode	getRenderingMode()	Deprecated. in favour of SignatureFieldAppearance, rendering mode will be detected depending on specified setContent method parameters.
SignatureFieldAppearance	getSignatureAppearance()	Gets the signature layout element.
String	getSignatureCreator()	Deprecated. Use PdfSigner.getSignatureCreator() instead.
ImageData	getSignatureGraphic()	Deprecated. in favour of SignatureFieldAppearance.
protected Calendar	getSignDate()	Deprecated. use PdfSigner.getSignDate() instead.
boolean	isInvisible()	Deprecated. won't be public in the next major release.
PdfSignatureAppearance	setCertificate(Certificate signCertificate)	Deprecated. in favour of SignedAppearanceText that should be used for SignatureFieldAppearance.
PdfSignatureAppearance	setContact(String contact)	Deprecated. Use PdfSigner.setContact(String) instead.
protected PdfSignatureAppearance	setFieldName(String fieldName)	Set the field name of the appearance.
PdfSignatureAppearance	setFontFamily(String... fontFamilyNames)	Deprecated. in favour of ElementPropertyContainer.setFontFamily(String...).
PdfSignatureAppearance	setFontProvider(FontProvider fontProvider)	Deprecated. in favour of ElementPropertyContainer.setProperty(int, Object).
PdfSignatureAppearance	setImage(ImageData image)	Deprecated. in favour of ElementPropertyContainer.setBackgroundImage(BackgroundImage).
PdfSignatureAppearance	setImageScale(float imageScale)	Deprecated. in favour of ElementPropertyContainer.setBackgroundImage(BackgroundImage).
PdfSignatureAppearance	setLayer2Font(PdfFont font)	Deprecated. in favour of ElementPropertyContainer.setFont(PdfFont).
PdfSignatureAppearance	setLayer2FontColor(Color color)	Deprecated. in favour of ElementPropertyContainer.setFontColor(Color).
PdfSignatureAppearance	setLayer2FontSize(float fontSize)	Deprecated. in favour of ElementPropertyContainer.setFontSize(float).
PdfSignatureAppearance	setLayer2Text(String text)	Deprecated. in favour of SignatureFieldAppearance.
PdfSignatureAppearance	setLocation(String location)	Deprecated. won't be public in the next major release.
PdfSignatureAppearance	setLocationCaption(String locationCaption)	Deprecated. in favour of SignedAppearanceText that should be used for SignatureFieldAppearance.
PdfSignatureAppearance	setPageNumber(int pageNumber)	Deprecated. won't be public in the next major release.
PdfSignatureAppearance	setPageRect(Rectangle pageRect)	Deprecated. won't be public in the next major release.
PdfSignatureAppearance	setReason(String reason)	Deprecated. won't be public in the next major release.
PdfSignatureAppearance	setReasonCaption(String reasonCaption)	Deprecated. in favour of SignedAppearanceText that should be used for SignatureFieldAppearance.
PdfSignatureAppearance	setRenderingMode(PdfSignatureAppearance.RenderingMode renderingMode)	Deprecated. in favour of SignatureFieldAppearance, rendering mode will be detected depending on specified setContent method parameters.
PdfSignatureAppearance	setReuseAppearance(boolean reuseAppearance)	Deprecated. in favour of PdfSignatureFormField.setReuseAppearance(boolean).
PdfSignatureAppearance	setSignatureAppearance(SignatureFieldAppearance modelElement)	Deprecated. Use PdfSigner.setSignatureAppearance(SignatureFieldAppearance) instead.
PdfSignatureAppearance	setSignatureCreator(String signatureCreator)	Deprecated. Use PdfSigner.setSignatureCreator(String) instead.
PdfSignatureAppearance	setSignatureGraphic(ImageData signatureGraphic)	Deprecated. in favour of SignatureFieldAppearance.setContent(ImageData) or SignatureFieldAppearance.setContent(String, ImageData).
protected PdfSignatureAppearance	setSignDate(Calendar signDate)	Deprecated. use PdfSigner.setSignDate(Calendar) instead.

Methods inherited from class java.lang.Object

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

Constructor Details

PdfSignatureAppearance

             protected PdfSignatureAppearance
             (PdfDocument document, Rectangle pageRect, int pageNumber)
            

Creates a PdfSignatureAppearance.

Parameters:

document - PdfDocument

pageRect - Rectangle of the appearance

pageNumber - Number of the page the appearance should be on

Method Details

getPageNumber

             @Deprecated public int getPageNumber()
            

Deprecated.

won't be public in the next major release. Use PdfSigner.getPageNumber() instead.

Provides the page number of the signature field which this signature appearance is associated with.

Returns:

The page number of the signature field which this signature appearance is associated with.

setPageNumber

             @Deprecated public PdfSignatureAppearance setPageNumber
             (int pageNumber)
            

Deprecated.

won't be public in the next major release. Use PdfSigner.setPageNumber(int) instead.

Sets the page number of the signature field which this signature appearance is associated with. Implicitly calls setPageRect(com.itextpdf.kernel.geom.Rectangle) which considers page number to process the rectangle correctly.

Parameters:

pageNumber - The page number of the signature field which this signature appearance is associated with.

Returns:

this instance to support fluent interface.

getPageRect

             @Deprecated public Rectangle getPageRect()
            

Deprecated.

won't be public in the next major release. Use PdfSigner.getPageRect() instead.

Provides the rectangle that represent the position and dimension of the signature field in the page.

Returns:

the rectangle that represent the position and dimension of the signature field in the page.

setPageRect

             @Deprecated public PdfSignatureAppearance setPageRect
             (Rectangle pageRect)
            

Deprecated.

won't be public in the next major release. Use PdfSigner.setPageRect(Rectangle) instead.

Sets the rectangle that represent the position and dimension of the signature field in the page.

Parameters:

pageRect - The rectangle that represents the position and dimension of the signature field in the page.

Returns:

this instance to support fluent interface.

getLayer0

             @Deprecated public PdfFormXObject getLayer0()
            

Deprecated.

will be deleted in the next major release. See PdfSignatureFormField.setBackgroundLayer(PdfFormXObject). Note that it should be called for the field retrieved with PdfSigner.getSignatureField() method.

Get Layer 0 of the appearance.

The size of the layer is determined by the rectangle set via setPageRect(Rectangle)

Returns:

layer 0.

getLayer2

             @Deprecated public PdfFormXObject getLayer2()
            

Deprecated.

will be deleted in the next major release. See PdfSignatureFormField.setSignatureAppearanceLayer(PdfFormXObject). Note that it should be called for the field retrieved with PdfSigner.getSignatureField() method.

Get Layer 2 of the appearance.

The size of the layer is determined by the rectangle set via setPageRect(Rectangle)

Returns:

layer 2.

getRenderingMode

             @Deprecated public PdfSignatureAppearance.RenderingMode getRenderingMode()
            

Deprecated.

in favour of SignatureFieldAppearance, rendering mode will be detected depending on specified setContent method parameters.

Gets the rendering mode for this signature.

Returns:

the rendering mode for this signature.

setRenderingMode

             @Deprecated public PdfSignatureAppearance setRenderingMode
             (PdfSignatureAppearance.RenderingMode renderingMode)
            

Deprecated.

in favour of SignatureFieldAppearance, rendering mode will be detected depending on specified setContent method parameters.

Sets the rendering mode for this signature.

Parameters:

renderingMode - the rendering mode.

Returns:

this instance to support fluent interface.

getReason

             @Deprecated public String getReason()
            

Deprecated.

won't be public in the next major release. Use PdfSigner.getReason() instead.

Returns the signing reason.

Returns:

reason for signing.

setReason

             @Deprecated public PdfSignatureAppearance setReason
             (String reason)
            

Deprecated.

won't be public in the next major release. Use PdfSigner.setReason(java.lang.String) instead.

Sets the signing reason.

Parameters:

reason - signing reason.

Returns:

this instance to support fluent interface.

setReasonCaption

             @Deprecated public PdfSignatureAppearance setReasonCaption
             (String reasonCaption)
            

Deprecated.

in favour of SignedAppearanceText that should be used for SignatureFieldAppearance.

Sets the caption for the signing reason.

Parameters:

reasonCaption - A new signing reason caption.

Returns:

this instance to support fluent interface.

getLocation

             @Deprecated public String getLocation()
            

Deprecated.

won't be public in the next major release. Use PdfSigner.getLocation() instead.

Returns the signing location.

Returns:

signing location.

setLocation

             @Deprecated public PdfSignatureAppearance setLocation
             (String location)
            

Deprecated.

won't be public in the next major release. Use PdfSigner.setLocation(java.lang.String) instead.

Sets the signing location.

Parameters:

location - A new signing location.

Returns:

this instance to support fluent interface.

setLocationCaption

             @Deprecated public PdfSignatureAppearance setLocationCaption
             (String locationCaption)
            

Deprecated.

in favour of SignedAppearanceText that should be used for SignatureFieldAppearance.

Sets the caption for the signing location.

Parameters:

locationCaption - A new signing location caption.

Returns:

this instance to support fluent interface.

getSignatureCreator

             @Deprecated public String getSignatureCreator()
            

Deprecated.

Use PdfSigner.getSignatureCreator() instead.

Returns the signature creator.

Returns:

The signature creator.

setSignatureCreator

             @Deprecated public PdfSignatureAppearance setSignatureCreator
             (String signatureCreator)
            

Deprecated.

Use PdfSigner.setSignatureCreator(String) instead.

Sets the name of the application used to create the signature.

Parameters:

signatureCreator - A new name of the application signing a document.

Returns:

this instance to support fluent interface.

getContact

             @Deprecated public String getContact()
            

Deprecated.

Use PdfSigner.getContact() instead.

Returns the signing contact.

Returns:

The signing contact.

setContact

             @Deprecated public PdfSignatureAppearance setContact
             (String contact)
            

Deprecated.

Use PdfSigner.setContact(String) instead.

Sets the signing contact.

Parameters:

contact - A new signing contact.

Returns:

this instance to support fluent interface.

setCertificate

             @Deprecated public PdfSignatureAppearance setCertificate
             (Certificate signCertificate)
            

Deprecated.

in favour of SignedAppearanceText that should be used for SignatureFieldAppearance. Specified certificate provides signer name.

Sets the certificate used to provide the text in the appearance. This certificate doesn't take part in the actual signing process.

Parameters:

signCertificate - the certificate.

Returns:

this instance to support fluent interface.

getCertificate

             @Deprecated public Certificate getCertificate()
            

Deprecated.

in favour of SignedAppearanceText that should be used for SignatureFieldAppearance.

Get the signing certificate.

Returns:

the signing certificate.

getSignatureGraphic

             @Deprecated public ImageData getSignatureGraphic()
            

Deprecated.

in favour of SignatureFieldAppearance.

Gets the Image object to render.

Returns:

the image.

setSignatureGraphic

             @Deprecated public PdfSignatureAppearance setSignatureGraphic
             (ImageData signatureGraphic)
            

Deprecated.

in favour of SignatureFieldAppearance.setContent(ImageData) or SignatureFieldAppearance.setContent(String, ImageData).

Sets the Image object to render when Render is set to RenderingMode.GRAPHIC or RenderingMode.GRAPHIC_AND_DESCRIPTION.

Parameters:

signatureGraphic - image rendered. If null the mode is defaulted to RenderingMode.DESCRIPTION

Returns:

this instance to support fluent interface.

setReuseAppearance

             @Deprecated public PdfSignatureAppearance setReuseAppearance
             (boolean reuseAppearance)
            

Deprecated.

in favour of PdfSignatureFormField.setReuseAppearance(boolean). Note that it should be called for the field retrieved with PdfSigner.getSignatureField() method.

Indicates that the existing appearances needs to be reused as a background layer.

Parameters:

reuseAppearance - is an appearances reusing flag value to set.

Returns:

this instance to support fluent interface.

getImage

             @Deprecated public ImageData getImage()
            

Deprecated.

in favour of ElementPropertyContainer.setBackgroundImage(BackgroundImage).

Gets the background image for the layer 2.

Returns:

the background image for the layer 2.

setImage

             @Deprecated public PdfSignatureAppearance setImage
             (ImageData image)
            

Deprecated.

in favour of ElementPropertyContainer.setBackgroundImage(BackgroundImage).

Sets the background image for the text in the layer 2.

Parameters:

image - the background image for the layer 2.

Returns:

this instance to support fluent interface.

getImageScale

             @Deprecated public float getImageScale()
            

Deprecated.

in favour of ElementPropertyContainer.setBackgroundImage(BackgroundImage).

Gets the scaling to be applied to the background image.

Returns:

the scaling to be applied to the background image.

setImageScale

             @Deprecated public PdfSignatureAppearance setImageScale
             (float imageScale)
            

Deprecated.

in favour of ElementPropertyContainer.setBackgroundImage(BackgroundImage).

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.

Parameters:

imageScale - the scaling to be applied to the background image.

Returns:

this instance to support fluent interface.

setLayer2Text

             @Deprecated public PdfSignatureAppearance setLayer2Text
             (String text)
            

Deprecated.

in favour of SignatureFieldAppearance.

Sets the signature text identifying the signer.

Parameters:

text - the signature text identifying the signer. If null or not set a standard description will be used.

Returns:

this instance to support fluent interface.

getLayer2Text

             @Deprecated public String getLayer2Text()
            

Deprecated.

in favour of SignatureFieldAppearance.

Gets the signature text identifying the signer if set by setLayer2Text().

Returns:

the signature text identifying the signer.

getLayer2Font

             @Deprecated public PdfFont getLayer2Font()
            

Deprecated.

in favour of SignatureFieldAppearance.

Gets the n2 and n4 layer font.

Returns:

the n2 and n4 layer font.

setLayer2Font

             @Deprecated public PdfSignatureAppearance setLayer2Font
             (PdfFont font)
            

Deprecated.

in favour of ElementPropertyContainer.setFont(PdfFont).

Sets the n2 layer font. If the font size is zero, auto-fit will be used.

Parameters:

font - the n2 font.

Returns:

this instance to support fluent interface.

setLayer2FontSize

             @Deprecated public PdfSignatureAppearance setLayer2FontSize
             (float fontSize)
            

Deprecated.

in favour of ElementPropertyContainer.setFontSize(float).

Sets the n2 and n4 layer font size.

Parameters:

fontSize - font size.

Returns:

this instance to support fluent interface.

getLayer2FontSize

             @Deprecated public float getLayer2FontSize()
            

Deprecated.

in favour of SignatureFieldAppearance.

Gets the n2 and n4 layer font size.

Returns:

the n2 and n4 layer font size.

setLayer2FontColor

             @Deprecated public PdfSignatureAppearance setLayer2FontColor
             (Color color)
            

Deprecated.

in favour of ElementPropertyContainer.setFontColor(Color).

Sets the n2 and n4 layer font color.

Parameters:

color - font color.

Returns:

this instance to support fluent interface.

getLayer2FontColor

             @Deprecated public Color getLayer2FontColor()
            

Deprecated.

in favour of SignatureFieldAppearance.

Gets the n2 layer font color.

Returns:

the n2 layer font color.

getSignatureAppearance

             public SignatureFieldAppearance getSignatureAppearance()
            

Gets the signature layout element.

Returns:

the signature layout element.

setSignatureAppearance

             @Deprecated public PdfSignatureAppearance setSignatureAppearance
             (SignatureFieldAppearance modelElement)
            

Deprecated.

Use PdfSigner.setSignatureAppearance(SignatureFieldAppearance) instead.

Sets the signature layout element.

Parameters:

modelElement - the signature layout element.

Returns:

this instance to support fluent interface.

setFontProvider

             @Deprecated public PdfSignatureAppearance setFontProvider
             (FontProvider fontProvider)
            

Deprecated.

in favour of ElementPropertyContainer.setProperty(int, Object).

Sets FontProvider. Note, font provider is inherited property.

Parameters:

fontProvider - the instance of FontProvider.

Returns:

this instance to support fluent interface.

setFontFamily

             @Deprecated public PdfSignatureAppearance setFontFamily
             (String... fontFamilyNames)
            

Deprecated.

in favour of ElementPropertyContainer.setFontFamily(String...).

Sets the preferable font families for the signature content. Note that FontProvider shall be set as well.

Parameters:

fontFamilyNames - defines an ordered list of preferable font families for the signature element.

Returns:

this instance to support fluent interface.

isInvisible

             @Deprecated public boolean isInvisible()
            

Deprecated.

won't be public in the next major release.

Gets the visibility status of the signature.

Returns:

the visibility status of the signature.

getAppearance

             @Deprecated protected PdfFormXObject getAppearance() throws IOException
            

Deprecated.

in favour of SignatureFieldAppearance. Shouldn't be used.

Constructs appearance (top-level) for a signature.

Returns:

a top-level signature appearance.

Throws:

IOException - if font cannot be created.

See Also:

• Adobe Pdf Digital Signature Appearances

getSignDate

             @Deprecated protected Calendar getSignDate()
            

Deprecated.

use PdfSigner.getSignDate() instead.

Returns the signature date.

Returns:

the signature date.

setSignDate

             @Deprecated protected PdfSignatureAppearance setSignDate
             (Calendar signDate)
            

Deprecated.

use PdfSigner.setSignDate(Calendar) instead.

Sets the signature date.

Parameters:

signDate - A new signature date.

Returns:

this instance to support fluent interface.

setFieldName

             protected PdfSignatureAppearance setFieldName
             (String fieldName)
            

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.

Parameters:

fieldName - name of the field

Returns:

this instance to support fluent interface