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 inSigner.addSignatureField(com.pdftools.pdf.Document, com.pdftools.sign.SignatureFieldOptions, com.pdftools.sys.Stream)
.
-
-
Constructor Summary
Constructors Constructor Description SignatureFieldOptions(Appearance boundingBox)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Appearance
getBoundingBox()
The bounding box of the signature field (Getter)java.lang.String
getFieldName()
The name of the new signature field (Getter)void
setFieldName(java.lang.String value)
The name of the new signature field (Setter)-
Methods inherited from class com.pdftools.internal.NativeObject
equals, hashCode
-
-
-
-
Constructor Detail
-
SignatureFieldOptions
public SignatureFieldOptions(Appearance boundingBox)
- Parameters:
boundingBox
- The bounding box of the signature field- Throws:
java.lang.IllegalArgumentException
- If the {@link com.pdftools.sign.SignatureFieldOptions# boundingBox} argument isnull
or not a valid bounding boxjava.lang.IllegalArgumentException
- ifboundingBox
isnull
-
-
Method Detail
-
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 java.lang.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(java.lang.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
-
-