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

PDPageLabelRange

PDPageLabelRangeは、Apache PDFBoxの高レベルPDModel APIに含まれるクラスで、PDF文書内のページラベリング情報にプログラムからアクセスする機能を提供します。

キーワード: pdpagelabelrange, PDPageLabelRange

概要

PDPageLabelRangeは、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 ) で定義されているように、文書内の物理的なページ位置とは異なるカスタムページ識別子(ローマ数字、アルファベット、カスタムプレフィックスなど)を表示できます。このクラスにより、開発者は既存のページラベル設定を読み取ったり、PDFページの新しいラベリングスキームを作成したりできます。

定義

PDPageLabelRangeは、PDF文書のページラベル辞書内の単一のページラベル範囲を表します。PDF文書では、単純な連番ではなく、異なる番号スタイルやプレフィックスでページにラベルを付けることができます。たとえば、前付けには小文字のローマ数字(i、ii、iii)を使用し、本文にはアラビア数字(1、2、3)を使用する場合があります。各PDPageLabelRangeオブジェクトは、番号スタイル、開始値、プレフィックステキストなど、そのような範囲のプロパティをカプセル化します。このクラスは、実際のページコンテンツを表すPDPageや、文書のページ階層を管理するPDPageTreeなど、他のページ関連PDFBoxクラスとは異なり、PDFビューアでの表示目的でページがどのようにラベル付けされるかに専念しています。

重要性

ページラベルを理解し適切に実装することは、非連続的または特殊なページ番号付けが必要な専門的な文書を扱う開発者にとって極めて重要です。法的文書、学術論文、書籍、技術マニュアルでは、異なるセクションに異なる番号スキームを使用することが頻繁にあります。アクセシビリティツールや支援技術は、ユーザーが文書を効果的にナビゲートできるように正確なページラベルに依存しており、これは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生成または操作ツールを構築する開発者にとって、PDPageLabelRangeは、従来の出版規則に合致し、文書ナビゲーションに対するユーザーの期待に応える文書を作成するために必要な機能を提供します。

仕組み

PDPageLabelRangeは、PDF仕様で定義されているページラベル辞書エントリにマッピングすることで動作します。各範囲は、開始ページインデックス、番号スタイル(10進アラビア数字、大文字または小文字のローマ数字、大文字または小文字のアルファベット、または番号なし)、数値シーケンスのオプションの開始値、およびオプションのプレフィックス文字列を指定します。ページラベルを作成または変更する際、開発者は希望するプロパティでPDPageLabelRangeオブジェクトをインスタンス化し、PDPageLabelsコレクションクラスを通じて文書のページラベル番号ツリーに追加します。その後、PDFビューアはこれらの範囲を使用して、各ページに適切な表示ラベルを生成します。単一の文書内に複数の範囲を設定でき、各新しい範囲は指定された開始ページで有効になり、次の範囲が始まるか文書が終了するまで継続します。

関連用語

  • PDPage – PDF文書内の個別のページを表し、ページのコンテンツストリームとリソースを含む
  • PDPageTree – PDF文書内のページの階層構造を管理する
  • PDPageLabels – PDF文書内のすべてのページラベル範囲のコレクションを管理するコンテナクラス
  • Tagged PDF – アクセシビリティとコンテンツの再利用性を向上させる構造マークアップを持つPDF文書
  • PDDocument – Apache PDFBoxで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