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

PDOptionalContentProperties

PDOptionalContentPropertiesは、Apache PDFBox PDModel APIの高レベルクラスで、PDF文書のオプショナルコンテンツ(OC)設定へのプログラマティックなアクセスを提供します。

キーワード: pdoptionalcontentproperties, PDOptionalContentProperties

概要

PDOptionalContentPropertiesは、Apache PDFBox PDModel APIの高レベルクラスで、PDF文書のオプショナルコンテンツ(OC)設定へのプログラマティックなアクセスを提供します。 ( 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作成者がユーザー設定やアプリケーション状態に基づいて、コンテンツのレイヤーを選択的に表示または非表示にすることを可能にします。このクラスを使用することで、開発者はPDF文書内のオプショナルコンテンツグループとそのプロパティの読み取り、変更、管理を行うことができます。

定義

PDOptionalContentPropertiesは、PDF文書のカタログにあるオプショナルコンテンツプロパティ辞書(OCPropertiesエントリ)を表現します。この辞書は、PDF内のすべてのレイヤーベースのコンテンツ可視性制御の中心的な設定ポイントとして機能します。このクラスは、オプショナルコンテンツグループ(OCG)、オプショナルコンテンツメンバーシップ辞書(OCMD)、および異なる表示条件下でレイヤーがどのように動作するかを決定する設定にアクセスするメソッドを提供します。

PDF構文を直接扱うPDFBoxの低レベルCOS(Carousel Object System)クラスとは異なり、PDOptionalContentPropertiesはPDModelパッケージの一部であり、基礎となるPDF構造に対する開発者フレンドリーな抽象化を提供します。個々のオプショナルコンテンツグループクラスとの違いは、個別のレイヤーインスタンスではなく、文書全体のオプショナルコンテンツシステムを管理する点にあります。

重要性

レイヤー化されたPDF文書を扱う開発者にとって、PDOptionalContentPropertiesはレイヤー可視性制御の実装や複雑な文書プレゼンテーションの管理に不可欠です。この機能は、技術図面、地図、多言語文書、またはユーザーのニーズやデバイス機能に基づいてコンテンツを選択的に表示する必要があるアクセシブルな文書を扱うアプリケーションを構築する際に特に重要です。

このクラスにより、開発者は異なるコンテキストでどのレイヤーを表示するかをプログラマティックに制御できます。これは、印刷用と画面表示用で簡略化されたビューを表示する、言語固有のコンテンツレイヤーを表示する、または注釈やマークアップの可視性を管理するといったユースケースをサポートします。 ( 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 ) のような標準に準拠したアクセシビリティ実装では、オプショナルコンテンツの適切な管理により、メインコンテンツフローを乱すことなく補足情報の表示を制御できます。

仕組み

PDOptionalContentPropertiesは、PDFオプショナルコンテンツシステムの3つの主要コンポーネントへのアクセスを提供することで動作します。

オプショナルコンテンツグループ(OCG):これらは個々のレイヤーまたはコンテンツのコレクションを表す基本単位です。このクラスは、文書内のすべてのOCGを取得したり、新しいグループを追加したり、既存のグループを削除したりするメソッドを提供します。各OCGには、名前、目的(intent)、使用情報など、その動作を制御するプロパティがあります。

設定辞書:これらは異なる表示コンテキスト(「View」、「Print」、「Export」など)を定義し、各コンテキストでどのOCGを表示するかを指定します。PDOptionalContentPropertiesを使用することで、開発者はデフォルト設定と文書に保存されている代替設定にアクセスできます。

管理操作:このクラスは、オプショナルコンテンツグループの現在の状態の照会、可視性設定の変更、オプショナルコンテンツ設定の更新をサポートします。開発者はプログラマティックにレイヤーを有効または無効にしたり、初期可視性状態を設定したり、親子関係やラジオボタングループを通じてレイヤーがどのように相互作用するかを設定したりできます。

PDOptionalContentPropertiesを使用する際、開発者は通常、PDDocumentのカタログからインスタンスを取得し、オプショナルコンテンツ構造を照会または変更し、変更をPDFに保存します。このクラスは、高レベルのPDModel表現と、 ( 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レベルのPDF構造との間の同期を処理します。

関連用語

  • PDDocument – インメモリPDF文書を表すApache PDFBoxのメインクラス
  • PDOptionalContentGroup – PDF内の個別のオプショナルコンテンツグループ(レイヤー)を表現
  • PDPage – オプショナルコンテンツを含む可能性のあるPDF文書の単一ページを表現
  • PDResources – オプショナルコンテンツに関連付けられる可能性のある画像やフォントなどのリソースを管理
  • COSDictionary – Carousel Object SystemにおけるPDF辞書オブジェクトを表す低レベルクラス

出典

(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