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
An AcroForm field containing signature data.
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate boolean
Indicates if we need to ignore page rotation for the signature field annotation.private PdfFormXObject
Background level of the signature appearance.private PdfFormXObject
Signature appearance layer that contains information about the signature.private boolean
Indicates if we need to reuse the existing appearance as a background layer.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, pdfAConformanceLevel, pdfConformanceLevel
-
Constructor Summary
ConstructorsModifierConstructorDescriptionprotected
PdfSignatureFormField
(PdfWidgetAnnotation widget, PdfDocument pdfDocument) Creates a signature form field as a parent of aPdfWidgetAnnotation
.protected
PdfSignatureFormField
(PdfDictionary pdfObject) Creates a signature form field as a wrapper object around aPdfDictionary
.protected
PdfSignatureFormField
(PdfDocument pdfDocument) Creates a minimalPdfSignatureFormField
. -
Method Summary
Modifier and TypeMethodDescription(package private) PdfFormXObject
Gets the background layer that is present when creating the signature field if it was set.ReturnsSig
, the form type for signature form fields.Gets thePdfSigFieldLock
, which contains fields that must be locked if the document is signed.(package private) PdfFormXObject
Gets the signature appearance layer that contains information about the signature if it was set.(package private) boolean
Indicates if page rotation should be ignored for the signature appearance.(package private) boolean
Indicates if the existing appearances needs to be reused as a background.Sets the background layer that is present when creating the signature field.setIgnorePageRotation
(boolean ignore) Sets the boolean value which indicates if page rotation should be ignored for the signature appearance.setReuseAppearance
(boolean reuseAppearance) Indicates that the existing appearances needs to be reused as a background.Sets the signature appearance layer that contains information about the signature, e.g.Adds the signature to the signature field.Methods inherited from class com.itextpdf.forms.fields.PdfFormField
addKid, addKid, addKid, getAdditionalAction, getAllChildFields, getAllChildFormFields, getAlternativeName, getAppearanceStates, getChildField, getChildFields, getChildFormAnnotations, getChildFormFields, getDefaultAppearance, getDefaultStyle, getDefaultValue, getDisplayValue, getFieldFlag, getFieldFlags, getFirstFormAnnotation, getFormFieldKeys, getFormType, getJustification, getKids, getMappingName, getOptions, getPartialFieldName, getRichText, getValue, getValueAsString, getWidgets, isFormField, isInReadingMode, isMultiline, isNoExport, isPassword, isReadOnly, isRequired, makeFieldFlag, makeFormField, makeFormFieldOrAnnotation, optionsArrayToString, regenerateField, release, removeChild, removeChildren, replaceKids, setAdditionalAction, setAlternativeName, setCheckType, setChildField, setColor, setDefaultStyle, setDefaultValue, setFieldFlag, setFieldFlag, setFieldFlags, setFieldName, setJustification, setMappingName, setNoExport, setOptions, setReadOnly, setRequired, setRichText, setValue, setValue, setValue, setValue, updateDefaultAppearance, updateFontAndFontSize
Methods inherited from class com.itextpdf.forms.fields.AbstractPdfFormField
disableCurrentFieldRegeneration, disableFieldRegeneration, enableCurrentFieldRegeneration, enableFieldRegeneration, equals, getAcroFormObject, getColor, getDocument, getFieldName, getFont, getFontSize, getParent, getParentField, getPdfAConformanceLevel, getPdfConformanceLevel, getPdfObject, hashCode, isFieldRegenerationEnabled, isTerminalFormField, isWrappedObjectMustBeIndirect, put, remove, retrieveStyles, setColorNoRegenerate, 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
-
Field Details
-
reuseAppearance
private boolean reuseAppearanceIndicates if we need to reuse the existing appearance as a background layer. -
ignorePageRotation
private boolean ignorePageRotationIndicates if we need to ignore page rotation for the signature field annotation. -
n0
Background level of the signature appearance. -
n2
Signature appearance layer that contains information about the signature.
-
-
Constructor Details
-
PdfSignatureFormField
Creates a minimalPdfSignatureFormField
.- Parameters:
pdfDocument
- ThePdfDocument
instance.
-
PdfSignatureFormField
Creates a signature form field as a parent of aPdfWidgetAnnotation
.- Parameters:
widget
- The widget which will be a kid of thePdfSignatureFormField
.pdfDocument
- ThePdfDocument
instance.
-
PdfSignatureFormField
Creates a signature form field as a wrapper object around aPdfDictionary
. ThisPdfDictionary
must be an indirect object.- Parameters:
pdfObject
- the dictionary to be wrapped, must have an indirect reference.
-
-
Method Details
-
getFormType
ReturnsSig
, the form type for signature form fields.- Overrides:
getFormType
in classPdfFormField
- Returns:
- the form type, as a
PdfName
-
setValue
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
Gets thePdfSigFieldLock
, which contains fields that must be locked if the document is signed.- Returns:
- a dictionary containing locked fields.
- See Also:
-
setBackgroundLayer
Sets the background layer that is present when creating the signature field.- Parameters:
n0
- layer xObject.- Returns:
- this same
PdfSignatureFormField
instance.
-
setSignatureAppearanceLayer
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
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
Sets the boolean value which indicates if page rotation should be ignored for the signature appearance.Default value is
true
.- Parameters:
ignore
- boolean value to set.- Returns:
- this same
PdfSignatureFormField
instance.
-
getBackgroundLayer
PdfFormXObject getBackgroundLayer()Gets the background layer that is present when creating the signature field if it was set.- Returns:
- n0 layer xObject.
-
getSignatureAppearanceLayer
PdfFormXObject getSignatureAppearanceLayer()Gets the signature appearance layer that contains information about the signature if it was set.- Returns:
- n2 layer xObject.
-
isReuseAppearance
boolean isReuseAppearance()Indicates if the existing appearances needs to be reused as a background.- Returns:
- appearances reusing flag value.
-
isPageRotationIgnored
boolean isPageRotationIgnored()Indicates if page rotation should be ignored for the signature appearance.- Returns:
- the boolean value which indicates if we need to ignore page rotation for the signature appearance.
-