Class AsposePdfTemplateProcessor

java.lang.Object

com.flowable.template.engine.impl.processor.DocumentTemplateProcessor

com.flowable.template.engine.impl.processor.AsposePdfTemplateProcessor

All Implemented Interfaces:

TemplateProcessor

public class AsposePdfTemplateProcessor
extends DocumentTemplateProcessor

A TemplateProcessor using the Aspose Document.

Field Summary

Fields

Modifier and Type	Field	Description
protected final AsposeTemplateProcessorSettings	asposeTemplateProcessorSettings

Fields inherited from class DocumentTemplateProcessor

OUTPUT_TYPE_PDF, OUTPUT_TYPE_WORD, supportedContentType, templateResourceResolver

Constructor Summary

Constructors

Constructor	Description
AsposePdfTemplateProcessor(TemplateResourceResolver templateResourceResolver, AsposeTemplateProcessorSettings asposeTemplateProcessorSettings)

Method Summary

Modifier and Type	Method	Description
protected void	clearIncorrectCombFlagIfNecessary(com.aspose.pdf.TextBoxField textBoxField)	Clears the comb flag on text fields where it must be ignored according to the PDF specification (ISO 32000-1, Table 228): the comb flag is only meaningful when a MaxLen is present and the Multiline flag is clear.
protected byte[]	getAsByteArray(com.aspose.pdf.Document doc, String pdfComplianceLevel)
protected int	getChoiceIndex(Object varValue, com.aspose.pdf.ChoiceField choiceField)
protected String	getDocumentName(Map<String,Object> payload)
protected String	getFieldExpression(com.aspose.pdf.Field field)
protected Iterable<com.aspose.pdf.Field>	getSupportedFields(com.aspose.pdf.Form pdfForm)
protected com.aspose.pdf.Document	getTemplateDocument(TemplateHolder templateHolder)
protected boolean	isExpression(String fieldExpression)
protected boolean	isOptionField(com.aspose.pdf.Field field)
protected byte[]	processDocument(TemplateHolder templateHolder, org.flowable.common.engine.impl.el.ExpressionManager expressionManager, org.flowable.common.engine.api.variable.VariableContainer variableContainer, String pdfComplianceLevel)
TemplateProcessingResult	processTemplate(TemplateHolder templateHolder, Map<String,Object> payload, Map<String,Object> templateProcessingSettings)	Processes a template given by its definition which might have been loaded through the TemplateRepositoryService.

Methods inherited from class DocumentTemplateProcessor

canRender, createContentItem, createProcessingResult, getContentInputStream, getContentService, getExpressionManager, getFromPayloadOrDefault, getVariableContainer, isContentItemGenerationEnabled

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface TemplateProcessor

processTemplate

Field Details

asposeTemplateProcessorSettings

protected final AsposeTemplateProcessorSettings asposeTemplateProcessorSettings

Constructor Details

AsposePdfTemplateProcessor

public AsposePdfTemplateProcessor(TemplateResourceResolver templateResourceResolver,
 AsposeTemplateProcessorSettings asposeTemplateProcessorSettings)

Method Details

getDocumentName

protected String getDocumentName(Map<String,Object> payload)

processTemplate

public TemplateProcessingResult processTemplate(TemplateHolder templateHolder,
 Map<String,Object> payload,
 Map<String,Object> templateProcessingSettings)

Description copied from interface: TemplateProcessor

Processes a template given by its definition which might have been loaded through the TemplateRepositoryService. The payload is used for the placeholders within the template content and must be valid according the TemplateVariationModel.getParameters() definition.

Parameters:

templateHolder - the template holder with template and template variation information

payload - the optional payload, if the template is using placeholders to render properly (must be valid according the parameter definition)

Returns:

the template processing results

processDocument

protected byte[] processDocument(TemplateHolder templateHolder,
 org.flowable.common.engine.impl.el.ExpressionManager expressionManager,
 org.flowable.common.engine.api.variable.VariableContainer variableContainer,
 String pdfComplianceLevel)
                          throws Exception

Throws:

Exception

clearIncorrectCombFlagIfNecessary

protected void clearIncorrectCombFlagIfNecessary(com.aspose.pdf.TextBoxField textBoxField)

Clears the comb flag on text fields where it must be ignored according to the PDF specification (ISO 32000-1, Table 228): the comb flag is only meaningful when a MaxLen is present and the Multiline flag is clear. Some templates (e.g., authored by external tools) leave an incorrect comb flag on multi-line free-text fields. Spec-compliant renderers ignore it, but Aspose honors it regardless and spreads each character evenly across the full field width, producing stretched text (see JIRA FLW-6425).

getChoiceIndex

protected int getChoiceIndex(Object varValue,
 com.aspose.pdf.ChoiceField choiceField)

isExpression

protected boolean isExpression(String fieldExpression)

getFieldExpression

protected String getFieldExpression(com.aspose.pdf.Field field)

getSupportedFields

protected Iterable<com.aspose.pdf.Field> getSupportedFields(com.aspose.pdf.Form pdfForm)

isOptionField

protected boolean isOptionField(com.aspose.pdf.Field field)

getAsByteArray

protected byte[] getAsByteArray(com.aspose.pdf.Document doc,
 String pdfComplianceLevel)
                         throws Exception

Throws:

Exception

getTemplateDocument

protected com.aspose.pdf.Document getTemplateDocument(TemplateHolder templateHolder)