Class 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.
  • Constructor Details

    • PdfSigFieldLock

      public PdfSigFieldLock()
      Creates an instance of PdfSigFieldLock.
    • PdfSigFieldLock

      public PdfSigFieldLock (PdfDictionary dict)
      Creates an instance of PdfSigFieldLock.
      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.
      permissions - The permissions granted for the document.
      This PdfSigFieldLock object.
    • setFieldLock

      public PdfSigFieldLock setFieldLock (PdfSigFieldLock.LockAction action, String... fields)
      Sets signature lock for specific fields in the document.
      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.
      This PdfSigFieldLock object.
    • getLockActionValue

      public static PdfName getLockActionValue (PdfSigFieldLock.LockAction action)
    • getLockPermission

      public static PdfNumber getLockPermission (PdfSigFieldLock.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>
      true if in the resultant document the object behind the wrapper must be indirect, otherwise false.