Apache PDFBox 3.0.4 · org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDVisibleSignDesigner

Modifier and Type	Field and Description
private AffineTransform	affineTransform
private int[]	formatterRectangleParameters
private BufferedImage	image
private Float	imageHeight
private float	imageSizeInPercents
private Float	imageWidth
private float	pageHeight
private float	pageWidth
private int	rotation
private String	signatureFieldName
private float	xAxis
private float	yAxis

Constructor Summary

Access	Constructor and Description
public	PDVisibleSignDesigner(String Path of the PDF file filename, InputStream image as a stream imageStream, int The 1-based page number for which the page size should be calculated. page) Constructor.
public	PDVisibleSignDesigner(RandomAccessRead Original PDF document as RandomAccessRead documentSource, InputStream Image as a stream imageStream, int The 1-based page number for which the page size should be calculated. page) Constructor.
public	PDVisibleSignDesigner(PDDocument Already created PDDocument of your PDF document. document, InputStream Image as a stream. imageStream, int The 1-based page number for which the page size should be calculated. page) Constructor.
public	PDVisibleSignDesigner(String Path of the PDF file filename, BufferedImage the image to be used for the visible signature image, int The 1-based page number for which the page size should be calculated. page) Constructor.
public	PDVisibleSignDesigner(RandomAccessRead Original PDF document as RandomAccessRead documentSource, BufferedImage the image to be used for the visible signature image, int The 1-based page number for which the page size should be calculated. page) Constructor.
public	PDVisibleSignDesigner(PDDocument Already created PDDocument of your PDF document. document, BufferedImage the image to be used for the visible signature image, int The 1-based page number for which the page size should be calculated. page) Constructor.
public	PDVisibleSignDesigner(InputStream image as a stream imageStream) Constructor usable for signing existing signature fields.

Method Summary

Modifier and Type	Method and Description
public PDVisibleSignDesigner	Returns: Visible Signature Configuration Object adjustForRotation() Adjust signature for page rotation.
private void	calculatePageSize(PDDocument document, int The 1-based page number for which the page size should be calculated. page) Each page of document can be different sizes.
private void	calculatePageSizeFromFile(String filename, int page)
private void	calculatePageSizeFromRandomAccessRead(RandomAccessRead documentSource, int page)
public PDVisibleSignDesigner	Returns: Visible Signature Configuration Object coordinates(float - x coordinate x, float - y coordinate y)
public PDVisibleSignDesigner	Returns: Visible Signature Configuration Object formatterRectangleParameters(int[] rectangle parameter of the formatter formatterRectangleParameters) Sets formatter PDRectangle
public int[]	Returns: formatter PDRectangle parameters getFormatterRectangleParameters()
public float	Returns: signature image height getHeight()
public BufferedImage	Returns: image Image getImage()
public float	Returns: the image size in percent getImageSizeInPercents() get image size in percents
public float	Returns: page height getPageHeight()
public float	Returns: page width getPageWidth()
public String	Returns: signature field name getSignatureFieldName()
public String	Returns: the visible signature's text getSignatureText() returns visible signature text
protected float	Returns: template height getTemplateHeight()
public AffineTransform	Returns: Affine Transform parameters for PDF Matrix getTransform()
public float	Returns: signature image width getWidth()
public float	Returns: xAxis - gets x coordinates getxAxis()
public float	Returns: yAxis getyAxis()
public PDVisibleSignDesigner	Returns: Visible Signature Configuration Object height(float signature image height height)
public void	imageSizeInPercents(float image size in percents imageSizeInPercents)
private PDVisibleSignDesigner	Returns: Visible Signature Configuration Object pageHeight(float templateHeight)
public PDVisibleSignDesigner	Returns: Visible Signature Configuration Object pageWidth(float pageWidth pageWidth)
private void	readImageStream(InputStream stream of your visible signature image stream) Read the image stream of the signature and set height and width.
private void	setImage(BufferedImage image) Set image and its height and width.
public PDVisibleSignDesigner	Returns: Visible Signature Configuration Object signatureFieldName(String the name of the signature field signatureFieldName)
public PDVisibleSignDesigner	Returns: Visible Signature Configuration Object signatureImage(String Path of the image file. path) Set the image for the signature.
public PDVisibleSignDesigner	Returns: the signature design signatureText(String - adds the text on visible signature signatureText)
public PDVisibleSignDesigner	Returns: Visible Signature Configuration Object transform(AffineTransform the affine transformation affineTransform)
public PDVisibleSignDesigner	Returns: Visible Signature Configuration Object width(float signature image width width)
public PDVisibleSignDesigner	Returns: Visible Signature Configuration Object xAxis(float - x coordinate xAxis)
public PDVisibleSignDesigner	Returns: Visible Signature Configuration Object yAxis(float y coordinate yAxis)
public PDVisibleSignDesigner	Returns: Visible Signature Configuration Object zoom(float increase (positive value) or decrease (negative value) image with x percent. percent) Zoom signature image with some percent.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

affineTransform	back to summary
private AffineTransform affineTransform

formatterRectangleParameters	back to summary
private int[] formatterRectangleParameters

image	back to summary
private BufferedImage image

imageHeight	back to summary
private Float imageHeight

imageSizeInPercents	back to summary
private float imageSizeInPercents

imageWidth	back to summary
private Float imageWidth

pageHeight	back to summary
private float pageHeight

pageWidth	back to summary
private float pageWidth

rotation	back to summary
private int rotation

signatureFieldName	back to summary
private String signatureFieldName

xAxis	back to summary
private float xAxis

yAxis	back to summary
private float yAxis

Constructor Detail

PDVisibleSignDesigner	back to summary
public PDVisibleSignDesigner(String filename, InputStream imageStream, int page) throws IOException Constructor. Parameters filename:String Path of the PDF file imageStream:InputStream image as a stream page:int The 1-based page number for which the page size should be calculated. Exceptions IOException: if the new instance of PDVisibleSignDesigner could not be created

PDVisibleSignDesigner

back to summary

public PDVisibleSignDesigner(String filename, InputStream imageStream, int page) throws IOException

Constructor.

Parameters

filename:String: Path of the PDF file
imageStream:InputStream: image as a stream
page:int: The 1-based page number for which the page size should be calculated.

Exceptions

IOException:: if the new instance of PDVisibleSignDesigner could not be created

PDVisibleSignDesigner	back to summary
public PDVisibleSignDesigner(RandomAccessRead documentSource, InputStream imageStream, int page) throws IOException Constructor. Parameters documentSource:RandomAccessRead Original PDF document as RandomAccessRead imageStream:InputStream Image as a stream page:int The 1-based page number for which the page size should be calculated. Exceptions IOException: if the new instance of PDVisibleSignDesigner could not be created

PDVisibleSignDesigner

back to summary

public PDVisibleSignDesigner(RandomAccessRead documentSource, InputStream imageStream, int page) throws IOException

Constructor.

Parameters

documentSource:RandomAccessRead: Original PDF document as RandomAccessRead
imageStream:InputStream: Image as a stream
page:int: The 1-based page number for which the page size should be calculated.

Exceptions

IOException:: if the new instance of PDVisibleSignDesigner could not be created

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

PDVisibleSignDesigner

back to summary

public PDVisibleSignDesigner(PDDocument document, InputStream imageStream, int page) throws IOException

Constructor.

Parameters

document:PDDocument: Already created PDDocument of your PDF document.
imageStream:InputStream: Image as a stream.
page:int: The 1-based page number for which the page size should be calculated.

Exceptions

IOException:: If we can't read, flush, or can't close stream.

PDVisibleSignDesigner	back to summary
public PDVisibleSignDesigner(String filename, BufferedImage image, int page) throws IOException Constructor. Parameters filename:String Path of the PDF file image:BufferedImage the image to be used for the visible signature page:int The 1-based page number for which the page size should be calculated. Exceptions IOException: if the new instance of PDVisibleSignDesigner could not be created

PDVisibleSignDesigner

back to summary

public PDVisibleSignDesigner(String filename, BufferedImage image, int page) throws IOException

Constructor.

Parameters

filename:String: Path of the PDF file
image:BufferedImage: the image to be used for the visible signature
page:int: The 1-based page number for which the page size should be calculated.

Exceptions

IOException:: if the new instance of PDVisibleSignDesigner could not be created

PDVisibleSignDesigner	back to summary
public PDVisibleSignDesigner(RandomAccessRead documentSource, BufferedImage image, int page) throws IOException Constructor. Parameters documentSource:RandomAccessRead Original PDF document as RandomAccessRead image:BufferedImage the image to be used for the visible signature page:int The 1-based page number for which the page size should be calculated. Exceptions IOException: if the new instance of PDVisibleSignDesigner could not be created

PDVisibleSignDesigner

back to summary

public PDVisibleSignDesigner(RandomAccessRead documentSource, BufferedImage image, int page) throws IOException

Constructor.

Parameters

documentSource:RandomAccessRead: Original PDF document as RandomAccessRead
image:BufferedImage: the image to be used for the visible signature
page:int: The 1-based page number for which the page size should be calculated.

Exceptions

IOException:: if the new instance of PDVisibleSignDesigner could not be created

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

PDVisibleSignDesigner

back to summary

public PDVisibleSignDesigner(PDDocument document, BufferedImage image, int page)

Constructor.

Parameters

document:PDDocument: Already created PDDocument of your PDF document.
image:BufferedImage: the image to be used for the visible signature
page:int: The 1-based page number for which the page size should be calculated.

PDVisibleSignDesigner	back to summary
public PDVisibleSignDesigner(InputStream imageStream) throws IOException Constructor usable for signing existing signature fields. Parameters imageStream:InputStream image as a stream Exceptions IOException: if the new instance of PDVisibleSignDesigner could not be created

PDVisibleSignDesigner

back to summary

public PDVisibleSignDesigner(InputStream imageStream) throws IOException

Constructor usable for signing existing signature fields.

Parameters

imageStream:InputStream: image as a stream

Exceptions

IOException:: if the new instance of PDVisibleSignDesigner could not be created

Method Detail

adjustForRotation	back to summary
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:PDVisibleSignDesigner Visible Signature Configuration Object

adjustForRotation

back to summary

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:PDVisibleSignDesigner: Visible Signature Configuration Object

calculatePageSize	back to summary
private void calculatePageSize(PDDocument document, int page) Each page of document can be different sizes. This method calculates the page size based on the page media box. Parameters page:int The 1-based page number for which the page size should be calculated. Exceptions IllegalArgumentException: if the page argument is lower than 0.

calculatePageSize

back to summary

private void calculatePageSize(PDDocument document, int page)

Each page of document can be different sizes. This method calculates the page size based on the page media box.

Parameters

page:int: The 1-based page number for which the page size should be calculated.

Exceptions

IllegalArgumentException:: if the page argument is lower than 0.

calculatePageSizeFromFile	back to summary
private void calculatePageSizeFromFile(String filename, int page) throws IOException

calculatePageSizeFromRandomAccessRead	back to summary
private void calculatePageSizeFromRandomAccessRead(RandomAccessRead documentSource, int page) throws IOException

coordinates	back to summary
public PDVisibleSignDesigner coordinates(float x, float y) Parameters x:float - x coordinate y:float - y coordinate Returns:PDVisibleSignDesigner Visible Signature Configuration Object

formatterRectangleParameters	back to summary
public PDVisibleSignDesigner formatterRectangleParameters(int[] formatterRectangleParameters) Sets formatter PDRectangle Parameters formatterRectangleParameters:int[] rectangle parameter of the formatter Returns:PDVisibleSignDesigner Visible Signature Configuration Object

formatterRectangleParameters

back to summary

public PDVisibleSignDesigner formatterRectangleParameters(int[] formatterRectangleParameters)

Sets formatter PDRectangle

Parameters

formatterRectangleParameters:int[]: rectangle parameter of the formatter

Returns:PDVisibleSignDesigner

Visible Signature Configuration Object

getFormatterRectangleParameters	back to summary
public int[] getFormatterRectangleParameters() Returns:int[] formatter PDRectangle parameters

getHeight	back to summary
public float getHeight() Returns:float signature image height

getImage	back to summary
public BufferedImage getImage() Returns:BufferedImage image Image

getImageSizeInPercents	back to summary
public float getImageSizeInPercents() get image size in percents Returns:float the image size in percent

getImageSizeInPercents

back to summary

public float getImageSizeInPercents()

get image size in percents

Returns:float: the image size in percent

getPageHeight	back to summary
public float getPageHeight() Returns:float page height

getPageWidth	back to summary
public float getPageWidth() Returns:float page width

getSignatureFieldName	back to summary
public String getSignatureFieldName() Returns:String signature field name

getSignatureText	back to summary
public String getSignatureText() returns visible signature text Returns:String the visible signature's text

getSignatureText

back to summary

public String getSignatureText()

returns visible signature text

Returns:String: the visible signature's text

getTemplateHeight	back to summary
protected float getTemplateHeight() Returns:float template height

getTransform	back to summary
public AffineTransform getTransform() Returns:AffineTransform Affine Transform parameters for PDF Matrix

getWidth	back to summary
public float getWidth() Returns:float signature image width

getxAxis	back to summary
public float getxAxis() Returns:float xAxis - gets x coordinates

getyAxis	back to summary
public float getyAxis() Returns:float yAxis

height	back to summary
public PDVisibleSignDesigner height(float height) Parameters height:float signature image height Returns:PDVisibleSignDesigner Visible Signature Configuration Object

imageSizeInPercents	back to summary
public void imageSizeInPercents(float imageSizeInPercents) Parameters imageSizeInPercents:float image size in percents

pageHeight	back to summary
private PDVisibleSignDesigner pageHeight(float templateHeight) Returns:PDVisibleSignDesigner Visible Signature Configuration Object

pageWidth	back to summary
public PDVisibleSignDesigner pageWidth(float pageWidth) Parameters pageWidth:float pageWidth Returns:PDVisibleSignDesigner Visible Signature Configuration Object

readImageStream	back to summary
private void readImageStream(InputStream stream) throws IOException Read the image stream of the signature and set height and width. Parameters stream:InputStream stream of your visible signature image Exceptions IOException: If we can't read, flush, or close stream of image

readImageStream

back to summary

private void readImageStream(InputStream stream) throws IOException

Read the image stream of the signature and set height and width.

Parameters

stream:InputStream: stream of your visible signature image

Exceptions

IOException:: If we can't read, flush, or close stream of image

setImage	back to summary
private void setImage(BufferedImage image) Set image and its height and width.

signatureFieldName	back to summary
public PDVisibleSignDesigner signatureFieldName(String signatureFieldName) Parameters signatureFieldName:String the name of the signature field Returns:PDVisibleSignDesigner Visible Signature Configuration Object

signatureImage	back to summary
public PDVisibleSignDesigner signatureImage(String path) throws IOException Set the image for the signature. Parameters path:String Path of the image file. Returns:PDVisibleSignDesigner Visible Signature Configuration Object Exceptions IOException: if the image for the signature could not be set

signatureImage

back to summary

public PDVisibleSignDesigner signatureImage(String path) throws IOException

Set the image for the signature.

Parameters

path:String: Path of the image file.

Returns:PDVisibleSignDesigner

Visible Signature Configuration Object

Exceptions

IOException:: if the image for the signature could not be set

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

transform	back to summary
public PDVisibleSignDesigner transform(AffineTransform affineTransform) Parameters affineTransform:AffineTransform the affine transformation Returns:PDVisibleSignDesigner Visible Signature Configuration Object

width	back to summary
public PDVisibleSignDesigner width(float width) Parameters width:float signature image width Returns:PDVisibleSignDesigner Visible Signature Configuration Object

xAxis	back to summary
public PDVisibleSignDesigner xAxis(float xAxis) Parameters xAxis:float - x coordinate Returns:PDVisibleSignDesigner Visible Signature Configuration Object

yAxis	back to summary
public PDVisibleSignDesigner yAxis(float yAxis) Parameters yAxis:float y coordinate Returns:PDVisibleSignDesigner Visible Signature Configuration Object

zoom

back to summary

public PDVisibleSignDesigner zoom(float percent)

Zoom signature image with some percent.

Parameters

percent:float: increase (positive value) or decrease (negative value) image with x percent.

Returns:PDVisibleSignDesigner

Visible Signature Configuration Object

public Class PDVisibleSignDesigner

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail