iText - 文本注释

在本章中，我们将了解如何使用 iText 库向 PDF 文档添加文本注释。

在 PDF 中创建文本注释

您可以通过实例化 Document 类来创建一个空的 PDF 文档。在实例化此类时，您需要将 PdfDocument 对象作为参数传递给其构造函数。

要在 PDF 文档中使用文本注释，您需要创建 PdfTextAnnotation 类的对象并将其添加到 PdfPage。

以下是在 PDF 文档中使用文本注释的步骤。

步骤 1：创建 PdfWriter 对象

PdfWriter 类代表 PDF 的 DocWriter。此类属于包 com.itextpdf.kernel.pdf。此类的构造函数接受一个字符串，表示要创建 PDF 的文件的路径。

通过将字符串值（表示需要创建 PDF 的路径）传递给其构造函数来实例化 PdfWriter 类，如下所示。

// 创建 PdfWriter
String dest = "C:/itextExamples/textAnnotation.pdf";
PdfWriter writer = new PdfWriter(dest);

当将此类型的对象传递给 PdfDocument（类）时，添加到此文档的每个元素都将写入指定的文件。

步骤 2：创建 PdfDocument 对象

PdfDocument 类是 iText 中表示 PDF 文档的类。此类属于包 com.itextpdf.kernel.pdf。要实例化此类（在写入模式下），您需要将类 PdfWriter 的对象传递给其构造函数。

通过将 PdfWriter 对象传递给其构造函数来实例化 PdfDocument 类，如下所示。

// 创建 PdfDocument
PdfDocument pdfDoc = new PdfDocument(writer);

创建 PdfDocument 对象后，您可以使用其类提供的相应方法添加各种元素，如页面、字体、文件附件和事件处理程序。

步骤 3：创建 Document 对象

包 com.itextpdf.layout 的 Document 类是创建自给自足 PDF 时的根元素。此类的构造函数之一接受 PdfDocument 类的对象。

通过传递在前面步骤中创建的 PdfDocument 类的对象来实例化 Document 类，如下所示。

// 创建文档
Document document = new Document(pdfDoc);

步骤 4：创建 PdfAnnotation 对象

包 com.itextpdf.kernel.pdf.annot 的 PdfAnnotation 类代表所有注释的超类。

在其派生类中，PdfTextAnnotation 类代表文本注释。创建此类的对象，如下所示。

// 创建 PdfAnnotation
Rectangle rect = new Rectangle(20, 800, 0, 0);
PdfAnnotation ann = new PdfTextAnnotation(rect);

步骤 5：设置注释的颜色

使用 PdfAnnotation 类的 setColor() 方法将注释的颜色设置为注释。将表示注释颜色的 color 对象作为参数传递给此方法。

// 将注释的颜色设置为注释
ann.setColor(Color.GREEN);

步骤 6：设置注释的标题和内容

分别使用 PdfAnnotation 类的 setTitle() 和 setContents() 方法设置注释的标题和内容，如下所示。

// 将注释的标题设置为注释
ann.setTitle(new PdfString("Hello"));

// 设置注释的内容
ann.setContents("Hi welcome to Tutorialspoint.");

步骤 7：向页面添加注释

使用 PdfDocument 类的 addNewPage() 方法创建一个新的 PdfPage 类，并使用 PdfPage 类的 addAnnotation() 方法添加上述注释，如下所示。

// 创建新页面 PdfPage page =
pdf.addNewPage();

// 向 PDF 中的页面添加注释
page.addAnnotation(ann);

步骤 8：关闭文档

使用 Document 类的 close() 方法关闭文档，如下所示。

// 关闭文档
document.close();

示例

以下 Java 程序演示如何使用 iText 库向 PDF 文档添加文本注释。它创建一个名为 textAnnotation.pdf 的 PDF 文档，向其添加文本注释，并将其保存在路径 C:/itextExamples/

将此代码保存在名为 TextAnnotation.java 的文件中。

import com.itextpdf.kernel.color.Color; 
import com.itextpdf.kernel.geom.Rectangle; 
import com.itextpdf.kernel.pdf.PdfDocument;
import com.itextpdf.kernel.pdf.PdfPage; 
import com.itextpdf.kernel.pdf.PdfString; 
import com.itextpdf.kernel.pdf.PdfWriter; 
import com.itextpdf.kernel.pdf.annot.PdfAnnotation; 
import com.itextpdf.kernel.pdf.annot.PdfTextAnnotation; 
import com.itextpdf.layout.Document;  

public class TextAnnotation {    
   public static void main(String args[]) throws Exception {        
        // 创建 PdfWriter
        String dest = "C:/itextExamples/textAnnotation.pdf";
        PdfWriter writer = new PdfWriter(dest);
        
        // 创建 PdfDocument
        PdfDocument pdf = new PdfDocument(writer);
        
        // 创建 Document
        Document document = new Document(pdf);
        
        // 创建 PdfTextAnnotation 对象
        Rectangle rect = new Rectangle(20, 800, 0, 0);
        PdfAnnotation ann = new PdfTextAnnotation(rect);
        
        // 设置注释颜色
        ann.setColor(Color.GREEN);
        
        // 设置注释标题
        ann.setTitle(new PdfString("Hello"));
        
        // 设置注释内容
        ann.setContents("Hi welcome to Tutorialspoint.");
        
        // 创建新页面
        PdfPage page = pdf.addNewPage();
        
        // 向 PDF 中的页面添加注释
        page.addAnnotation(ann);
        
        // 关闭文档
        document.close();
        
        System.out.println("注释添加成功");
   } 
}

使用以下命令从命令提示符编译并执行保存的 Java 文件。

javac TextAnnotation.java
java TextAnnotation

执行后，上述程序将创建一个 PDF 文档，并显示以下消息。

注释已成功添加

如果验证指定的路径，则可以找到创建的 PDF 文档，如下所示。