iText7中文教程：第四章 - 创建交互式PDF文档

前言

在PDF文档开发中，交互功能是提升用户体验的关键要素。本章将深入探讨如何使用iText7库为PDF文档添加丰富的交互功能，包括各种注解类型和交互式表单的创建与处理。

注解基础

注解(Annotation)是PDF标准中定义的一种特殊对象，它不属于文档内容流，而是作为附加层覆盖在内容之上。iText7支持所有PDF标准定义的注解类型，让我们能够为文档添加丰富的交互元素。

文本注解

文本注解是最基础的注解类型之一，它会在文档中显示一个带有标题和内容的弹出框：

PdfAnnotation ann = new PdfTextAnnotation(new Rectangle(20, 800, 0, 0))
    .setColor(Color.GREEN)
    .setTitle(new PdfString("iText"))
    .setContents("使用iText可以将文档需求提升到新水平。")
    .setOpen(true);
pdf.getFirstPage().addAnnotation(ann);

这段代码创建了一个绿色文本注解，其中：

• Rectangle定义注解位置和大小
• setColor()设置注解颜色
• setTitle()设置标题
• setContents()设置显示内容
• setOpen(true)使注解默认展开

链接注解

链接注解让PDF中的文字或区域可点击，实现超链接功能：

PdfLinkAnnotation annotation = new PdfLinkAnnotation(new Rectangle(0, 0))
        .setAction(PdfAction.createURI("http://itextpdf.com/"));
Link link = new Link("点击这里", annotation);
Paragraph p = new Paragraph("链接注解示例。")
        .add(link.setUnderline())
        .add("了解更多...");
document.add(p);

这里我们：

1. 创建URI动作指向iText官网
2. 将动作与链接注解关联
3. 创建Link对象包装注解
4. 将链接添加到段落中

线条注解

线条注解可用于在文档中添加带样式的线条：

PdfArray lineEndings = new PdfArray();
lineEndings.add(new PdfName("Diamond"));
lineEndings.add(new PdfName("Diamond"));

PdfAnnotation annotation = new PdfLineAnnotation(
    new Rectangle(0, 0),
    new float[]{20, 790, page.getPageSize().getWidth() - 20, 790})
        .setLineEndingStyles((lineEndings))
        .setContentsAsCaption(true)
        .setTitle(new PdfString("iText"))
        .setContents("线条注解示例")
        .setColor(Color.BLUE);

这段代码创建了一个两端带有菱形箭头的蓝色线条，展示了如何：

• 定义线条端点样式
• 设置线条标题和内容
• 指定线条颜色

文本标记注解

文本标记注解可用于高亮文档中的特定文本：

PdfAnnotation ann = PdfTextMarkupAnnotation.createHighLight(
        new Rectangle(105, 790, 64, 10),
        new float[]{169, 790, 105, 790, 169, 800, 105, 800})
    .setColor(Color.YELLOW)
    .setTitle(new PdfString("提示"))
    .setContents(new PdfString("这是一个弹出框。"))
    .setOpen(true);

交互式表单

PDF表单是交互式PDF的核心功能之一。iText7提供了完整的API来创建和处理PDF表单。

创建表单基础

首先需要获取或创建PdfAcroForm对象：

PdfAcroForm form = PdfAcroForm.getAcroForm(doc.getPdfDocument(), true);

第二个参数true表示如果文档没有表单则创建新表单。

文本字段

添加文本字段是最基本的表单操作：

PdfTextFormField nameField = PdfTextFormField.createText(
    doc.getPdfDocument(), 
    new Rectangle(99, 753, 425, 15), 
    "name", 
    "");
form.addField(nameField);

参数依次为：PdfDocument、位置矩形、字段名和默认值。

单选按钮

创建单选按钮组：

PdfButtonFormField group = PdfFormField.createRadioGroup(
    doc.getPdfDocument(), "language", "");
    
PdfFormField.createRadioButton(doc.getPdfDocument(),
    new Rectangle(130, 728, 15, 15), group, "English");
// 添加更多单选按钮...
    
form.addField(group);

同一组内的单选按钮互斥，只能选择一个。

复选框

复选框允许选择多个选项：

PdfButtonFormField checkField = PdfFormField.createCheckBox(
    doc.getPdfDocument(), 
    new Rectangle(119, 701, 15, 15),
    "experience1", 
    "Off",
    PdfFormField.TYPE_CHECK);
form.addField(checkField);

复选框有"On"和"Off"两种状态。

下拉列表

创建下拉选择框：

String[] options = {"任何", "上午6:30 - 下午2:30", "下午1:30 - 晚上9:30"};
PdfChoiceFormField choiceField = PdfFormField.createComboBox(
    doc.getPdfDocument(), 
    new Rectangle(163, 676, 115, 15),
    "shift", 
    "任何", 
    options);
form.addField(choiceField);

多行文本

多行文本字段支持自动换行：

PdfTextFormField infoField = PdfTextFormField.createMultilineText(
    doc.getPdfDocument(), 
    new Rectangle(158, 625, 366, 40), 
    "info", 
    "");
form.addField(infoField);

按钮

添加重置按钮示例：

PdfButtonFormField button = PdfFormField.createPushButton(
    doc.getPdfDocument(),
    new Rectangle(479, 594, 45, 15), 
    "reset", 
    "重置");
    
button.setAction(PdfAction.createResetForm(
    new String[] {"name", "language", "experience1", "experience2",
        "experience3", "shift", "info"}, 0));
        
form.addField(button);

表单处理

填写表单

可以通过编程方式填写表单字段：

Map<String, PdfFormField> fields = form.getFormFields();
fields.get("name").setValue("张三");
fields.get("language").setValue("中文");
// 设置其他字段...

读取并填写现有表单

处理现有PDF表单：

PdfDocument pdf = new PdfDocument(
    new PdfReader("input.pdf"), 
    new PdfWriter("output.pdf"));
    
PdfAcroForm form = PdfAcroForm.getAcroForm(pdf, false);
Map<String, PdfFormField> fields = form.getFormFields();
fields.get("name").setValue("李四");
// 设置其他字段...

pdf.close();

表单扁平化

将交互式表单转换为静态内容：

form.flattenFields();

扁平化后表单字段将变为普通内容，无法再编辑。

总结

本章详细介绍了iText7中创建交互式PDF的两大核心技术：

1. 注解系统：包括文本、链接、线条、标记等多种注解类型，为PDF添加丰富的交互层。

2. 表单处理：完整的工作流程包括：

   • 创建各种表单字段（文本、单选、复选、下拉等）
   • 编程方式填写表单数据
   • 处理现有PDF表单
   • 表单扁平化转换

掌握这些技术后，开发者可以创建功能丰富的交互式PDF文档，满足各种业务场景需求。在实际应用中，应根据具体需求选择最合适的技术方案，平衡交互性和安全性。