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

PDViewerPreferences

PDViewerPreferencesは、Apache PDFBox PDModel APIのクラスで、PDFドキュメントのビューア設定辞書へのプログラマティックなアクセスを提供します。

キーワード: pdviewerpreferences, PDViewerPreferences

概要

PDViewerPreferencesは、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ビューアアプリケーションがドキュメントをどのように表示すべきかを制御します。このクラスにより、開発者はPDFドキュメントの作成または変更時に、既存のビューア設定を読み取ったり、新しい設定を行ったりすることができます。

定義

PDViewerPreferencesは、Apache PDFBoxのPDModel APIレイヤー内の高レベルJavaクラスで、PDFドキュメントのカタログに含まれるViewerPreferences辞書エントリをカプセル化します。この辞書には、準拠するPDFリーダーがユーザーにドキュメントをどのように提示すべきかを示唆するオプション設定が含まれています。ドキュメントコンテンツや構造要素とは異なり、ビューア設定はPDFの実際のコンテンツには影響しませんが、ブックマークを表示するか、ツールバーを非表示にするか、ページをウィンドウに合わせるか、特定のレイアウトモードでページを表示するかなど、表示特性についてビューアアプリケーションにヒントを提供します。

このクラスは、基礎となるCOS(Carousel Object Structure)辞書のラッパーとして機能し、 ( 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 ) で定義されている標準のビューア設定キーに対応する型安全なgetterおよびsetterメソッドを提供します。この抽象化により、開発者は低レベルのPDF辞書オブジェクトを直接操作することなく、ビューア設定機能へのフルアクセスを維持できます。

重要性

PDViewerPreferencesの理解と活用は、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レポート、フォーム、またはドキュメントをプログラマティックに生成する際、ビューア設定により、開発者はドキュメントの目的に最適な表示設定を事前に構成することで、より洗練されたプロフェッショナルなエクスペリエンスを作成できます。例えば、フォームは単一ページビューでツールバーを表示するページレイアウトから恩恵を受ける可能性があり、一方、プレゼンテーションPDFはよりクリーンな表示のためにユーザーインターフェース要素を非表示にする方が適している場合があります。

仕組み

PDViewerPreferencesは、標準のPDFビューア設定エントリにマッピングされるgetterおよびsetterメソッドのコレクションを通じて動作します。開発者は通常、PDDocumentのカタログを使用してgetViewerPreferences()を通じてインスタンスを取得します。これは、既存のPDViewerPreferencesオブジェクトを返すか、設定されていない場合はnullを返します。

主な機能には以下が含まれます:

ページ表示設定setPageLayout()setPageMode()などのメソッドは、ページの配置方法(単一ページ、連続、見開き)と、ドキュメントを開いたときにナビゲーションパネル(ブックマーク、サムネイル、添付ファイル)を表示するかどうかを制御します。

ユーザーインターフェース制御setHideToolbar()setHideMenubar()setHideWindowUI()などの設定は、ビューアがさまざまなインターフェース要素を非表示にすべきかどうかを示唆し、プレゼンテーションやキオスクスタイルの表示に有用です。

読み取り方向setDirection()メソッドは、左から右または右から左への読み取り順序を指定します。これは、アラビア語やヘブライ語などの言語のドキュメントに不可欠であり、 ( 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 ) に基づくアクセシビリティ準拠にとって重要です。

印刷スケーリングsetPrintScaling()などのメソッドは、ビューアが印刷可能領域に合わせてページをスケーリングするか、実際のサイズで印刷するかを示唆します。

ビューア設定を行う際、開発者はPDViewerPreferencesオブジェクトを作成または取得し、適切なsetterメソッドを呼び出し、それがドキュメントカタログに関連付けられていることを確認します。これらの設定はPDFファイルに保存され、準拠するビューアによって読み取られますが、アプリケーションはすべての設定を尊重する必要はありません。

関連用語

  • PDDocument – Apache PDFBoxのPDModel APIにおけるPDFドキュメントを表すメインクラス
  • PDDocumentCatalog – ビューア設定を含むドキュメントレベルの情報を含むカタログ辞書オブジェクト
  • PDPageMode – ドキュメントを開いたときの表示方法(ナビゲーションパネルありまたはなし)を定義する列挙型
  • PDPageLayout – ページレイアウト(単一ページ、連続、見開きページ)を指定する列挙型
  • COS(Carousel Object Structure) – PDFBoxの高レベルPDModelクラスの基礎となる低レベルオブジェクトモデル

出典

(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