Package com.itextpdf.forms
Class PdfSigFieldLock
- java.lang.Object
-
- com.itextpdf.kernel.pdf.PdfObjectWrapper<PdfDictionary>
-
- com.itextpdf.forms.PdfSigFieldLock
-
public class PdfSigFieldLock extends PdfObjectWrapper<PdfDictionary>
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 Classes Modifier and Type Class Description static class
PdfSigFieldLock.LockAction
Enumerates the different actions of a signature field lock.static class
PdfSigFieldLock.LockPermissions
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
Constructors Constructor Description PdfSigFieldLock()
Creates an instance ofPdfSigFieldLock
.PdfSigFieldLock(PdfDictionary dict)
Creates an instance ofPdfSigFieldLock
.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static PdfName
getLockActionValue(PdfSigFieldLock.LockAction action)
Returns the specified action of a signature field lock asPdfName
value.static PdfNumber
getLockPermission(PdfSigFieldLock.LockPermissions permissions)
Returns the specified level of access permissions granted for the document asPdfNumber
value.protected boolean
isWrappedObjectMustBeIndirect()
Defines if the object behind this wrapper must be an indirect object in the resultant document.PdfSigFieldLock
setDocumentPermissions(PdfSigFieldLock.LockPermissions permissions)
Sets the permissions granted for the document when the corresponding signature field is signed.PdfSigFieldLock
setFieldLock(PdfSigFieldLock.LockAction action, java.lang.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 Detail
-
PdfSigFieldLock
public PdfSigFieldLock()
Creates an instance ofPdfSigFieldLock
.
-
PdfSigFieldLock
public PdfSigFieldLock(PdfDictionary dict)
Creates an instance ofPdfSigFieldLock
.- Parameters:
dict
- the dictionary whose entries should be added to the signature field lock dictionary
-
-
Method Detail
-
setDocumentPermissions
public PdfSigFieldLock setDocumentPermissions(PdfSigFieldLock.LockPermissions permissions)
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
public PdfSigFieldLock setFieldLock(PdfSigFieldLock.LockAction action, java.lang.String... fields)
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 placefields
- names indicating the fields- Returns:
- this
PdfSigFieldLock
object.
-
getLockActionValue
public static PdfName getLockActionValue(PdfSigFieldLock.LockAction action)
Returns the specified action of a signature field lock asPdfName
value.- Parameters:
action
- the action asPdfSigFieldLock.LockAction
- Returns:
- the specified action of a signature field lock as
PdfName
.
-
getLockPermission
public static PdfNumber getLockPermission(PdfSigFieldLock.LockPermissions permissions)
Returns the specified level of access permissions granted for the document asPdfNumber
value.- Parameters:
permissions
- the level of access permissions asPdfSigFieldLock.LockPermissions
- Returns:
- the specified level of access permissions as
PdfNumber
.
-
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.
-
-