Package com.itextpdf.forms
Class PdfSigFieldLock
A signature field lock dictionary. Specifies a set of form fields that shall be locked when this signature field is signed.
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic enum
Enumerates the different actions of a signature field lock.static enum
Enumerates the different levels of access permissions granted for the document when the corresponding signature field is signed:PdfSigFieldLock.LockPermissions.NO_CHANGES_ALLOWED
- no changes to the document are permitted; any change to the document invalidates the signature,PdfSigFieldLock.LockPermissions.FORM_FILLING
- permitted changes are filling in forms, instantiating page templates, and signing; other changes invalidate the signature,PdfSigFieldLock.LockPermissions.FORM_FILLING_AND_ANNOTATION
- permitted changes are the same as for the previous, as well as annotation creation, deletion, and modification; other changes invalidate the signature. -
Constructor Summary
ConstructorsConstructorDescriptionCreates an instance ofPdfSigFieldLock
.PdfSigFieldLock
(PdfDictionary dict) Creates an instance ofPdfSigFieldLock
. -
Method Summary
Modifier and TypeMethodDescriptionstatic PdfName
static PdfNumber
getLockPermission
(PdfSigFieldLock.LockPermissions permissions) protected boolean
Defines if the object behind this wrapper must be an indirect object in the resultant document.setDocumentPermissions
(PdfSigFieldLock.LockPermissions permissions) Sets the permissions granted for the document when the corresponding signature field is signed.setFieldLock
(PdfSigFieldLock.LockAction action, String... fields) Sets signature lock for specific fields in the document.Methods inherited from class com.itextpdf.kernel.pdf.PdfObjectWrapper
ensureObjectIsAddedToDocument, ensureUnderlyingObjectHasIndirectReference, flush, getPdfObject, isFlushed, makeIndirect, makeIndirect, markObjectAsIndirect, setForbidRelease, setModified, setPdfObject, unsetForbidRelease
-
Constructor Details
-
PdfSigFieldLock
public PdfSigFieldLock()Creates an instance ofPdfSigFieldLock
. -
PdfSigFieldLock
Creates an instance ofPdfSigFieldLock
.- Parameters:
-
dict
- The dictionary whose entries should be added to the signature field lock dictionary.
-
-
Method Details
-
setDocumentPermissions
Sets the permissions granted for the document when the corresponding signature field is signed. SeePdfSigFieldLock.LockPermissions
for getting more info.- Parameters:
-
permissions
- The permissions granted for the document. - Returns:
-
This
PdfSigFieldLock
object.
-
setFieldLock
Sets signature lock for specific fields in the document.- Parameters:
-
action
- Indicates the set of fields that should be locked after the actual signing of the corresponding signature takes place. -
fields
- Names indicating the fields. - Returns:
-
This
PdfSigFieldLock
object.
-
getLockActionValue
-
getLockPermission
-
isWrappedObjectMustBeIndirect
protected boolean isWrappedObjectMustBeIndirect()Description copied from class:PdfObjectWrapper
Defines if the object behind this wrapper must be an indirect object in the resultant document.
If this method returns true it doesn't necessarily mean that object must be in the indirect state at any moment, but rather defines that when the object will be written to the document it will be transformed into indirect object if it's not indirect yet.
Return value of this method shouldn't depend on any logic, it should return always true or false.- Specified by:
-
isWrappedObjectMustBeIndirect
in classPdfObjectWrapper<PdfDictionary>
- Returns:
- true if in the resultant document the object behind the wrapper must be indirect, otherwise false.
-