iText - 线条标注

本章将介绍如何使用 iText 库向 PDF 文档添加线条标注。

在 PDF 中创建线条标注

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

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

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

步骤 1：创建 PdfWriter 对象

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

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

// Creating a PdfWriter 
String dest = "C:/itextExamples/lineAnnotation.pdf"; 
PdfWriter writer = new PdfWriter(dest);

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

步骤 2：创建 PdfDocument 对象

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

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

// Creating a PdfDocument  
PdfDocument pdfDoc = new PdfDocument(writer);

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

步骤 3：创建 Document 对象

**com.itextpdf.layout** 包的 **Document** 类是在创建自包含 PDF 时使用的根元素。此类的一个构造函数接受 **PdfDocument** 类的对象。

通过将前面步骤中创建的 **PdfDocument** 类的对象传递给构造函数来实例化 Document 类，如下所示。

// Creating a Document  
Document document = new Document(pdfDoc);

步骤 4：创建 PdfAnnotation 对象

**com.itextpdf.kernel.pdf.annot** 包的 **PdfAnnotation** 类是所有标注的超类。

在其派生类中，**PdfLineAnnotation** 类表示线条标注。创建此类的对象，如下所示。

// Creating PdfAnnotation 
Rectangle rect = new Rectangle(20, 800, 0, 0); 
PdfAnnotation annotation = new PdfLineAnnotation(rect);

步骤 5：设置标注的颜色

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

// Setting color to the annotation 
annotation.setColor(Color.BLUE);

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

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

// Setting title to the PdfLineAnnotation 
annotation.setTitle(new PdfString("iText"));        

// Setting contents of the PdfLineAnnotation 
annotation.setContents("Hi welcome to Tutorialspoint");

步骤 7：将标注添加到页面

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

// Creating a new page 
PdfPage page = pdf.addNewPage();

// Adding annotation to a page in a PDF 
page.addAnnotation(annotation);

步骤 8：关闭文档

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

// Closing the document 
document.close();

示例

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

将此代码保存在名为 **LineAnnotation.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.PdfLineAnnotation; 
import com.itextpdf.layout.Document;  

public class LineAnnotation {
   public static void main(String args[]) throws Exception {             
      // Creating a PdfWriter       
      String dest = "C:/itextExamples/lineAnnotations.pdf";       
      PdfWriter writer = new PdfWriter(dest);               

      // Creating a PdfDocument       
      PdfDocument pdf = new PdfDocument(writer);               

      // Creating a Document        
      Document document = new Document(pdf);              
      
      // Creating a PdfPage       
      PdfPage page = pdf.addNewPage();              

      // creating PdfLineAnnotation object       
      Rectangle rect = new Rectangle(0, 0);
      float[] floatArray  = new float[]{
         20, 790, page.getPageSize().getWidth() - 20, 790
      };
      PdfAnnotation annotation = new PdfLineAnnotation(rect, floatArray);              
      
      // Setting color of the PdfLineAnnotation       
      annotation.setColor(Color.BLUE);              
      
      // Setting title to the PdfLineAnnotation       
      annotation.setTitle(new PdfString("iText"));              
      
      // Setting contents of the PdfLineAnnotation       
      annotation.setContents("Hi welcome to Tutorialspoint");              
      
      // Adding annotation to the page       
      page.addAnnotation(annotation);               
      
      // Closing the document       
      document.close();              
      
      System.out.println("Annotation added successfully");   
   } 
}

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

javac LineAnnotation.java 
java LineAnnotation

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

Annotation added successfully

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

打印页面