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

SetLineDashPattern

SetLineDashPatternは、Apache PDFBox Javaライブラリにおいて、PDFドキュメント内のグラフィカルコンテンツに破線や点線のパターンを定義するためのメソッドです。

キーワード: setlinedashpattern, SetLineDashPattern

概要

SetLineDashPatternは、Apache PDFBox Javaライブラリにおいて、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コンテンツを作成または変更する際に、このメソッドを使用します。

定義

SetLineDashPatternは、Apache PDFBoxのPDPageContentStreamクラス内の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グラフィックス状態パラメータの線破線パターンに直接マッピングされ、線のレンダリングを正確に制御できます。実線レンダリング(デフォルト状態)とは異なり、SetLineDashPatternは指定されたパターンに従って、塗りつぶされたセグメントと塗りつぶされていないセグメントを交互に配置することで、非連続的なストロークを作成します。

重要性

PDF生成および操作に取り組む開発者にとって、SetLineDashPatternは視覚的プレゼンテーションとドキュメントフォーマットに対する重要な制御を提供します。この機能は、エンジニアリング図面、署名欄のあるフォーム、異なる境界線スタイルを持つテーブルなど、線の種類を視覚的に区別する必要があるプロフェッショナルなドキュメントを作成する際に特に重要です。破線パターンをプログラム的に定義できる機能により、動的に生成される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 ) などの標準に準拠した構造化ドキュメントを作成する際に関連性があります。これらの標準では、視覚的な区別を適切に伝える必要があります。

仕組み

SetLineDashPatternメソッドは、PDFコンテンツストリームのグラフィックス状態を変更することで動作し、具体的にはダッシュ配列とダッシュフェーズのパラメータを設定します。ダッシュ配列は、ダッシュ(塗りつぶされたセグメント)の長さとギャップ(塗りつぶされていないセグメント)の長さを交互に表す数値のシーケンスであり、ユーザー空間単位で測定されます。例えば、[3, 2]という配列は、3単位のダッシュに続いて2単位のギャップを持つパターンを作成します。ダッシュフェーズパラメータは、パス上のパターンの開始点をオフセットし、パターンがパスの終点とどのように整列するかを細かく制御できます。このパターンを設定した後にパスがストロークされると、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 ) に従って破線パターンを適用します。空のダッシュ配列を使用するか、ダッシュなしでメソッドを呼び出すと、線は実線レンダリングに戻ります。このパターンは、別のグラフィックス状態の変更によって変更またはリセットされるまで、以降のすべてのストローク操作に対して有効なままです。

関連用語

  • PDPageContentStream – SetLineDashPatternを含む、PDFページにコンテンツを追加するためのメソッドを提供するApache PDFBoxクラス
  • Graphics State(グラフィックス状態) – PDFドキュメント内でグラフィカル要素がどのようにレンダリングされるかを制御するパラメータの集合
  • Stroke Operation(ストローク操作) – 現在の線プロパティを使用してパスの輪郭に沿って描画するPDF操作
  • Content Stream(コンテンツストリーム) – PDFページ上のコンテンツの外観を定義する命令のシーケンス
  • Line Cap Style(ラインキャップスタイル) – ストロークパスの端点がどのようにレンダリングされるかを制御する、関連するグラフィックス状態パラメータ

出典

(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