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 enum	PdfSigFieldLock.LockAction	Enumerates the different actions of a signature field lock.
static enum	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 of PdfSigFieldLock.
PdfSigFieldLock(PdfDictionary dict)	Creates an instance of PdfSigFieldLock.

Method Summary

Modifier and Type	Method	Description
static PdfName	getLockActionValue(PdfSigFieldLock.LockAction action)	Returns the specified action of a signature field lock as PdfName value.
static PdfNumber	getLockPermission(PdfSigFieldLock.LockPermissions permissions)	Returns the specified level of access permissions granted for the document as PdfNumber 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, 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

Methods inherited from class java.lang.Object

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

Constructor Details

PdfSigFieldLock

             public PdfSigFieldLock()
            

Creates an instance of PdfSigFieldLock.

PdfSigFieldLock

             public PdfSigFieldLock
             (PdfDictionary dict)
            

Creates an instance of PdfSigFieldLock.

Parameters:

dict - the dictionary whose entries should be added to the signature field lock dictionary

Method Details

setDocumentPermissions

             public PdfSigFieldLock setDocumentPermissions
             (PdfSigFieldLock.LockPermissions permissions)
            

Sets the permissions granted for the document when the corresponding signature field is signed. See PdfSigFieldLock.LockPermissions for getting more info.

Parameters:

permissions - the permissions granted for the document

Returns:

this PdfSigFieldLock object.

setFieldLock

             public PdfSigFieldLock setFieldLock
             (PdfSigFieldLock.LockAction action, 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 place

fields - 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 as PdfName value.

Parameters:

action - the action as PdfSigFieldLock.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 as PdfNumber value.

Parameters:

permissions - the level of access permissions as PdfSigFieldLock.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 class PdfObjectWrapper<PdfDictionary>

Returns:

true if in the resultant document the object behind the wrapper must be indirect, otherwise false.