Class PDSignatureField

java.lang.Object
org.apache.pdfbox.pdmodel.interactive.form.PDField
org.apache.pdfbox.pdmodel.interactive.form.PDSignatureField
All Implemented Interfaces:
COSObjectable

public class PDSignatureField extends PDField
A class for handling the PDF field as a signature.
Version:
$Revision: 1.5 $
Author:
Ben Litchfield, Thomas Chojecki
  • Constructor Details

  • Method Details

    • setValue

      @Deprecated public void setValue(String value) throws IOException
      Deprecated.
      use setSignature(PDSignature) instead
      Description copied from class: PDField
      setValue sets the fields value to a given string.
      Specified by:
      setValue in class PDField
      Parameters:
      value - The new value for the field.
      Throws:
      IOException - If there is an error creating the appearance stream.
      See Also:
    • getValue

      @Deprecated public String getValue() throws IOException
      Deprecated.
      use getSignature() instead
      Description copied from class: PDField
      getValue gets the fields value to as a string.
      Specified by:
      getValue in class PDField
      Returns:
      The string value of this field.
      Throws:
      IOException - If there is an error creating the appearance stream.
      See Also:
    • toString

      public String toString()
      Return a string rep of this object.
      Overrides:
      toString in class PDField
      Returns:
      A string rep of this object.
    • setSignature

      public void setSignature(PDSignature value)
      Add a signature dictionary to the signature field.
      Parameters:
      value - is the PDSignature
    • getSignature

      public PDSignature getSignature()
      Get the signature dictionary.
      Returns:
      the signature dictionary
    • getSeedValue

      public PDSeedValue getSeedValue()

      (Optional; PDF 1.5) A seed value dictionary containing information that constrains the properties of a signature that is applied to the field.

      Returns:
      the seed value dictionary as PDSeedValue
    • setSeedValue

      public void setSeedValue(PDSeedValue sv)

      (Optional; PDF 1.) A seed value dictionary containing information that constrains the properties of a signature that is applied to the field.

      Parameters:
      sv - is the seed value dictionary as PDSeedValue