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
-
-
Field Summary
-
Fields inherited from class org.apache.pdfbox.pdmodel.interactive.form.PDField
FLAG_NO_EXPORT, FLAG_READ_ONLY, FLAG_REQUIRED
-
-
Constructor Summary
Constructors Constructor Description PDSignatureField(PDAcroForm theAcroForm)
PDSignatureField(PDAcroForm theAcroForm, COSDictionary field)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description 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.PDSignature
getSignature()
Get the signature dictionary.java.lang.String
getValue()
Deprecated.use getSignature() insteadvoid
setSeedValue(PDSeedValue sv)
(Optional; PDF 1.)void
setSignature(PDSignature value)
Add a signature dictionary to the signature field.void
setValue(java.lang.String value)
Deprecated.use setSignature(PDSignature) insteadjava.lang.String
toString()
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 Detail
-
PDSignatureField
public PDSignatureField(PDAcroForm theAcroForm, COSDictionary field) throws java.io.IOException
- Parameters:
theAcroForm
- The acroForm for this field.field
- The dictionary for the signature.- Throws:
java.io.IOException
- If there is an error while resolving partital name for the signature field- See Also:
PDField(PDAcroForm,COSDictionary)
-
PDSignatureField
public PDSignatureField(PDAcroForm theAcroForm) throws java.io.IOException
- Parameters:
theAcroForm
- The acroForm for this field.- Throws:
java.io.IOException
- If there is an error while resolving partial name for the signature field or getting the widget object.- See Also:
PDField(PDAcroForm)
-
-
Method Detail
-
setValue
@Deprecated public void setValue(java.lang.String value) throws java.io.IOException
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:
java.io.IOException
- If there is an error creating the appearance stream.- See Also:
PDField.setValue(java.lang.String)
-
getValue
@Deprecated public java.lang.String getValue() throws java.io.IOException
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:
java.io.IOException
- If there is an error creating the appearance stream.- See Also:
PDField.setValue(java.lang.String)
-
toString
public java.lang.String toString()
Return 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
-
-