PDListBox

PDListBoxは、Apache PDFBox PDModel API内のクラスで、PDF文書内のリストボックスフォームフィールドを表します。リストボックスは、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 ) で定義されているインタラクティブなフォーム要素で、ユーザーがスクロール可能なオプションリストから1つまたは複数の項目を選択できるようにします。この高レベルAPIクラスは、開発者にPDFフォーム内のリストボックスのプロパティと動作をプログラムで作成、読み取り、変更するためのメソッドを提供します。

PDListBoxは、Apache PDFBoxのフォームフィールド階層内の特殊なサブクラスで、PDFフォーム(AcroFormsとも呼ばれる)内のリストボックスウィジェットを具体的に処理します。単一の選択項目のみを表示するために折りたたまれるコンボボックス(ドロップダウンメニュー)とは異なり、リストボックスはスクロール可能な長方形の領域内に複数の表示可能なオプションを同時に表示します。このクラスはPDChoiceを継承しており、PDChoiceはリストボックスとコンボボックスの両方の親クラスで、共通の選択ベースの機能を継承しながらリストボックス固有の動作を実装しています。PDListBoxは、利用可能なオプションのリスト、現在選択されている値、視覚的な外観設定、複数選択が許可されているかどうかなどのプロパティへのアクセスを提供します。これは、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 ) に従ってリストボックスフィールドを定義する基礎となるPDFディクショナリ構造のJavaオブジェクト表現として機能します。

PDFフォームを扱う開発者にとって、PDListBoxはユーザーから構造化されたデータを収集するアクセシブルでインタラクティブな文書を作成するために不可欠です。このクラスを理解することで、開発者は動的なPDFフォームを生成し、データベースやAPIからのデータでリストボックスを事前入力し、送信されたフォームからユーザーの選択を抽出し、フォーム入力を検証するアプリケーションを構築できます。これは、PDF/UA ( Citation: N.A., 2014 (N.A.). (2014). 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を作成する際に特に重要です。適切な属性を持つ正しく構成されたフォームフィールドは、支援技術が障害のあるユーザーにフォームコントロールを提示するのに役立つためです。このクラスは基礎となるPDF構造の複雑さを抽象化し、開発者が低レベルのPDFディクショナリを直接操作するのではなく、直感的なJavaメソッドで作業できるようにします。

PDListBoxは、PDFフィールド定義を含むCOSDictionaryオブジェクトをラップし、そのプロパティと対話するためのJavaメソッドを提供することで機能します。新しいリストボックスを作成する際、開発者はPDFのフォームを表すPDAcroFormオブジェクトをインスタンス化し、次にPDListBoxインスタンスを作成してフォームのフィールド階層に追加します。このクラスは、利用可能な選択肢を定義するためのsetOptions()(文字列の配列またはエクスポート値のペアとして)、項目をプログラムで選択するためのsetValue()またはsetSelectedOptionsIndex()、ユーザーが複数の項目を選択できるかどうかを制御するためのsetMultiSelect()などのメソッドを提供します。視覚的な外観は、フィールドの位置、サイズ、特定のページでのレンダリングを定義する関連するウィジェット注釈を通じて管理されます。既存のPDFを読み取る際、開発者はPDDocumentからPDAcroFormを取得し、getField()などのメソッドを通じてPDListBoxにアクセスし、getValue()やgetOptions()などのメソッドを使用して現在の状態を照会します。このクラスは、Javaデータ構造と ( 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 ) で定義された実際のPDF構文を表す基礎となるCOS(Carousel Object Structure)レイヤー間の変換を処理します。

• PDAcroForm – PDF文書内の完全なインタラクティブフォーム構造を表すクラス
• PDComboBox – 単一の値を表示するために折りたたまれるドロップダウン選択メニュー用の関連フォームフィールドクラス
• PDChoice – リストボックスやコンボボックスを含む選択ベースのフォームフィールドの親抽象クラス
• PDField – Apache PDFBoxのPDModel API内のすべてのフォームフィールドタイプの基底クラス
• COSDictionary – フィールド定義を格納するPDFディクショナリオブジェクトを表す低レベルクラス