PDFBox - PDF 文档中的 JavaScript

在上一章中，我们学习了如何将图像插入 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 对象，如下所示。向此类的构造函数传递所需的 JavaScript，形式为字符串，如下所示。

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

步骤 3:在文档中嵌入 Java 脚本

将所需字符串嵌入 PDF 文档，如下所示。

document.getDocumentCatalog().setOpenAction(PDAjavascript);

步骤 4:保存文档

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

document.save("Path");

步骤 5:关闭文档

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

document.close();

示例

假设，我们有一个名为 sample.pdf 的 PDF 文档，位于路径 C:/PdfBox_Examples/，其中有空白页，如下所示。

此示例演示如何将 JavaScript 嵌入上述 PDF 文档中。在这里，我们将加载名为 sample.pdf 的 PDF 文档并在其中嵌入 JavaScript。将此代码保存在名为 AddJavaScript.java.

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 {

        //加载现有文件
        File file = new File("C:/PdfBox_Examples/new.pdf");
        PDDocument document = PDDocument.load(file);
        
        String javaScript = "app.alert( {cMsg: 'this is an example', nIcon: 3,"
        + " nType: 0, cTitle: 'PDFBox Javascript example'} );";
        
        //创建 PDActionJavaScript 对象
        PDActionJavaScript PDAjavascript = new PDActionJavaScript(javaScript);
        
        //嵌入 java 脚本
        document.getDocumentCatalog().setOpenAction(PDAjavascript);
        
        //保存文档
        document.save( new File("C:/PdfBox_Examples/new.pdf") );
        System.out.println("Data added to the given PDF"); 
        
        //关闭文档
        document.close();

   }
}

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

javac AddJavaScript.java
java AddJavaScript

执行后，上述程序将 JavaScript 嵌入给定的 PDF 文档中，并显示以下消息。

Data added to the given PDF

如果您尝试打开文档 new.pdf，它将显示一条警告消息，如下所示。