com.whitestein.lsps.stdlib.function

Interface PdfFunctions

All Known Implementing Classes:

PdfFunctionsImpl

public interface PdfFunctions

PDF utility functions.

Method Summary

Modifier and Type	Method and Description
RecordHolder	fillPdfForm(ExecutionContext context, RecordHolder pdfInput, String fileName, MapHolder values) Deprecated.
BinaryHolder	fillPdfTemplate(ExecutionContext context, BinaryHolder pdfTemplate, BinaryHolder fdfDocument) Creates a new PDF document from a template.
BinaryHolder	fillPdfTemplate(ExecutionContext context, BinaryHolder pdfTemplate, MapHolder values) Creates a new PDF document from a template.
BinaryHolder	fillXfaPdfTemplate(ExecutionContext context, BinaryHolder xfaTemplate, RecordHolder data) Creates a new PDF document from the XFA template.
BinaryHolder	fillXfaPdfTemplate(ExecutionContext context, BinaryHolder xfaTemplate, String xml) Creates a new PDF document from the XFA template.

Method Detail

fillPdfForm

@Deprecated
RecordHolder fillPdfForm(ExecutionContext context,
                                     RecordHolder pdfInput,
                                     String fileName,
                                     MapHolder values)
                              throws ErrorException

Deprecated.

Fills a given PDF form.

Parameters:

context - the LSPS execution context

pdfInput - PDF form as a BinaryHandle record

fileName - a file name of the created output BinaryHandle

values - a map with PDF form field names as keys

Returns:

the created BinaryHandle record

Throws:

ErrorException

fillPdfTemplate

BinaryHolder fillPdfTemplate(ExecutionContext context,
                             BinaryHolder pdfTemplate,
                             MapHolder values)
                      throws ErrorException

Creates a new PDF document from a template. It fills the template with data from the values map. The keys of the map represent the field names.

Parameters:

context - the execution context

pdfTemplate - a PDF template

values - the values for the form fields

Returns:

a binary holder representing the produced PDF document.

Throws:

ErrorException - If error occurs during the creation of the PDF document

fillPdfTemplate

BinaryHolder fillPdfTemplate(ExecutionContext context,
                             BinaryHolder pdfTemplate,
                             BinaryHolder fdfDocument)
                      throws ErrorException

Creates a new PDF document from a template. It fills the template with data from the FDF document.

Parameters:

context - the execution context

pdfTemplate - a PDF template

fdfDocument - the values for the form fields

Returns:

a binary holder representing the produced PDF document.

Throws:

ErrorException - If error occurs during the creation of the PDF document

fillXfaPdfTemplate

BinaryHolder fillXfaPdfTemplate(ExecutionContext context,
                                BinaryHolder xfaTemplate,
                                String xml)
                         throws ErrorException

Creates a new PDF document from the XFA template. It fills the template with data specified by the xml. The xml must conform to the XSD specified by the template.

Parameters:

context - the execution context

xfaTemplate - the PDF template with XFA controls

xml - the data for the template

Returns:

a binary holder representing the produced PDF document.

Throws:

ErrorException

fillXfaPdfTemplate

BinaryHolder fillXfaPdfTemplate(ExecutionContext context,
                                BinaryHolder xfaTemplate,
                                RecordHolder data)
                         throws ErrorException

Creates a new PDF document from the XFA template. It fills the template with the data record. The type of populated record must specify the XML mapping that conforms to the XML schema required by the template.

Parameters:

context - the execution context

xfaTemplate - the PDF template with XFA controls

data - the data for the template

Returns:

a binary holder representing the produced PDF document.

Throws:

ErrorException