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

PDOutlineItem

PDOutlineItemは、Apache PDFBox PDModel APIにおけるクラスで、PDF文書のアウトライン階層内の個別項目を表現します。

キーワード: pdoutlineitem, PDOutlineItem

概要

PDOutlineItemは、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 ) で定義されているアウトライン項目辞書に対応し、ユーザーがPDF文書内の特定の位置にジャンプできるナビゲーション構造を提供します。PDOutlineItemクラスは、タイトル、移動先、アクション、階層関係などのブックマークプロパティを読み取りおよび変更するためのメソッドを提供します。

定義

PDOutlineItemは、 ( 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クラスです。各PDOutlineItemオブジェクトは、文書のブックマークツリー構造内の単一ノードを表し、親、兄弟、子アウトライン項目との関係を維持します。PDFデータ構造を直接表現する低レベルのCOSDictionaryオブジェクトとは異なり、PDOutlineItemは、PDF構文の詳細な知識を必要とせずにブックマークプロパティを操作するための開発者にとって使いやすいメソッドを提供します。このクラスは、表示タイトルの設定、ナビゲーションターゲット(移動先)の定義、視覚的表示属性(色、フォントスタイル)の構成、ネストされたブックマークの階層ツリー構造の管理など、一般的なブックマーク操作を処理します。

重要性

PDF文書を扱う開発者にとって、PDOutlineItemは、複雑な文書内にアクセス可能でユーザーフレンドリーなナビゲーションを作成するために不可欠です。ブックマークは、特に長大な技術マニュアル、レポート、構造化された文書において、迅速なナビゲーションが重要な場合に、文書の使いやすさを大幅に向上させます。 ( 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を作成する際、適切に構造化されたアウトラインは、支援技術が障害を持つユーザーにより良いナビゲーション体験を提供するのに役立ちます。PDOutlineItemにより、開発者は、PDFを結合したり、動的な文書を作成したり、他の形式からコンテンツを変換したりする際に、プログラム的にブックマーク構造を生成、変更、または抽出できます。このクラスは、ブックマーク構造の検証、文書変更後のタイトルの更新、ブックマークが文書内の有効な移動先を指していることの確認など、タスクの自動化も可能にします。

仕組み

PDOutlineItemは、Apache PDFBoxの3層アーキテクチャ内で動作し、基礎となるCOS(Carousel Object Structure)レイヤーの上にPDModelレベルの抽象化として機能します。アウトライン項目を操作する際、開発者は通常、文書のルートPDDocumentOutlineオブジェクトを取得し、getFirstChild()getNextSibling()などのメソッドを使用してその子要素をナビゲートします。各PDOutlineItemは、setTitle()を使用してタイトルを設定し、setDestination()またはsetAction()を使用して移動先またはアクションに関連付け、setTextColor()setItalic()などのメソッドを通じて視覚的属性でスタイル設定できます。階層構造は、明示的な親子関係を通じて維持され、開発者はaddLast()を使用して子要素を追加したり、特定の位置に挿入したりできます。新しいアウトライン項目を作成する際、開発者はPDOutlineItemオブジェクトをインスタンス化し、アウトラインツリーに追加する前にそのプロパティを設定することで、 ( 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仕様で要求される基礎となる辞書エントリ、キー、参照を自動的に処理するため、開発者は生のPDF構文ではなく、直感的なJavaオブジェクトを使用して作業できます。

関連用語

  • PDDocumentOutline – PDF文書のブックマーク階層内のトップレベルのアウトライン項目を保持するルートコンテナオブジェクト
  • PDPageDestination – アウトライン項目がナビゲートできるPDF文書内のターゲット位置を表すオブジェクト
  • PDAction – アウトライン項目がアクティブ化されたときに実行される動作(ナビゲーションやJavaScript実行など)を定義するPDFアクションオブジェクト
  • PDModel – Apache PDFBoxにおける高レベルAPIレイヤーで、PDF操作のための開発者にとって使いやすいクラスを提供する
  • COSDictionary – PDFBoxにおける低レベルのデータ構造で、PDFの辞書オブジェクトを表現し、PDOutlineItemがブックマーク機能のためにラップする

出典

(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