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

PDActionHide

PDActionHideは、Apache PDFBoxの高レベルPDModel APIに含まれるクラスで、PDF仕様で定義されているHideアクションタイプを表します。

キーワード: pdactionhide, PDActionHide

概要

PDActionHideは、Apache PDFBoxの高レベルPDModel APIに含まれるクラスで、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 ) で定義されているHideアクションタイプを表します。このアクションにより、PDFドキュメントは、ユーザーの操作やその他のトリガーに応じて、注釈、フォームフィールド、その他のインタラクティブ要素をプログラム的に表示または非表示にすることができます。PDActionHideクラスは、PDFBoxのオブジェクト指向インターフェースを使用して、PDFドキュメント内のHideアクションを読み取り、操作するためのメソッドをJava開発者に提供します。

定義

PDActionHideは、Apache PDFBoxのorg.apache.pdfbox.pdmodel.interactive.actionパッケージ内の具象実装クラスで、PDFのHideアクションタイプに対応しています。PDFにおけるHideアクションは、ドキュメント構造から要素を削除することなく、注釈やフォームフィールドの表示状態を制御するように設計されています。目的地に移動するGoToアクションや、Webリンクを開くURIアクションなど、他のアクションタイプとは異なり、Hideアクションは指定された注釈の可視性を切り替えることで、視覚的なプレゼンテーション層を具体的に変更します。

PDActionHideクラスはPDAction基底クラスを継承し、どの注釈やフォームフィールドが影響を受けるべきか、それらを非表示にするか表示するか、どのような条件でアクションを実行するかを指定するメソッドを実装しています。これは、単に注釈を削除することとは異なり、非表示にされた要素はドキュメント構造の一部として残り、後でプログラム的に再表示することができます。

重要性

Hideアクションは、ユーザー入力やワークフロー状態に基づいてコンテンツの可視性を変更する必要がある、動的でインタラクティブなPDFフォームやドキュメントを作成する上で特に重要です。複雑なPDFフォームを扱う開発者にとって、注釈の可視性をプログラム的に制御する機能により、関連する場合にのみ表示される条件付きフォームセクション、段階的な情報開示インターフェース、コンテキスト依存のヘルプ注釈など、洗練されたユーザー体験を実現できます。

PDActionHideの理解は、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ドキュメントを開発する際に不可欠です。不適切に非表示にされたフォームフィールドは、スクリーンリーダーのナビゲーションやドキュメント構造に影響を与える可能性があるためです。開発者は、ドキュメントのアクセシビリティと論理的な読み取り順序を維持するために、非表示のインタラクティブ要素が正しく処理されるようにする必要があります。

仕組み

PDActionHideクラスは、 ( 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構造内のHideアクションを定義する辞書エントリをカプセル化することで機能します。PDFBoxを通じてHideアクションを作成または変更する際、開発者はPDF辞書を直接操作するのではなく、PDActionHideオブジェクトのメソッドを通じて操作します。

主な技術的側面は以下の通りです:

  • ターゲットの指定:アクションは、注釈辞書またはフィールド名を通じてターゲット注釈を識別します。PDActionHideは、これらのターゲットをPDAnnotationオブジェクトまたは文字列識別子として設定・取得するメソッドを提供します。

  • Hideフラグ:ブール値のフラグは、アクションが指定された注釈を非表示にするか(true)、表示するか(false)を決定します。このフラグは、クラスのgetterおよびsetterメソッドを通じてアクセスおよび変更できます。

  • アクションのトリガー:Hideアクションは通常、注釈アクション(ボタンクリックなど)やページイベントに関連付けられます。PDActionHideオブジェクトは、それぞれのアクションプロパティを通じて、ウィジェット注釈、リンク、その他のインタラクティブ要素に割り当てることができます。

  • 複数のターゲット:単一のHideアクションは、複数の注釈に同時に影響を与えることができます。PDActionHideクラスは、ターゲット注釈またはフィールド名の配列を管理するメソッドをサポートしています。

PDFビューアがユーザーの操作中にHideアクションに遭遇すると、ドキュメントの基盤構造や注釈配列内の注釈の存在を変更することなく、可視性を制御する注釈プロパティを変更することでアクションを処理します。

関連用語

  • PDAction – Apache PDFBoxにおけるすべてのPDFアクションタイプの抽象基底クラス
  • PDAnnotation – Hideアクションのターゲットとなり得るPDF注釈を表す
  • PDFormField – Hideアクションを使用して表示または非表示にできるフォームフィールドを表す
  • Action Triggers – 関連するPDFアクションを実行するイベントまたはユーザー操作
  • Widget Annotation – 条件付き表示のためにHideアクションを一般的に使用するインタラクティブなフォーム要素

出典

(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