Class PdfSignatureFormField


  • public class PdfSignatureFormField
    extends PdfFormField
    An AcroForm field containing signature data.
    • Field Detail

      • reuseAppearance

        private boolean reuseAppearance
        Indicates if we need to reuse the existing appearance as a background layer.
      • ignorePageRotation

        private boolean ignorePageRotation
        Indicates if we need to ignore page rotation for the signature field annotation.
      • n0

        private PdfFormXObject n0
        Background level of the signature appearance.
      • n2

        private PdfFormXObject n2
        Signature appearance layer that contains information about the signature.
    • Method Detail

      • setValue

        public PdfSignatureFormField setValue​(PdfObject value)
        Adds the signature to the signature field.
        Parameters:
        value - the signature to be contained in the signature field, or an indirect reference to it
        Returns:
        the edited field
      • getSigFieldLockDictionary

        public PdfSigFieldLock getSigFieldLockDictionary()
        Gets the PdfSigFieldLock, which contains fields that must be locked if the document is signed.
        Returns:
        a dictionary containing locked fields.
        See Also:
        PdfSigFieldLock
      • setSignatureAppearanceLayer

        public PdfSignatureFormField setSignatureAppearanceLayer​(PdfFormXObject n2)
        Sets the signature appearance layer that contains information about the signature, e.g. the line art for the handwritten signature, the text giving the signer’s name, date, reason, location and so on.
        Parameters:
        n2 - layer xObject.
        Returns:
        this same PdfSignatureFormField instance.
      • setReuseAppearance

        public PdfSignatureFormField setReuseAppearance​(boolean reuseAppearance)
        Indicates that the existing appearances needs to be reused as a background.
        Parameters:
        reuseAppearance - is an appearances reusing flag value to set.
        Returns:
        this same PdfSignatureFormField instance.
      • setIgnorePageRotation

        public PdfSignatureFormField setIgnorePageRotation​(boolean ignore)
        Sets the boolean value which indicates if page rotation should be ignored for the signature appearance.

        Default value is true.

        Parameters:
        ignore - boolean value to set.
        Returns:
        this same PdfSignatureFormField instance.
      • getBackgroundLayer

        PdfFormXObject getBackgroundLayer()
        Gets the background layer that is present when creating the signature field if it was set.
        Returns:
        n0 layer xObject.
      • getSignatureAppearanceLayer

        PdfFormXObject getSignatureAppearanceLayer()
        Gets the signature appearance layer that contains information about the signature if it was set.
        Returns:
        n2 layer xObject.
      • isReuseAppearance

        boolean isReuseAppearance()
        Indicates if the existing appearances needs to be reused as a background.
        Returns:
        appearances reusing flag value.
      • isPageRotationIgnored

        boolean isPageRotationIgnored()
        Indicates if page rotation should be ignored for the signature appearance.
        Returns:
        the boolean value which indicates if we need to ignore page rotation for the signature appearance.