PDVisibleSigBuilder (PDFBox reactor 2.0.7 API)

java.lang.Object
- org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDVisibleSigBuilder

All Implemented Interfaces:

PDFTemplateBuilder
```
public class PDVisibleSigBuilder
extends Object
implements PDFTemplateBuilder
```
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

Constructor Summary

Constructors
Constructor and Description

PDVisibleSigBuilder()
Constructor, creates PDF template structure.

Constructors
Constructor and Description
`PDVisibleSigBuilder()` Constructor, creates PDF template structure.

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`appendRawCommands(OutputStream os, String commands)`
`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(AffineTransform affineTransform)` In order to create Affine Transform, using parameters.
`void`	`createAffineTransform(byte[] params)` Deprecated. use `createAffineTransform(java.awt.geom.AffineTransform)`
`void`	`createAppearanceDictionary(PDFormXObject holderForml, PDSignatureField signatureField)` Creates appearance dictionary
`void`	`createBackgroundLayerForm(PDResources innerFormResource, PDRectangle formatter)` Creates the background layer form (n0).
`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 at, 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 signerName)` Creates the signature with the given name and assign it to the signature field parameter and assign the page parameter to the widget.
`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 a PDDocument and adds the page parameter to it and keeps this as a template in the PDF template Structure.
`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 innerFormStream, PDStream imageFormStream, COSName imageFormName, 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)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - PDVisibleSigBuilder
```
public PDVisibleSigBuilder()
```
    Constructor, creates PDF template structure.
- Method Detail
  - createPage
```
public void createPage(PDVisibleSignDesigner properties)
```
    Description copied from interface: PDFTemplateBuilder
    
    Creates specified size page.
    
    Specified by:
    
    createPage in interface PDFTemplateBuilder
  - createTemplate
```
public void createTemplate(PDPage page)
                    throws IOException
```
    Creates a PDDocument and adds the page parameter to it and keeps this as a template in the PDF template Structure.
    
    Specified by:
    
    createTemplate in interface PDFTemplateBuilder
    
    Parameters:
    page -
    
    Throws:
    
    IOException
  - createAcroForm
```
public void createAcroForm(PDDocument template)
```
    Description copied from interface: PDFTemplateBuilder
    
    Creates Acro forms in the template.
    
    Specified by:
    
    createAcroForm in interface PDFTemplateBuilder
  - getStructure
```
public PDFTemplateStructure getStructure()
```
    Specified by:
    
    getStructure in interface PDFTemplateBuilder
    
    Returns:
    - PDF template Structure
  - createSignatureField
```
public void createSignatureField(PDAcroForm acroForm)
                          throws IOException
```
    Description copied from interface: PDFTemplateBuilder
    
    Creates signature fields.
    
    Specified by:
    
    createSignatureField in interface PDFTemplateBuilder
    
    Throws:
    
    IOException
  - createSignature
```
public void createSignature(PDSignatureField pdSignatureField,
                   PDPage page,
                   String signerName)
                     throws IOException
```
    Description copied from interface: PDFTemplateBuilder
    
    Creates the signature with the given name and assign it to the signature field parameter and assign the page parameter to the widget.
    
    Specified by:
    
    createSignature in interface PDFTemplateBuilder
    
    signerName - 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.
    
    Throws:
    
    IOException
  - createAcroFormDictionary
```
public void createAcroFormDictionary(PDAcroForm acroForm,
                            PDSignatureField signatureField)
                              throws IOException
```
    Description copied from interface: PDFTemplateBuilder
    
    Create AcroForm Dictionary.
    
    Specified by:
    
    createAcroFormDictionary in interface PDFTemplateBuilder
    
    Throws:
    
    IOException
  - createSignatureRectangle
```
public void createSignatureRectangle(PDSignatureField signatureField,
                            PDVisibleSignDesigner properties)
                              throws IOException
```
    Description copied from interface: PDFTemplateBuilder
    
    Creates SignatureRectangle.
    
    Specified by:
    
    createSignatureRectangle in interface PDFTemplateBuilder
    
    Throws:
    
    IOException
  - createAffineTransform
```
@Deprecated
public void createAffineTransform(byte[] params)
```
    Deprecated. use createAffineTransform(java.awt.geom.AffineTransform)
    
    In order to create Affine Transform, using parameters.
    
    Specified by:
    
    createAffineTransform in interface PDFTemplateBuilder
  - createAffineTransform
```
public void createAffineTransform(AffineTransform affineTransform)
```
    Description copied from interface: PDFTemplateBuilder
    
    In order to create Affine Transform, using parameters.
    
    Specified by:
    
    createAffineTransform in interface PDFTemplateBuilder
  - createProcSetArray
```
public void createProcSetArray()
```
    Description copied from interface: PDFTemplateBuilder
    
    Creates procSetArray of PDF,Text,ImageB,ImageC,ImageI.
    
    Specified by:
    
    createProcSetArray in interface PDFTemplateBuilder
  - createSignatureImage
```
public void createSignatureImage(PDDocument template,
                        BufferedImage image)
                          throws IOException
```
    Description copied from interface: PDFTemplateBuilder
    
    Creates signature image.
    
    Specified by:
    
    createSignatureImage in interface PDFTemplateBuilder
    
    Throws:
    
    IOException
  - createFormatterRectangle
```
public void createFormatterRectangle(byte[] params)
```
    Specified by:
    
    createFormatterRectangle in interface PDFTemplateBuilder
  - createHolderFormStream
```
public void createHolderFormStream(PDDocument template)
```
    Specified by:
    
    createHolderFormStream in interface PDFTemplateBuilder
  - createHolderFormResources
```
public void createHolderFormResources()
```
    Description copied from interface: PDFTemplateBuilder
    
    Creates resources of form
    
    Specified by:
    
    createHolderFormResources in interface PDFTemplateBuilder
  - createHolderForm
```
public void createHolderForm(PDResources holderFormResources,
                    PDStream holderFormStream,
                    PDRectangle formrect)
```
    Description copied from interface: PDFTemplateBuilder
    
    Creates Form
    
    Specified by:
    
    createHolderForm in interface PDFTemplateBuilder
  - createAppearanceDictionary
```
public void createAppearanceDictionary(PDFormXObject holderForml,
                              PDSignatureField signatureField)
                                throws IOException
```
    Description copied from interface: PDFTemplateBuilder
    
    Creates appearance dictionary
    
    Specified by:
    
    createAppearanceDictionary in interface PDFTemplateBuilder
    
    Throws:
    
    IOException
  - createInnerFormStream
```
public void createInnerFormStream(PDDocument template)
```
    Specified by:
    
    createInnerFormStream in interface PDFTemplateBuilder
  - createInnerFormResource
```
public void createInnerFormResource()
```
    Description copied from interface: PDFTemplateBuilder
    
    Creates InnerForm
    
    Specified by:
    
    createInnerFormResource in interface PDFTemplateBuilder
  - createInnerForm
```
public void createInnerForm(PDResources innerFormResources,
                   PDStream innerFormStream,
                   PDRectangle formrect)
```
    Specified by:
    
    createInnerForm in interface PDFTemplateBuilder
  - insertInnerFormToHolderResources
```
public void insertInnerFormToHolderResources(PDFormXObject innerForm,
                                    PDResources holderFormResources)
```
    Specified by:
    
    insertInnerFormToHolderResources in interface PDFTemplateBuilder
  - createImageFormStream
```
public void createImageFormStream(PDDocument template)
```
    Specified by:
    
    createImageFormStream in interface PDFTemplateBuilder
  - createImageFormResources
```
public void createImageFormResources()
```
    Description copied from interface: PDFTemplateBuilder
    
    Create resource of image form
    
    Specified by:
    
    createImageFormResources in interface PDFTemplateBuilder
  - createImageForm
```
public void createImageForm(PDResources imageFormResources,
                   PDResources innerFormResource,
                   PDStream imageFormStream,
                   PDRectangle formrect,
                   AffineTransform at,
                   PDImageXObject img)
                     throws IOException
```
    Description copied from interface: PDFTemplateBuilder
    
    Creates Image form
    
    Specified by:
    
    createImageForm in interface PDFTemplateBuilder
    
    Throws:
    
    IOException
  - createBackgroundLayerForm
```
public void createBackgroundLayerForm(PDResources innerFormResource,
                             PDRectangle formatter)
                               throws IOException
```
    Description copied from interface: PDFTemplateBuilder
    
    Creates the background layer form (n0).
    
    Specified by:
    
    createBackgroundLayerForm in interface PDFTemplateBuilder
    
    Throws:
    
    IOException
  - injectProcSetArray
```
public void injectProcSetArray(PDFormXObject innerForm,
                      PDPage page,
                      PDResources innerFormResources,
                      PDResources imageFormResources,
                      PDResources holderFormResources,
                      COSArray procSet)
```
    Description copied from interface: PDFTemplateBuilder
    
    Inject procSetArray
    
    Specified by:
    
    injectProcSetArray in interface PDFTemplateBuilder
  - injectAppearanceStreams
```
public void injectAppearanceStreams(PDStream holderFormStream,
                           PDStream innerFormStream,
                           PDStream imageFormStream,
                           COSName imageFormName,
                           COSName imageName,
                           COSName innerFormName,
                           PDVisibleSignDesigner properties)
                             throws IOException
```
    Description copied from interface: PDFTemplateBuilder
    
    injects appearance streams
    
    Specified by:
    
    injectAppearanceStreams in interface PDFTemplateBuilder
    
    Throws:
    
    IOException
  - appendRawCommands
```
public void appendRawCommands(OutputStream os,
                     String commands)
                       throws IOException
```
    Throws:
    
    IOException
  - createVisualSignature
```
public void createVisualSignature(PDDocument template)
```
    Description copied from interface: PDFTemplateBuilder
    
    just to create visible signature
    
    Specified by:
    
    createVisualSignature in interface PDFTemplateBuilder
  - createWidgetDictionary
```
public void createWidgetDictionary(PDSignatureField signatureField,
                          PDResources holderFormResources)
                            throws IOException
```
    Description copied from interface: PDFTemplateBuilder
    
    adds Widget Dictionary
    
    Specified by:
    
    createWidgetDictionary in interface PDFTemplateBuilder
    
    Throws:
    
    IOException
  - closeTemplate
```
public void closeTemplate(PDDocument template)
                   throws IOException
```
    Description copied from interface: PDFTemplateBuilder
    
    Closes template
    
    Specified by:
    
    closeTemplate in interface PDFTemplateBuilder
    
    Throws:
    
    IOException

Class PDVisibleSigBuilder

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

PDVisibleSigBuilder

Method Detail

createPage

createTemplate

createAcroForm

getStructure

createSignatureField

createSignature

createAcroFormDictionary

createSignatureRectangle

createAffineTransform

createAffineTransform

createProcSetArray

createSignatureImage

createFormatterRectangle

createHolderFormStream

createHolderFormResources

createHolderForm

createAppearanceDictionary

createInnerFormStream

createInnerFormResource

createInnerForm

insertInnerFormToHolderResources

createImageFormStream

createImageFormResources

createImageForm

createBackgroundLayerForm

injectProcSetArray

injectAppearanceStreams

appendRawCommands

createVisualSignature

createWidgetDictionary

closeTemplate