Class PDVisibleSignDesigner
- java.lang.Object
-
- org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDVisibleSignDesigner
-
public class PDVisibleSignDesigner extends java.lang.Object
That class is in order to build your visible signature design. Because of this is builder, instead of setParam() we use param() methods.
-
-
Constructor Summary
Constructors Constructor Description PDVisibleSignDesigner(java.io.InputStream originalDocumenStream, java.io.InputStream imageStream, int page)
PDVisibleSignDesigner(java.lang.String documentPath, java.io.InputStream imageStream, int page)
PDVisibleSignDesigner(PDDocument doc, java.io.InputStream imageStream, int page)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method 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 percentsjava.io.InputStream
getImageStream()
float
getPageHeight()
float
getPageWidth()
java.lang.String
getSignatureFieldName()
java.lang.String
getSignatureText()
returns visible signature textprotected float
getTemplateHeight()
float
getWidth()
float
getxAxis()
float
getyAxis()
PDVisibleSignDesigner
height(float signatureImgHeight)
void
imageSizeInPercents(float imageSizeInPercents)
PDVisibleSignDesigner
pageWidth(float pageWidth)
PDVisibleSignDesigner
signatureFieldName(java.lang.String signatureFieldName)
PDVisibleSignDesigner
signatureImage(java.lang.String path)
PDVisibleSignDesigner
signatureText(java.lang.String signatureText)
PDVisibleSignDesigner
width(float signatureImgWidth)
PDVisibleSignDesigner
xAxis(float xAxis)
PDVisibleSignDesigner
yAxis(float yAxis)
PDVisibleSignDesigner
zoom(float percent)
zoom signature image with some percent.
-
-
-
Constructor Detail
-
PDVisibleSignDesigner
public PDVisibleSignDesigner(java.io.InputStream originalDocumenStream, java.io.InputStream imageStream, int page) throws java.io.IOException
- Parameters:
originalDocumenStream
-imageStream
- stream of JPEG imagepage
- the 1-based page number for which the page size should be calculated.- Throws:
java.io.IOException
-
PDVisibleSignDesigner
public PDVisibleSignDesigner(java.lang.String documentPath, java.io.InputStream imageStream, int page) throws java.io.IOException
- Parameters:
documentPath
- path of your pdf documentimageStream
- stream of JPEG imagepage
- the 1-based page number for which the page size should be calculated.- Throws:
java.io.IOException
-
PDVisibleSignDesigner
public PDVisibleSignDesigner(PDDocument doc, java.io.InputStream imageStream, int page) throws java.io.IOException
- Parameters:
doc
- Already created PDDocument of your PDF documentimageStream
- stream of JPEG imagepage
- the 1-based page number for which the page size should be calculated.- Throws:
java.io.IOException
- If we can't read, flush, or can't close stream
-
-
Method Detail
-
signatureImage
public PDVisibleSignDesigner signatureImage(java.lang.String path) throws java.io.IOException
- Parameters:
path
- JPEG image location- Returns:
- Visible signature configuration object
- Throws:
java.io.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 coordinatey
- 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 java.lang.String getSignatureFieldName()
- Returns:
- signature field name
-
signatureFieldName
public PDVisibleSignDesigner signatureFieldName(java.lang.String signatureFieldName)
- Parameters:
signatureFieldName
-- Returns:
- Visible Signature Configuration Object
-
getImageStream
public java.io.InputStream getImageStream()
- Returns:
- JPEG 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 java.lang.String getSignatureText()
returns visible signature text- Returns:
- visible signature text.
-
signatureText
public PDVisibleSignDesigner signatureText(java.lang.String signatureText)
- Parameters:
signatureText
- - adds the text on visible signature- Returns:
- Visible Signature Configuration Object
-
-