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

PDAnnotationText

PDAnnotationTextは、Apache PDFBox PDModel APIに含まれるJavaクラスで、PDFドキュメント内のテキスト注釈(「付箋」または「コメント注釈」とも呼ばれます)を表現します。

キーワード: pdannotationtext, PDAnnotationText

概要

PDAnnotationTextは、Apache PDFBox PDModel APIに含まれるJavaクラスで、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内の特定の位置にテキストコメントやノートを添付できます。このクラスは、コンテンツ、アイコンタイプ、開閉状態、視覚的外観などのテキスト注釈プロパティを作成、読み取り、変更するためのメソッドを提供します。

定義

PDAnnotationTextは、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 ) で定義されている標準的な注釈タイプの一つであるテキスト注釈を専門的に扱います。通常はドキュメントコンテンツに関連付けられるマークアップ注釈とは異なり、テキスト注釈はページ上のどこにでも配置できる独立したノートアイコンです。クリックすると、注釈のテキストコンテンツを含むポップアップウィンドウが表示されます。

このクラスはPDAnnotation基底クラスを拡張し、テキスト注釈固有の属性のための特殊化されたメソッドを提供します。これには、アイコン名(Comment、Key、Note、Help、NewParagraph、Paragraph、Insert)、ポップアップウィンドウの初期表示を決定するオープンフラグ、注釈の状態および状態モデルプロパティが含まれます。PDAnnotationTextは、インラインコンテンツではなくデフォルトで閉じたアイコンを表現する点で、PDAnnotationMarkupやPDAnnotationFreeTextなどの他の注釈タイプとは異なります。

重要性

PDFドキュメントを扱う開発者にとって、PDAnnotationTextは協調的なレビューとコメントワークフローを実装するために不可欠です。テキスト注釈はPDFビューアーで最も一般的に使用される注釈タイプの一つであり、複数のレビュアーが元のコンテンツを変更することなく、ドキュメントに控えめなフィードバックを追加できます。このクラスを理解することで、開発者は次のことが可能になります:

  • 関係者がコメントを残せるドキュメントレビューおよび承認システムの構築
  • 注釈付き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ドキュメント間での注釈の移行、または他の形式への変換
  • 完全な注釈サポートを備えたカスタムPDFビューアーやエディターの実装

テキスト注釈をプログラム的に管理する機能は、エンタープライズドキュメント管理システム、法的文書レビュープロセス、講師のフィードバックを体系的に収集・処理する必要がある教育プラットフォームにおいて特に有用です。

仕組み

PDAnnotationTextは、PDFファイル形式でテキスト注釈を表すPDF辞書構造をカプセル化することによって機能します。PDAnnotationTextのインスタンスを作成すると、/Subtypeエントリが/Textに設定された必要な注釈プロパティを持つ辞書が生成または参照されます。

PDAnnotationTextの主な操作には次のものが含まれます:

テキスト注釈の作成:新しいPDAnnotationTextオブジェクトをインスタンス化し、PDRectangleを使用して位置(アイコンが表示される場所)を設定し、コンテンツ文字列を指定し、オプションでアイコン名と初期オープン状態を設定します。その後、注釈をページの注釈リストに追加する必要があります。

注釈プロパティの読み取り:このクラスは、注釈のコンテンツ(getContents())、アイコン名(getName())、オープン状態(getOpen())、状態(getState())、状態モデル(getStateModel())を取得するゲッターメソッドを提供します。これらのプロパティは、 ( 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辞書構造から直接読み取られます。

注釈の変更:セッターメソッドにより、setContents()setName()setOpen()などの注釈プロパティを変更できます。変更はPDF辞書に書き戻され、ドキュメントが保存されると永続化されます。

座標系の処理:すべてのPDF注釈と同様に、PDAnnotationTextは原点(0,0)がページの左下隅にあるPDF座標系を使用します。注釈の矩形は、ポップアップウィンドウのサイズではなく、クリック可能なアイコン領域を定義します。

このクラスは、PDFBoxの広範な注釈フレームワークと統合されており、外観ストリーム、色、変更日などの共通の注釈動作をPDAnnotation親クラスから継承しています。

関連用語

  • PDAnnotation – Apache PDFBoxにおけるすべてのPDF注釈タイプの基底クラス
  • PDAnnotationMarkup – 作成者とレビューメタデータを含むドキュメントコンテンツをマークアップする注釈の親クラス
  • PDAnnotationPopup – テキスト注釈に関連付けられたポップアップウィンドウを表示する注釈タイプ
  • PDPage – 注釈配列に注釈を含むPDFページを表す
  • PDAppearanceStream – 注釈がページ上でどのように表示されるかの視覚的表現を定義する

出典

(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