PdfSignatureAppearance (openpdf 1.3.17 API)

java.lang.Object
- com.lowagie.text.pdf.PdfSignatureAppearance

```
public class PdfSignatureAppearance
extends Object
```
This class takes care of the cryptographic options and appearances that form a signature.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface PdfSignatureAppearance.SignatureEvent
An interface to retrieve the signature dictionary for modification.

Nested Classes
Modifier and Type	Class and Description
`static interface`	`PdfSignatureAppearance.SignatureEvent` An interface to retrieve the signature dictionary for modification.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`CERTIFIED_FORM_FILLING`
`static int`	`CERTIFIED_FORM_FILLING_AND_ANNOTATIONS`
`static int`	`CERTIFIED_NO_CHANGES_ALLOWED`
`static int`	`NOT_CERTIFIED`
`static String`	`questionMark` Commands to draw a yellow question mark in a stream content
`static PdfName`	`SELF_SIGNED` The self signed filter.
`static int`	`SignatureRenderDescription` The rendering mode is just the description
`static int`	`SignatureRenderGraphicAndDescription` The rendering mode is an image and the description
`static int`	`SignatureRenderNameAndDescription` The rendering mode is the name of the signer and the description
`static PdfName`	`VERISIGN_SIGNED` The VeriSign filter.
`static PdfName`	`WINCER_SIGNED` The Windows Certificate Security.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`close(PdfDictionary update)` This is the last method to be called when using external signatures.
`static float`	`fitText(Font font, String text, Rectangle rect, float maxFontSize, int runDirection)` Fits the text to some rectangle adjusting the font size as needed.
`PdfTemplate`	`getAppearance()` Gets the main appearance layer.
`int`	`getCertificationLevel()` Gets the certified status of this document.
`String`	`getContact()` Gets the signing contact.
`CRL[]`	`getCrlList()` Gets the certificate revocation list.
`PdfDictionary`	`getCryptoDictionary()` Gets the user made signature dictionary.
`String`	`getFieldName()` Gets the field name.
`PdfName`	`getFilter()` Gets the filter used to sign the document.
`Image`	`getImage()` Gets the background image for the layer 2.
`float`	`getImageScale()` Gets the scaling to be applied to the background image.
`PdfTemplate`	`getLayer(int layer)` Gets a template layer to create a signature appearance.
`Font`	`getLayer2Font()` Gets the n2 and n4 layer font.
`String`	`getLayer2Text()` Gets the signature text identifying the signer if set by setLayer2Text().
`String`	`getLayer4Text()` Gets the text identifying the signature status if set by setLayer4Text().
`String`	`getLocation()` Gets the signing location.
`String`	`getNewSigName()` Gets a new signature fied name that doesn't clash with any existing name.
`int`	`getPage()` Gets the page number of the field.
`Rectangle`	`getPageRect()` Gets the rectangle that represent the position and dimension of the signature in the page.
`PrivateKey`	`getPrivKey()` Gets the private key.
`String`	`getProvider()` Returns the Cryptographic Service Provider that will sign the document.
`InputStream`	`getRangeStream()` Gets the document bytes that are hashable when using external signatures.
`String`	`getReason()` Gets the signing reason.
`Rectangle`	`getRect()` Gets the rectangle representing the signature dimensions.
`int`	`getRender()` Gets the rendering mode for this signature.
`int`	`getRunDirection()` Gets the run direction.
`PdfSignatureAppearance.SignatureEvent`	`getSignatureEvent()` Getter for property signatureEvent.
`Image`	`getSignatureGraphic()` Gets the Image object to render.
`Calendar`	`getSignDate()` Gets the signature date.
`PdfSigGenericPKCS`	`getSigStandard()` Gets the instance of the standard signature dictionary.
`PdfStamper`	`getStamper()` Gets the `PdfStamper` associated with this instance.
`File`	`getTempFile()` Gets the temporary file.
`PdfTemplate`	`getTopLayer()` Gets the template that aggregates all appearance layers.
`boolean`	`isAcro6Layers()` Gets the Acrobat 6.0 layer mode.
`boolean`	`isInvisible()` Gets the visibility status of the signature.
`boolean`	`isNewField()` Checks if a new field was created.
`boolean`	`isPreClosed()` Checks if the document is in the process of closing.
`void`	`preClose()` This is the first method to be called when using external signatures.
`void`	`preClose(Map<PdfName,Integer> exclusionSizes)` This is the first method to be called when using external signatures.
`void`	`setAcro6Layers(boolean acro6Layers)` Acrobat 6.0 and higher recommends that only layer n2 and n4 be present.
`void`	`setCertificationLevel(int certificationLevel)` Sets the document type to certified instead of simply signed.
`void`	`setContact(String contact)` Sets the signing contact.
`void`	`setCrypto(PrivateKey privKey, Certificate[] certChain, CRL[] crlList, PdfName filter)` Sets the cryptographic parameters.
`void`	`setCrypto(PrivateKey privKey, X509Certificate certificate, CRL crl, PdfName filter)` Sets the cryptographic parameters.
`void`	`setCryptoDictionary(PdfDictionary cryptoDictionary)` Sets a user made signature dictionary.
`void`	`setExternalDigest(byte[] digest, byte[] RSAdata, String digestEncryptionAlgorithm)` Sets the digest/signature to an external calculated value.
`void`	`setImage(Image image)` Sets the background image for the layer 2.
`void`	`setImageScale(float imageScale)` Sets the scaling to be applied to the background image.
`void`	`setLayer2Font(Font layer2Font)` Sets the n2 and n4 layer font.
`void`	`setLayer2Text(String text)` Sets the signature text identifying the signer.
`void`	`setLayer4Text(String text)` Sets the text identifying the signature status.
`void`	`setLocation(String location)` Sets the signing location.
`void`	`setProvider(String provider)` Sets the Cryptographic Service Provider that will sign the document.
`void`	`setReason(String reason)` Sets the signing reason.
`void`	`setRender(int render)` Sets the rendering mode for this signature.
`void`	`setRunDirection(int runDirection)` Sets the run direction in the n2 and n4 layer.
`void`	`setSignatureEvent(PdfSignatureAppearance.SignatureEvent signatureEvent)` Sets the signature event to allow modification of the signature dictionary.
`void`	`setSignatureGraphic(Image signatureGraphic)` Sets the Image object to render when Render is set to `SignatureRenderGraphicAndDescription`
`void`	`setSignDate(Calendar signDate)` Sets the signature date.
`void`	`setVisibleSignature(Rectangle pageRect, int page)`
`void`	`setVisibleSignature(Rectangle pageRect, int page, String fieldName)` Sets the signature to be visible.
`void`	`setVisibleSignature(String fieldName)` Sets the signature to be visible.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - SignatureRenderDescription
```
public static final int SignatureRenderDescription
```
    The rendering mode is just the description
    
    See Also:
    
    Constant Field Values
  - SignatureRenderNameAndDescription
```
public static final int SignatureRenderNameAndDescription
```
    The rendering mode is the name of the signer and the description
    
    See Also:
    
    Constant Field Values
  - SignatureRenderGraphicAndDescription
```
public static final int SignatureRenderGraphicAndDescription
```
    The rendering mode is an image and the description
    
    See Also:
    
    Constant Field Values
  - SELF_SIGNED
```
public static final PdfName SELF_SIGNED
```
    The self signed filter.
  - VERISIGN_SIGNED
```
public static final PdfName VERISIGN_SIGNED
```
    The VeriSign filter.
  - WINCER_SIGNED
```
public static final PdfName WINCER_SIGNED
```
    The Windows Certificate Security.
  - NOT_CERTIFIED
```
public static final int NOT_CERTIFIED
```
    See Also:
    
    Constant Field Values
  - CERTIFIED_NO_CHANGES_ALLOWED
```
public static final int CERTIFIED_NO_CHANGES_ALLOWED
```
    See Also:
    
    Constant Field Values
  - CERTIFIED_FORM_FILLING
```
public static final int CERTIFIED_FORM_FILLING
```
    See Also:
    
    Constant Field Values
  - CERTIFIED_FORM_FILLING_AND_ANNOTATIONS
```
public static final int CERTIFIED_FORM_FILLING_AND_ANNOTATIONS
```
    See Also:
    
    Constant Field Values
  - questionMark
```
public static final String questionMark
```
    Commands to draw a yellow question mark in a stream content
    
    See Also:
    
    Constant Field Values
- Method Detail
  - getRender
```
public int getRender()
```
    Gets the rendering mode for this signature.
    
    Returns:
    
    the rendering mode for this signature
  - setRender
```
public void setRender(int render)
```
    Sets the rendering mode for this signature. The rendering modes can be the constants SignatureRenderDescription, SignatureRenderNameAndDescription or SignatureRenderGraphicAndDescription. The two last modes should be used with Acrobat 6 layer type.
    
    Parameters:
    
    render - the render mode
  - getSignatureGraphic
```
public Image getSignatureGraphic()
```
    Gets the Image object to render.
    
    Returns:
    
    the image
  - setSignatureGraphic
```
public void setSignatureGraphic(Image signatureGraphic)
```
    Sets the Image object to render when Render is set to SignatureRenderGraphicAndDescription
    
    Parameters:
    
    signatureGraphic - image rendered. If null the mode is defaulted to SignatureRenderDescription
  - setLayer2Text
```
public void setLayer2Text(String text)
```
    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
  - getLayer2Text
```
public String getLayer2Text()
```
    Gets the signature text identifying the signer if set by setLayer2Text().
    
    Returns:
    
    the signature text identifying the signer
  - setLayer4Text
```
public void setLayer4Text(String text)
```
    Sets the text identifying the signature status.
    
    Parameters:
    
    text - the text identifying the signature status. If null or not set the description "Signature Not Verified" will be used
  - getLayer4Text
```
public String getLayer4Text()
```
    Gets the text identifying the signature status if set by setLayer4Text().
    
    Returns:
    
    the text identifying the signature status
  - getRect
```
public Rectangle getRect()
```
    Gets the rectangle representing the signature dimensions.
    
    Returns:
    
    the rectangle representing the signature dimensions. It may be null or have zero width or height for invisible signatures
  - isInvisible
```
public boolean isInvisible()
```
    Gets the visibility status of the signature.
    
    Returns:
    
    the visibility status of the signature
  - setCrypto
```
public void setCrypto(PrivateKey privKey,
                      X509Certificate certificate,
                      CRL crl,
                      PdfName filter)
```
    Sets the cryptographic parameters.
    
    Parameters:
    
    privKey - the private key
    
    certificate - the certificate
    
    crl - the certificate revocation list. It may be null
    
    filter - the cryptographic filter type. It can be SELF_SIGNED, VERISIGN_SIGNED or WINCER_SIGNED
  - setCrypto
```
public void setCrypto(PrivateKey privKey,
                      Certificate[] certChain,
                      CRL[] crlList,
                      PdfName filter)
```
    Sets the cryptographic parameters.
  - setVisibleSignature
```
public void setVisibleSignature(Rectangle pageRect,
                                int page)
```
  - setVisibleSignature
```
public void setVisibleSignature(Rectangle pageRect,
                                int page,
                                String fieldName)
```
    Sets the signature to be visible. It creates a new visible signature field.
    
    Parameters:
    
    pageRect - the position and dimension of the field in the page
    
    page - the page to place the field. The fist page is 1
    
    fieldName - the field name or null to generate automatically a new field name
  - setVisibleSignature
```
public void setVisibleSignature(String fieldName)
```
    Sets the signature to be visible. An empty signature field with the same name must already exist.
    
    Parameters:
    
    fieldName - the existing empty signature field name
  - getLayer
```
public PdfTemplate getLayer(int layer)
```
    Gets a template layer to create a signature appearance. The layers can go from 0 to 4.
    Consult PPKAppearances.pdf for further details.
    
    Parameters:
    
    layer - the layer
    
    Returns:
    
    a template
  - getTopLayer
```
public PdfTemplate getTopLayer()
```
    Gets the template that aggregates all appearance layers. This corresponds to the /FRM resource.
    Consult PPKAppearances.pdf for further details.
    
    Returns:
    
    the template that aggregates all appearance layers
  - getAppearance
```
public PdfTemplate getAppearance()
                          throws DocumentException
```
    Gets the main appearance layer.
    Consult PPKAppearances.pdf for further details.
    
    Returns:
    
    the main appearance layer
    
    Throws:
    
    DocumentException - on error
  - fitText
```
public static float fitText(Font font,
                            String text,
                            Rectangle rect,
                            float maxFontSize,
                            int runDirection)
```
    Fits the text to some rectangle adjusting the font size as needed.
    
    Parameters:
    
    font - the font to use
    
    text - the text
    
    rect - the rectangle where the text must fit
    
    maxFontSize - the maximum font size
    
    runDirection - the run direction
    
    Returns:
    
    the calculated font size that makes the text fit
  - setExternalDigest
```
public void setExternalDigest(byte[] digest,
                              byte[] RSAdata,
                              String digestEncryptionAlgorithm)
```
    Sets the digest/signature to an external calculated value.
    
    Parameters:
    
    digest - the digest. This is the actual signature
    
    RSAdata - the extra data that goes into the data tag in PKCS#7
    
    digestEncryptionAlgorithm - the encryption algorithm. It may must be null if the digest is also null. If the digest is not null then it may be "RSA" or "DSA"
  - getReason
```
public String getReason()
```
    Gets the signing reason.
    
    Returns:
    
    the signing reason
  - setReason
```
public void setReason(String reason)
```
    Sets the signing reason.
    
    Parameters:
    
    reason - the signing reason
  - getLocation
```
public String getLocation()
```
    Gets the signing location.
    
    Returns:
    
    the signing location
  - setLocation
```
public void setLocation(String location)
```
    Sets the signing location.
    
    Parameters:
    
    location - the signing location
  - getProvider
```
public String getProvider()
```
    Returns the Cryptographic Service Provider that will sign the document.
    
    Returns:
    
    provider the name of the provider, for example "SUN", or null to use the default provider.
  - setProvider
```
public void setProvider(String provider)
```
    Sets the Cryptographic Service Provider that will sign the document.
    
    Parameters:
    
    provider - the name of the provider, for example "SUN", or null to use the default provider.
  - getPrivKey
```
public PrivateKey getPrivKey()
```
    Gets the private key.
    
    Returns:
    
    the private key
  - getCrlList
```
public CRL[] getCrlList()
```
    Gets the certificate revocation list.
    
    Returns:
    
    the certificate revocation list
  - getFilter
```
public PdfName getFilter()
```
    Gets the filter used to sign the document.
    
    Returns:
    
    the filter used to sign the document
  - isNewField
```
public boolean isNewField()
```
    Checks if a new field was created.
    
    Returns:
    
    true if a new field was created, false if signing an existing field or if the signature is invisible
  - getPage
```
public int getPage()
```
    Gets the page number of the field.
    
    Returns:
    
    the page number of the field
  - getFieldName
```
public String getFieldName()
```
    Gets the field name.
    
    Returns:
    
    the field name
  - getPageRect
```
public Rectangle getPageRect()
```
    Gets the rectangle that represent the position and dimension of the signature in the page.
    
    Returns:
    
    the rectangle that represent the position and dimension of the signature in the page
  - getSignDate
```
public Calendar getSignDate()
```
    Gets the signature date.
    
    Returns:
    
    the signature date
  - setSignDate
```
public void setSignDate(Calendar signDate)
```
    Sets the signature date.
    
    Parameters:
    
    signDate - the signature date
  - getTempFile
```
public File getTempFile()
```
    Gets the temporary file.
    
    Returns:
    
    the temporary file or null is the document is created in memory
  - getNewSigName
```
public final String getNewSigName()
```
    Gets a new signature fied name that doesn't clash with any existing name.
    
    Returns:
    
    a new signature fied name
  - preClose
```
public void preClose()
              throws IOException,
                     DocumentException
```
    This is the first method to be called when using external signatures. The general sequence is: preClose(), getDocumentBytes() and close().
    If calling preClose() dont't call PdfStamper.close().
    No external signatures are allowed if this method is called.
    
    Throws:
    
    IOException - on error
    
    DocumentException - on error
  - preClose
```
public void preClose(Map<PdfName,Integer> exclusionSizes)
              throws IOException,
                     DocumentException
```
    This is the first method to be called when using external signatures. The general sequence is: preClose(), getDocumentBytes() and close().
    If calling preClose() dont't call PdfStamper.close().
    If using an external signature exclusionSizes must contain at least the PdfName.CONTENTS key with the size that it will take in the document. Note that due to the hex string coding this size should be byte_size*2+2.
    
    Parameters:
    
    exclusionSizes - a HashMap with names and sizes to be excluded in the signature calculation. The key is a PdfName and the value an Integer. At least the PdfName.CONTENTS must be present
    
    Throws:
    
    IOException - on error
    
    DocumentException - on error
  - close
```
public void close(PdfDictionary update)
           throws IOException,
                  DocumentException
```
    This is the last method to be called when using external signatures. The general sequence is: preClose(), getDocumentBytes() and close().
    update is a PdfDictionary that must have exactly the same keys as the ones provided in preClose(Map).
    
    Parameters:
    
    update - a PdfDictionary with the key/value that will fill the holes defined in preClose(Map)
    
    Throws:
    
    DocumentException - on error
    
    IOException - on error
  - getRangeStream
```
public InputStream getRangeStream()
```
    Gets the document bytes that are hashable when using external signatures. The general sequence is: preClose(), getRangeStream() and close().
    
    Returns:
    
    the document bytes that are hashable
  - getCryptoDictionary
```
public PdfDictionary getCryptoDictionary()
```
    Gets the user made signature dictionary. This is the dictionary at the /V key.
    
    Returns:
    
    the user made signature dictionary
  - setCryptoDictionary
```
public void setCryptoDictionary(PdfDictionary cryptoDictionary)
```
    Sets a user made signature dictionary. This is the dictionary at the /V key.
    
    Parameters:
    
    cryptoDictionary - a user made signature dictionary
  - getStamper
```
public PdfStamper getStamper()
```
    Gets the PdfStamper associated with this instance.
    
    Returns:
    
    the PdfStamper associated with this instance
  - isPreClosed
```
public boolean isPreClosed()
```
    Checks if the document is in the process of closing.
    
    Returns:
    
    true if the document is in the process of closing, false otherwise
  - getSigStandard
```
public PdfSigGenericPKCS getSigStandard()
```
    Gets the instance of the standard signature dictionary. This instance is only available after pre close.
    The main use is to insert external signatures.
    
    Returns:
    
    the instance of the standard signature dictionary
  - getContact
```
public String getContact()
```
    Gets the signing contact.
    
    Returns:
    
    the signing contact
  - setContact
```
public void setContact(String contact)
```
    Sets the signing contact.
    
    Parameters:
    
    contact - the signing contact
  - getLayer2Font
```
public Font getLayer2Font()
```
    Gets the n2 and n4 layer font.
    
    Returns:
    
    the n2 and n4 layer font
  - setLayer2Font
```
public void setLayer2Font(Font layer2Font)
```
    Sets the n2 and n4 layer font. If the font size is zero, auto-fit will be used.
    
    Parameters:
    
    layer2Font - the n2 and n4 font
  - isAcro6Layers
```
public boolean isAcro6Layers()
```
    Gets the Acrobat 6.0 layer mode.
    
    Returns:
    
    the Acrobat 6.0 layer mode
  - setAcro6Layers
```
public void setAcro6Layers(boolean acro6Layers)
```
    Acrobat 6.0 and higher recommends that only layer n2 and n4 be present. This method sets that mode.
    
    Parameters:
    
    acro6Layers - if true only the layers n2 and n4 will be present
  - setRunDirection
```
public void setRunDirection(int runDirection)
```
    Sets the run direction in the n2 and n4 layer.
    
    Parameters:
    
    runDirection - the run direction
  - getRunDirection
```
public int getRunDirection()
```
    Gets the run direction.
    
    Returns:
    
    the run direction
  - getSignatureEvent
```
public PdfSignatureAppearance.SignatureEvent getSignatureEvent()
```
    Getter for property signatureEvent.
    
    Returns:
    
    Value of property signatureEvent.
  - setSignatureEvent
```
public void setSignatureEvent(PdfSignatureAppearance.SignatureEvent signatureEvent)
```
    Sets the signature event to allow modification of the signature dictionary.
    
    Parameters:
    
    signatureEvent - the signature event
  - getImage
```
public Image getImage()
```
    Gets the background image for the layer 2.
    
    Returns:
    
    the background image for the layer 2
  - setImage
```
public void setImage(Image image)
```
    Sets the background image for the layer 2.
    
    Parameters:
    
    image - the background image for the layer 2
  - getImageScale
```
public float getImageScale()
```
    Gets the scaling to be applied to the background image.
    
    Returns:
    
    the scaling to be applied to the background image
  - setImageScale
```
public void setImageScale(float imageScale)
```
    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
  - getCertificationLevel
```
public int getCertificationLevel()
```
    Gets the certified status of this document.
    
    Returns:
    
    the certified status
  - setCertificationLevel
```
public void setCertificationLevel(int certificationLevel)
```
    Sets the document type to certified instead of simply signed.
    
    Parameters:
    
    certificationLevel - the values can be: NOT_CERTIFIED, CERTIFIED_NO_CHANGES_ALLOWED, CERTIFIED_FORM_FILLING and CERTIFIED_FORM_FILLING_AND_ANNOTATIONS

Class PdfSignatureAppearance

Nested Class Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SignatureRenderDescription

SignatureRenderNameAndDescription

SignatureRenderGraphicAndDescription

SELF_SIGNED

VERISIGN_SIGNED

WINCER_SIGNED

NOT_CERTIFIED

CERTIFIED_NO_CHANGES_ALLOWED

CERTIFIED_FORM_FILLING

CERTIFIED_FORM_FILLING_AND_ANNOTATIONS

questionMark

Method Detail

getRender

setRender

getSignatureGraphic

setSignatureGraphic

setLayer2Text

getLayer2Text

setLayer4Text

getLayer4Text

getRect

isInvisible

setCrypto

setCrypto

setVisibleSignature

setVisibleSignature

setVisibleSignature

getLayer

getTopLayer

getAppearance

fitText

setExternalDigest

getReason

setReason

getLocation

setLocation

getProvider

setProvider

getPrivKey

getCrlList

getFilter

isNewField

getPage

getFieldName

getPageRect

getSignDate

setSignDate

getTempFile

getNewSigName

preClose

preClose

close

getRangeStream

getCryptoDictionary

setCryptoDictionary

getStamper

isPreClosed

getSigStandard

getContact

setContact

getLayer2Font

setLayer2Font

isAcro6Layers

setAcro6Layers

setRunDirection

getRunDirection

getSignatureEvent

setSignatureEvent

getImage

setImage

getImageScale

setImageScale

getCertificationLevel

setCertificationLevel