はじめに (対象読者・この記事でわかること)

この記事は、Javaプログラミングに慣れ、iText7ライブラリを使用してPDFを生成している開発者を対象としています。特に、PDF内で段落の先頭スペースやインデントを正確に表示させたいと考えている方に最適です。

この記事を読むことで、iText7のParagraphクラスで先頭のスペースを保持する具体的な方法を学ぶことができます。また、実際のコード例を通じて、すぐに実践できる技術を習得できます。PDFの見栄えを正確に制御したいというニーズは多くの開発者に共通するものですので、この知識は今後の開発に必ず役立つでしょう。

前提知識

この記事を読み進める上で、以下の知識があるとスムーズです。

  • Javaの基本的なプログラミング知識
  • iText7ライブラリの基本的な使い方
  • MavenやGradleを使った依存関係管理の経験
  • PDF生成の基本的な概念

iText7とParagraphの概要

iText7は、Javaと.NETプラットフォーム向けのPDF生成ライブラリです。テキスト、画像、表などをPDFドキュメントに追加するための強力な機能を提供しています。特に、ビジネスアプリケーションでの帳票作成やレポート生成に広く利用されています。

Paragraphクラスは、iText7でテキスト段落を表現するための主要なクラスです。複数行のテキストを扱う際に使用され、フォント、サイズ、色などのスタイル設定が可能です。しかし、デフォルトの設定では、段落の先頭にある連続するスペースやタブが自動的に削除されてしまうという問題があります。

この問題は、特にレポートやフォーマットが厳密に定められたドキュメントを生成する際に問題となります。例えば、技術文書のインデントや、箇条書きの先頭スペースなどが失われてしまうと、ドキュメントの見栄えが著しく損なわれます。

なぜこの問題が起きるのかというと、iText7のParagraphクラスは内部でテキストの前処理を行い、不要な空白文字を削除してレイアウトの最適化を図っているためです。この挙動は一般的なテキスト処理では望ましいものの、特定のフォーマットを維持したい場合には不都合です。

Paragraphで先頭スペースを保持する具体的な方法

では、実際にiText7のParagraphで先頭スペースを保持する方法を具体的に見ていきましょう。いくつかのアプローチがありますが、ここでは最も効果的な方法をステップバイステップで解説します。

ステップ1：通常のParagraphの挙動を確認

まず、デフォルトのParagraphがどのように振る舞うかを確認してみましょう。以下のような簡単なコードを実行してみます。

Java

import com.itextpdf.kernel.pdf.PdfDocument;
import com.itextpdf.kernel.pdf.PdfWriter;
import com.itextpdf.layout.Document;
import com.itextpdf.layout.element.Paragraph;

public class DefaultParagraphExample {
    public static void main(String[] args) {
        try {
            // PDFドキュメントの作成
            PdfWriter writer = new PdfWriter("default_paragraph.pdf");
            PdfDocument pdf = new PdfDocument(writer);
            Document document = new Document(pdf);

            // 先頭にスペースを含む段落を作成
            String textWithSpaces = "    これは先頭にスペースを含む段落です。";
            Paragraph paragraph = new Paragraph(textWithSpaces);

            // ドキュメントに追加
            document.add(paragraph);

            // ドキュメントを閉じる
            document.close();

            System.out.println("PDFが生成されました");
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

このコードを実行すると、先頭の4つのスペースがPDF上では表示されず、テキストが左詰めで表示されることがわかります。これはiText7のParagraphクラスのデフォルトの振る舞いです。

ステップ2：先頭スペースを保持するための設定方法

先頭スペースを保持するには、Paragraphのプロパティを設定する必要があります。以下に、その方法を示します。

Java

import com.itextpdf.kernel.pdf.PdfDocument;
import com.itextpdf.kernel.pdf.PdfWriter;
import com.itextpdf.layout.Document;
import com.itextpdf.layout.element.Paragraph;
import com.itextpdf.layout.property.Property;

public class LeadingSpaceExample {
    public static void main(String[] args) {
        try {
            // PDFドキュメントの作成
            PdfWriter writer = new PdfWriter("leading_space.pdf");
            PdfDocument pdf = new PdfDocument(writer);
            Document document = new Document(pdf);

            // 先頭にスペースを含む段落を作成
            String textWithSpaces = "    これは先頭にスペースを含む段落です。";
            Paragraph paragraph = new Paragraph(textWithSpaces);

            // 先頭スペースを保持するための設定
            paragraph.setProperty(Property.LEADING, new com.itextpdf.layout.property.Leading(
                com.itextpdf.layout.property.Leading.MULTIPLIED, 1.0f));

            // ドキュメントに追加
            document.add(paragraph);

            // ドキュメントを閉じる
            document.close();

            System.out.println("PDFが生成されました");
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

このコードでは、setPropertyメソッドを使用して、ParagraphのLEADINGプロパティを設定しています。LEADINGプロパティは、行間を制御するものですが、この設定によって先頭スペースの保持が可能になります。

ステップ3：より確実な方法 - Paragraphのコンストラクタを使用

上記の方法では、すべてのケースで先頭スペースが保持されるとは限りません。より確実な方法として、Paragraphのコンストラクタを使用してテキストを直接渡す方法があります。

Java

import com.itextpdf.kernel.pdf.PdfDocument;
import com.itextpdf.kernel.pdf.PdfWriter;
import com.itextpdf.layout.Document;
import com.itextpdf.layout.element.Paragraph;
import com.itextpdf.layout.property.TextAlignment;

public class ConstructorExample {
    public static void main(String[] args) {
        try {
            // PDFドキュメントの作成
            PdfWriter writer = new PdfWriter("constructor_example.pdf");
            PdfDocument pdf = new PdfDocument(writer);
            Document document = new Document(pdf);

            // 先頭にスペースを含む段落を作成
            String textWithSpaces = "    これは先頭にスペースを含む段落です。";
            Paragraph paragraph = new Paragraph(textWithSpaces);

            // テキスト配置を左寄せに設定
            paragraph.setTextAlignment(TextAlignment.LEFT);

            // ドキュメントに追加
            document.add(paragraph);

            // ドキュメントを閉じる
            document.close();

            System.out.println("PDFが生成されました");
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

この方法では、TextAlignment.LEFTを設定することで、テキストの左寄せを明示的に指定しています。これにより、先頭スペースが保持される可能性が高まります。

ステップ4：より確実な方法 - Chunkクラスを使用

最も確実な方法として、Chunkクラスを使用してテキストを分割し、個別に処理する方法があります。

Java

import com.itextpdf.kernel.pdf.PdfDocument;
import com.itextpdf.kernel.pdf.PdfWriter;
import com.itextpdf.layout.Document;
import com.itextpdf.layout.element.Paragraph;
import com.itextpdf.layout.element.Chunk;
import com.itextpdf.layout.property.TextAlignment;

public class ChunkExample {
    public static void main(String[] args) {
        try {
            // PDFドキュメントの作成
            PdfWriter writer = new PdfWriter("chunk_example.pdf");
            PdfDocument pdf = new PdfDocument(writer);
            Document document = new Document(pdf);

            // 先頭にスペースを含む段落を作成
            String textWithSpaces = "    これは先頭にスペースを含む段落です。";

            // ParagraphとChunkを作成
            Paragraph paragraph = new Paragraph();
            paragraph.setTextAlignment(TextAlignment.LEFT);

            // スペース部分を別のChunkとして追加
            String spaces = textWithSpaces.substring(0, 4);
            Chunk spaceChunk = new Chunk(spaces);
            paragraph.add(spaceChunk);

            // テキスト部分を別のChunkとして追加
            String text = textWithSpaces.substring(4);
            Chunk textChunk = new Chunk(text);
            paragraph.add(textChunk);

            // ドキュメントに追加
            document.add(paragraph);

            // ドキュメントを閉じる
            document.close();

            System.out.println("PDFが生成されました");
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

この方法では、テキストをスペース部分とそれ以外の部分に分割し、それぞれを別々のChunkとしてParagraphに追加しています。これにより、先頭のスペースが確実に保持されます。

ステップ5：応用例 - 複数段落での使用

実際のアプリケーションでは、複数の段落を扱うことが多いため、その場合の実装例も紹介します。

Java

import com.itextpdf.kernel.pdf.PdfDocument;
import com.itextpdf.kernel.pdf.PdfWriter;
import com.itextpdf.layout.Document;
import com.itextpdf.layout.element.Paragraph;
import com.itextpdf.layout.element.Chunk;
import com.itextpdf.layout.property.TextAlignment;

public class MultipleParagraphsExample {
    public static void main(String[] args) {
        try {
            // PDFドキュメントの作成
            PdfWriter writer = new PdfWriter("multiple_paragraphs.pdf");
            PdfDocument pdf = new PdfDocument(writer);
            Document document = new Document(pdf);

            // 複数の段落を定義
            String[] paragraphs = {
                "    これは最初の段落です。先頭にスペースを含んでいます。",
                "        これは2番目の段落です。先頭に多くのスペースを含んでいます。",
                "    これは3番目の段落です。"
            };

            // 各段落を処理
            for (String paragraphText : paragraphs) {
                Paragraph paragraph = new Paragraph();
                paragraph.setTextAlignment(TextAlignment.LEFT);

                // 先頭のスペースを数える
                int spaceCount = 0;
                while (spaceCount < paragraphText.length() && paragraphText.charAt(spaceCount) == ' ') {
                    spaceCount++;
                }

                // スペース部分を別のChunkとして追加
                if (spaceCount > 0) {
                    String spaces = paragraphText.substring(0, spaceCount);
                    Chunk spaceChunk = new Chunk(spaces);
                    paragraph.add(spaceChunk);
                }

                // テキスト部分を別のChunkとして追加
                String text = paragraphText.substring(spaceCount);
                if (!text.isEmpty()) {
                    Chunk textChunk = new Chunk(text);
                    paragraph.add(textChunk);
                }

                // ドキュメントに追加
                document.add(paragraph);
            }

            // ドキュメントを閉じる
            document.close();

            System.out.println("PDFが生成されました");
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

この例では、複数の段落を配列で定義し、各段落の先頭スペースを保持してPDFに追加しています。このような方法を用いることで、複数の段落を含むドキュメントでも正確なフォーマットを維持できます。

ハマった点やエラー解決

問題1：スペースが依然として削除される

上記の方法を試しても、スペースが削除されてしまう場合があります。特に、テキストに含まれる連続するスペースがすべて削除されてしまうことがあります。

解決策1：ノーマライズの無効化

iText7には、テキストのノーマライズ（正規化）機能があり、これがスペースの削除を引き起こしている可能性があります。この機能を無効にするには、以下のように設定します。

Java

// Paragraphの作成後
paragraph.setKeepTogether(true);
paragraph.setKeepWithNext(true);
paragraph.setFirstLineIndent(0); // 最初の行のインデントを0に設定

問題2：フォントの問題によるスペースの非表示

フォントによっては、スペース文字が正しく表示されないことがあります。特に、日本語フォントを使用している場合にこの問題が発生することがあります。

解決策2：適切なフォントの選択

この問題を解決するには、スペース文字を正しく表示できるフォントを選択する必要があります。例えば、以下のようにフォントを明示的に指定します。

Java

// フォントの設定
PdfFont font = PdfFontFactory.createFont("Helvetica", true);
paragraph.setFont(font);

問題3：複数行にわたる段落でのスペースの保持

段落が複数行にわたる場合、先頭スペースが2行目以降にも適用されてしまい、意図しないレイアウトになることがあります。

解決策3：最初の行のみに適用するインデント

この問題を解決するには、最初の行のみにインデントを適用する方法があります。iText7のsetFirstLineIndentメソッドを使用します。

Java

// 最初の行のみにインデントを適用
paragraph.setFirstLineIndent(20f); // 20単位のインデント

まとめ

本記事では、iText7のParagraphで先頭のスペースを保持する方法を解説しました。主なポイントは以下の通りです。

  • デフォルトのParagraphでは、先頭スペースが削除される
  • setPropertyメソッドでLEADINGプロパティを設定することで、スペースの保持が可能になる
  • Chunkクラスを使用してテキストを分割することで、確実にスペースを保持できる
  • 複数の段落を扱う場合、各段落の先頭スペースを個別に処理する必要がある

この技術を習得することで、PDFの見栄えを正確に制御し、よりプロフェッショナルなドキュメントを生成できるようになります。特に、フォーマットが厳密に定められたレポートや帳票を作成する際には、この知識が不可欠です。

今後は、iText7の他の高度な機能や、PDFのアクセシビリティ向上についても記事に予定です。より高度なPDF生成技術を学び、スキルを向上させていきましょう。

参考資料