📜  iText-文本注释

📅  最后修改于: 2020-10-16 02:54:30             🧑  作者: Mango


在本章中,我们将看到如何使用iText库向PDF文档添加文本注释。

在PDF中创建文本注释

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

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

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

步骤1:创建一个PdfWriter对象

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

实例化PdfWriter类,方法是将一个字符串值(代表您需要在其中创建PDF的路径)传递给它的构造函数,如下所示。

// Creating a 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类,如下所示。

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

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

步骤3:创建Document对象

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

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

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

步骤4:创建PdfAnnotation对象

com.itextpdf.kernel.pdf.annotPdfAnnotation类表示所有注释的超类。

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

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

第5步:设置注释的颜色

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

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

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

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

// Setting title to the annotation 
ann.setTitle(new PdfString("Hello"));        

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

步骤7:将注释添加到页面

创建使用PdfDocument类的addNewPage()方法的新PdfPage类和使用addAnnotation(PdfPage类的方法中添加上述注释,如下所示。

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

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

步骤8:关闭文档

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

// Closing the document 
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 {        
      // Creating a PdfWriter       
      String dest = "C:/itextExamples/textAnnotation.pdf";       
      PdfWriter writer = new PdfWriter(dest);               
      
      // Creating a PdfDocument       
      PdfDocument pdf = new PdfDocument(writer);               
      
      // Creating a Document        
      Document document = new Document(pdf);             
      
      // Creating PdfTextAnnotation object
      Rectangle rect = new Rectangle(20, 800, 0, 0);       
      PdfAnnotation ann = new PdfTextAnnotation(rect);              
      
      // Setting color to the annotation
      ann.setColor(Color.GREEN);              
      
      // Setting title to the annotation 
      ann.setTitle(new PdfString("Hello"));              
      
      // Setting contents of the annotation       
      ann.setContents("Hi welcome to Tutorialspoint.");              
      
      // Creating a new page       
      PdfPage page =  pdf.addNewPage();              
      
      // Adding annotation to a page in a PDF
      page.addAnnotation(ann);

      // Closing the document       
      document.close();       
      
      System.out.println("Annotation added successfully");    
   } 
}

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

javac TextAnnotation.java 
java TextAnnotation 

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

Annotation added successfully 

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

文字注解