PDFBox - 在PDF文档中使用JavaScript

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

向PDF文档添加JavaScript

您可以使用PDActionJavaScript类向PDF文档添加JavaScript操作。这表示一个JavaScript操作。

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

步骤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：将JavaScript嵌入文档

将所需的字符串嵌入到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 {

      //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文档，它将显示如下所示的警告消息。

打印页面