Class PDVisibleSigBuilder
- java.lang.Object
-
- org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDVisibleSigBuilder
-
- All Implemented Interfaces:
PDFTemplateBuilder
public class PDVisibleSigBuilder extends java.lang.Object implements PDFTemplateBuilder
Implementation ofPDFTemplateBuilder
. This builds the signature PDF but doesn't keep the elements, these are kept in its PDF template structure.
-
-
Field Summary
Fields Modifier and Type Field Description private static org.apache.commons.logging.Log
LOG
private PDFTemplateStructure
pdfStructure
-
Constructor Summary
Constructors Constructor Description PDVisibleSigBuilder()
Constructor, creates PDF template structure.
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description void
appendRawCommands(java.io.OutputStream os, java.lang.String commands)
void
closeTemplate(PDDocument template)
Closes templatevoid
createAcroForm(PDDocument template)
Creates Acro forms in the template.void
createAcroFormDictionary(PDAcroForm acroForm, PDSignatureField signatureField)
Create AcroForm Dictionary.void
createAffineTransform(byte[] params)
Deprecated.void
createAffineTransform(java.awt.geom.AffineTransform affineTransform)
In order to create Affine Transform, using parameters.void
createAppearanceDictionary(PDFormXObject holderForml, PDSignatureField signatureField)
Creates appearance dictionaryvoid
createBackgroundLayerForm(PDResources innerFormResource, PDRectangle bbox)
Creates the background layer form (n0).void
createFormatterRectangle(byte[] params)
Deprecated.void
createFormatterRectangle(int[] params)
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.void
createHolderForm(PDResources holderFormResources, PDStream holderFormStream, PDRectangle bbox)
Creates Formvoid
createHolderFormResources()
Creates resources of formvoid
createHolderFormStream(PDDocument template)
void
createImageForm(PDResources imageFormResources, PDResources innerFormResource, PDStream imageFormStream, PDRectangle bbox, java.awt.geom.AffineTransform at, PDImageXObject img)
Creates Image formvoid
createImageFormResources()
Create resource of image formvoid
createImageFormStream(PDDocument template)
void
createInnerForm(PDResources innerFormResources, PDStream innerFormStream, PDRectangle bbox)
void
createInnerFormResource()
Creates InnerFormvoid
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, java.lang.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, java.awt.image.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 signaturevoid
createWidgetDictionary(PDSignatureField signatureField, PDResources holderFormResources)
adds Widget DictionaryPDFTemplateStructure
getStructure()
void
injectAppearanceStreams(PDStream holderFormStream, PDStream innerFormStream, PDStream imageFormStream, COSName imageFormName, COSName imageName, COSName innerFormName, PDVisibleSignDesigner properties)
injects appearance streamsvoid
injectProcSetArray(PDFormXObject innerForm, PDPage page, PDResources innerFormResources, PDResources imageFormResources, PDResources holderFormResources, COSArray procSet)
Inject procSetArrayvoid
insertInnerFormToHolderResources(PDFormXObject innerForm, PDResources holderFormResources)
-
-
-
Field Detail
-
pdfStructure
private final PDFTemplateStructure pdfStructure
-
LOG
private static final org.apache.commons.logging.Log LOG
-
-
Method Detail
-
createPage
public void createPage(PDVisibleSignDesigner properties)
Description copied from interface:PDFTemplateBuilder
Creates specified size page.- Specified by:
createPage
in interfacePDFTemplateBuilder
- Parameters:
properties
- property value
-
createTemplate
public void createTemplate(PDPage page) throws java.io.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 interfacePDFTemplateBuilder
- Parameters:
page
-- Throws:
java.io.IOException
-
createAcroForm
public void createAcroForm(PDDocument template)
Description copied from interface:PDFTemplateBuilder
Creates Acro forms in the template.- Specified by:
createAcroForm
in interfacePDFTemplateBuilder
- Parameters:
template
- the template document
-
getStructure
public PDFTemplateStructure getStructure()
- Specified by:
getStructure
in interfacePDFTemplateBuilder
- Returns:
- - PDF template Structure
-
createSignatureField
public void createSignatureField(PDAcroForm acroForm) throws java.io.IOException
Description copied from interface:PDFTemplateBuilder
Creates signature fields.- Specified by:
createSignatureField
in interfacePDFTemplateBuilder
- Parameters:
acroForm
- the acroform- Throws:
java.io.IOException
- if something went wrong
-
createSignature
public void createSignature(PDSignatureField pdSignatureField, PDPage page, java.lang.String signerName) throws java.io.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 interfacePDFTemplateBuilder
- Parameters:
pdSignatureField
- signature filedpage
- the given pagesignerName
- 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:
java.io.IOException
- if something went wrong
-
createAcroFormDictionary
public void createAcroFormDictionary(PDAcroForm acroForm, PDSignatureField signatureField) throws java.io.IOException
Description copied from interface:PDFTemplateBuilder
Create AcroForm Dictionary.- Specified by:
createAcroFormDictionary
in interfacePDFTemplateBuilder
- Parameters:
acroForm
- the acroformsignatureField
- the signature field- Throws:
java.io.IOException
- if something went wrong
-
createSignatureRectangle
public void createSignatureRectangle(PDSignatureField signatureField, PDVisibleSignDesigner properties) throws java.io.IOException
Description copied from interface:PDFTemplateBuilder
Creates SignatureRectangle.- Specified by:
createSignatureRectangle
in interfacePDFTemplateBuilder
- Parameters:
signatureField
- the signature fieldproperties
- properties- Throws:
java.io.IOException
- if something went wrong
-
createAffineTransform
@Deprecated public void createAffineTransform(byte[] params)
Deprecated.In order to create Affine Transform, using parameters.- Specified by:
createAffineTransform
in interfacePDFTemplateBuilder
- Parameters:
params
- parameter values
-
createAffineTransform
public void createAffineTransform(java.awt.geom.AffineTransform affineTransform)
Description copied from interface:PDFTemplateBuilder
In order to create Affine Transform, using parameters.- Specified by:
createAffineTransform
in interfacePDFTemplateBuilder
- Parameters:
affineTransform
- the transformation
-
createProcSetArray
public void createProcSetArray()
Description copied from interface:PDFTemplateBuilder
Creates procSetArray of PDF,Text,ImageB,ImageC,ImageI.- Specified by:
createProcSetArray
in interfacePDFTemplateBuilder
-
createSignatureImage
public void createSignatureImage(PDDocument template, java.awt.image.BufferedImage image) throws java.io.IOException
Description copied from interface:PDFTemplateBuilder
Creates signature image.- Specified by:
createSignatureImage
in interfacePDFTemplateBuilder
- Parameters:
template
- template documentimage
- signature image- Throws:
java.io.IOException
- if something went wrong
-
createFormatterRectangle
@Deprecated public void createFormatterRectangle(byte[] params)
Deprecated.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.- Specified by:
createFormatterRectangle
in interfacePDFTemplateBuilder
- Parameters:
params
- parameters
-
createFormatterRectangle
public void createFormatterRectangle(int[] params)
Description copied from interface:PDFTemplateBuilder
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.- Specified by:
createFormatterRectangle
in interfacePDFTemplateBuilder
- Parameters:
params
- parameters
-
createHolderFormStream
public void createHolderFormStream(PDDocument template)
- Specified by:
createHolderFormStream
in interfacePDFTemplateBuilder
- Parameters:
template
- template document
-
createHolderFormResources
public void createHolderFormResources()
Description copied from interface:PDFTemplateBuilder
Creates resources of form- Specified by:
createHolderFormResources
in interfacePDFTemplateBuilder
-
createHolderForm
public void createHolderForm(PDResources holderFormResources, PDStream holderFormStream, PDRectangle bbox)
Description copied from interface:PDFTemplateBuilder
Creates Form- Specified by:
createHolderForm
in interfacePDFTemplateBuilder
- Parameters:
holderFormResources
- holder form resourcesholderFormStream
- holder streambbox
- bounding box
-
createAppearanceDictionary
public void createAppearanceDictionary(PDFormXObject holderForml, PDSignatureField signatureField) throws java.io.IOException
Description copied from interface:PDFTemplateBuilder
Creates appearance dictionary- Specified by:
createAppearanceDictionary
in interfacePDFTemplateBuilder
- Parameters:
holderForml
- holder XObjectsignatureField
- the signature field- Throws:
java.io.IOException
- if something went wrong
-
createInnerFormStream
public void createInnerFormStream(PDDocument template)
- Specified by:
createInnerFormStream
in interfacePDFTemplateBuilder
- Parameters:
template
- template document
-
createInnerFormResource
public void createInnerFormResource()
Description copied from interface:PDFTemplateBuilder
Creates InnerForm- Specified by:
createInnerFormResource
in interfacePDFTemplateBuilder
-
createInnerForm
public void createInnerForm(PDResources innerFormResources, PDStream innerFormStream, PDRectangle bbox)
- Specified by:
createInnerForm
in interfacePDFTemplateBuilder
- Parameters:
innerFormResources
- inner form resourcesinnerFormStream
- inner form streambbox
- bounding box
-
insertInnerFormToHolderResources
public void insertInnerFormToHolderResources(PDFormXObject innerForm, PDResources holderFormResources)
- Specified by:
insertInnerFormToHolderResources
in interfacePDFTemplateBuilder
- Parameters:
innerForm
- inner form XObjectholderFormResources
- holder form resources
-
createImageFormStream
public void createImageFormStream(PDDocument template)
- Specified by:
createImageFormStream
in interfacePDFTemplateBuilder
- Parameters:
template
- template document
-
createImageFormResources
public void createImageFormResources()
Description copied from interface:PDFTemplateBuilder
Create resource of image form- Specified by:
createImageFormResources
in interfacePDFTemplateBuilder
-
createImageForm
public void createImageForm(PDResources imageFormResources, PDResources innerFormResource, PDStream imageFormStream, PDRectangle bbox, java.awt.geom.AffineTransform at, PDImageXObject img) throws java.io.IOException
Description copied from interface:PDFTemplateBuilder
Creates Image form- Specified by:
createImageForm
in interfacePDFTemplateBuilder
- Parameters:
imageFormResources
- image form resourcesinnerFormResource
- inner form resourcesimageFormStream
- image from streambbox
- bounding boxat
- transformationimg
- ImageXObject- Throws:
java.io.IOException
- if something went wrong
-
createBackgroundLayerForm
public void createBackgroundLayerForm(PDResources innerFormResource, PDRectangle bbox) throws java.io.IOException
Description copied from interface:PDFTemplateBuilder
Creates the background layer form (n0).- Specified by:
createBackgroundLayerForm
in interfacePDFTemplateBuilder
- Parameters:
innerFormResource
- inner acroform resourcesbbox
- rectangle of the formatter- Throws:
java.io.IOException
- if something went wrong
-
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 interfacePDFTemplateBuilder
- Parameters:
innerForm
- inner formpage
- the given pageinnerFormResources
- inner form resourcesimageFormResources
- image form resourcesholderFormResources
- holder form resourcesprocSet
- procset values
-
injectAppearanceStreams
public void injectAppearanceStreams(PDStream holderFormStream, PDStream innerFormStream, PDStream imageFormStream, COSName imageFormName, COSName imageName, COSName innerFormName, PDVisibleSignDesigner properties) throws java.io.IOException
Description copied from interface:PDFTemplateBuilder
injects appearance streams- Specified by:
injectAppearanceStreams
in interfacePDFTemplateBuilder
- Parameters:
holderFormStream
- holder form streaminnerFormStream
- inner form streamimageFormStream
- image form streamimageFormName
- image form nameimageName
- image nameinnerFormName
- inner form nameproperties
- property values- Throws:
java.io.IOException
- if something went wrong
-
appendRawCommands
public void appendRawCommands(java.io.OutputStream os, java.lang.String commands) throws java.io.IOException
- Throws:
java.io.IOException
-
createVisualSignature
public void createVisualSignature(PDDocument template)
Description copied from interface:PDFTemplateBuilder
just to create visible signature- Specified by:
createVisualSignature
in interfacePDFTemplateBuilder
- Parameters:
template
- template document
-
createWidgetDictionary
public void createWidgetDictionary(PDSignatureField signatureField, PDResources holderFormResources) throws java.io.IOException
Description copied from interface:PDFTemplateBuilder
adds Widget Dictionary- Specified by:
createWidgetDictionary
in interfacePDFTemplateBuilder
- Parameters:
signatureField
- the signature fieldholderFormResources
- holder form resources- Throws:
java.io.IOException
- if something went wrong
-
closeTemplate
public void closeTemplate(PDDocument template) throws java.io.IOException
Description copied from interface:PDFTemplateBuilder
Closes template- Specified by:
closeTemplate
in interfacePDFTemplateBuilder
- Parameters:
template
- template document- Throws:
java.io.IOException
- if something went wrong
-
-