PDVisibleSignDesigner (Apache PDFBox 1.8.13 API)

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

```
public class PDVisibleSignDesigner
extends Object
```
That class is in order to build your visible signature design. Because of this is builder, instead of setParam() we use param() methods.

Author:

vakhtang koroghlishvili (gogebashvili)

Constructor Summary

Constructors
Constructor and Description
`PDVisibleSignDesigner(InputStream originalDocumenStream, InputStream imageStream, int page)`
`PDVisibleSignDesigner(PDDocument doc, InputStream imageStream, int page)`
`PDVisibleSignDesigner(String documentPath, InputStream imageStream, int page)`

Method Summary

Methods
Modifier and Type	Method and Description
`PDVisibleSignDesigner`	`affineTransformParams(byte[] affineTransformParams)`
`PDVisibleSignDesigner`	`coordinates(float x, float y)`
`PDVisibleSignDesigner`	`formaterRectangleParams(byte[] formaterRectangleParams)` sets formatter PDRectangle;
`byte[]`	`getAffineTransformParams()`
`byte[]`	`getFormaterRectangleParams()`
`float`	`getHeight()`
`float`	`getImageSizeInPercents()` get image size in percents
`InputStream`	`getImageStream()`
`float`	`getPageHeight()`
`float`	`getPageWidth()`
`String`	`getSignatureFieldName()`
`String`	`getSignatureText()` returns visible signature text
`protected float`	`getTemplateHeight()`
`float`	`getWidth()`
`float`	`getxAxis()`
`float`	`getyAxis()`
`PDVisibleSignDesigner`	`height(float signatureImgHeight)`
`void`	`imageSizeInPercents(float imageSizeInPercents)`
`PDVisibleSignDesigner`	`pageWidth(float pageWidth)`
`PDVisibleSignDesigner`	`signatureFieldName(String signatureFieldName)`
`PDVisibleSignDesigner`	`signatureImage(String path)`
`PDVisibleSignDesigner`	`signatureText(String signatureText)`
`PDVisibleSignDesigner`	`width(float signatureImgWidth)`
`PDVisibleSignDesigner`	`xAxis(float xAxis)`
`PDVisibleSignDesigner`	`yAxis(float yAxis)`
`PDVisibleSignDesigner`	`zoom(float percent)` zoom signature image with some percent.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - PDVisibleSignDesigner
```
public PDVisibleSignDesigner(InputStream originalDocumenStream,
                     InputStream imageStream,
                     int page)
                      throws IOException
```
    Parameters:
    originalDocumenStream -
    imageStream -
    page - the 1-based page number for which the page size should be calculated.
    
    Throws:
    
    IOException
  - PDVisibleSignDesigner
```
public PDVisibleSignDesigner(String documentPath,
                     InputStream imageStream,
                     int page)
                      throws IOException
```
    Parameters:
    documentPath - - path of your pdf document
    imageStream - - stream of image
    page - the 1-based page number for which the page size should be calculated.
    
    Throws:
    
    IOException
  - PDVisibleSignDesigner
```
public PDVisibleSignDesigner(PDDocument doc,
                     InputStream imageStream,
                     int page)
                      throws IOException
```
    Parameters:
    doc - - Already created PDDocument of your PDF document
    imageStream -
    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
- Method Detail
  - signatureImage
```
public PDVisibleSignDesigner signatureImage(String path)
                                     throws IOException
```
    Parameters:
    path - of image location
    
    Returns:
    image Stream
    
    Throws:
    
    IOException
  - zoom
```
public PDVisibleSignDesigner zoom(float percent)
```
    zoom signature image with some percent.
    
    Parameters:
    percent - the percentage for zooming the image.
    
    Returns:
    Visible Signature Configuration Object
  - coordinates
```
public PDVisibleSignDesigner coordinates(float x,
                                float y)
```
    Parameters:
    x - the x coordinate
    y - the 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 signatureImgWidth)
```
    Parameters:
    signatureImgWidth - the signature image width
    
    Returns:
    Visible Signature Configuration Object
  - getHeight
```
public float getHeight()
```
    Returns:
    signature image height
  - height
```
public PDVisibleSignDesigner height(float signatureImgHeight)
```
    Parameters:
    signatureImgHeight - the 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
  - getImageStream
```
public InputStream getImageStream()
```
    Returns:
    image Stream
  - getAffineTransformParams
```
public byte[] getAffineTransformParams()
```
    Returns:
    Affine Transform parameters of for PDF Matrix
  - affineTransformParams
```
public PDVisibleSignDesigner affineTransformParams(byte[] affineTransformParams)
```
    Parameters:
    affineTransformParams -
    
    Returns:
    Visible Signature Configuration Object
  - getFormaterRectangleParams
```
public byte[] getFormaterRectangleParams()
```
    Returns:
    formatter PDRectanle parameters
  - formaterRectangleParams
```
public PDVisibleSignDesigner formaterRectangleParams(byte[] formaterRectangleParams)
```
    sets formatter PDRectangle;
    
    Parameters:
    formaterRectangleParams -
    
    Returns:
    Visible Signature Configuration Object
  - getPageWidth
```
public float getPageWidth()
```
    Returns:
    page width
  - pageWidth
```
public PDVisibleSignDesigner pageWidth(float pageWidth)
```
    Parameters:
    pageWidth - the pageWidth
    
    Returns:
    Visible Signature Configuration Object
  - getPageHeight
```
public float getPageHeight()
```
    Returns:
    page height
  - getImageSizeInPercents
```
public float getImageSizeInPercents()
```
    get image size in percents
    
    Returns:
    image size in percent.
  - imageSizeInPercents
```
public void imageSizeInPercents(float imageSizeInPercents)
```
    Parameters:
    imageSizeInPercents -
  - getSignatureText
```
public String getSignatureText()
```
    returns visible signature text
    
    Returns:
    visible signature text.
  - signatureText
```
public PDVisibleSignDesigner signatureText(String signatureText)
```
    Parameters:
    signatureText - - adds the text on visible signature
    
    Returns:
    Visible Signature Configuration Object

Class PDVisibleSignDesigner

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

PDVisibleSignDesigner

PDVisibleSignDesigner

PDVisibleSignDesigner

Method Detail

signatureImage

zoom

coordinates

getxAxis

xAxis

getyAxis

yAxis

getWidth

width

getHeight

height

getTemplateHeight

getSignatureFieldName

signatureFieldName

getImageStream

getAffineTransformParams

affineTransformParams

getFormaterRectangleParams

formaterRectangleParams

getPageWidth

pageWidth

getPageHeight

getImageSizeInPercents

imageSizeInPercents

getSignatureText

signatureText