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

PDPageAdditionalActions

PDPageAdditionalActionsは、Apache PDFBox PDModel APIのクラスで、PDFページに関連付けられた追加アクションを表します。

キーワード: pdpageadditionalactions, PDPageAdditionalActions

概要

PDPageAdditionalActionsは、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 ) で定義されたアクション辞書エントリを読み取り、変更するためのメソッドを提供します。

定義

PDPageAdditionalActionsは、Apache PDFBoxにおける高レベルのラッパークラスで、PDFページオブジェクトのAdditional-Actions(AA)辞書をカプセル化します。この辞書は、ページイベントと、そのイベントが発生したときに実行されるべき対応するアクションをマッピングします。このクラスは、ページオープン(O)イベントやページクローズ(C)イベントを含む特定のページトリガーに対するgetterおよびsetterメソッドを提供します。ドキュメントレベルの追加アクションやフィールドレベルの追加アクションとは異なり、PDPageAdditionalActionsは、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 ) で規定されたページ固有のインタラクティブな動作を定義する、基盤となるCOS(Carousel Object Structure)辞書エントリへの型安全なアクセスを提供することで、基本的なPDFBoxモデルを拡張しています。

重要性

インタラクティブなPDF文書を扱う開発者にとって、PDPageAdditionalActionsは、低レベルの辞書構造を手動で操作することなく、ページレベルの動作をプログラム的に制御できるようにします。これは、ユーザーがページ間を移動する際に特定の初期化やクリーンアップアクションを必要とするアクセシブルな文書を作成する場合に特に重要です。適切なイベント処理は、支援技術のユーザーエクスペリエンスを向上させることができます。このクラスは、ページが読み込まれたときの自動フォームフィールド計算、ナビゲーション要素の更新、ページから離れるときのクリーンアップスクリプトの実行などの機能実装を簡素化します。このクラスの理解は、特にフォーム、マルチメディアコンテンツ、またはページナビゲーションに紐づいた動的な動作を必要とする文書を扱う際に、インタラクティブなPDF機能を維持または拡張する必要がある開発者にとって不可欠です。

仕組み

PDPageAdditionalActionsは、ページの追加アクションエントリを含むCOSDictionaryオブジェクトをラップすることで動作します。開発者は、ページのAAエントリから既存のCOSDictionaryを使用してクラスをインスタンス化するか、ページにアクションを追加するために新しいインスタンスを作成します。このクラスは、setO(PDAction action)のようなメソッドを提供し、ページが開かれたときに実行されるアクションを設定したり、setC(PDAction action)でページが閉じられたときのアクションを設定したりします。各メソッドは、JavaScriptアクション、GoToアクション、URIアクションなど、さまざまなアクションタイプを表現できるPDActionオブジェクトを受け取ります。既存のアクションを読み取る場合、対応するgetterメソッドは、検査または変更が可能なPDActionオブジェクトを返します。このクラスは、高レベルのPDActionオブジェクトと基盤となるCOS辞書エントリ間の変換を自動的に処理し、結果として得られるPDF構造がページ追加アクション辞書に関するPDF仕様の要件に準拠していることを保証します。これらのアクションをページに適用するには、開発者はページのPDPageオブジェクトを取得し、そのsetActions(PDPageAdditionalActions actions)メソッドを使用してアクション辞書をページに関連付けます。

関連用語

  • PDAction – PDF文書内のイベントによってトリガーされるアクションを表す基底クラス
  • PDPage – PDF文書内の単一ページを表すApache PDFBoxクラス
  • PDDocumentCatalogAdditionalActions – ドキュメントイベントによってトリガーされるドキュメントレベルの追加アクションを管理するクラス
  • PDAnnotation – 追加アクションを関連付けることができるPDFアノテーションを表すクラス
  • COSDictionary – PDFファイル構造内の辞書オブジェクトを表す低レベルのPDFBoxクラス

出典

(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