PDFBox - 添加文本

在上一章中，我们讨论了如何向 PDF 文档添加页面。在本章中，我们将讨论如何向现有 PDF 文档添加文本。

向现有 PDF 文档添加文本

您可以使用 PDFBox 库向文档添加内容，它为您提供了一个名为 PDPageContentStream 的类，其中包含在 PDFDocument 页面中插入文本、图像和其他类型内容所需的方法。

以下是创建空文档并向其中的页面添加内容的步骤。

步骤 1:加载现有文档

您可以使用 PDDocument 类的 load() 方法加载现有文档。因此，实例化此类并加载所需的文档，如下所示。

File file = new File("文档路径");
PDDocument doc = document.load(file);

步骤 2:获取所需页面

您可以使用 getPage() 方法获取文档中所需的页面。通过将所需页面的索引传递给此方法，检索所需页面的对象，如下所示。

PDPage page = doc.getPage(1);

步骤 3:准备内容流

您可以使用类 PDPageContentStream 的对象插入各种数据元素。您需要将文档对象和页面对象传递给此类的构造函数，因此，通过传递前面步骤中创建的这两个对象来实例化此类，如下所示。

PDPageContentStream contentStream = new PDPageContentStream(doc, page);

步骤 4:开始文本

在 PDF 文档中插入文本时，您可以使用 PDPageContentStream 类的 beginText() 和 endText() 方法指定文本的起点和终点，如下所示。

contentStream.beginText(); 
……………………….. 
code to add text content 
……………………….. 
contentStream.endText();

因此，使用 beginText() 方法开始文本，如下所示。

contentStream.beginText();

步骤 5:设置文本的位置

使用 newLineAtOffset() 方法，您可以设置页面中内容流的位置。

//设置行的位置
contentStream.newLineAtOffset(25, 700);

步骤 6:设置字体

您可以使用 PDPageContentStream 类的 setFont() 方法将文本的字体设置为所需的样式，如下所示。您需要向此方法传递字体的类型和大小。

contentStream.setFont( font_type, font_size );

步骤 7:插入文本

您可以使用 PDPageContentStream 类的 ShowText() 方法将文本插入页面，如下所示。此方法以字符串形式接受所需的文本。

contentStream.showText(text);

步骤 8:结束文本

插入文本后，您需要使用 PDPageContentStream 类的 endText() 方法结束文本，如下所示。

contentStream.endText();

步骤 9:关闭 PDPageContentStream

使用 close() 方法关闭 PDPageContentStream 对象，如下所示。

contentstream.close();

步骤 10:保存文档

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

doc.save("Path");

步骤 11:关闭文档

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

doc.close();

示例

此示例演示如何向文档中的页面添加内容。在这里，我们将创建一个 Java 程序来加载名为 my_doc.pdf 的 PDF 文档，该文档保存在路径 C:/PdfBox_Examples/ 中，并向其中添加一些文本。将此代码保存在名为 AddingContent.java 的文件中。

import java.io.File; 
import java.io.IOException;
  
import org.apache.pdfbox.pdmodel.PDDocument; 
import org.apache.pdfbox.pdmodel.PDPage; 
import org.apache.pdfbox.pdmodel.PDPageContentStream; 
import org.apache.pdfbox.pdmodel.font.PDType1Font;
  
public class AddingContent {
   public static void main (String args[]) throws IOException {

        //加载现有文档
        File file = new File("C:/PdfBox_Examples/my_doc.pdf");
        PDDocument document = PDDocument.load(file);
        
        //获取文档页面
        PDPage page = document.getPage(1);
        PDPageContentStream contentStream = new PDPageContentStream(document, page);
        
        //开始内容流
        contentStream.beginText();
        
        //设置内容流的字体
        contentStream.setFont(PDType1Font.TIMES_ROMAN, 12);
        
        //设置行的位置
        contentStream.newLineAtOffset(25, 500);
        
        String text = "这是示例文档，我们正在向其中添加内容。";
        
        //以字符串形式添加文本
        contentStream.showText(text);
        
        //结束内容流
        contentStream.endText();
        
        System.out.println("内容已添加");
        
        //关闭内容流
        contentStream.close();
        
        //保存文档
        document.save(new File("C:/PdfBox_Examples/new.pdf"));
        
        //关闭文档
        document.close();

   }
}

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

javac AddingContent.java
java AddingContent

执行后，上述程序将给定的文本添加到文档并显示以下消息。

Content added

如果您在指定路径中验证 PDF 文档 new.pdf，您可以观察到给定的内容已添加到文档中，如下所示。

PDFBox 教程

PDFBox 有用资源