Class SignerProperties


  • public class SignerProperties
    extends java.lang.Object
    Properties to be used in signing operations.
    • Field Detail

      • signDate

        private java.util.Calendar signDate
      • fieldName

        private java.lang.String fieldName
      • pageNumber

        private int pageNumber
      • signatureCreator

        private java.lang.String signatureCreator
      • contact

        private java.lang.String contact
      • reason

        private java.lang.String reason
      • location

        private java.lang.String location
    • Constructor Detail

      • SignerProperties

        public SignerProperties()
        Create instance of SignerProperties.
    • Method Detail

      • getClaimedSignDate

        public java.util.Calendar getClaimedSignDate()
        Gets the signature date.
        Returns:
        calendar set to the signature date
      • setClaimedSignDate

        public SignerProperties setClaimedSignDate​(java.util.Calendar signDate)
        Sets the signature date.
        Parameters:
        signDate - the signature date
        Returns:
        this instance to support fluent interface
      • setCertificationLevel

        public SignerProperties setCertificationLevel​(AccessPermissions accessPermissions)
        Sets the document's certification level.
        Parameters:
        accessPermissions - AccessPermissions enum which specifies which certification level shall be used
        Returns:
        this instance to support fluent interface
      • getFieldName

        public java.lang.String getFieldName()
        Gets the field name.
        Returns:
        the field name
      • getPageNumber

        public int getPageNumber()
        Provides the page number of the signature field which this signature appearance is associated with.
        Returns:
        the page number of the signature field which this signature appearance is associated with
      • setPageNumber

        public SignerProperties setPageNumber​(int pageNumber)
        Sets the page number of the signature field which this signature appearance is associated with.
        Parameters:
        pageNumber - the page number of the signature field which this signature appearance is associated with
        Returns:
        this instance to support fluent interface
      • getPageRect

        public Rectangle getPageRect()
        Provides the rectangle that represent the position and dimension of the signature field in the page.
        Returns:
        the rectangle that represent the position and dimension of the signature field in the page
      • setPageRect

        public SignerProperties setPageRect​(Rectangle pageRect)
        Sets the rectangle that represent the position and dimension of the signature field in the page.
        Parameters:
        pageRect - the rectangle that represents the position and dimension of the signature field in the page
        Returns:
        this instance to support fluent interface
      • getFieldLockDict

        public PdfSigFieldLock getFieldLockDict()
        Getter for the field lock dictionary.
        Returns:
        field lock dictionary
      • setFieldLockDict

        public SignerProperties setFieldLockDict​(PdfSigFieldLock fieldLock)
        Setter for the field lock dictionary.

        Be aware: if a signature is created on an existing signature field, then its /Lock dictionary takes the precedence (if it exists).

        Parameters:
        fieldLock - field lock dictionary
        Returns:
        this instance to support fluent interface
      • getSignatureCreator

        public java.lang.String getSignatureCreator()
        Returns the signature creator.
        Returns:
        the signature creator
      • setSignatureCreator

        public SignerProperties setSignatureCreator​(java.lang.String signatureCreator)
        Sets the name of the application used to create the signature.
        Parameters:
        signatureCreator - A new name of the application signing a document.
        Returns:
        this instance to support fluent interface.
      • getContact

        public java.lang.String getContact()
        Returns the signing contact.
        Returns:
        the signing contact
      • setContact

        public SignerProperties setContact​(java.lang.String contact)
        Sets the signing contact.
        Parameters:
        contact - a new signing contact
        Returns:
        this instance to support fluent interface
      • getReason

        public java.lang.String getReason()
        Returns the signing reason.
        Returns:
        the signing reason
      • setReason

        public SignerProperties setReason​(java.lang.String reason)
        Sets the signing reason.
        Parameters:
        reason - a new signing reason
        Returns:
        this instance to support fluent interface
      • getLocation

        public java.lang.String getLocation()
        Returns the signing location.
        Returns:
        the signing location
      • setLocation

        public SignerProperties setLocation​(java.lang.String location)
        Sets the signing location.
        Parameters:
        location - a new signing location
        Returns:
        this instance to support fluent interface