Top Description Fields Constructors Methods
org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible

public Class PDVisibleSigBuilder

extends Object
implements PDFTemplateBuilder
Class Inheritance
All Implemented Interfaces
org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDFTemplateBuilder
Imports
java.awt.geom.AffineTransform, java.awt.image.BufferedImage, java.io.IOException, .OutputStream, java.nio.charset.StandardCharsets, java.util.List, org.apache.commons.logging.Log, .LogFactory, org.apache.pdfbox.cos.COSArray, .COSDictionary, .COSName, org.apache.pdfbox.pdmodel.PDDocument, .PDPage, .PDResources, org.apache.pdfbox.pdmodel.common.PDRectangle, .PDStream, org.apache.pdfbox.pdmodel.graphics.form.PDFormXObject, org.apache.pdfbox.pdmodel.graphics.image.LosslessFactory, .PDImageXObject, org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationWidget, .PDAppearanceDictionary, .PDAppearanceStream, org.apache.pdfbox.pdmodel.interactive.digitalsignature.PDSignature, org.apache.pdfbox.pdmodel.interactive.form.PDAcroForm, .PDField, .PDSignatureField
Implementation of PDFTemplateBuilder. This builds the signature PDF but doesn't keep the elements, these are kept in its PDF template structure.
Author
Vakhtang Koroghlishvili

Field Summary

Modifier and TypeField and Description
private static final Log
LOG

private final PDFTemplateStructure
pdfStructure

Constructor Summary

AccessConstructor and Description
public
PDVisibleSigBuilder()

Constructor, creates PDF template structure.

Method Summary

Modifier and TypeMethod and Description
public void
appendRawCommands(OutputStream os, String commands)

public void
closeTemplate(PDDocument
the document to be closed
template)

Implements org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDFTemplateBuilder.closeTemplate.

Closes template

public void
createAcroForm(PDDocument
the document the acroform is added to
template)

Implements org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDFTemplateBuilder.createAcroForm.

Creates Acro forms in the template.

public void
createAcroFormDictionary(PDAcroForm
the acroform the signature field is added to
acroForm, PDSignatureField
the signature filed to be added
signatureField)

Implements org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDFTemplateBuilder.createAcroFormDictionary.

Create AcroForm Dictionary.

public void
createAffineTransform(AffineTransform
the affine transformation to be used
affineTransform)

Implements org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDFTemplateBuilder.createAffineTransform.

In order to create Affine Transform, using parameters.

public void
createAppearanceDictionary(PDFormXObject
form object to be used for the appearance stream
holderForml, PDSignatureField
the signature field the appearance stream is added to
signatureField)

Implements org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDFTemplateBuilder.createAppearanceDictionary.

Creates appearance dictionary

public void
createBackgroundLayerForm(PDResources
resources to be used for the form object
innerFormResource, PDRectangle
the bounding box of the form object
bbox)

Implements org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDFTemplateBuilder.createBackgroundLayerForm.

Creates the background layer form (n0).

public void
createFormatterRectangle(int[]
the parameters of the formatter rectangle
params)

Implements org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDFTemplateBuilder.createFormatterRectangle.

An array of four numbers in the form coordinate system, giving the coordinates of the left, bottom, right, and top edges, respectively, of the form XObject’s bounding box.

public void
createHolderForm(PDResources
resources to be used for the form object
holderFormResources, PDStream
the stream to be used for the form object
holderFormStream, PDRectangle
the bounding box of the form object
bbox)

Implements org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDFTemplateBuilder.createHolderForm.

Creates Form

public void
createHolderFormResources()

Implements org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDFTemplateBuilder.createHolderFormResources.

Creates resources of form

public void
createHolderFormStream(PDDocument
the document to be used to create the new stream
template)

Implements org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDFTemplateBuilder.createHolderFormStream.

Create a holder for the form stream.

public void
createImageForm(PDResources
the resources of the form object
imageFormResources, PDResources
the resources the image object is added
innerFormResource, PDStream
the stream of the form object
imageFormStream, PDRectangle
the bounding box of the form object
bbox, AffineTransform
the matrix of the form object
at, PDImageXObject
the image object to be used for the form object
img)

Implements org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDFTemplateBuilder.createImageForm.

Creates Image form

public void
createImageFormResources()

Implements org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDFTemplateBuilder.createImageFormResources.

Create resource of image form

public void
createImageFormStream(PDDocument
the document to be used to create the new stream
template)

Implements org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDFTemplateBuilder.createImageFormStream.

Create image form stream.

public void
createInnerForm(PDResources
resources to be used for the inner form object
innerFormResources, PDStream
the stream to be used for the inner form object
innerFormStream, PDRectangle
the bounding box of the inner form object
bbox)

Implements org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDFTemplateBuilder.createInnerForm.

Creates InnerForm.

public void
createInnerFormResource()

Implements org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDFTemplateBuilder.createInnerFormResource.

Creates InnerForm

public void
createInnerFormStream(PDDocument
the document to be used to create the new stream
template)

Implements org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDFTemplateBuilder.createInnerFormStream.

Create a holder for the inner form stream.

public void
createPage(PDVisibleSignDesigner
page properties
properties)

Implements org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDFTemplateBuilder.createPage.

Creates specified size page.

public void
createProcSetArray()

Implements org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDFTemplateBuilder.createProcSetArray.

Creates procSetArray of PDF,Text,ImageB,ImageC,ImageI.

public void
createSignature(PDSignatureField
the signature filed the signatur is added to
pdSignatureField, PDPage
the page the widgt ist added to
page, String
the name of the person or authority signing the document. According to the PDF specification, this value should be used only when it is not possible to extract the name from the signature.
signerName)

Implements org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDFTemplateBuilder.createSignature.

Creates the signature with the given name and assign it to the signature field parameter and assign the page parameter to the widget.

public void
createSignatureField(PDAcroForm
the acroform the signature is added to
acroForm)

Implements org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDFTemplateBuilder.createSignatureField.

Creates signature fields.

public void
createSignatureImage(PDDocument
the document the image is added to
template, BufferedImage
to imager to be added
image)

Implements org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDFTemplateBuilder.createSignatureImage.

Creates signature image.

public void
createSignatureRectangle(PDSignatureField
the signature field the rectangle is added to
signatureField, PDVisibleSignDesigner
the properties used to create the rectangle
properties)

Implements org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDFTemplateBuilder.createSignatureRectangle.

Creates SignatureRectangle.

public void
createTemplate(PDPage
the page to be added
page)

Implements org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDFTemplateBuilder.createTemplate.

Creates a PDDocument and adds the page parameter to it and keeps this as a template in the PDF template Structure.

public void
createVisualSignature(PDDocument
the document holding the visible signatue
template)

Implements org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDFTemplateBuilder.createVisualSignature.

just to create visible signature

public void
createWidgetDictionary(PDSignatureField
the field to be used as widget dictionary
signatureField, PDResources
the resources to be added to the widget dictionary
holderFormResources)

Implements org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDFTemplateBuilder.createWidgetDictionary.

adds Widget Dictionary

public PDFTemplateStructure
getStructure()

Implements org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDFTemplateBuilder.getStructure.

Resturns the PDF template Structure

public void
injectAppearanceStreams(PDStream
the holder form stream
holderFormStream, PDStream
the inner form stream
innerFormStream, PDStream
the image form stream
imageFormStream, COSName
the name of the form image to be used
imageFormName, COSName
the name of the image to be used
imageName, COSName
the name of the form object to be used
innerFormName, PDVisibleSignDesigner
properties to be used to create the appearance stream
properties)

Implements org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDFTemplateBuilder.injectAppearanceStreams.

injects appearance streams

public void
injectProcSetArray(PDFormXObject
form object the given proc set array is added to
innerForm, PDPage
page the given proc set array is added to
page, PDResources
inner form resources the given proc set array is added to
innerFormResources, PDResources
inner image resources the given proc set array is added to
imageFormResources, PDResources
holder form resources the given proc set array is added to
holderFormResources, COSArray
the pro set array to be added
procSet)

Implements org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDFTemplateBuilder.injectProcSetArray.

Inject procSetArray

public void
insertInnerFormToHolderResources(PDFormXObject
the form object to be inserted
innerForm, PDResources
resources the fomr object is added to
holderFormResources)

Implements org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDFTemplateBuilder.insertInnerFormToHolderResources.

Insert given from as inner form.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

LOGback to summary
private static final Log LOG
pdfStructureback to summary
private final PDFTemplateStructure pdfStructure

Constructor Detail

PDVisibleSigBuilderback to summary
public PDVisibleSigBuilder()

Constructor, creates PDF template structure.

Method Detail

appendRawCommandsback to summary
public void appendRawCommands(OutputStream os, String commands) throws IOException
closeTemplateback to summary
public void closeTemplate(PDDocument template) throws IOException

Implements org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDFTemplateBuilder.closeTemplate.

Doc from org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDFTemplateBuilder.closeTemplate.

Closes template

Parameters
template:PDDocument

the document to be closed

Annotations
@Override
Exceptions
IOException:
if the document could not be closed
createAcroFormback to summary
public void createAcroForm(PDDocument template)

Implements org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDFTemplateBuilder.createAcroForm.

Doc from org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDFTemplateBuilder.createAcroForm.

Creates Acro forms in the template.

Parameters
template:PDDocument

the document the acroform is added to

Annotations
@Override
createAcroFormDictionaryback to summary
public void createAcroFormDictionary(PDAcroForm acroForm, PDSignatureField signatureField) throws IOException

Implements org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDFTemplateBuilder.createAcroFormDictionary.

Doc from org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDFTemplateBuilder.createAcroFormDictionary.

Create AcroForm Dictionary.

Parameters
acroForm:PDAcroForm

the acroform the signature field is added to

signatureField:PDSignatureField

the signature filed to be added

Annotations
@Override
Exceptions
IOException:
if the signature field could not be added
createAffineTransformback to summary
public void createAffineTransform(AffineTransform affineTransform)

Implements org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDFTemplateBuilder.createAffineTransform.

Doc from org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDFTemplateBuilder.createAffineTransform.

In order to create Affine Transform, using parameters.

Parameters
affineTransform:AffineTransform

the affine transformation to be used

Annotations
@Override
createAppearanceDictionaryback to summary
public void createAppearanceDictionary(PDFormXObject holderForml, PDSignatureField signatureField) throws IOException

Implements org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDFTemplateBuilder.createAppearanceDictionary.

Doc from org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDFTemplateBuilder.createAppearanceDictionary.

Creates appearance dictionary

Parameters
holderForml:PDFormXObject

form object to be used for the appearance stream

signatureField:PDSignatureField

the signature field the appearance stream is added to

Annotations
@Override
Exceptions
IOException:
if the appearance stream could not be created
createBackgroundLayerFormback to summary
public void createBackgroundLayerForm(PDResources innerFormResource, PDRectangle bbox) throws IOException

Implements org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDFTemplateBuilder.createBackgroundLayerForm.

Doc from org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDFTemplateBuilder.createBackgroundLayerForm.

Creates the background layer form (n0).

Parameters
innerFormResource:PDResources

resources to be used for the form object

bbox:PDRectangle

the bounding box of the form object

Annotations
@Override
Exceptions
IOException:
if the form object could not be created
createFormatterRectangleback to summary
public void createFormatterRectangle(int[] params)

Implements org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDFTemplateBuilder.createFormatterRectangle.

Doc from org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDFTemplateBuilder.createFormatterRectangle.

An array of four numbers in the form coordinate system, giving the coordinates of the left, bottom, right, and top edges, respectively, of the form XObject’s bounding box. These boundaries shall be used to clip the form XObject and to determine its size for caching.

Parameters
params:int[]

the parameters of the formatter rectangle

Annotations
@Override
createHolderFormback to summary
public void createHolderForm(PDResources holderFormResources, PDStream holderFormStream, PDRectangle bbox)

Implements org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDFTemplateBuilder.createHolderForm.

Doc from org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDFTemplateBuilder.createHolderForm.

Creates Form

Parameters
holderFormResources:PDResources

resources to be used for the form object

holderFormStream:PDStream

the stream to be used for the form object

bbox:PDRectangle

the bounding box of the form object

Annotations
@Override
createHolderFormResourcesback to summary
public void createHolderFormResources()

Implements org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDFTemplateBuilder.createHolderFormResources.

Doc from org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDFTemplateBuilder.createHolderFormResources.

Creates resources of form

Annotations
@Override
createHolderFormStreamback to summary
public void createHolderFormStream(PDDocument template)

Implements org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDFTemplateBuilder.createHolderFormStream.

Doc from org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDFTemplateBuilder.createHolderFormStream.

Create a holder for the form stream.

Parameters
template:PDDocument

the document to be used to create the new stream

Annotations
@Override
createImageFormback to summary
public void createImageForm(PDResources imageFormResources, PDResources innerFormResource, PDStream imageFormStream, PDRectangle bbox, AffineTransform at, PDImageXObject img) throws IOException

Implements org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDFTemplateBuilder.createImageForm.

Doc from org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDFTemplateBuilder.createImageForm.

Creates Image form

Parameters
imageFormResources:PDResources

the resources of the form object

innerFormResource:PDResources

the resources the image object is added

imageFormStream:PDStream

the stream of the form object

bbox:PDRectangle

the bounding box of the form object

at:AffineTransform

the matrix of the form object

img:PDImageXObject

the image object to be used for the form object

Annotations
@Override
Exceptions
IOException:
if the form object could not be created
createImageFormResourcesback to summary
public void createImageFormResources()

Implements org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDFTemplateBuilder.createImageFormResources.

Doc from org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDFTemplateBuilder.createImageFormResources.

Create resource of image form

Annotations
@Override
createImageFormStreamback to summary
public void createImageFormStream(PDDocument template)

Implements org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDFTemplateBuilder.createImageFormStream.

Doc from org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDFTemplateBuilder.createImageFormStream.

Create image form stream.

Parameters
template:PDDocument

the document to be used to create the new stream

Annotations
@Override
createInnerFormback to summary
public void createInnerForm(PDResources innerFormResources, PDStream innerFormStream, PDRectangle bbox)

Implements org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDFTemplateBuilder.createInnerForm.

Doc from org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDFTemplateBuilder.createInnerForm.

Creates InnerForm.

Parameters
innerFormResources:PDResources

resources to be used for the inner form object

innerFormStream:PDStream

the stream to be used for the inner form object

bbox:PDRectangle

the bounding box of the inner form object

Annotations
@Override
createInnerFormResourceback to summary
public void createInnerFormResource()

Implements org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDFTemplateBuilder.createInnerFormResource.

Doc from org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDFTemplateBuilder.createInnerFormResource.

Creates InnerForm

Annotations
@Override
createInnerFormStreamback to summary
public void createInnerFormStream(PDDocument template)

Implements org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDFTemplateBuilder.createInnerFormStream.

Doc from org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDFTemplateBuilder.createInnerFormStream.

Create a holder for the inner form stream.

Parameters
template:PDDocument

the document to be used to create the new stream

Annotations
@Override
createPageback to summary
public void createPage(PDVisibleSignDesigner properties)

Implements org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDFTemplateBuilder.createPage.

Doc from org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDFTemplateBuilder.createPage.

Creates specified size page.

Parameters
properties:PDVisibleSignDesigner

page properties

Annotations
@Override
createProcSetArrayback to summary
public void createProcSetArray()

Implements org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDFTemplateBuilder.createProcSetArray.

Doc from org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDFTemplateBuilder.createProcSetArray.

Creates procSetArray of PDF,Text,ImageB,ImageC,ImageI.

Annotations
@Override
createSignatureback to summary
public void createSignature(PDSignatureField pdSignatureField, PDPage page, String signerName) throws IOException

Implements org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDFTemplateBuilder.createSignature.

Doc from org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDFTemplateBuilder.createSignature.

Creates the signature with the given name and assign it to the signature field parameter and assign the page parameter to the widget.

Parameters
pdSignatureField:PDSignatureField

the signature filed the signatur is added to

page:PDPage

the page the widgt ist added to

signerName:String

the name of the person or authority signing the document. According to the PDF specification, this value should be used only when it is not possible to extract the name from the signature.

Annotations
@Override
Exceptions
IOException:
if the signature could not be created
createSignatureFieldback to summary
public void createSignatureField(PDAcroForm acroForm) throws IOException

Implements org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDFTemplateBuilder.createSignatureField.

Doc from org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDFTemplateBuilder.createSignatureField.

Creates signature fields.

Parameters
acroForm:PDAcroForm

the acroform the signature is added to

Annotations
@Override
Exceptions
IOException:
if the signature could not be created
createSignatureImageback to summary
public void createSignatureImage(PDDocument template, BufferedImage image) throws IOException

Implements org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDFTemplateBuilder.createSignatureImage.

Doc from org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDFTemplateBuilder.createSignatureImage.

Creates signature image.

Parameters
template:PDDocument

the document the image is added to

image:BufferedImage

to imager to be added

Annotations
@Override
Exceptions
IOException:
if the image could not be added
createSignatureRectangleback to summary
public void createSignatureRectangle(PDSignatureField signatureField, PDVisibleSignDesigner properties) throws IOException

Implements org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDFTemplateBuilder.createSignatureRectangle.

Doc from org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDFTemplateBuilder.createSignatureRectangle.

Creates SignatureRectangle.

Parameters
signatureField:PDSignatureField

the signature field the rectangle is added to

properties:PDVisibleSignDesigner

the properties used to create the rectangle

Annotations
@Override
Exceptions
IOException:
if the rectangle could not be created
createTemplateback to summary
public void createTemplate(PDPage page) throws IOException

Implements org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDFTemplateBuilder.createTemplate.

Creates a PDDocument and adds the page parameter to it and keeps this as a template in the PDF template Structure.

Parameters
page:PDPage

the page to be added

Annotations
@Override
Exceptions
IOException:
if the document could not be created
createVisualSignatureback to summary
public void createVisualSignature(PDDocument template)

Implements org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDFTemplateBuilder.createVisualSignature.

Doc from org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDFTemplateBuilder.createVisualSignature.

just to create visible signature

Parameters
template:PDDocument

the document holding the visible signatue

Annotations
@Override
createWidgetDictionaryback to summary
public void createWidgetDictionary(PDSignatureField signatureField, PDResources holderFormResources) throws IOException

Implements org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDFTemplateBuilder.createWidgetDictionary.

Doc from org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDFTemplateBuilder.createWidgetDictionary.

adds Widget Dictionary

Parameters
signatureField:PDSignatureField

the field to be used as widget dictionary

holderFormResources:PDResources

the resources to be added to the widget dictionary

Annotations
@Override
Exceptions
IOException:
if the widget dictionary could not be created
getStructureback to summary
public PDFTemplateStructure getStructure()

Implements org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDFTemplateBuilder.getStructure.

Doc from org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDFTemplateBuilder.getStructure.

Resturns the PDF template Structure

Returns:PDFTemplateStructure

PDF template Structure

Annotations
@Override
injectAppearanceStreamsback to summary
public void injectAppearanceStreams(PDStream holderFormStream, PDStream innerFormStream, PDStream imageFormStream, COSName imageFormName, COSName imageName, COSName innerFormName, PDVisibleSignDesigner properties) throws IOException

Implements org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDFTemplateBuilder.injectAppearanceStreams.

Doc from org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDFTemplateBuilder.injectAppearanceStreams.

injects appearance streams

Parameters
holderFormStream:PDStream

the holder form stream

innerFormStream:PDStream

the inner form stream

imageFormStream:PDStream

the image form stream

imageFormName:COSName

the name of the form image to be used

imageName:COSName

the name of the image to be used

innerFormName:COSName

the name of the form object to be used

properties:PDVisibleSignDesigner

properties to be used to create the appearance stream

Annotations
@Override
Exceptions
IOException:
if the appearance stream could not be created
injectProcSetArrayback to summary
public void injectProcSetArray(PDFormXObject innerForm, PDPage page, PDResources innerFormResources, PDResources imageFormResources, PDResources holderFormResources, COSArray procSet)

Implements org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDFTemplateBuilder.injectProcSetArray.

Doc from org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDFTemplateBuilder.injectProcSetArray.

Inject procSetArray

Parameters
innerForm:PDFormXObject

form object the given proc set array is added to

page:PDPage

page the given proc set array is added to

innerFormResources:PDResources

inner form resources the given proc set array is added to

imageFormResources:PDResources

inner image resources the given proc set array is added to

holderFormResources:PDResources

holder form resources the given proc set array is added to

procSet:COSArray

the pro set array to be added

Annotations
@Override
insertInnerFormToHolderResourcesback to summary
public void insertInnerFormToHolderResources(PDFormXObject innerForm, PDResources holderFormResources)

Implements org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDFTemplateBuilder.insertInnerFormToHolderResources.

Doc from org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDFTemplateBuilder.insertInnerFormToHolderResources.

Insert given from as inner form.

Parameters
innerForm:PDFormXObject

the form object to be inserted

holderFormResources:PDResources

resources the fomr object is added to

Annotations
@Override