Java 建立、填充、讀取PDF表單域

Mia張發表於2020-03-02
Java

概述

表單域，可以按用途分為多種不同的型別，常見的有文字框、多行文字框、密碼框、隱藏域、核取方塊、單選框和下拉選擇框等，目的是用於採集使用者的輸入或選擇的資料。

下面的示例中，將分享通過Java程式設計在PDF中建立、填充以及讀取PDF表單域的方法。 建立表單域包括文字框、核取方塊、單選按鈕、列表框、組合框、簽名域、按鈕等。 填充表單域時可分為2種情況，一種是在建立表單域時填充，一種是載入已經建立好表單域的文件進行填充；對於已經建立表單域並填寫好的文件，也可以設定只讀，防止修改、編輯等； 讀取表單域時，可獲取指定（可通過索引值或表單域名稱）表單域的值，或者獲取文件中所有表單域的值。

示例要點概括：

1.建立表單域

2.填充表單域

3.設定表單域只讀

4.讀取表單域值

工具

  • Free Spire.PDF for Java（免費版）

Jar檔案獲取及匯入：

方法1： 通過官網 下載jar檔案包。下載後，解壓檔案，並將lib資料夾下的Spire.Pdf.jar檔案匯入到java程式。

方法2： 通過 maven 倉庫安裝匯入。

 

Java程式碼示例（供參考）

【示例1】 建立並填充PDF表單域

import java.awt.*;
import java.awt.geom.Point2D;
import java.awt.geom.Rectangle2D;
import com.spire.pdf.FileFormat;
import com.spire.pdf.PdfDocument;
import com.spire.pdf.PdfPageBase;
import com.spire.pdf.fields.*;
import com.spire.pdf.graphics.*;
 
public class AddFormFieldsToPdf {
 
    public static void main(String[] args) throws Exception {
       
        //建立PdfDocument物件，並新增頁面
        PdfDocument doc = new PdfDocument();        
        PdfPageBase page = doc.getPages().add();
 
        //初始化位置變數
        float baseX = 100;
        float baseY = 0;
 
        //建立畫刷物件
        PdfSolidBrush brush1 = new PdfSolidBrush(new PdfRGBColor(Color.BLUE));
        PdfSolidBrush brush2 = new PdfSolidBrush(new PdfRGBColor(Color.black));
        
        //建立TrueType字型
        PdfTrueTypeFont font= new PdfTrueTypeFont(new Font("Arial Unicode MS",Font.PLAIN,10),true); 
 
        //新增文字框
        String text = "姓名：";//新增文字
        page.getCanvas().drawString(text, font, brush1, new Point2D.Float(0, baseY));//在PDF中繪製文字
        Rectangle2D.Float tbxBounds = new Rectangle2D.Float(baseX, baseY , 150, 15);//建立Rectangle2D物件
        PdfTextBoxField textBox = new PdfTextBoxField(page, "TextBox");//建立文字框物件
        textBox.setBounds(tbxBounds);//設定文字框的Bounds
        textBox.setText("劉興");//填充文字框
        textBox.setFont(font);//應用文字框的字型
        doc.getForm().getFields().add(textBox);//新增文字框到PDF域的集合
        baseY +=25;
 
        //新增核取方塊
        page.getCanvas().drawString("所在院系：", font, brush1, new Point2D.Float(0, baseY));
        java.awt.geom.Rectangle2D.Float rec1 = new java.awt.geom.Rectangle2D.Float(baseX, baseY, 15, 15);
        PdfCheckBoxField checkBoxField = new PdfCheckBoxField(page, "CheckBox1");//建立第一個核取方塊物件
        checkBoxField.setBounds(rec1);
        checkBoxField.setChecked(false);//填充核取方塊
        page.getCanvas().drawString("經管系", font, brush2, new Point2D.Float(baseX + 20, baseY));
        java.awt.geom.Rectangle2D.Float rec2 = new java.awt.geom.Rectangle2D.Float(baseX + 70, baseY, 15, 15);
        PdfCheckBoxField checkBoxField1 = new PdfCheckBoxField(page, "CheckBox2");//建立第二個核取方塊物件
        checkBoxField1.setBounds(rec2);
        checkBoxField1.setChecked(true);//填充核取方塊
        page.getCanvas().drawString("創新班", font,  brush2, new Point2D.Float(baseX+90, baseY));      
        doc.getForm().getFields().add(checkBoxField);//新增核取方塊到PDF
        baseY += 25;
 
        //新增列表框
        page.getCanvas().drawString("錄取批次：", font, brush1, new Point2D.Float(0, baseY));
        java.awt.geom.Rectangle2D.Float rec = new java.awt.geom.Rectangle2D.Float(baseX, baseY, 150, 50);
        PdfListBoxField listBoxField = new PdfListBoxField(page, "ListBox");//建立列表框物件
        listBoxField.getItems().add(new PdfListFieldItem("第一批次", "item1"));
        listBoxField.getItems().add(new PdfListFieldItem("第二批次", "item2"));
        listBoxField.getItems().add(new PdfListFieldItem("第三批次", "item3"));
        listBoxField.setBounds(rec);
        listBoxField.setFont(font);
        listBoxField.setSelectedIndex(0);//填充列表框
        doc.getForm().getFields().add(listBoxField);//新增列表框到PDF
        baseY += 60;
 
        //新增單選按鈕
        page.getCanvas().drawString("招收方式：", font, brush1, new Point2D.Float(0, baseY));
        PdfRadioButtonListField radioButtonListField = new PdfRadioButtonListField(page, "Radio");//建立單選按鈕物件
        PdfRadioButtonListItem radioItem1 = new PdfRadioButtonListItem("Item1");//建立第一個單選按鈕
        radioItem1.setBounds(new Rectangle2D.Float(baseX, baseY, 15, 15));
        page.getCanvas().drawString("全日制", font, brush2, new Point2D.Float(baseX + 20, baseY));
        PdfRadioButtonListItem radioItem2 = new PdfRadioButtonListItem("Item2");//建立第二個單選按鈕
        radioItem2.setBounds(new Rectangle2D.Float(baseX + 70, baseY, 15, 15));
        page.getCanvas().drawString("成人教育", font, brush2, new Point2D.Float(baseX + 90, baseY));
        radioButtonListField.getItems().add(radioItem1);
        radioButtonListField.getItems().add(radioItem2);
        radioButtonListField.setSelectedIndex(0);//選擇填充第一個單選按鈕
        doc.getForm().getFields().add(radioButtonListField);//新增單選按鈕到PDF
        baseY += 25;
 
        //新增組合框
        page.getCanvas().drawString("最高學歷：", font, brush1, new Point2D.Float(0, baseY));
        Rectangle2D.Float cmbBounds = new Rectangle2D.Float(baseX, baseY, 150, 15);//建立cmbBounds物件
        PdfComboBoxField comboBoxField = new PdfComboBoxField(page, "ComboBox");//建立comboBoxField物件
        comboBoxField.setBounds(cmbBounds);
        comboBoxField.getItems().add(new PdfListFieldItem("博士", "item1"));
        comboBoxField.getItems().add(new PdfListFieldItem("碩士", "itme2"));
        comboBoxField.getItems().add(new PdfListFieldItem("本科", "item3"));
        comboBoxField.getItems().add(new PdfListFieldItem("大專", "item4"));
        comboBoxField.setSelectedIndex(0);      
        comboBoxField.setFont(font);
        doc.getForm().getFields().add(comboBoxField);//新增組合框到PDF
        baseY += 25;
 
        //新增簽名域
        page.getCanvas().drawString("本人簽字確認\n以上資訊屬實：", font, brush1, new Point2D.Float(0, baseY));
        PdfSignatureField sgnField= new PdfSignatureField(page,"sgnField");//建立sgnField物件
        Rectangle2D.Float sgnBounds = new Rectangle2D.Float(baseX, baseY, 150, 80);//建立sgnBounds物件
        sgnField.setBounds(sgnBounds);          
        doc.getForm().getFields().add(sgnField);//新增sgnField到PDF
        baseY += 90;
 
        //新增按鈕
        page.getCanvas().drawString("", font, brush1, new Point2D.Float(0, baseY));
        Rectangle2D.Float btnBounds = new Rectangle2D.Float(baseX, baseY, 50, 15);//建立btnBounds物件
        PdfButtonField buttonField = new PdfButtonField(page, "Button");//建立buttonField物件
        buttonField.setBounds(btnBounds);
        buttonField.setText("提交");//設定按鈕顯示文字
        buttonField.setFont(font);
        doc.getForm().getFields().add(buttonField);//新增按鈕到PDF  
        
        //儲存文件
        doc.saveToFile("result.pdf", FileFormat.PDF);              
    }
}

建立（填充）效果：



【示例2】 載入並填充已有的表單域文件

測試文件如下：

import com.spire.pdf.FileFormat;
import com.spire.pdf.PdfDocument;
import com.spire.pdf.fields.PdfField;
import com.spire.pdf.widget.*;
 
public class FillFormField_PDF{
    public static void main(String[] args){
        
        //建立PdfDocument物件，並載入PDF文件
        PdfDocument doc = new PdfDocument();
        doc.loadFromFile("output.pdf");
 
        //獲取文件中的域
        PdfFormWidget form = (PdfFormWidget) doc.getForm();        
        //獲取域控制元件集合
        PdfFormFieldWidgetCollection formWidgetCollection = form.getFieldsWidget();
 
        //遍歷域控制元件並填充資料
        for (int i = 0; i < formWidgetCollection.getCount(); i++) {
            
            PdfField field = formWidgetCollection.get(i);         
            if (field instanceof PdfTextBoxFieldWidget) {
                PdfTextBoxFieldWidget textBoxField = (PdfTextBoxFieldWidget) field;
                textBoxField.setText("吳 敏");
            }  
            if (field instanceof PdfCheckBoxWidgetFieldWidget) {
                PdfCheckBoxWidgetFieldWidget checkBoxField = (PdfCheckBoxWidgetFieldWidget) field;
                switch(checkBoxField.getName()){
                case "CheckBox1":
                    checkBoxField.setChecked(true);
                    break;
                case "CheckBox2":
                    checkBoxField.setChecked(true);
                    break;
                }
            }
            if (field instanceof PdfRadioButtonListFieldWidget) {
                PdfRadioButtonListFieldWidget radioButtonListField = (PdfRadioButtonListFieldWidget) field;
                radioButtonListField.setSelectedIndex(1);
            }
            if (field instanceof PdfListBoxWidgetFieldWidget) {
                PdfListBoxWidgetFieldWidget listBox = (PdfListBoxWidgetFieldWidget) field;
                listBox.setSelectedIndex(1);
            }
            
            if (field instanceof PdfComboBoxWidgetFieldWidget) {
                PdfComboBoxWidgetFieldWidget comboBoxField = (PdfComboBoxWidgetFieldWidget) field;
                comboBoxField.setSelectedIndex(1);
            }
        }
        
        //儲存文件
        doc.saveToFile("FillFormFields.pdf", FileFormat.PDF);
    }
}

填充效果：


【示例3】限制表單域編輯（只讀） 

import com.spire.pdf.PdfDocument;
 
public class FieldReadonly_PDF {
    public static void main(String[] args) throws Exception {
    {
    //建立PdfDocument物件，並載入包含表單域的PDF文件
    PdfDocument pdf = new PdfDocument();
    pdf.loadFromFile("test.pdf");
    
    //將文件中的所有表單域設定為只讀
    pdf.getForm().setReadOnly(true);
    
    //儲存文件
    pdf.saveToFile("result.pdf");   
     }
  }


生成的文件中，表單域將不可編輯，為只讀狀態。


【示例4】獲取表單域值

     1. 獲取指定表單域值

 import com.spire.pdf.PdfDocument;
 import com.spire.pdf.widget.PdfFormWidget;
 import com.spire.pdf.widget.PdfTextBoxFieldWidget;
 
 import java.io.FileWriter;
 import java.io.IOException;
 
 public class GetSpecificFormfieldValue {
     public static void main(String[] args) {
         //載入PDF文件
         PdfDocument pdf = new PdfDocument();
         pdf.loadFromFile("test.pdf");
 
         //獲取表單域
         PdfFormWidget formWidget = (PdfFormWidget)pdf.getForm();
 
         //通過索引值來獲取指定表單域中的值
         PdfTextBoxFieldWidget textbox = ( PdfTextBoxFieldWidget)formWidget.getFieldsWidget().get(0);
         //PdfTextBoxFieldWidget textbox = ( PdfTextBoxFieldWidget)formWidget.getFieldsWidget().get("TextBox");//通過表單域名稱來獲取值
 
         //將獲取的值寫入txt文件
         String text = textbox.getText();
         try {
             //將文字寫入 .txt檔案
             FileWriter writer = new FileWriter("GetSpecificFormfieldValue.txt");
             writer.write(text);
             writer.flush();
         } catch (IOException e) {
             e.printStackTrace();
         }
         pdf.close();
     }
 }

指定表單域值獲取結果：


    2. 獲取全部表單域值

 import com.spire.pdf.PdfDocument;
 import com.spire.pdf.fields.PdfField;
 import com.spire.pdf.widget.*;
 
 import java.io.FileWriter;
 import java.io.IOException;
 
 public class GetAllFormfieldValue {
     public static void main(String[] args) {
         //載入PDF文件
         PdfDocument pdf = new PdfDocument();
         pdf.loadFromFile("測試.pdf");
 
         //獲取表單域
         PdfFormWidget formWidget = (PdfFormWidget)pdf.getForm();
         StringBuilder sb = new StringBuilder();
 
         //遍歷表單域控制元件集合並提取所有表單的值
         for (int i = 0; i < formWidget.getFieldsWidget().getCount(); i++)
         {
             PdfField field = (PdfField)formWidget.getFieldsWidget().getList().get(i);
 
             //獲取文字框的值
             if (field instanceof PdfTextBoxFieldWidget)
             {
                 PdfTextBoxFieldWidget textBoxField = (PdfTextBoxFieldWidget)field ;
                 String text = textBoxField.getText();
                 sb.append("文字框內容： " + text + "\r\n");
             }
 
             //獲取列表框的值
             if (field instanceof PdfListBoxWidgetFieldWidget)
             {
                 PdfListBoxWidgetFieldWidget listBoxField = (PdfListBoxWidgetFieldWidget)field;
 
                 //獲取列表框中選中的值
                 String selectedValue = listBoxField.getSelectedValue();
                 sb.append("列表框選中的內容： " + selectedValue + "\r\n");
 
                 //獲取列表框中的所有選項值
                 sb.append("列表框內容： \r\n");
                 PdfListWidgetItemCollection items = listBoxField.getValues();
                 for (PdfListWidgetItem item : (Iterable<PdfListWidgetItem>) items)
                 {
                     sb.append(item.getValue() + "\r\n");
                 }
             }
 
             //獲取組合框的值
             if (field instanceof PdfComboBoxWidgetFieldWidget)
             {
                 PdfComboBoxWidgetFieldWidget comBoxField = (PdfComboBoxWidgetFieldWidget)field ;
 
                 //獲取組合框中選中的值
                 String selectedValue = comBoxField.getSelectedValue();
                 sb.append("組合框選中的內容： " + selectedValue + "\r\n");
 
                 //獲取組合框中所有選項值
                 sb.append("組合框內容： \r\n");
                 PdfListWidgetItemCollection items = comBoxField.getValues();
                 for (PdfListWidgetItem item : (Iterable<PdfListWidgetItem>) items)
                 {
                     sb.append(item.getValue() + "\r\n");
                 }
             }
 
             //獲取單選按鈕值
             if (field instanceof PdfRadioButtonListFieldWidget)
             {
                 PdfRadioButtonListFieldWidget radioBtnField = (PdfRadioButtonListFieldWidget)field;
                 String Value = radioBtnField.getValue();
                 sb.append("單選按鈕內容： " + Value + "\r\n");
             }
 
             //獲取核取方塊值
             if (field instanceof PdfCheckBoxWidgetFieldWidget)
             {
                 PdfCheckBoxWidgetFieldWidget checkBoxField = (PdfCheckBoxWidgetFieldWidget)field;
                 //獲取核取方塊的選中狀態
                 boolean state = checkBoxField.getChecked();
                 sb.append("核取方塊是否被選中？ " + state + "\r\n");
             }
         }
 
         try {
             //將文字寫入 .txt檔案
             FileWriter writer = new FileWriter("GetAllFormfieldValues.txt");
             writer.write(sb.toString());
             writer.flush();
         } catch (IOException e) {
             e.printStackTrace();
         }
         pdf.close();
     }
 }

表單域讀取結果：

來自 “ ITPUB部落格 ” ，連結：http://blog.itpub.net/31499788/viewspace-2678010/，如需轉載，請註明出處，否則將追究法律責任。

相關文章