org.dromara.pdf.pdfbox.core.ext.processor.form

Class FormProcessor

java.lang.Object

org.dromara.pdf.pdfbox.core.ext.AbstractExpander

org.dromara.pdf.pdfbox.core.ext.processor.AbstractProcessor

org.dromara.pdf.pdfbox.core.ext.processor.form.FormProcessor

public class FormProcessor
extends AbstractProcessor

表单处理器

Since:

1.8

Copyright (c) 2020 xsx All Rights Reserved. x-easypdf-pdfbox is licensed under Mulan PSL v2. You can use this software according to the terms and conditions of the Mulan PSL v2. You may obtain a copy of Mulan PSL v2 at: http://license.coscl.org.cn/MulanPSL2 THIS SOFTWARE IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO NON-INFRINGEMENT, MERCHANTABILITY OR FIT FOR A PARTICULAR PURPOSE. See the Mulan PSL v2 for more details.

Author:

xsx

Field Summary

Fields

Modifier and Type	Field and Description
protected Color	fontColor 字体颜色
protected String	fontName 字体名称
protected Float	fontSize 字体大小
protected org.apache.pdfbox.pdmodel.interactive.form.PDAcroForm	form 表单

Fields inherited from class org.dromara.pdf.pdfbox.core.ext.AbstractExpander

document, log

Constructor Summary

Constructors

Constructor and Description
FormProcessor(Document document) 有参构造
FormProcessor(Document document, boolean isFixForm, boolean isNeedAppearance) 有参构造

Method Summary

Modifier and Type	Method and Description
void	addField(AbstractFormFieldBuilder... builders) 添加字段
protected String	createDefaultAppearance(PDFont font) 创建默认样式字符串
void	fillCheckBox(Map<String,Boolean> formMap) 填写多选
void	fillImage(Map<String,BufferedImage> formMap) 填写图像
void	fillRadio(String key, int index) 填写单选
void	fillText(Map<String,String> formMap) 填写文本
void	flatten(boolean refreshAppearances, String... keys) 扁平化表单
void	flush() 刷新
List<org.apache.pdfbox.pdmodel.interactive.form.PDField>	getFields() 获取字段
protected org.apache.pdfbox.pdmodel.interactive.form.PDAcroForm	initForm(PDDocument document, boolean isFixForm, boolean isNeedAppearance) 初始化表单
protected boolean	isAddAppearance() 是否添加外观
void	readOnly(String... keys) 只读
void	remove(String... keys) 移除字段
void	replaceKey(Map<String,String> keyMap) 替换关键字
void	setFont(String fontName, float fontSize, Color fontColor) 设置字体

Methods inherited from class org.dromara.pdf.pdfbox.core.ext.AbstractExpander

getDocument

Methods inherited from class java.lang.Object

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

Field Detail

form

protected org.apache.pdfbox.pdmodel.interactive.form.PDAcroForm form

表单

fontName

protected String fontName

字体名称

fontSize

protected Float fontSize

字体大小

fontColor

protected Color fontColor

字体颜色

Constructor Detail

FormProcessor

public FormProcessor(Document document)

有参构造

Parameters:

document - 文档

FormProcessor

public FormProcessor(Document document,
                     boolean isFixForm,
                     boolean isNeedAppearance)

有参构造

Parameters:

document - 文档

Method Detail

getFields

public List<org.apache.pdfbox.pdmodel.interactive.form.PDField> getFields()

获取字段

Returns:

返回字段

setFont

public void setFont(String fontName,
                    float fontSize,
                    Color fontColor)

设置字体

Parameters:

fontName - 字体名称

fontSize - 字体大小

fontColor - 字体颜色

addField

public void addField(AbstractFormFieldBuilder... builders)

添加字段

Parameters:

builders - 构建器

replaceKey

public void replaceKey(Map<String,String> keyMap)

替换关键字

Parameters:

keyMap - 关键字字典

remove

public void remove(String... keys)

移除字段

Parameters:

keys - 字段关键字

fillText

public void fillText(Map<String,String> formMap)

填写文本

Parameters:

formMap - 表单字典

fillImage

public void fillImage(Map<String,BufferedImage> formMap)

填写图像

Parameters:

formMap - 表单字典

fillRadio

public void fillRadio(String key,
                      int index)

填写单选

Parameters:

key - 字段键

index - 选项索引

fillCheckBox

public void fillCheckBox(Map<String,Boolean> formMap)

填写多选

Parameters:

formMap - 表单字典

flatten

public void flatten(boolean refreshAppearances,
                    String... keys)

扁平化表单

Parameters:

refreshAppearances - 是否刷新外观

keys - 字段关键字

readOnly

public void readOnly(String... keys)

只读

Parameters:

keys - 关键字

flush

public void flush()

刷新

initForm

protected org.apache.pdfbox.pdmodel.interactive.form.PDAcroForm initForm(PDDocument document,
                                                                         boolean isFixForm,
                                                                         boolean isNeedAppearance)

初始化表单

Parameters:

document - pdfbox文档

isFixForm - 是否修复表单

isNeedAppearance - 是否启用外观

Returns:

返回pdfbox表单

isAddAppearance

protected boolean isAddAppearance()

是否添加外观

Returns:

返回布尔值，true为是，false为否

createDefaultAppearance

protected String createDefaultAppearance(PDFont font)

创建默认样式字符串

Parameters:

font - 字体