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

PDButton

PDButtonは、Apache PDFBoxのPDModel APIにおけるJavaクラスであり、PDFドキュメント内のボタンフォームフィールドを表現します。

キーワード: pdbutton, PDButton

概要

PDButtonは、Apache PDFBoxのPDModel APIにおけるJavaクラスであり、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 ) で定義されているボタンフィールドには、プッシュボタン、チェックボックス、ラジオボタンが含まれ、PDFフォームとのユーザーインタラクションを可能にします。この高レベルクラスは、開発者がプログラム的にボタンフィールドのプロパティと動作を作成、読み取り、変更するためのメソッドを提供します。

定義

PDButtonは、Apache PDFBoxライブラリ内の具象実装クラスであり、PDFieldクラス階層を拡張してボタン型フォームフィールドを専門的に処理します。 ( 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 ) で定義されているPDF用語において、ボタンはユーザーがアクションをトリガーしたりオプションを選択したりできるインタラクティブフォームフィールド(AcroFormフィールド)です。PDButtonは、これらのインタラクティブ要素を定義する基礎となるPDFディクショナリ構造に対するJava APIの抽象化を提供します。

このクラスは、PDTextFieldPDChoiceなどの他のフォームフィールドクラスとは異なり、3つのボタンサブタイプを専門的に処理します。それは、プッシュボタン(アクションをトリガー)、チェックボックス(二値選択のトグルコントロール)、ラジオボタン(グループ内の排他的オプション選択)です。各サブタイプは、状態の保存方法とユーザーインタラクションへの応答方法において独自の特性を持っています。

重要性

PDFフォームをプログラム的に扱う開発者にとって、PDButtonはユーザー入力を収集したりワークフローをトリガーしたりするインタラクティブドキュメントを作成するために不可欠です。このクラスを理解することで、開発者は異なるPDFリーダーや支援技術で動作するアクセシブルで準拠したフォームインターフェースを構築できるようになります。これは ( 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 ) などのアクセシビリティ標準を満たす上で特に重要です。

PDButtonにより、開発者はフォーム生成の自動化、フォーム値の事前入力、送信されたフォームからのユーザー選択の抽出、ボタンフィールド構成の検証が可能になります。これは、政府機関、金融機関、標準化されたデータ収集を必要とする医療システムなど、大量のPDFフォームを処理するエンタープライズアプリケーションにとって重要です。

仕組み

PDButtonは、PDF仕様に従ってボタンフィールドを定義する基礎となるPDFディクショナリオブジェクトをラップすることで動作します。インスタンス化されると、このクラスはJavaオブジェクト表現とドキュメント構造に格納されているPDFディクショナリのキーと値のペアの間を変換するゲッターメソッドとセッターメソッドを提供します。

チェックボックスとラジオボタンの場合、PDButtonはボタンが選択されているか未選択かを決定するアピアランスストリームと状態値を管理します。このクラスは、/AS(アピアランス状態)エントリを処理し、/AP(アピアランスディクショナリ)と連携して、視覚的表現がフィールドの値と一致するようにします。ラジオボタングループの場合、PDButtonは親子フィールド階層で動作し、個々のラジオボタンは共通の親フィールドの子になります。

プッシュボタンは、通常状態を保持せず、代わりにボタンがクリックされたときに発生する内容を定義するアクションディクショナリを参照する点で異なります。PDButtonは、これらのアクション参照を設定および取得するメソッドを提供し、開発者がプログラム的にJavaScriptアクション、フォーム送信アクション、またはナビゲーションアクションをボタンに割り当てることを可能にします。

このクラスは、PDFページ上のボタンの視覚的表現であるウィジェット注釈も管理します。これには、位置、サイズ、境界線スタイル、背景色、ツールチップテキストなどのプロパティが含まれます。 ( 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の場合、PDButtonを使用して適切な代替テキストとフォームフィールドの説明が存在することを確認できます。

関連用語

  • PDField – テキストフィールド、選択フィールド、ボタンを含むすべてのPDFフォームフィールドを表す親クラス
  • PDAnnotation – PDF注釈の基底クラスであり、フォームフィールドウィジェットをサブタイプとして含む
  • PDAcroForm – PDFドキュメント内のすべてのフォームフィールドを含むインタラクティブフォームディクショナリを表すクラス
  • PDAppearanceStream – フォームフィールド状態の視覚的表現を処理するクラス
  • PDAction – プッシュボタンや他のインタラクティブ要素によってトリガーされるアクションを表すクラス

出典

(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