PDFTemplateBuilder (Apache PDFBox 2.0.1 API)

All Known Implementing Classes:

PDVisibleSigBuilder
```
public interface PDFTemplateBuilder
```
That class builds visible signature template which will be added in our PDF document.

Author:

Vakhtang Koroghlishvili

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`closeTemplate(PDDocument template)` Closes template
`void`	`createAcroForm(PDDocument template)` Creates Acro forms in the template.
`void`	`createAcroFormDictionary(PDAcroForm acroForm, PDSignatureField signatureField)` Create AcroForm Dictionary.
`void`	`createAffineTransform(byte[] params)` In order to create Affine Transform, using parameters.
`void`	`createAppearanceDictionary(PDFormXObject holderForml, PDSignatureField signatureField)` Creates appearance dictionary
`void`	`createFormatterRectangle(byte[] params)`
`void`	`createHolderForm(PDResources holderFormResources, PDStream holderFormStream, PDRectangle formrect)` Creates Form
`void`	`createHolderFormResources()` Creates resources of form
`void`	`createHolderFormStream(PDDocument template)`
`void`	`createImageForm(PDResources imageFormResources, PDResources innerFormResource, PDStream imageFormStream, PDRectangle formrect, AffineTransform affineTransform, PDImageXObject img)` Creates Image form
`void`	`createImageFormResources()` Create resource of image form
`void`	`createImageFormStream(PDDocument template)`
`void`	`createInnerForm(PDResources innerFormResources, PDStream innerFormStream, PDRectangle formrect)`
`void`	`createInnerFormResource()` Creates InnerForm
`void`	`createInnerFormStream(PDDocument template)`
`void`	`createPage(PDVisibleSignDesigner properties)` Creates specified size page.
`void`	`createProcSetArray()` Creates procSetArray of PDF,Text,ImageB,ImageC,ImageI.
`void`	`createSignature(PDSignatureField pdSignatureField, PDPage page, String signatureName)` Creates PDSignatureField.
`void`	`createSignatureField(PDAcroForm acroForm)` Creates signature fields.
`void`	`createSignatureImage(PDDocument template, BufferedImage image)` Creates signature image.
`void`	`createSignatureRectangle(PDSignatureField signatureField, PDVisibleSignDesigner properties)` Creates SignatureRectangle.
`void`	`createTemplate(PDPage page)` Creates template using page.
`void`	`createVisualSignature(PDDocument template)` just to create visible signature
`void`	`createWidgetDictionary(PDSignatureField signatureField, PDResources holderFormResources)` adds Widget Dictionary
`PDFTemplateStructure`	`getStructure()`
`void`	`injectAppearanceStreams(PDStream holderFormStream, PDStream innterFormStream, PDStream imageFormStream, COSName imageObjectName, COSName imageName, COSName innerFormName, PDVisibleSignDesigner properties)` injects appearance streams
`void`	`injectProcSetArray(PDFormXObject innerForm, PDPage page, PDResources innerFormResources, PDResources imageFormResources, PDResources holderFormResources, COSArray procSet)` Inject procSetArray
`void`	`insertInnerFormToHolderResources(PDFormXObject innerForm, PDResources holderFormResources)`

Method Detail

createAffineTransform
```
void createAffineTransform(byte[] params)
```
In order to create Affine Transform, using parameters.

Parameters:
params -

createPage
```
void createPage(PDVisibleSignDesigner properties)
```
Creates specified size page.

Parameters:
properties -

createTemplate

void createTemplate(PDPage page)
                    throws IOException

Creates template using page.

Parameters:: page -
Throws:: IOException

createAcroForm
```
void createAcroForm(PDDocument template)
```
Creates Acro forms in the template.

Parameters:
template -

createSignatureField

void createSignatureField(PDAcroForm acroForm)
                          throws IOException

Creates signature fields.

Parameters:: acroForm -
Throws:: IOException

createSignature

void createSignature(PDSignatureField pdSignatureField,
                   PDPage page,
                   String signatureName)
                     throws IOException

Creates PDSignatureField.

Parameters:: pdSignatureField -; page -; signatureName -
Throws:: IOException

createAcroFormDictionary

void createAcroFormDictionary(PDAcroForm acroForm,
                            PDSignatureField signatureField)
                              throws IOException

Create AcroForm Dictionary.

Parameters:: acroForm -; signatureField -
Throws:: IOException

createSignatureRectangle

void createSignatureRectangle(PDSignatureField signatureField,
                            PDVisibleSignDesigner properties)
                              throws IOException

Creates SignatureRectangle.

Parameters:: signatureField -; properties -
Throws:: IOException

createProcSetArray
```
void createProcSetArray()
```
Creates procSetArray of PDF,Text,ImageB,ImageC,ImageI.

createSignatureImage

void createSignatureImage(PDDocument template,
                        BufferedImage image)
                          throws IOException

Creates signature image.

Parameters:: template -; image -
Throws:: IOException

createFormatterRectangle

void createFormatterRectangle(byte[] params)

Parameters:: params -

createHolderFormStream

void createHolderFormStream(PDDocument template)

Parameters:: template -

createHolderFormResources
```
void createHolderFormResources()
```
Creates resources of form

createHolderForm

void createHolderForm(PDResources holderFormResources,
                    PDStream holderFormStream,
                    PDRectangle formrect)

Creates Form

Parameters:: holderFormResources -; holderFormStream -; formrect -

createAppearanceDictionary

void createAppearanceDictionary(PDFormXObject holderForml,
                              PDSignatureField signatureField)
                                throws IOException

Creates appearance dictionary

Parameters:: holderForml -; signatureField -
Throws:: IOException

createInnerFormStream

void createInnerFormStream(PDDocument template)

Parameters:: template -

createInnerFormResource
```
void createInnerFormResource()
```
Creates InnerForm

createInnerForm

void createInnerForm(PDResources innerFormResources,
                   PDStream innerFormStream,
                   PDRectangle formrect)

Parameters:: innerFormResources -; innerFormStream -; formrect -

insertInnerFormToHolderResources

void insertInnerFormToHolderResources(PDFormXObject innerForm,
                                    PDResources holderFormResources)

Parameters:: innerForm -; holderFormResources -

createImageFormStream

void createImageFormStream(PDDocument template)

Parameters:: template -

createImageFormResources
```
void createImageFormResources()
```
Create resource of image form

createImageForm

void createImageForm(PDResources imageFormResources,
                   PDResources innerFormResource,
                   PDStream imageFormStream,
                   PDRectangle formrect,
                   AffineTransform affineTransform,
                   PDImageXObject img)
                     throws IOException

Creates Image form

Parameters:: imageFormResources -; innerFormResource -; imageFormStream -; formrect -; affineTransform -; img -
Throws:: IOException

injectProcSetArray

void injectProcSetArray(PDFormXObject innerForm,
                      PDPage page,
                      PDResources innerFormResources,
                      PDResources imageFormResources,
                      PDResources holderFormResources,
                      COSArray procSet)

Inject procSetArray

Parameters:: innerForm -; page -; innerFormResources -; imageFormResources -; holderFormResources -; procSet -

injectAppearanceStreams

void injectAppearanceStreams(PDStream holderFormStream,
                           PDStream innterFormStream,
                           PDStream imageFormStream,
                           COSName imageObjectName,
                           COSName imageName,
                           COSName innerFormName,
                           PDVisibleSignDesigner properties)
                             throws IOException

injects appearance streams

Parameters:: holderFormStream -; innterFormStream -; imageFormStream -; imageObjectName -; imageName -; innerFormName -; properties -
Throws:: IOException

createVisualSignature
```
void createVisualSignature(PDDocument template)
```
just to create visible signature

Parameters:
template -

createWidgetDictionary

void createWidgetDictionary(PDSignatureField signatureField,
                          PDResources holderFormResources)
                            throws IOException

adds Widget Dictionary

Parameters:: signatureField -; holderFormResources -
Throws:: IOException

getStructure
```
PDFTemplateStructure getStructure()
```
Returns:
- PDF template Structure

closeTemplate

void closeTemplate(PDDocument template)
                   throws IOException

Closes template

Parameters:: template -
Throws:: IOException

Interface PDFTemplateBuilder