markdown

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

この記事は、Java の GUI フレームワークである Swing を使ってデスクトップアプリを開発しているエンジニア、特に JComboBox の選択変更時に発生する ItemEvent や ActionEvent の取り扱いに悩んでいる方を対象としています。
本稿を読むことで、以下のことができるようになります。

  • ItemEvent の SELECTED と DESELECTED の違いと、event.consume()（擬似的なキャンセル）の挙動を正しく理解する
  • キャンセル後にコンボボックスを再度操作してもイベントが発火しない原因を特定できる
  • ActionListener への再バインド、removeItemListener / addItemListener のタイミング調整、あるいは fireActionPerformed の手動呼び出しといった具体的な回避策を実装できる

この記事を書いたきっかけは、社内ツールの設定画面で「一時的に変更を無効化」したいケースが頻出したものの、ユーザーが再度選択を変えてもイベントが走らず、設定が永遠に反映されないというバグに遭遇したことです。その経験を踏まえて、同様の問題に直面した開発者の方々の足場となる情報をまとめました。

前提知識

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

  • Java SE 基本文法とオブジェクト指向の概念
  • Swing の基本コンポーネント（JFrame、JPanel、JComboBox など）とイベントリスナーの使い方
  • IDE（IntelliJ IDEA/Eclipse 等）でのデバッグ手法

Java Swing におけるコンボボックスのイベント概観

JComboBox は主に 2 種類のイベントを提供します。

  1. ItemEvent
    - ItemListener を介して itemStateChanged が呼び出され、SELECTED と DESELECTED の 2 つの状態が通知されます。
    - 注意点：ItemEvent は「選択が変わった瞬間」に発生し、SELECTED が先に、続いて DESELECTED が送られます。
  2. ActionEvent
    - ActionListener の actionPerformed が呼び出され、ユーザーが確定的に選択を決めたとき（Enter キーやマウスクリックでドロップダウンが閉じたとき）に発火します。

多くのケースで ItemEvent が便利ですが、「変更をキャンセルしたい」 という要件では、ItemEvent を一旦無視（擬似的にキャンセル）した後に再び選択が変わったときに正しくイベントが走るようにする必要があります。

キャンセルの典型的な実装例

Java

comboBox.addItemListener(e -> {
    if (e.getStateChange() == ItemEvent.SELECTED) {
        if (shouldCancel(e.getItem())) {
            // 何らかの条件で変更を「キャンセル」したい
            // ここでは擬似的にイベントを無視するだけ
            return;
        }
        // 正常な処理
        System.out.println("選択された: " + e.getItem());
    }
});

上記のように return で処理を抜けるだけだと、内部的な選択状態は変わったまま です。その結果、ユーザーが再度別の項目を選んでも ItemEvent の SELECTED が再度送られず、ActionEvent すら発火しません。この振る舞いが「キャンセル後にイベントが起きない」問題の根源です。

コンボボックスのイベントが再度発火しない原因と対策

原因 1: コンポーネントの内部状態が既に「選択済み」のままになる

ItemListener 内で単に return しても、JComboBox の内部モデル (ComboBoxModel) の選択インデックスは更新された状態のままです。Swing は「状態が変化した」ことを検知できないため、次回の変更で ItemEvent がスキップされます。

原因 2: ActionListener が ItemEvent の後に発火しない

ActionEvent は ItemEvent がすべて処理された後に生成されます。ItemEvent を途中でキャンセル（例：例外投げる、removeAllItems してから再追加する）すると、ActionEvent が生成されるタイミングが失われます。

対策まとめ

方法 実装概要 メリット デメリット
1. 選択状態を元に戻す (setSelectedItem で元の項目に復帰) キャンセル判断後、元の値に強制的に戻す 内部状態が元に戻るので次回選択時に必ず ItemEvent が発火 UI が一瞬フラッシュする可能性
2. removeItemListener / addItemListener の切り替え キャンセル時にリスナーを一時的に外し、再度追加 余計なイベントが流れない リスナー管理が煩雑になる
3. fireActionPerformed の手動呼び出し キャンセル後に comboBox.dispatchEvent(new ActionEvent(...)) 任意のタイミングで ActionEvent を発火できる 本来のイベントフローと異なるため注意が必要
4. ItemEvent ではなく ActionListener のみで処理 ItemListener を使わず、ActionListener にロジックを集約 ActionEvent は確実に発火する SELECTED/DESELECTED の細かい状態が取れない

以下では、実務で最も使いやすい 「選択状態を元に戻す」 と 「ActionListener でハンドリング」 の2パターンを実装例付きで詳しく解説します。

手順 1：選択状態を元に戻す（setSelectedItem を利用）

1‑1. 前回選択項目を保持する

Java

JComboBox<String> combo = new JComboBox<>(new String[]{"A", "B", "C"});
final Object[] lastSelection = {combo.getSelectedItem()};

combo.addActionListener(e -> {
    Object selected = combo.getSelectedItem();
    if (shouldCancel(selected)) {
        // キャンセル → 前回の選択に戻す
        SwingUtilities.invokeLater(() -> combo.setSelectedItem(lastSelection[0]));
        // 必要ならユーザーへ通知
        JOptionPane.showMessageDialog(null, "選択はキャンセルされました");
    } else {
        // 正常に選択が確定したので状態を更新
        lastSelection[0] = selected;
        System.out.println("確定選択: " + selected);
    }
});
  • SwingUtilities.invokeLater を使うことで、setSelectedItem が現在のイベント処理の後に実行され、無限ループ を防げます。
  • lastSelection は配列で保持し、final 修飾子で外部からの再代入を防ぎつつ内部で変更可能にしています。

1‑2. UI フラッシュ対策

選択が戻るときに UI がちらつくとユーザー体験が損なわれます。これを抑えるために JComboBox の setEnabled(false) → setEnabled(true) を短時間で切り替えるテクニックがあります。

Java

SwingUtilities.invokeLater(() -> {
    combo.setEnabled(false);
    combo.setSelectedItem(lastSelection[0]);
    combo.setEnabled(true);
});

手順 2：ActionListener にロジックを集約する

ItemListener を捨てて、ActionListener のみで選択確定を判定 すると、キャンセル後でも次回の選択で必ず actionPerformed が呼ばれます。

Java

JComboBox<String> combo = new JComboBox<>(new String[]{"A", "B", "C"});
Object prev = combo.getSelectedItem();

combo.addActionListener(e -> {
    Object cur = combo.getSelectedItem();
    if (shouldCancel(cur)) {
        // キャンセル → 前回に戻す
        SwingUtilities.invokeLater(() -> combo.setSelectedItem(prev));
    } else {
        // 正常な選択
        prev = cur;
        System.out.println("選択確定: " + cur);
    }
});
  • ActionListener は ドロップダウンが閉じたタイミング（＝ユーザーが最終的に選んだとき）にだけ呼ばれるので、ItemListener の DESELECTED/SELECTED の二回呼び出しに悩まされません。
  • ただし、ComboBox が editable でテキスト入力が可能な場合は、ActionEvent が入力確定（Enter キー）でも走る点に注意が必要です。

手順 3：リスナーの一時的除外

どうしても ItemListener で細かい状態管理が必要なケース（例：別スレッドで非同期処理を走らせ、結果に応じてキャンセル判定を行う場合）では、リスナーの一時除外が有効です。

Java

ItemListener listener = e -> {
    if (e.getStateChange() == ItemEvent.SELECTED) {
        if (shouldCancel(e.getItem())) {
            // リスナー自体を外す → 次回は無視
            combo.removeItemListener(this);
            // 選択を元に戻す
            SwingUtilities.invokeLater(() -> {
                combo.setSelectedItem(prev);
                // 再度リスナーを付ける
                combo.addItemListener(this);
            });
        } else {
            prev = e.getItem();
        }
    }
};
combo.addItemListener(listener);
  • this が ItemListener のインスタンスであることを前提にしています。
  • invokeLater で addItemListener を遅延させることで、同一イベントループ内での再登録 を防ぎ、スタックオーバーフローの危険を回避します。

ハマった点やエラー解決

症状 原因 解決策
setSelectedItem を呼んだ瞬間に actionPerformed が再度呼ばれ、無限ループになる 同一スレッドで即座に再設定している SwingUtilities.invokeLater で次の EDT タスクに遅らせる
キャンセル後に ActionEvent が発生しない ItemListener で return しただけでモデルが更新されている setSelectedItem で元の項目に戻すか、removeItemListener/addItemListener の切り替え
UI がちらつく setSelectedItem が即座に描画される setEnabled(false/true) で一時的に描画を抑制、または JComboBox#setEditable(false) にして変更時のリフレッシュを最小化
ActionListener が期待したタイミングで呼ばれない（editable コンボで文字入力したとき） ActionEvent が「Enter キー」でも走るため、文字入力が途中でトリガーされる comboBox.setEditable(false) にするか、DocumentListener でテキスト入力を別管理する

完全サンプルコード

以下は、選択状態を元に戻す方式 と ActionListener に集約する方式 の両方をコメントで切り替えて使用できるサンプルです。

Java

import javax.swing.*;
import java.awt.*;
import java.awt.event.*;

public class ComboBoxCancelDemo {
    private static Object previousSelection;

    public static void main(String[] args) {
        SwingUtilities.invokeLater(() -> createAndShowGui());
    }

    private static void createAndShowGui() {
        JFrame frame = new JFrame("JComboBox キャンセルデモ");
        frame.setDefaultCloseOperation(JFrame.EXIT_ON_CLOSE);
        frame.setLayout(new FlowLayout());

        String[] items = {"Apple", "Banana", "Cherry", "Date"};
        JComboBox<String> combo = new JComboBox<>(items);
        previousSelection = combo.getSelectedItem();

        // ------------------- 方法 1: ActionListener に集約 -------------------
        combo.addActionListener(e -> {
            Object cur = combo.getSelectedItem();
            if (shouldCancel(cur)) {
                // キャンセル → 前回に戻す
                SwingUtilities.invokeLater(() -> combo.setSelectedItem(previousSelection));
                JOptionPane.showMessageDialog(frame, "選択はキャンセルされました");
            } else {
                previousSelection = cur;
                System.out.println("選択確定: " + cur);
            }
        });

        // ------------------- 方法 2: ItemListener + setSelectedItem -------------------
        // Uncomment 以下のコードを有効化すれば、ItemListener 方式に切り替わります
        /*
        combo.addItemListener(e -> {
            if (e.getStateChange() == ItemEvent.SELECTED) {
                Object cur = e.getItem();
                if (shouldCancel(cur)) {
                    SwingUtilities.invokeLater(() -> combo.setSelectedItem(previousSelection));
                    JOptionPane.showMessageDialog(frame, "選択はキャンセルされました");
                } else {
                    previousSelection = cur;
                    System.out.println("選択確定: " + cur);
                }
            }
        });
        */

        frame.add(new JLabel("フルーツを選択:"));
        frame.add(combo);
        frame.setSize(350, 120);
        frame.setLocationRelativeTo(null);
        frame.setVisible(true);
    }

    // ここでは例として「Cherry」の選択を禁止するロジックにしています
    private static boolean shouldCancel(Object item) {
        return "Cherry".equals(item);
    }
}
  • shouldCancel メソッドを自分のビジネスロジックに置き換えるだけで、任意の条件で選択をキャンセルできます。
  • コメントアウト部分を切り替えるだけで、ActionListener と ItemListener のどちらの実装でも同様の効果が得られます。

まとめ

本記事では、Java Swing の JComboBox で変更をキャンセルした後に再度 change（ItemEvent/ActionEvent）が発火しない 問題の原因を、内部モデルが更新されたままであることと、イベントフローの特性にあると説明しました。

解決策としては以下の3点が有効です。

  1. 選択状態を元に戻す（setSelectedItem を invokeLater で遅延実行）
  2. ActionListener にロジックを集約し、確定時のみ処理を走らせる
  3. リスナーの一時除外（removeItemListener/addItemListener）で余計なイベントを抑制

これらを組み合わせることで、ユーザーがキャンセル後に再度コンボボックスを操作しても期待通りにイベントが発火し、正しい状態遷移が保証されます。

今後は、非同期バックエンド呼び出しと連携したキャンセルロジックや、テスト自動化の観点からのイベント検証についても取り上げる予定です。

参考資料