Class PDSignatureField
java.lang.Object
org.apache.pdfbox.pdmodel.interactive.form.PDField
org.apache.pdfbox.pdmodel.interactive.form.PDSignatureField
- All Implemented Interfaces:
COSObjectable
A class for handling the PDF field as a signature.
- Version:
- $Revision: 1.5 $
- Author:
- Ben Litchfield, Thomas Chojecki
-
Field Summary
Fields inherited from class org.apache.pdfbox.pdmodel.interactive.form.PDField
FLAG_NO_EXPORT, FLAG_READ_ONLY, FLAG_REQUIRED
-
Constructor Summary
ConstructorsConstructorDescriptionPDSignatureField
(PDAcroForm theAcroForm) PDSignatureField
(PDAcroForm theAcroForm, COSDictionary field) -
Method Summary
Modifier and TypeMethodDescription(Optional; PDF 1.5) A seed value dictionary containing information that constrains the properties of a signature that is applied to the field.Get the signature dictionary.getValue()
Deprecated.use getSignature() insteadvoid
(Optional; PDF 1.) A seed value dictionary containing information that constrains the properties of a signature that is applied to the field.void
setSignature
(PDSignature value) Add a signature dictionary to the signature field.void
Deprecated.use setSignature(PDSignature) insteadtoString()
Return a string rep of this object.Methods inherited from class org.apache.pdfbox.pdmodel.interactive.form.PDField
findFieldType, findKid, getAcroForm, getActions, getAlternateFieldName, getCOSObject, getDictionary, getFieldFlags, getFieldType, getFullyQualifiedName, getKids, getParent, getPartialName, getWidget, getWidgets, importFDF, isNoExport, isReadonly, isRequired, setAcroForm, setActions, setAlternateFieldName, setFieldFlags, setFieldType, setKids, setNoExport, setParent, setPartialName, setReadonly, setRequired
-
Constructor Details
-
PDSignatureField
- Parameters:
theAcroForm
- The acroForm for this field.field
- The dictionary for the signature.- Throws:
IOException
- If there is an error while resolving partital name for the signature field- See Also:
-
PDSignatureField
- Parameters:
theAcroForm
- The acroForm for this field.- Throws:
IOException
- If there is an error while resolving partial name for the signature field or getting the widget object.- See Also:
-
-
Method Details
-
setValue
Deprecated.use setSignature(PDSignature) insteadDescription copied from class:PDField
setValue sets the fields value to a given string.- Specified by:
setValue
in classPDField
- Parameters:
value
- The new value for the field.- Throws:
IOException
- If there is an error creating the appearance stream.- See Also:
-
getValue
Deprecated.use getSignature() insteadDescription copied from class:PDField
getValue gets the fields value to as a string.- Specified by:
getValue
in classPDField
- Returns:
- The string value of this field.
- Throws:
IOException
- If there is an error creating the appearance stream.- See Also:
-
toString
Return a string rep of this object. -
setSignature
Add a signature dictionary to the signature field.- Parameters:
value
- is the PDSignature
-
getSignature
Get the signature dictionary.- Returns:
- the signature dictionary
-
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
(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
-