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/linkAnnotation.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.layoutDocument 类是创建自给自足 PDF 时的根元素。此类的构造函数之一接受 PdfDocument 类的对象。

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

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

步骤 4:创建 PdfAnnotation 对象

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

在其派生类中,PdfLinkAnnotation 类代表链接注释。创建此类的对象,如下所示。

// 创建 PdfLinkAnnotation 对象
Rectangle rect = new Rectangle(0, 0);
PdfLinkAnnotation comment = new PdfLinkAnnotation(rect);

步骤 5:设置注释的操作

使用 PdfLinkAnnotation 类的 setAction() 方法将操作设置为注释,如下所示。

// 设置注释的动作
PdfAction action = PdfAction.createURI("http://www.tutorialspoint.com/");
annotation.setAction(action);

第 6 步:创建链接

通过实例化包 com.itextpdf.layout.elementLink 类来创建链接,如下所示。

// 创建链接
Link link = new Link("单击此处",annotation);

步骤 7:向段落添加链接注释

通过实例化 Paragraph 类创建一个新段落,并使用此类的 add() 方法添加上一步中创建的链接,如下所示。

// 创建段落
Paragraph passage = new Paragraph("Hi welcome to Tutorialspoint ");

// 向段落添加链接
paragraph.add(link.setUnderline());

步骤 8:向文档添加段落

使用 Document 类的 add() 方法将段落添加到文档,如下所示。

// 向文档添加段落
document.add(paragraph);

步骤 9:关闭文档

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

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

示例

以下 Java 程序演示如何使用 iText 库向 PDF 文档添加链接注释。

它创建一个名为 linkAnnotation.pdf 的 PDF 文档,向其添加链接注释,并将其保存在路径 C:/itextExamples/

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

import com.itextpdf.kernel.geom.Rectangle; 
import com.itextpdf.kernel.pdf.PdfDocument; 
import com.itextpdf.kernel.pdf.PdfWriter; 
import com.itextpdf.kernel.pdf.action.PdfAction; 
import com.itextpdf.kernel.pdf.annot.PdfLinkAnnotation; 

import com.itextpdf.layout.Document; 
import com.itextpdf.layout.element.Link; 
import com.itextpdf.layout.element.Paragraph;  

public class LinkAnnotation {      
   public static void main(String args[]) throws Exception {             
         // 创建 PdfWriter
        String dest = "C:/itextExamples/linkAnnotation.pdf";
        
        PdfWriter writer = new
        PdfWriter(dest);
        
        // 创建 PdfDocument
        PdfDocument pdf = new PdfDocument(writer);
        
        // 创建 Document
        Document document = new Document(pdf);
        
        // 创建 PdfLinkAnnotation 对象
        Rectangle rect = new Rectangle(0, 0);
        PdfLinkAnnotation comment = new PdfLinkAnnotation(rect);
        
        // 设置注释的操作
        PdfAction action = PdfAction.createURI("http:// www.tutorialspoint.com/");
        comment.setAction(action);
        
        // 创建链接
        Link link = new Link("Click here", comment);
        
        // 创建段落
        Paragraph passage = new Paragraph("Hi 欢迎来到 Tutorialspoint ");
        
        // 向段落添加链接
        passage.add(link.setUnderline());
        
        // 向文档添加段落
        document.add(paragraph);
        
        // 关闭文档
        document.close();
        
        System.out.println("注释添加成功");  
   } 
}  

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

javac LinkAnnotation.java 
java LinkAnnotation 

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

注释添加成功

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

链接注释