Java SwingのUndo/Redo機能をマスター！javax.swing.undoパッケージ徹底解説

サンプルコード: JTextAreaにUndo/Redoを実装する

以下のコードは、JTextArea、Undoボタン、Redoボタンを持つシンプルなウィンドウを作成します。

<?xml version="1.0" encoding="UTF-8"?>
import javax.swing.*;
import javax.swing.event.UndoableEditEvent;
import javax.swing.event.UndoableEditListener;
import javax.swing.undo.UndoManager;
import java.awt.*;
import java.awt.event.ActionEvent;
import java.awt.event.ActionListener;
public class SimpleUndoExample extends JFrame { private JTextArea textArea; private JButton undoButton; private JButton redoButton; private final UndoManager undoManager = new UndoManager(); public SimpleUndoExample() { setTitle("Simple Undo/Redo Example"); setDefaultCloseOperation(JFrame.EXIT_ON_CLOSE); setSize(500, 400); setLocationRelativeTo(null); // 1. コンポーネントの初期化 textArea = new JTextArea(); textArea.setLineWrap(true); textArea.setWrapStyleWord(true); // 2. Documentを取得し、UndoableEditListenerを追加 textArea.getDocument().addUndoableEditListener(new UndoableEditListener() { @Override public void undoableEditHappened(UndoableEditEvent e) { // 編集が発生したらUndoManagerに登録 undoManager.addEdit(e.getEdit()); // ボタンの状態を更新 updateButtonStatus(); } }); // 3. ボタンの初期化とアクションリスナーの設定 undoButton = new JButton("元に戻す (Undo)"); redoButton = new JButton("やり直す (Redo)"); undoButton.addActionListener(new ActionListener() { @Override public void actionPerformed(ActionEvent e) { if (undoManager.canUndo()) { undoManager.undo(); } updateButtonStatus(); } }); redoButton.addActionListener(new ActionListener() { @Override public void actionPerformed(ActionEvent e) { if (undoManager.canRedo()) { undoManager.redo(); } updateButtonStatus(); } }); // 初期のボタン状態を設定 updateButtonStatus(); // 4. レイアウトの設定 JPanel buttonPanel = new JPanel(new FlowLayout()); buttonPanel.add(undoButton); buttonPanel.add(redoButton); Container contentPane = getContentPane(); contentPane.setLayout(new BorderLayout()); contentPane.add(new JScrollPane(textArea), BorderLayout.CENTER); contentPane.add(buttonPanel, BorderLayout.SOUTH); } private void updateButtonStatus() { // canUndo()とcanRedo()でUndo/Redoが可能かチェックし、ボタンの有効/無効を切り替える undoButton.setEnabled(undoManager.canUndo()); redoButton.setEnabled(undoManager.canRedo()); } public static void main(String[] args) { SwingUtilities.invokeLater(() -> { new SimpleUndoExample().setVisible(true); }); }
}

コードの解説

• textArea.getDocument().addUndoableEditListener(...): ここが最も重要な部分です。JTextAreaの内部モデルであるDocumentで発生する全ての編集イベント（文字の挿入、削除など）が、このリスナーによって捕捉されます。
• undoManager.addEdit(e.getEdit()): 捕捉した編集イベント(UndoableEdit)をUndoManagerに追加しています。これにより、編集履歴が記録されていきます。
• updateButtonStatus(): このメソッドでは、undoManager.canUndo()とundoManager.canRedo()を呼び出しています。これらは、それぞれUndoスタック、Redoスタックに編集履歴が存在するかどうかをboolean値で返します。この結果を用いて、ユーザーがクリックできないようにボタンを無効化しています。これにより、不要な例外（CannotUndoExceptionなど）の発生を防ぎ、UIをより親切なものにしています。

サンプルコード: `setText()`を一つのUndo単位にする

<?xml version="1.0" encoding="UTF-8"?>
// ... (前章のコードの続き)
// 例えば、特定のテキストをセットするボタンを追加する場合
JButton setTextButton = new JButton("Set Text");
setTextButton.addActionListener(e -> { try { // 1. グループ化を開始 undoManager.beginUpdate(); // 2. この間の操作がグループ化される textArea.setText("This is a new text set by the button.\n" + "This operation should be undone in one step."); } finally { // 3. 必ずグループ化を終了する undoManager.endUpdate(); updateButtonStatus(); }
});
// このボタンをbuttonPanelに追加する
// buttonPanel.add(setTextButton);

コードの解説

このコードでは、textArea.setText(...)をundoManager.beginUpdate()とundoManager.endUpdate()で囲んでいます。setTextは内部的にドキュメントの全内容を削除し、新しいテキストを挿入するという2つのUndoableEditを発生させることがありますが、この処理によって、それらが一つのCompoundEditとしてまとめられます。結果として、ユーザーが「元に戻す」ボタンをクリックすると、ボタンを押す前の状態に一度で戻るようになります。

注意点: beginUpdate()を呼び出した後は、必ずfinallyブロックでendUpdate()を呼び出すようにしてください。これにより、処理の途中で例外が発生した場合でも、UndoManagerが不整合な状態になるのを防ぐことができます。

サンプルコード: パネルの背景色変更にUndo/Redoを実装

この例では、ボタンをクリックするとパネルの背景色がランダムに変わり、その操作をUndo/Redoできるようにします。

<?xml version="1.0" encoding="UTF-8"?>
import javax.swing.*;
import javax.swing.undo.StateEdit;
import javax.swing.undo.StateEditable;
import javax.swing.undo.UndoManager;
import java.awt.*;
import java.awt.event.ActionEvent;
import java.awt.event.ActionListener;
import java.util.Hashtable;
import java.util.Random;
public class StateEditableExample extends JFrame { private final UndoManager undoManager = new UndoManager(); private final ColorPanel colorPanel = new ColorPanel(); // 1. StateEditableを実装したカスタムコンポーネント（今回はJPanelを継承） private static class ColorPanel extends JPanel implements StateEditable { private static final String KEY_COLOR = "Color"; public ColorPanel() { setBackground(Color.WHITE); } public void changeColor() { Random rand = new Random(); Color newColor = new Color(rand.nextFloat(), rand.nextFloat(), rand.nextFloat()); setBackground(newColor); } @Override public void storeState(Hashtable<Object, Object> state) { // 現在の状態（背景色）をハッシュテーブルに保存 state.put(KEY_COLOR, getBackground()); } @Override public void restoreState(Hashtable<?, ?> state) { // ハッシュテーブルから状態を復元 Color newColor = (Color) state.get(KEY_COLOR); if (newColor != null) { setBackground(newColor); } } } public StateEditableExample() { setTitle("StateEditable Example"); setDefaultCloseOperation(JFrame.EXIT_ON_CLOSE); setSize(500, 400); setLocationRelativeTo(null); JButton changeColorButton = new JButton("Change Color"); changeColorButton.addActionListener(e -> { // 2. 状態変更の前にStateEditを作成 StateEdit stateEdit = new StateEdit(colorPanel); // 3. 状態を変更 colorPanel.changeColor(); // 4. 状態変更の後にend()を呼び出し、編集を確定 stateEdit.end(); // 5. UndoManagerに登録 undoManager.addEdit(stateEdit); updateButtonStatus(); }); JButton undoButton = new JButton("Undo"); JButton redoButton = new JButton("Redo"); undoButton.addActionListener(e -> { if (undoManager.canUndo()) { undoManager.undo(); } updateButtonStatus(); }); redoButton.addActionListener(e -> { if (undoManager.canRedo()) { undoManager.redo(); } updateButtonStatus(); }); updateButtonStatus(); JPanel buttonPanel = new JPanel(); buttonPanel.add(changeColorButton); buttonPanel.add(undoButton); buttonPanel.add(redoButton); getContentPane().add(colorPanel, BorderLayout.CENTER); getContentPane().add(buttonPanel, BorderLayout.SOUTH); } // updateButtonStatusメソッドは前章と同じなので省略 private void updateButtonStatus() { /* ... */ } public static void main(String[] args) { SwingUtilities.invokeLater(() -> new StateEditableExample().setVisible(true)); }
}

コードの解説

• ColorPanelクラス: このクラスはStateEditableを実装しています。storeStateでは現在の背景色を"Color"というキーでハッシュテーブルに保存し、restoreStateではそのキーを使って色を取り出し、背景色として設定し直しています。
• changeColorButtonのアクションリスナー: 色を変更する一連の処理の流れが重要です。まずnew StateEdit(colorPanel)で編集前の状態がキャプチャされます。次にcolorPanel.changeColor()で実際の状態が変更されます。そしてstateEdit.end()で編集後の状態がキャプチャされ、一つのUndoableEditとして完成します。最後に、完成したstateEditをundoManagerに追加しています。

このようにStateEditableとStateEditを使うことで、あらゆる種類のオブジェクトの状態変化に対して、柔軟にUndo/Redo機能を実装することが可能になります。