com.itextpdf.forms

Class PdfSigFieldLockDictionary

java.lang.Object

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

com.itextpdf.forms.PdfSigFieldLockDictionary

All Implemented Interfaces:

Serializable

public class PdfSigFieldLockDictionary
extends PdfObjectWrapper<PdfDictionary>

A signature field lock dictionary. Specifies a set of form fields that shall be locked when this signature field is signed.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PdfSigFieldLockDictionary.LockAction Enumerates the different actions of a signature field lock.
static class	PdfSigFieldLockDictionary.LockPermissions Enumerates the different levels of access permissions granted for the document when the corresponding signature field is signed: PdfSigFieldLockDictionary.LockPermissions.NO_CHANGES_ALLOWED - no changes to the document are permitted; any change to the document invalidates the signature, PdfSigFieldLockDictionary.LockPermissions.FORM_FILLING - permitted changes are filling in forms, instantiating page templates, and signing; other changes invalidate the signature, PdfSigFieldLockDictionary.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 and Description
PdfSigFieldLockDictionary() Creates an instance of PdfSigFieldLockDictionary.
PdfSigFieldLockDictionary(PdfDictionary dict) Creates an instance of PdfSigFieldLockDictionary.

Method Summary

Modifier and Type	Method and Description
static PdfName	getLockActionValue(PdfSigFieldLockDictionary.LockAction action)
static PdfNumber	getLockPermission(PdfSigFieldLockDictionary.LockPermissions permissions)
protected boolean	isWrappedObjectMustBeIndirect() Defines if the object behind this wrapper must be an indirect object in the resultant document.
PdfSigFieldLockDictionary	setDocumentPermissions(PdfSigFieldLockDictionary.LockPermissions permissions) Sets the permissions granted for the document when the corresponding signature field is signed.
PdfSigFieldLockDictionary	setFieldLock(PdfSigFieldLockDictionary.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 Detail

PdfSigFieldLockDictionary

public PdfSigFieldLockDictionary()

Creates an instance of PdfSigFieldLockDictionary.

PdfSigFieldLockDictionary

public PdfSigFieldLockDictionary(PdfDictionary dict)

Creates an instance of PdfSigFieldLockDictionary.

Parameters:

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

Method Detail

setDocumentPermissions

public PdfSigFieldLockDictionary setDocumentPermissions(PdfSigFieldLockDictionary.LockPermissions permissions)

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

Parameters:

permissions - The permissions granted for the document.

Returns:

This PdfSigFieldLockDictionary object.

setFieldLock

public PdfSigFieldLockDictionary setFieldLock(PdfSigFieldLockDictionary.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 PdfSigFieldLockDictionary object.

getLockActionValue

public static PdfName getLockActionValue(PdfSigFieldLockDictionary.LockAction action)

getLockPermission

public static PdfNumber getLockPermission(PdfSigFieldLockDictionary.LockPermissions permissions)

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.