Skip to main content
Interwork Corporation
IDR Solutions Product Support Portal
PDF開発用語集 モードの切替 ダーク/ライト/自動 モードの切替 ダーク/ライト/自動 モードの切替 ダーク/ライト/自動

PDFormFieldAdditionalActions

PDFormFieldAdditionalActionsは、Apache PDFBox PDModel APIのクラスであり、PDFドキュメント内のフォームフィールドに関連付けられた追加アクションを表します。

キーワード: pdformfieldadditionalactions, PDFormFieldAdditionalActions

概要

PDFormFieldAdditionalActionsは、Apache PDFBox PDModel APIのクラスであり、PDFドキュメント内のフォームフィールドに関連付けられた追加アクションを表します。これらの追加アクションは、PDF仕様 ( Citation: N.A., (N.A.). (). Document management — Portable document format — Part 2: PDF 2.0 International Organization for Standardization Retrieved from https://www.iso.org/standard/75839.html ) で規定されているように、特定のユーザーイベントやフォームフィールド内の状態変化に応じて発生するインタラクティブな動作を定義します。このクラスは、基本的なフィールド機能を超えてフォームのインタラクティブ性を強化する、トリガーベースのアクションを読み取りおよび変更するためのメソッドを提供します。

定義

PDFormFieldAdditionalActionsは、Apache PDFBoxにおける高レベルのJavaクラスで、PDFフォームフィールドのAA(Additional Actions)ディクショナリをカプセル化します。このディクショナリは、フィールドがフォーカスを取得または喪失したとき、値が変更されたとき、フィールドのフォーマット処理の前後など、特定のイベントが発生したときに自動的に実行されるアクションを定義します。外観やデータ検証を定義する標準的なフォームフィールドプロパティとは異なり、追加アクションはユーザーインタラクションに対する動的な動作応答を制御します。

このクラスは、 ( Citation: N.A., (N.A.). (). Document management — Portable document format — Part 2: PDF 2.0 International Organization for Standardization Retrieved from https://www.iso.org/standard/75839.html ) で定義されているフォームフィールドのディクショナリ内のAAエントリにマッピングされ、キーストローク検証、フォーマット計算、フィールドエントリ(フォーカス)、フィールドエグジット(ブラー)、値変更イベントなど、さまざまなトリガータイプのgetterおよびsetterメソッドを提供します。PDFormFieldAdditionalActionsは、ボタンのマウスクリックのような即座のアクションではなく、イベント駆動型の動作を処理する点で、直接的なフォームフィールドアクションとは異なります。

重要性

Apache PDFBoxでインタラクティブなPDFフォームを構築する開発者にとって、PDFormFieldAdditionalActionsは、ユーザーエクスペリエンスとデータ品質を向上させる高度なフォーム動作を可能にします。このクラスにより、JavaScriptベースのフィールド検証、フィールド間の自動計算、入力値の動的フォーマット、条件付きフィールド動作など、プロフェッショナルなフォームアプリケーションに不可欠な機能をプログラム的に実装できます。

追加アクションの理解と適切な実装は、PDF/UA ( Citation: N.A., (N.A.). (). Document management applications — Electronic document file format enhancement for accessibility — Part 1: Use of ISO 32000-1 (PDF/UA-1) International Organization for Standardization Retrieved from https://www.iso.org/standard/64599.html ) などの規格に準拠したアクセシブルなPDFフォームを作成する際に特に重要です。これらのアクションは、支援技術とのインタラクションやユーザーのナビゲーションパターンに影響を与える可能性があるためです。追加アクションを適切に処理しないと、フォームが処理、編集、または変換される際に重要な機能が失われ、フィールドレベルの自動化に依存するビジネスワークフローが破損する可能性があります。

仕組み

PDFormFieldAdditionalActionsは、PDFフォームフィールドのAAディクショナリのJavaオブジェクト表現を提供することで機能します。既存のPDFからインスタンス化される際、このクラスは、サポートされている各トリガータイプのアクションディクショナリへの参照を含む基礎となるCOS(Carousel Object Structure)ディクショナリを読み取ります。

このクラスを通じてアクセス可能な主なトリガータイプには以下が含まれます:

  • K(Keystroke):文字が入力される際にユーザー入力を検証
  • F(Format):表示用にフィールド値をフォーマット
  • V(Validate):フォーカスが離れる際に完全なフィールド値を検証
  • C(Calculate):他のフィールドに基づいてフィールド値を再計算

各トリガーはPDActionオブジェクト(通常、スクリプトベースのアクションの場合はPDActionJavaScript)として表され、対応するgetterおよびsetterメソッドを通じて取得または設定できます。PDFormFieldAdditionalActionsを使用する際、開発者は通常、フォームフィールドの追加アクションを取得し、適切なJavaScriptコードまたはアクションタイプで特定のアクショントリガーを変更または作成し、更新されたアクションを ( Citation: N.A., (N.A.). (). Document management — Portable document format — Part 2: PDF 2.0 International Organization for Standardization Retrieved from https://www.iso.org/standard/75839.html ) で定義されているフォームフィールドのディクショナリ構造に関連付けます。

関連用語

  • PDFormField – 追加アクションを含む親フォームフィールドクラス
  • PDAction – PDFドキュメント内の実行可能なアクションを表す基底クラス
  • PDActionJavaScript – PDFビューアでJavaScriptコードを実行する特定のアクションタイプ
  • PDAnnotationWidget – 追加アクションをトリガーできるフォームフィールドの視覚的表現
  • COSDictionary – 追加アクション定義を格納する低レベルのディクショナリ構造

出典

(N.A.) (2020)
(N.A.). (). Document management — Portable document format — Part 2: PDF 2.0 International Organization for Standardization Retrieved from https://www.iso.org/standard/75839.html
(N.A.) (2014)
(N.A.). (). Document management applications — Electronic document file format enhancement for accessibility — Part 1: Use of ISO 32000-1 (PDF/UA-1) International Organization for Standardization Retrieved from https://www.iso.org/standard/64599.html