java.lang.Object
org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDVisibleSignDesigner

public class PDVisibleSignDesigner extends Object
Class for visible signature design properties. Setters use param() instead of setParam() to allow chaining.
Author:
Vakhtang Koroghlishvili
  • Constructor Details

    • PDVisibleSignDesigner

      public PDVisibleSignDesigner(String filename, InputStream imageStream, int page) throws IOException
      Constructor.
      Parameters:
      filename - Path of the PDF file
      imageStream - image as a stream
      page - The 1-based page number for which the page size should be calculated.
      Throws:
      IOException
    • PDVisibleSignDesigner

      public PDVisibleSignDesigner(InputStream documentStream, InputStream imageStream, int page) throws IOException
      Constructor.
      Parameters:
      documentStream - Original PDF document as stream
      imageStream - Image as a stream
      page - The 1-based page number for which the page size should be calculated.
      Throws:
      IOException
    • PDVisibleSignDesigner

      public PDVisibleSignDesigner(PDDocument document, InputStream imageStream, int page) throws IOException
      Constructor.
      Parameters:
      document - Already created PDDocument of your PDF document.
      imageStream - Image as a stream.
      page - The 1-based page number for which the page size should be calculated.
      Throws:
      IOException - If we can't read, flush, or can't close stream.
    • PDVisibleSignDesigner

      public PDVisibleSignDesigner(String filename, BufferedImage image, int page) throws IOException
      Constructor.
      Parameters:
      filename - Path of the PDF file
      image -
      page - The 1-based page number for which the page size should be calculated.
      Throws:
      IOException
    • PDVisibleSignDesigner

      public PDVisibleSignDesigner(InputStream documentStream, BufferedImage image, int page) throws IOException
      Constructor.
      Parameters:
      documentStream - Original PDF document as stream
      image -
      page - The 1-based page number for which the page size should be calculated.
      Throws:
      IOException
    • PDVisibleSignDesigner

      public PDVisibleSignDesigner(PDDocument document, BufferedImage image, int page)
      Constructor.
      Parameters:
      document - Already created PDDocument of your PDF document.
      image -
      page - The 1-based page number for which the page size should be calculated.
    • PDVisibleSignDesigner

      public PDVisibleSignDesigner(InputStream imageStream) throws IOException
      Constructor usable for signing existing signature fields.
      Parameters:
      imageStream - image as a stream
      Throws:
      IOException
  • Method Details

    • adjustForRotation

      public PDVisibleSignDesigner adjustForRotation()
      Adjust signature for page rotation. This is optional, call this after all x and y coordinates have been set if you want the signature to be positioned regardless of page orientation.
      Returns:
      Visible Signature Configuration Object
    • signatureImage

      public PDVisibleSignDesigner signatureImage(String path) throws IOException
      Set the image for the signature.
      Parameters:
      path - Path of the image file.
      Returns:
      Visible Signature Configuration Object
      Throws:
      IOException
    • zoom

      public PDVisibleSignDesigner zoom(float percent)
      Zoom signature image with some percent.
      Parameters:
      percent - increase (positive value) or decrease (negative value) image with x percent.
      Returns:
      Visible Signature Configuration Object
    • coordinates

      public PDVisibleSignDesigner coordinates(float x, float y)
      Parameters:
      x - - x coordinate
      y - - y coordinate
      Returns:
      Visible Signature Configuration Object
    • getxAxis

      public float getxAxis()
      Returns:
      xAxis - gets x coordinates
    • xAxis

      public PDVisibleSignDesigner xAxis(float xAxis)
      Parameters:
      xAxis - - x coordinate
      Returns:
      Visible Signature Configuration Object
    • getyAxis

      public float getyAxis()
      Returns:
      yAxis
    • yAxis

      public PDVisibleSignDesigner yAxis(float yAxis)
      Parameters:
      yAxis -
      Returns:
      Visible Signature Configuration Object
    • getWidth

      public float getWidth()
      Returns:
      signature image width
    • width

      public PDVisibleSignDesigner width(float width)
      Parameters:
      width - signature image width
      Returns:
      Visible Signature Configuration Object
    • getHeight

      public float getHeight()
      Returns:
      signature image height
    • height

      public PDVisibleSignDesigner height(float height)
      Parameters:
      height - signature image height
      Returns:
      Visible Signature Configuration Object
    • getTemplateHeight

      protected float getTemplateHeight()
      Returns:
      template height
    • getSignatureFieldName

      public String getSignatureFieldName()
      Returns:
      signature field name
    • signatureFieldName

      public PDVisibleSignDesigner signatureFieldName(String signatureFieldName)
      Parameters:
      signatureFieldName -
      Returns:
      Visible Signature Configuration Object
    • getImage

      public BufferedImage getImage()
      Returns:
      image Image
    • getAffineTransformParams

      @Deprecated public byte[] getAffineTransformParams()
      Deprecated.
      Returns:
      Affine Transform parameters for PDF Matrix
    • getTransform

      public AffineTransform getTransform()
      Returns:
      Affine Transform parameters for PDF Matrix
    • affineTransformParams

      @Deprecated public PDVisibleSignDesigner affineTransformParams(byte[] affineTransformParams)
      Parameters:
      affineTransformParams -
      Returns:
      Visible Signature Configuration Object
    • transform

      public PDVisibleSignDesigner transform(AffineTransform affineTransform)
      Parameters:
      affineTransform -
      Returns:
      Visible Signature Configuration Object
    • getFormatterRectangleParams

      @Deprecated public byte[] getFormatterRectangleParams()
      Returns:
      formatter PDRectangle parameters
    • getFormatterRectangleParameters

      public int[] getFormatterRectangleParameters()
      Returns:
      formatter PDRectangle parameters
    • formatterRectangleParams

      @Deprecated public PDVisibleSignDesigner formatterRectangleParams(byte[] formatterRectangleParams)
      Sets formatter PDRectangle
      Parameters:
      formatterRectangleParams -
      Returns:
      Visible Signature Configuration Object
    • formatterRectangleParameters

      public PDVisibleSignDesigner formatterRectangleParameters(int[] formatterRectangleParameters)
      Sets formatter PDRectangle
      Parameters:
      formatterRectangleParameters -
      Returns:
      Visible Signature Configuration Object
    • getPageWidth

      public float getPageWidth()
      Returns:
      page width
    • pageWidth

      public PDVisibleSignDesigner pageWidth(float pageWidth)
      Parameters:
      pageWidth - pageWidth
      Returns:
      Visible Signature Configuration Object
    • getPageHeight

      public float getPageHeight()
      Returns:
      page height
    • getImageSizeInPercents

      public float getImageSizeInPercents()
      get image size in percents
      Returns:
      the image size in percent
    • imageSizeInPercents

      public void imageSizeInPercents(float imageSizeInPercents)
      Parameters:
      imageSizeInPercents -
    • getSignatureText

      public String getSignatureText()
      returns visible signature text
      Returns:
      the visible signature's text
    • signatureText

      public PDVisibleSignDesigner signatureText(String signatureText)
      Parameters:
      signatureText - - adds the text on visible signature
      Returns:
      the signature design