Package de.xima.fc.form.export
Class FormExporter
- java.lang.Object
-
- de.xima.fc.form.export.FormExporter
-
public class FormExporter extends Object
Exporter for creating documents from formcycle forms- Author:
- XIMA MEDIA GmbH
-
-
Constructor Summary
Constructors Constructor Description FormExporter(com.alibaba.fastjson.JSONObject persist, IXFormRenderConfig renderConfig)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description byte[]
doExport()
Creates a document for the configured formFormExporter
withExcludeImages(boolean excludeImages)
Sets whether or not to exclude images in exported documentFormExporter
withFormat(EFormPrintFormat format)
FormExporter
withKeepPlaceholder(boolean keepPlaceholder)
FormExporter
withLocale(Locale locale)
Sets the default editing language for the created document.FormExporter
withTemplate(ERessourcenTyp resourceType, UUID resourceUUID)
Sets the template that should be used via its resource type (client or project) and UUID
-
-
-
Constructor Detail
-
FormExporter
public FormExporter(com.alibaba.fastjson.JSONObject persist, IXFormRenderConfig renderConfig)
- Parameters:
persist
- Persist with the data of the form to export.renderConfig
- Render config to use for exporting.
-
-
Method Detail
-
withFormat
public FormExporter withFormat(EFormPrintFormat format)
- Parameters:
format
-EFormPrintFormat
export format- Returns:
FormExporter
for fluent API
-
withKeepPlaceholder
public FormExporter withKeepPlaceholder(boolean keepPlaceholder)
- Parameters:
keepPlaceholder
- Whether placeholders in form field properties are replaced.- Returns:
FormExporter
for fluent API
-
withTemplate
public FormExporter withTemplate(ERessourcenTyp resourceType, UUID resourceUUID)
Sets the template that should be used via its resource type (client or project) and UUID- Parameters:
resourceType
-ERessourcenTyp
client or project resourceresourceUUID
-UUID
of the resource- Returns:
FormExporter
for fluent API
-
withLocale
public FormExporter withLocale(Locale locale)
Sets the default editing language for the created document.- Parameters:
locale
- Locale to set.- Returns:
FormExporter
for fluent API
-
withExcludeImages
public FormExporter withExcludeImages(boolean excludeImages)
Sets whether or not to exclude images in exported document- Parameters:
excludeImages
-Boolean
excludeXImage
in the exported form- Returns:
FormExporter
for fluent API
-
doExport
public byte[] doExport()
Creates a document for the configured form- Returns:
- byte array of the exported form document
-
-