Package com.pdftools.sign

Class SignatureFieldOptions

java.lang.Object
com.pdftools.internal.NativeBase
com.pdftools.internal.NativeObject
com.pdftools.sign.SignatureFieldOptions
public class SignatureFieldOptions extends NativeObject

Options for adding unsigned signature fields

These options control the creation of unsigned signature fields in Signer.addSignatureField(com.pdftools.pdf.Document, com.pdftools.sign.SignatureFieldOptions, com.pdftools.sys.Stream).

  • Constructor Details

    • SignatureFieldOptions

      public SignatureFieldOptions(Appearance boundingBox)
      Parameters:
      boundingBox - The bounding box of the signature field
      Throws:
      IllegalArgumentException - If the
      invalid @link 
      {@link com.pdftools.sign.SignatureFieldOptions#
      boundingBox} argument is null or not a valid bounding box
      IllegalArgumentException - if boundingBox is null

  • Method Details

    • getBoundingBox

      public Appearance getBoundingBox()

      The bounding box of the signature field (Getter)

      The bounding box is the area where the visual appearance of the signature is inserted, when the signature field is signed.

      Use Appearance.createFieldBoundingBox(com.pdftools.geometry.units.Size) to create the bounding box object.

    • getFieldName

      public String getFieldName()

      The name of the new signature field (Getter)

      If null, a new signature field is created using a unique field name.

      Default: null

    • setFieldName

      public void setFieldName(String value)

      The name of the new signature field (Setter)

      If null, a new signature field is created using a unique field name.

      Default: null