PDFBox PDF文档中的JavaScript

精华

小牛编辑

110浏览

2023-03-14

在前一章中，我们学习了如何将图像插入到PDF文档中。在本章中，将学习如何将JavaScript添加到PDF文档。

将JavaScript添加到PDF文档

可以使用PDActionJavaScript类将JavaScript操作添加到PDF文档。它代表了JavaScript操作。

以下是将JavaScript操作添加到现有PDF文档的步骤。

第1步:加载现有的PDF文档

使用PDDocument类的load()静态方法加载现有的PDF文档。此方法接受一个文件对象作为参数，因为这是一个静态方法，可以使用类名称调用它，如下所示。

File file = new File("path of the document")
PDDocument document = PDDocument.load(file);

第2步:创建PDActionJavaScript对象

实例化PDActionJavaScript对象，如下所示。在这个类的构造函数中，以String的形式传递所需的JavaScript，如下所示。

String javaScript = "app.alert( {cMsg: 'this is an example', nIcon: 3,"
   + " nType: 0,cTitle: 'PDFBox Javascript example' } );";       
PDActionJavaScript PDAjavascript = new PDActionJavaScript(javaScript);

第3步:在文档中嵌入Javascript

如下所示将必需的字符串嵌入到PDF文档中。

document.getDocumentCatalog().setOpenAction(PDAjavascript);

第4步:保存文档

在添加所需内容后，使用PDDocument类的save()方法保存PDF文档，如以下代码块所示。

document.save("Path");

第5步:关闭文档

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

document.close();

示例

假设有一个名称为sample.pdf的PDF文档，存储在目录:F:\worksp\pdfbox，其空页如下所示。

这个例子演示了如何在上面提到的PDF文档中嵌入JavaScript。在这里，将加载sample.pdf PDF文档并在其中嵌入JavaScript。将此代码保存在名称为AddJavaScript.java的文件中。

package com.yiibai;

import java.io.File;

import org.apache.pdfbox.pdmodel.PDDocument; 
import org.apache.pdfbox.pdmodel.interactive.action.PDActionJavaScript;

public class AddJavaScript {

   public static void main(String args[]) throws Exception {

      //Loading an existing file
      File file = new File("F:/worksp/pdfbox/sample.pdf");
      PDDocument document = PDDocument.load(file);

      String javaScript = "app.alert( {cMsg: 'this is an example', nIcon: 3,"
         + " nType: 0, cTitle: 'PDFBox Javascript example’} );";

      //Creating PDActionJavaScript object 
      PDActionJavaScript PDAjavascript = new PDActionJavaScript(javaScript);

      //Embedding java script
      document.getDocumentCatalog().setOpenAction(PDAjavascript);

      //Saving the document
      document.save( new File("F:/worksp/pdfbox/smaple-js.pdf") );
      System.out.println("Data added to the given PDF"); 

      //Closing the document
      document.close();

   }
}

执行上面示例代码，得到以下结果 -

Data added to the given PDF

打开生成的PDF文件:smaple-js.pdf，应该会看到有以下提示信息 -