org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible
Interface PDFTemplateBuilder

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 (Gogebashvili)

Method Summary
 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(PDXObjectForm holderForml, PDSignatureField signatureField)
          Creates appearance dictionary
 void createFormaterRectangle(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, PDJpeg 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 PDSignature
 void createSignatureField(PDAcroForm acroForm)
          Creates signature fields
 void createSignatureImage(PDDocument template, InputStream InputStream)
          Creates signature image
 void createSignatureRectangle(PDSignatureField signatureField, PDVisibleSignDesigner properties)
          Creates SingatureRectangle
 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, String imageObjectName, String imageName, String innerFormName, PDVisibleSignDesigner properties)
          injects appearance streams
 void injectProcSetArray(PDXObjectForm innerForm, PDPage page, PDResources innerFormResources, PDResources imageFormResources, PDResources holderFormResources, COSArray procSet)
          Inject procSetArray
 void insertInnerFormToHolerResources(PDXObjectForm 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 PDSignature

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 SingatureRectangle

Parameters:
signatureField -
properties -
Throws:
IOException

createProcSetArray

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


createSignatureImage

void createSignatureImage(PDDocument template,
                          InputStream InputStream)
                          throws IOException
Creates signature image

Parameters:
template -
InputStream -
Throws:
IOException

createFormaterRectangle

void createFormaterRectangle(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(PDXObjectForm 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 -

insertInnerFormToHolerResources

void insertInnerFormToHolerResources(PDXObjectForm 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,
                     PDJpeg img)
                     throws IOException
Creates Image form

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

injectProcSetArray

void injectProcSetArray(PDXObjectForm 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,
                             String imageObjectName,
                             String imageName,
                             String 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


Copyright © 2002-2014 The Apache Software Foundation. All Rights Reserved.