Java SwingのRTFEditorKitを徹底解説！リッチテキストを自在に操る

この記事から得られる知識

  • javax.swing.text.rtf.RTFEditorKitの基本的な役割と概要
  • Java SwingアプリケーションでRTF（リッチテキスト形式）ファイルを読み込み、表示する方法
  • JTextPaneやJEditorPane上の書式付きテキストをRTFファイルとして保存する方法
  • プログラム上でテキストにスタイル（太字、色など）を適用し、それをRTFに反映させる方法
  • RTFEditorKitを使用する上での注意点、制限事項、そして実用上のヒント

目次

はじめに：RTFとRTFEditorKitとは？

現代の多くのアプリケーションでは、単なるプレーンテキストだけでなく、文字の大きさ、色、太字、斜体といった多彩な表現が可能な「リッチテキスト」が求められます。JavaのGUIツールキットであるSwingで、このようなリッチテキストを手軽に扱うために提供されているのが、RTF (Rich Text Format) と、それを操作するための javax.swing.text.rtf.RTFEditorKit です。

RTFは、Microsoftによって開発されたファイル形式で、異なるプラットフォームやアプリケーション間で書式情報を含んだテキストを交換するために広く使われています。 この形式の文書をJava Swingアプリケーションで読み書きする機能を提供してくれるのが、RTFEditorKitなのです。

このクラスは、JEditorPaneやJTextPaneといったSwingのテキストコンポーネントと連携し、RTFドキュメントのロード、表示、編集、そして保存といった一連の操作を可能にします。 この記事では、RTFEditorKitの基本的な使い方から、少し踏み込んだスタイルの操作、そして実用上の注意点まで、サンプルコードを交えながら詳しく解説していきます。

第1章: RTFファイルの読み込みと表示

RTFEditorKitの最も基本的な機能は、既存のRTFファイルを読み込んでSwingコンポーネント上に表示することです。これには主にJEditorPaneまたはそのサブクラスであるJTextPaneを使用します。

準備：EditorKitのセット

まず、JEditorPaneにRTFを扱う準備をさせなければなりません。これは、setEditorKit()メソッドを使ってRTFEditorKitのインスタンスをセットするだけで完了します。 


JEditorPane editorPane = new JEditorPane();
RTFEditorKit rtfKit = new RTFEditorKit();
editorPane.setEditorKit(rtfKit);

これにより、editorPaneはMIMEタイプがtext/rtfのコンテンツを解釈できるようになります。

readメソッドによるファイルの読み込み

ファイルの読み込みには、RTFEditorKitが提供するread()メソッドを使用します。 このメソッドは、入力ストリーム（InputStream）からデータを読み込み、指定されたドキュメント（Document）に内容を挿入します。

以下に、ファイルチューザーで選択したRTFファイルをJTextPaneに読み込んで表示する、完全なサンプルコードを示します。

ポイント: JTextPaneは、書式付きドキュメントを扱うJEditorPaneの拡張版です。内部ではStyledDocumentというモデルを持っており、文字単位でのスタイル設定など、より高度な操作が可能です。 

import javax.swing.*;
import javax.swing.text.*;
import javax.swing.text.rtf.RTFEditorKit;
import java.awt.*;
import java.io.*;

public class RtfReaderExample extends JFrame {

    private JTextPane textPane;
    private RTFEditorKit rtfKit;

    public RtfReaderExample() {
        super("RTF Reader");
        setDefaultCloseOperation(JFrame.EXIT_ON_CLOSE);
        setSize(600, 400);

        // JTextPaneとRTFEditorKitの初期化
        textPane = new JTextPane();
        rtfKit = new RTFEditorKit();
        textPane.setEditorKit(rtfKit);
        textPane.setEditable(false); // 読み込み専用にする

        // スクロール可能なようにJScrollPaneに追加
        JScrollPane scrollPane = new JScrollPane(textPane);
        add(scrollPane, BorderLayout.CENTER);

        // ファイルを開くボタンの設置
        JButton openButton = new JButton("Open RTF File");
        openButton.addActionListener(e -> openFile());
        add(openButton, BorderLayout.SOUTH);
    }

    private void openFile() {
        JFileChooser fileChooser = new JFileChooser();
        fileChooser.setFileFilter(new javax.swing.filechooser.FileFilter() {
            public boolean accept(File f) {
                return f.isDirectory() || f.getName().toLowerCase().endsWith(".rtf");
            }
            public String getDescription() {
                return "RTF Files (*.rtf)";
            }
        });

        int result = fileChooser.showOpenDialog(this);
        if (result == JFileChooser.APPROVE_OPTION) {
            File selectedFile = fileChooser.getSelectedFile();
            try (InputStream in = new FileInputStream(selectedFile)) {
                // ドキュメントを新規作成して読み込む
                Document doc = rtfKit.createDefaultDocument();
                rtfKit.read(in, doc, 0);
                textPane.setDocument(doc);
            } catch (IOException | BadLocationException ex) {
                ex.printStackTrace();
                JOptionPane.showMessageDialog(this,
                    "Error reading file: " + ex.getMessage(),
                    "Error",
                    JOptionPane.ERROR_MESSAGE);
            }
        }
    }

    public static void main(String[] args) {
        SwingUtilities.invokeLater(() -> {
            new RtfReaderExample().setVisible(true);
        });
    }
}

このコードでは、rtfKit.read(in, doc, 0)が中心的な役割を担っています。 ストリームから読み込んだ内容を、ドキュメントの先頭(位置0)から挿入しています。例外処理（IOException、BadLocationException）も適切に行うことが重要です。

第2章: コンテンツのRTFファイルへの保存

読み込みだけでなく、JTextPane上で編集したリッチテキストをRTFファイルとして保存することも可能です。これにはRTFEditorKitのwrite()メソッドを使用します。

writeメソッドによるファイルの書き出し

write()メソッドは、指定されたドキュメントの特定の部分を、出力ストリーム（OutputStream）へRTF形式で書き出します。

先ほどの読み込みサンプルに、編集機能と保存機能を追加してみましょう。 


import javax.swing.*;
import javax.swing.text.*;
import javax.swing.text.rtf.RTFEditorKit;
import java.awt.*;
import java.awt.event.ActionEvent;
import java.io.*;

public class RtfEditorExample extends JFrame {

    private JTextPane textPane;
    private RTFEditorKit rtfKit;

    public RtfEditorExample() {
        super("RTF Editor");
        setDefaultCloseOperation(JFrame.EXIT_ON_CLOSE);
        setSize(700, 500);

        // JTextPaneとRTFEditorKitの初期化
        textPane = new JTextPane();
        rtfKit = new RTFEditorKit();
        textPane.setEditorKit(rtfKit);

        JScrollPane scrollPane = new JScrollPane(textPane);
        add(scrollPane, BorderLayout.CENTER);

        // メニューバーの作成
        JMenuBar menuBar = new JMenuBar();
        JMenu fileMenu = new JMenu("File");
        
        JMenuItem openItem = new JMenuItem("Open...");
        openItem.addActionListener(this::openFileAction);
        fileMenu.add(openItem);

        JMenuItem saveItem = new JMenuItem("Save As...");
        saveItem.addActionListener(this::saveFileAction);
        fileMenu.add(saveItem);
        
        fileMenu.addSeparator();
        
        JMenuItem exitItem = new JMenuItem("Exit");
        exitItem.addActionListener(e -> System.exit(0));
        fileMenu.add(exitItem);

        menuBar.add(fileMenu);
        setJMenuBar(menuBar);
    }

    private void openFileAction(ActionEvent e) {
        // (前章のopenFileメソッドとほぼ同じ)
        JFileChooser fileChooser = new JFileChooser();
        // ... 省略 ...
        int result = fileChooser.showOpenDialog(this);
        if (result == JFileChooser.APPROVE_OPTION) {
            File selectedFile = fileChooser.getSelectedFile();
            try (InputStream in = new FileInputStream(selectedFile)) {
                Document doc = rtfKit.createDefaultDocument();
                rtfKit.read(in, doc, 0);
                textPane.setDocument(doc);
            } catch (IOException | BadLocationException ex) {
                // ... 省略 ...
            }
        }
    }

    private void saveFileAction(ActionEvent e) {
        JFileChooser fileChooser = new JFileChooser();
        fileChooser.setDialogTitle("Save As RTF");
        fileChooser.setFileFilter(new javax.swing.filechooser.FileFilter() {
            public boolean accept(File f) {
                return f.isDirectory() || f.getName().toLowerCase().endsWith(".rtf");
            }
            public String getDescription() {
                return "RTF Files (*.rtf)";
            }
        });

        int result = fileChooser.showSaveDialog(this);
        if (result == JFileChooser.APPROVE_OPTION) {
            File selectedFile = fileChooser.getSelectedFile();
            // 拡張子が.rtfでなければ付与する
            if (!selectedFile.getName().toLowerCase().endsWith(".rtf")) {
                selectedFile = new File(selectedFile.getParentFile(), selectedFile.getName() + ".rtf");
            }

            try (OutputStream out = new FileOutputStream(selectedFile)) {
                Document doc = textPane.getDocument();
                // ドキュメント全体(位置0から最後まで)を書き出す
                rtfKit.write(out, doc, 0, doc.getLength());
            } catch (IOException | BadLocationException ex) {
                ex.printStackTrace();
                JOptionPane.showMessageDialog(this,
                    "Error saving file: " + ex.getMessage(),
                    "Error",
                    JOptionPane.ERROR_MESSAGE);
            }
        }
    }

    public static void main(String[] args) {
        SwingUtilities.invokeLater(() -> {
            new RtfEditorExample().setVisible(true);
        });
    }
}

コードのポイント

保存処理の核となるのは rtfKit.write(out, doc, 0, doc.getLength()) の部分です。 textPane.getDocument()で現在のドキュメントを取得し、その内容を最初から（位置0）最後まで（doc.getLength()）出力ストリームに書き込んでいます。 これにより、ユーザーがGUI上で行ったテキスト編集や書式設定が、RTF形式のファイルとして永続化されます。

第3章: プログラムによるスタイルの操作

RTFEditorKitの真価は、ファイルI/Oだけではありません。JTextPaneが内部で保持するStyledDocumentと連携することで、プログラムコードから動的にテキストのスタイルを操作し、それをRTFに反映させることが可能です。

StyledDocumentとAttributeSet

JTextPaneのテキストと書式は、StyledDocumentインタフェースの実装（通常はDefaultStyledDocument）によって管理されます。テキストにスタイルを適用するには、AttributeSetという属性の集合を作成し、ドキュメントに設定します。

属性の定義にはStyleConstantsクラスの定数を使うのが便利です。 これにより、コードの可読性が向上します。例えば、以下のようにしてスタイルを定義できます。

  • 太字: StyleConstants.setBold(attributes, true);
  • 文字色: StyleConstants.setForeground(attributes, Color.RED);
  • フォントサイズ: StyleConstants.setFontSize(attributes, 24);

スタイル適用とRTF保存のサンプル

以下のサンプルコードは、プログラムでテキストを挿入し、部分的にスタイルを適用した後、その結果をRTFファイルとして保存する例です。 


import javax.swing.*;
import javax.swing.text.*;
import javax.swing.text.rtf.RTFEditorKit;
import java.awt.*;
import java.io.*;

public class StyledRtfWriter {

    public static void main(String[] args) {
        // Swingコンポーネントは不要だが、内部処理のためにKitとDocumentは必要
        RTFEditorKit rtfKit = new RTFEditorKit();
        StyledDocument doc = new DefaultStyledDocument();

        try {
            // 1. 通常のテキストを挿入
            doc.insertString(doc.getLength(), "これは通常のテキストです。\n", null);

            // 2. 赤色・太字のスタイルを作成
            SimpleAttributeSet redBoldAttrs = new SimpleAttributeSet();
            StyleConstants.setForeground(redBoldAttrs, Color.RED);
            StyleConstants.setBold(redBoldAttrs, true);
            doc.insertString(doc.getLength(), "これは赤色の太字テキストです。\n", redBoldAttrs);

            // 3. 青色・斜体・大きいフォントのスタイルを作成
            SimpleAttributeSet blueItalicLargeAttrs = new SimpleAttributeSet();
            StyleConstants.setForeground(blueItalicLargeAttrs, Color.BLUE);
            StyleConstants.setItalic(blueItalicLargeAttrs, true);
            StyleConstants.setFontSize(blueItalicLargeAttrs, 20);
            StyleConstants.setFontFamily(blueItalicLargeAttrs, "Serif");
            doc.insertString(doc.getLength(), "これは青色で斜体の大きなテキストです。\n", blueItalicLargeAttrs);

            // 4. スタイルを解除して再度挿入
            doc.insertString(doc.getLength(), "再び通常のテキストに戻ります。", null);

            // 結果をRTFファイルとして保存
            File outputFile = new File("styled_output.rtf");
            try (OutputStream out = new FileOutputStream(outputFile)) {
                rtfKit.write(out, doc, 0, doc.getLength());
                System.out.println("Styled RTF file created: " + outputFile.getAbsolutePath());
            }

        } catch (BadLocationException | IOException e) {
            e.printStackTrace();
        }

        // 生成されたRTFを読み込んでGUIで確認する（オプション）
        showRtfFile("styled_output.rtf");
    }

    private static void showRtfFile(String filePath) {
        SwingUtilities.invokeLater(() -> {
            JFrame frame = new JFrame("RTF Viewer");
            frame.setDefaultCloseOperation(JFrame.EXIT_ON_CLOSE);
            JTextPane textPane = new JTextPane();
            RTFEditorKit kit = new RTFEditorKit();
            textPane.setEditorKit(kit);
            textPane.setEditable(false);

            try (InputStream in = new FileInputStream(filePath)) {
                Document doc = kit.createDefaultDocument();
                kit.read(in, doc, 0);
                textPane.setDocument(doc);
            } catch (Exception e) {
                e.printStackTrace();
            }

            frame.add(new JScrollPane(textPane));
            frame.setSize(500, 300);
            frame.setLocationRelativeTo(null);
            frame.setVisible(true);
        });
    }
}

このコードを実行すると、styled_output.rtfというファイルが生成されます。このファイルをMicrosoft Wordやテキストエディットなどで開くと、プログラムで設定した通りの書式が適用されていることが確認できます。 このように、GUIを介さずに、バッチ処理などで書式付きのレポートを生成するような応用も考えられます。

第4章: 注意点と限界

RTFEditorKitは非常に便利なクラスですが、万能ではありません。実務で使用する際には、いくつかの注意点と限界を理解しておく必要があります。

重要な制限事項

公式ドキュメントにも記載がある通り、SwingのRTFサポートは完全ではありません。 元々Swingチームによって開発されたものではなく、後方互換性のために維持されている側面が強い機能です。 そのため、以下のような制限が存在します。
  • 不完全なRTF仕様サポート: RTF仕様のすべてをサポートしているわけではありません。 特に、近年のMicrosoft Wordが生成するような、表、複雑なヘッダー/フッター、描画オブジェクトなどを含む高度なRTFファイルは、正しく表示・保存できない可能性があります。
  • 画像の非サポート: 標準のRTFEditorKitは、RTFファイルに埋め込まれた画像を処理することができません。 画像を含むRTFを読み込もうとすると、画像は無視されるか、予期せぬ結果を引き起こす可能性があります。
  • 文字エンコーディングの問題: 特定の文字エンコーディング、特にファイル内で動的にエンコーディングが切り替わるようなRTF（一部の中国語文字を含むRTFなど）を正しく読み込めないという既知のバグ（制限）があります。
  • パフォーマンス: 非常に大きなRTFファイルを扱う場合、読み込みや表示に時間がかかり、メモリ消費量も大きくなる可能性があります。

どのような場合に有効か？

これらの制限を踏まえると、RTFEditorKitは以下のようなケースで依然として有効な選択肢となります。

  • 既存のSwingベースのデスクトップアプリケーションの保守・機能追加。
  • 文字の装飾（色、サイズ、太字など）が中心の、比較的シンプルなリッチテキストエディタ機能の実装。
  • サーバーサイドで、定型のテンプレートにデータを埋め込み、簡単な書式付きのRTFレポートを生成するようなバッチ処理。
  • 外部ライブラリを追加できない環境で、標準APIのみでリッチテキストを扱う必要がある場合。

一方で、高度なDTP（Desktop Publishing）機能や、最新のWordファイルとの完全な互換性が求められるような新規開発プロジェクトでは、Apache POIやその他のサードパーティ製ライブラリの利用を検討する方が賢明かもしれません。

まとめ

この記事では、Java Swing標準ライブラリに含まれるjavax.swing.text.rtf.RTFEditorKitについて、その基本的な使い方から応用、そして注意点までを包括的に解説しました。

RTFEditorKitは、read()メソッドとwrite()メソッドを通じてRTFファイルの入出力を容易にし、StyledDocumentと組み合わせることでプログラムからの動的なスタイル操作も可能にする、シンプルながら強力なツールです。

その一方で、RTF仕様への不完全な対応や画像の非サポートといった明確な限界も存在します。このライブラリを採用する際には、その特性と制限を正しく理解し、プロジェクトの要件と照らし合わせて適切に判断することが成功の鍵となります。

Swing自体がレガシーな技術と見なされることもありますが、既存システムの保守や特定の用途においては、RTFEditorKitは今なお価値のある選択肢の一つと言えるでしょう。

コメントを残す

メールアドレスが公開されることはありません。 ※ が付いている欄は必須項目です

前の記事

Java標準ライブラリ javax.swing.text.ht…

次の記事

Java SwingのJTreeを完全マスター！javax.s…