com.so.net

Class SignApi.Pdf

java.lang.Object

com.so.net.SignApi.Pdf

Enclosing class:

SignApi

public static final class SignApi.Pdf
extends Object

Has PDF-related functions.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SignApi.Pdf.ButtonField Represents a button field.
static class	SignApi.Pdf.CheckBox Represents a check box field.
static class	SignApi.Pdf.Choice Represents a choice field.
static class	SignApi.Pdf.ChoiceField Represents a choice field (field type Ch).
static class	SignApi.Pdf.ComboBox Represents a combo box.
static class	SignApi.Pdf.Field PDF documents may have AcroForm fields.
static class	SignApi.Pdf.FieldName Fields have names.
static class	SignApi.Pdf.FieldPosition Fields may have a position.
static class	SignApi.Pdf.Font Various fonts.
static class	SignApi.Pdf.ListBox Represents a list box.
static class	SignApi.Pdf.PushButton Represents a pushbutton.
static class	SignApi.Pdf.RadioButton Represents a radio button field.
static class	SignApi.Pdf.SignatureField Signature fields may be signed.
static class	SignApi.Pdf.SignatureInfo A signature field may have various signer related information.
static class	SignApi.Pdf.TextAppearance Text has an appearance.
static class	SignApi.Pdf.TextField Text fields may be edited.

Method Summary

Modifier and Type	Method and Description
static boolean	addSignatureField(SignApi.Pdf.FieldName fieldName, SignApi.Pdf.FieldPosition fieldPosition) Adds a signutare field.
static byte[]	downloadPdf() Downloads the document.
static boolean	drawImage(SignApi.Pdf.FieldPosition fieldPosition, BufferedImage image) Draws an image.
static List<SignApi.Pdf.FieldPosition>	findText(String text) Searches the document for the given text.
static List<SignApi.Pdf.Field>	getAcroFormFields() Gets the AcroForm fields.
static Optional<Integer>	getNumberOfPages() Gets the number of pages.
static List<SignApi.Pdf.FieldPosition>	getPageDimensions() Gets the page dimensions.
static boolean	loadPdf(byte[] document) Loads a PDF document.
static Optional<BufferedImage>	renderPage(int page) Renders a document page.
static Optional<BufferedImage>	renderPage(int page, int dpi) Renders a document page.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

addSignatureField

public static boolean addSignatureField(SignApi.Pdf.FieldName fieldName,
                                        SignApi.Pdf.FieldPosition fieldPosition)

Adds a signutare field.

Parameters:

fieldName - The name.

fieldPosition - The position.

Returns:

True in case of success.

getAcroFormFields

public static List<SignApi.Pdf.Field> getAcroFormFields()

Gets the AcroForm fields.

Returns:

An empty list in case of error.

getNumberOfPages

public static Optional<Integer> getNumberOfPages()

Gets the number of pages.

Returns:

Some number in case of success.

loadPdf

public static boolean loadPdf(byte[] document)

Loads a PDF document.

Parameters:

document - The document.

Returns:

True in case of success.

downloadPdf

public static byte[] downloadPdf()

Downloads the document.

Returns:

An empty array in case of error.

findText

public static List<SignApi.Pdf.FieldPosition> findText(String text)

Searches the document for the given text. If found, it yields its position.

Parameters:

text - The text to find.

Returns:

An empty list in case of absence or error.

drawImage

public static boolean drawImage(SignApi.Pdf.FieldPosition fieldPosition,
                                BufferedImage image)

Draws an image. Consider calling getPageDimensions() beforehand.

Parameters:

fieldPosition - The position to draw to.

image - The image to draw.

Returns:

True in case of success.

renderPage

public static Optional<BufferedImage> renderPage(int page)

Renders a document page. Consider using getNumberOfPages() beforehand.

Parameters:

page - The page number.

Returns:

Some image in case of success.

renderPage

public static Optional<BufferedImage> renderPage(int page,
                                                 int dpi)

Renders a document page. Consider using getNumberOfPages() beforehand.

Parameters:

page - The page number

dpi - The desired resolution in dots per inch.

Returns:

Some image in case of success.

getPageDimensions

public static List<SignApi.Pdf.FieldPosition> getPageDimensions()

Gets the page dimensions.

Returns:

An empty list in case of absence or error.