Package com.itextpdf.forms.fields

Class PdfSignatureFormField

java.lang.Object

com.itextpdf.kernel.pdf.PdfObjectWrapper<PdfDictionary>

com.itextpdf.forms.fields.AbstractPdfFormField

com.itextpdf.forms.fields.PdfFormField

com.itextpdf.forms.fields.PdfSignatureFormField

       public class PdfSignatureFormField extends PdfFormField
      

An AcroForm field containing signature data.

Field Summary

Fields inherited from class com.itextpdf.forms.fields.PdfFormField

checkType, FF_MULTILINE, FF_NO_EXPORT, FF_PASSWORD, FF_READ_ONLY, FF_REQUIRED, form, img, text

Fields inherited from class com.itextpdf.forms.fields.AbstractPdfFormField

color, DEFAULT_FONT_SIZE, font, fontSize, MIN_FONT_SIZE, parent, pdfConformance

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	PdfSignatureFormField(PdfWidgetAnnotation widget, PdfDocument pdfDocument)	Creates a signature form field as a parent of a PdfWidgetAnnotation.
protected	PdfSignatureFormField(PdfDictionary pdfObject)	Creates a signature form field as a wrapper object around a PdfDictionary.
protected	PdfSignatureFormField(PdfDocument pdfDocument)	Creates a minimal PdfSignatureFormField.

Method Summary

Modifier and Type	Method	Description
PdfName	getFormType()	Returns Sig, the form type for signature form fields.
PdfSigFieldLock	getSigFieldLockDictionary()	Gets the PdfSigFieldLock, which contains fields that must be locked if the document is signed.
PdfSignatureFormField	setBackgroundLayer(PdfFormXObject n0)	Sets the background layer that is present when creating the signature field.
PdfSignatureFormField	setIgnorePageRotation(boolean ignore)	Deprecated. Functionality is deprecated, see documentation for more information.
PdfSignatureFormField	setReuseAppearance(boolean reuseAppearance)	Indicates that the existing appearances needs to be reused as a background.
PdfSignatureFormField	setSignatureAppearanceLayer(PdfFormXObject n2)	Sets the signature appearance layer that contains information about the signature, e.g.
PdfSignatureFormField	setValue(PdfObject value)	Adds the signature to the signature field.

Methods inherited from class com.itextpdf.forms.fields.PdfFormField

addKid, addKid, addKid, applyAccessibilityProperties, getAdditionalAction, getAllChildFields, getAllChildFormFields, getAlternativeName, getAppearanceStates, getChildField, getChildFields, getChildFormAnnotations, getChildFormFields, getDefaultAppearance, getDefaultStyle, getDefaultValue, getDisplayValue, getFieldFlag, getFieldFlags, getFirstFormAnnotation, getFormFieldKeys, getFormType, getJustification, getKids, getMappingName, getOptions, getPartialFieldName, getRichText, getStringValue, getValue, getValueAsString, getWidgets, isFormField, isInReadingMode, isMultiline, isNoExport, isPassword, isReadOnly, isRequired, makeFieldFlag, makeFormField, makeFormFieldOrAnnotation, regenerateField, release, removeChild, removeChildren, setAdditionalAction, setAlternativeName, setCheckType, setColor, setDefaultStyle, setDefaultValue, setFieldFlag, setFieldFlag, setFieldFlags, setFieldName, setJustification, setMappingName, setNoExport, setOptions, setReadOnly, setRequired, setRichText, setValue, setValue, setValue, setValue, updateDefaultAppearance

Methods inherited from class com.itextpdf.forms.fields.AbstractPdfFormField

disableCurrentFieldRegeneration, disableFieldRegeneration, enableCurrentFieldRegeneration, enableFieldRegeneration, equals, getColor, getDocument, getFieldName, getFont, getFontSize, getParent, getParentField, getPdfConformance, getPdfObject, hashCode, isFieldRegenerationEnabled, isTerminalFormField, isWrappedObjectMustBeIndirect, put, remove, setFont, setFontAndSize, setFontSize, setFontSize, setFontSizeAutoScale, setParent

Methods inherited from class com.itextpdf.kernel.pdf.PdfObjectWrapper

ensureObjectIsAddedToDocument, ensureUnderlyingObjectHasIndirectReference, flush, isFlushed, makeIndirect, makeIndirect, markObjectAsIndirect, setForbidRelease, setModified, setPdfObject, unsetForbidRelease

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Details

PdfSignatureFormField

             protected PdfSignatureFormField
             (PdfDocument pdfDocument)
            

Creates a minimal PdfSignatureFormField.

Parameters:

pdfDocument - The PdfDocument instance.

PdfSignatureFormField

             protected PdfSignatureFormField
             (PdfWidgetAnnotation widget, PdfDocument pdfDocument)
            

Creates a signature form field as a parent of a PdfWidgetAnnotation.

Parameters:

widget - The widget which will be a kid of the PdfSignatureFormField.

pdfDocument - The PdfDocument instance.

PdfSignatureFormField

             protected PdfSignatureFormField
             (PdfDictionary pdfObject)
            

Creates a signature form field as a wrapper object around a PdfDictionary. This PdfDictionary must be an indirect object.

Parameters:

pdfObject - the dictionary to be wrapped, must have an indirect reference.

Method Details

getFormType

             public PdfName getFormType()
            

Returns Sig, the form type for signature form fields.

Overrides:

getFormType in class PdfFormField

Returns:

the form type, as a PdfName

setValue

             public PdfSignatureFormField setValue
             (PdfObject value)
            

Adds the signature to the signature field.

Parameters:

value - the signature to be contained in the signature field, or an indirect reference to it

Returns:

the edited field

getSigFieldLockDictionary

             public PdfSigFieldLock getSigFieldLockDictionary()
            

Gets the PdfSigFieldLock, which contains fields that must be locked if the document is signed.

Returns:

a dictionary containing locked fields.

See Also:

• PdfSigFieldLock

setBackgroundLayer

             public PdfSignatureFormField setBackgroundLayer
             (PdfFormXObject n0)
            

Sets the background layer that is present when creating the signature field.

Parameters:

n0 - layer xObject.

Returns:

this same PdfSignatureFormField instance.

setSignatureAppearanceLayer

             public PdfSignatureFormField setSignatureAppearanceLayer
             (PdfFormXObject n2)
            

Sets the signature appearance layer that contains information about the signature, e.g. the line art for the handwritten signature, the text giving the signer’s name, date, reason, location and so on.

Parameters:

n2 - layer xObject.

Returns:

this same PdfSignatureFormField instance.

setReuseAppearance

             public PdfSignatureFormField setReuseAppearance
             (boolean reuseAppearance)
            

Indicates that the existing appearances needs to be reused as a background.

Parameters:

reuseAppearance - is an appearances reusing flag value to set.

Returns:

this same PdfSignatureFormField instance.

setIgnorePageRotation

             @Deprecated public PdfSignatureFormField setIgnorePageRotation
             (boolean ignore)
            

Deprecated.

Functionality is deprecated, see documentation for more information.

Sets the boolean value which indicates if page rotation should be ignored for the signature appearance.

Default value is true.

If you have rotated pages but want to ignore that rotation when adding a new field, you need to disable this broken feature and negate page rotation by modifying form field rectangle and field rotation properties using PdfFormAnnotation.setRotation(int). An example code explaining how to do it can be found in SignatureAppearancePageRotationAgnosticExample sample in Java samples repository and C# samples repository.

Parameters:

ignore - boolean value to set

Returns:

this same PdfSignatureFormField instance