PDActionSubmitForm
PDActionSubmitFormは、Apache PDFBoxライブラリにおいて、PDF文書内のフォーム送信アクションを表す特殊なクラスです。
PDActionSubmitFormは、Apache PDFBoxライブラリにおいて、PDF文書内のフォーム送信アクションを表す特殊なクラスです。このアクションタイプは、ボタンのクリックなどのユーザー操作によってトリガーされた際に、PDFフォームのフィールドデータを指定されたURLまたはサーバーエンドポイントへ送信することを可能にします。PDFBoxの高レベルPDModel APIの一部として、このクラスはPDF仕様 ( Citation: N.A., 2020 (N.A.). (2020). Document management — Portable document format — Part 2: PDF 2.0 . International Organization for Standardization Retrieved from https://www.iso.org/standard/75839.html ) で定義されたフォーム送信アクションのプロパティを読み取り、変更するためのプログラマティックなアクセスを提供します。
PDActionSubmitFormは、PDF標準で定義されたフォーム送信アクション機能をカプセル化するJavaクラスです。Apache PDFBoxのオブジェクトモデル内でPDActionインターフェースを拡張または実装し、特に/SubmitFormアクションタイプを処理します。このクラスにより、開発者は送信URL、HTTPメソッド（GETまたはPOST）、送信対象フィールド、およびデータ送信のフォーマットと動作を制御する各種送信フラグなどのプロパティにアクセスし、操作することができます。
PDActionResetForm（フォームフィールドをクリアするクラス）やPDActionJavaScript（スクリプトを実行するクラス）とは異なり、PDActionSubmitFormは外部エンドポイントへのフォームデータの送信を専門的に処理します。また、低レベルのCos（Carousel Object Structure）クラスとは異なり、基礎となるPDF辞書構造を自動的に処理する開発者にとって使いやすい抽象化レイヤーを提供します。
インタラクティブなPDFフォームを扱う開発者にとって、PDActionSubmitFormは自動化されたフォーム送信ワークフローを実装する上で不可欠です。このクラスにより、フォーム送信エンドポイントのプログラマティックな設定が可能になり、アプリケーションは送信URLを動的に更新したり、送信に含めるフィールドを変更したり、PDF辞書を手動で編集することなく送信フォーマットを変更したりできます。
この機能は、PDFフォームがWebサービス、コンテンツ管理システム、またはドキュメント処理パイプラインと統合する必要があるエンタープライズ環境で特に価値があります。開発者はPDActionSubmitFormを使用してPDFフォーム内の送信ボタンを作成または変更し、フォームデータが処理、検証、または保存のためにバックエンドシステムへ正しく流れることを保証できます。
PDActionSubmitFormは、フォーム送信アクションを表す基礎となるCOS（PDFオブジェクト構造）辞書をラップすることで動作します。PDFにフォーム送信アクションを持つボタンまたは他のウィジェットが含まれている場合、PDFBoxはPDF構造をPDActionSubmitFormオブジェクトにデシリアライズし、アクションプロパティを読み取りおよび変更するためのメソッドを公開します。
このクラスを通じてアクセス可能な主要なプロパティには以下が含まれます：
- URL/URI：フォームデータが送信される宛先エンドポイント
- Fields配列：送信に含めるまたは除外するフォームフィールドを指定
- Flags：データフォーマット（FDF、XFDF、PDF、HTML）、空のフィールドを含めるかどうか、GETまたはPOSTメソッドを使用するかどうかなどの送信動作を制御
- エクスポートフォーマット：フォームデータが送信のためにどのようにエンコードされるかを決定
開発者は通常、フォームフィールドウィジェットを反復処理し、それらのアクションを取得し、アクションタイプがフォーム送信アクションであるかどうかを確認することで、PDActionSubmitFormインスタンスにアクセスします。このクラスは、Javaオブジェクトと基礎となるPDF辞書構造の間の変換を自動的に処理するgetterおよびsetterメソッドを提供し、開発プロセスを簡素化します。
- PDAction – PDFBoxにおけるすべてのアクションタイプを表す基底インターフェースまたは抽象クラス
- PDActionResetForm – フォームフィールド値をクリアまたはリセットする関連アクションクラス
- PDAnnotationWidget – 関連するアクションを持つことができるインタラクティブなフォームフィールドウィジェットを表す
- PDAcroForm – PDF文書内のインタラクティブなフォーム構造を表すメインクラス
- Forms Data Format (FDF) – PDFフォームデータの送信に一般的に使用されるファイルフォーマット
- (N.A.) (2020)
- (N.A.). (2020). Document management — Portable document format — Part 2: PDF 2.0 . International Organization for Standardization Retrieved from https://www.iso.org/standard/75839.html