Package de.xima.fc.workflow.processor.factory

Interface IFillPdfNodeBuilder

public interface IFillPdfNodeBuilder

Builder for configuring a EWorkflowNodeType.FC_FILL_PDF action.

Since:

8.1.0

Author:

XIMA MEDIA GmbH

Method Summary

Modifier and Type	Method	Description
IFillPdfNodeBuilder	attachToFormRecord(boolean attachToFormRecord)
WorkflowNode	build()	Creates a new workflow node for a EWorkflowNodeType.FC_FILL_PDF that fills a PDF document.
FcFillPdfProps	buildProps()	Creates a new properties model for a node that fill a PDF document.
IFillPdfNodeBuilder	exportName(String exportName)
IFillPdfNodeBuilder	flatten(boolean flatten)
IFillPdfNodeBuilder	pdfFile(SingleFile pdfFile)
IFillPdfNodeBuilder	usedFont(String usedFont)

Method Detail

attachToFormRecord

IFillPdfNodeBuilder attachToFormRecord(boolean attachToFormRecord)

Parameters:

attachToFormRecord - Whether to attach the created PDF file to the form record.

Returns:

This builder for chaining methods calls.

build

WorkflowNode build()
            throws FastJsonException

Creates a new workflow node for a EWorkflowNodeType.FC_FILL_PDF that fills a PDF document.

Returns:

The workflow node for a "fill PDF" action.

Throws:

FastJsonException - When the properties model could not be serialized.

buildProps

FcFillPdfProps buildProps()

Creates a new properties model for a node that fill a PDF document.

Returns:

The model for a "fill PDF" action.

exportName

IFillPdfNodeBuilder exportName(String exportName)

Parameters:

exportName - The file name of the PDF document to be created. When empty, a file is generated based on the input file.

Returns:

This builder for chaining methods calls.

flatten

IFillPdfNodeBuilder flatten(boolean flatten)

Parameters:

flatten - Whether to flatten the filled PDF document, i.e. removing AcroForm fields and replacing such fields with a shape representing the field.

Returns:

This builder for chaining methods calls.

pdfFile

IFillPdfNodeBuilder pdfFile(SingleFile pdfFile)

Parameters:

pdfFile - The PDF document to be filled with the form data.

Returns:

This builder for chaining methods calls.

usedFont

IFillPdfNodeBuilder usedFont(String usedFont)

Parameters:

usedFont - The font to use within the PDF for the inserted values.

Returns:

This builder for chaining methods calls.