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();

例子

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

样本文件

此示例演示如何在上述 PDF 文档中嵌入 JavaScript。在这里，我们将加载名为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 {

      //Loading an existing file
      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’} );";

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

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

      //Saving the document
      document.save( new File("C:/PdfBox_Examples/new.pdf") );
      System.out.println("Data added to the given PDF"); 

      //Closing the document
      document.close();

   }
}

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

javac AddJavaScript.java 
java AddJavaScript

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

Data added to the given PDF

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

添加 JavaScript