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

PDActionLaunch

PDActionLaunchは、Apache PDFBox PDModel APIのクラスで、PDF文書内の起動アクション(launch action)を表現します。

キーワード: pdactionlaunch, PDActionLaunch

概要

PDActionLaunchは、Apache PDFBox PDModel APIのクラスで、PDF文書内の起動アクション(launch action)を表現します。 ( 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文書が外部ファイルやアプリケーションを開いたり、コマンドを実行したりすることを可能にします。このクラスは、Java開発者がPDF文書内の起動アクションをプログラム的に読み取り、作成、変更するためのメソッドを提供します。

定義

PDActionLaunchは、Apache PDFBoxのPDModel APIレイヤー内の高レベルJavaクラスで、PDFの起動アクション辞書構造をカプセル化します。PDF用語では、起動アクション(アクションタイプ「Launch」)は、PDFビューアに外部アプリケーションの起動または別の文書を開くよう指示します。このクラスはPDActionを継承しており、PDActionはPDFBox内のすべてのアクションタイプの基底クラスです。PDActionLaunchは、ファイル仕様、新しいウィンドウで文書を開くかどうか、プラットフォーム固有の起動パラメータなど、起動アクションのプロパティにアクセスして操作するための専用メソッドを提供します。

PDActionGoTo(同じ文書内をナビゲート)やPDActionURI(WebのURLを開く)などの他のアクションタイプとは異なり、PDActionLaunchは外部ファイルやアプリケーションの起動を専門的に処理します。このクラスは、基礎となるCOS(Carousel Object Structure)辞書のラッパーとして機能し、低レベルのPDF構文をJava開発者が直感的に扱えるオブジェクト指向インターフェースに抽象化します。

重要性

インタラクティブなPDF文書を扱う開発者にとって、PDActionLaunchは外部リソースとの統合が必要なワークフローを実装する際に不可欠です。一般的なユースケースには、ヘルパーアプリケーションを起動する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仕様への準拠を維持しながら、起動アクションを適切に実装、検証、または変更できるようになります。

セキュリティとアクセシビリティの観点から、起動アクションは慎重な取り扱いが必要です。開発者は、起動アクションが任意のコマンドを実行できるためセキュリティリスクをもたらす可能性があることを認識し、適切な検証が極めて重要であることを理解する必要があります。さらに、 ( 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を扱う場合、開発者は起動アクションに適切な代替説明を含め、文書の論理構造に適切に統合されていることを確認する必要があります。

仕組み

PDActionLaunchは、Javaメソッド呼び出しを、起動アクションを定義する基礎となるPDF辞書エントリにマッピングすることで機能します。開発者がPDActionLaunchのインスタンスを作成する際、setterメソッドを使用して、起動するファイル(PDFileSpecificationを使用)、新しいウィンドウフラグ(文書を新しいウィンドウで開くかどうかを決定)、Windows、Unix、またはMac操作用のプラットフォーム固有のパラメータなどのプロパティを定義できます。

このクラスは、アクション辞書を適切な場所(通常は注釈、フォームフィールド、またはアウトライン項目に添付)に格納することで、PDF文書構造と相互作用します。PDFビューアが文書を処理して起動アクションのトリガーに遭遇すると、これらの辞書エントリを読み取って、どのファイルまたはアプリケーションをどのようなパラメータで起動するかを決定します。

PDActionLaunchが管理する主要なプロパティは以下の通りです:

  • ファイル仕様:起動するファイルまたはアプリケーションを定義し、PDFileSpecificationオブジェクトで表現されます
  • NewWindowフラグ:起動された文書を新しいウィンドウで開くべきかどうかを示すブール値
  • Win/Unix/Mac辞書:異なるオペレーティングシステムでアクションがどのように実行されるかを制御するプラットフォーム固有の起動パラメータ

開発者は通常、PDAnnotationオブジェクトのgetAction()などのメソッドを使用して注釈から既存の起動アクションを取得するか、PDActionLaunchをインスタンス化してPDF文書構造内のインタラクティブ要素に添付することで新しいアクションを作成します。

関連用語

  • PDAction – 起動、URI、ナビゲーションアクションを含む、Apache PDFBox内のすべてのアクションタイプの基底クラス
  • PDAnnotation – PDF内のインタラクティブ要素で、ユーザーの操作に応じてPDActionLaunchなどのアクションをトリガーできます
  • PDFileSpecification – PDF内のファイル参照を表すクラスで、PDActionLaunchが開くファイルを指定する際に使用されます
  • PDActionURI – WebのURLを開くためのアクションクラスで、PDActionLaunchと似ていますが、HTTP/HTTPSリソース専用です
  • COSDictionary – PDActionLaunchがラップして抽象化する低レベルのCarousel Object Structure辞書

出典

(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