6.4 コンボボックス

コンボボックスは単一の項目を選択するドロップダウンリストを提供する編集可能なリストコンポーネントです。項目を列挙するコンポーネントなので多くの点でリストに似ていますが、単一の項目しか選択できないことや、必要に応じて項目を編集するという部分でリストとは異なります。

コンボボックスは javax.swing.JComboBox クラスを使って生成します。

java.lang.Object
  |
  +--java.awt.Component
        |
        +--java.awt.Container
              |
              +--javax.swing.JComponent
                    |
                    +--javax.swing.JComboBox

public class JComboBox extends JComponent
	implements ItemSelectable, ListDataListener, ActionListener, Accessible

コンボボックスもデータをドロップダウンリストに列挙するので、リスト同様に Object 型の配列や Vector オブジェクトをコンストラクタから受けることができます。また、リストが内部で項目を管理する ListModel オブジェクトを保有していたように、コンボボックスもまた ComboBoxModel オブジェクトをデータモデルとして保有しています。

コンボボックスはデフォルトでは編集不可能になってますが、必要に応じて項目を編集することができるコンボボックスを設定することもできます。項目が選択されたり、編集が終了するとコンボボックスは ActionListener オブジェクトのメソッドを呼び出し、項目の選択が変更した時点では ItemListener オブジェクトを呼び出します。他の項目を選択したときの動作は ItemListener が先に呼び出され、その後 ActionListener の順番となります。

javax.swing.event.PopupMenuListener インタフェースは、クリックなどの動作で項目を列挙するリストが展開するポップアップ型コンポーネントが通知するイベントを処理します。このインタフェースを実装すれば、コンボボックスのリストが表示されたり閉じられたりした瞬間を捉えることができます。このインタフェースには次のメソッドが宣言されてます。

public void popupMenuWillBecomeVisible(PopupMenuEvent e)

public void popupMenuWillBecomeInvisible(PopupMenuEvent e)nuEvent e)

public void popupMenuCanceled(PopupMenuEvent e)

パラメータで受け取る PopupMenuEvent クラスは EventObject クラスを継承するイベント情報クラスですが、ポップアップに関する情報は存在しないので、このクラスは新しいメソッドを宣言してません。JComboBox クラスの showPopup() メソッドと hidePopup() メソッドを呼び出せば、プログラムかリストを開閉することができることにも注目してください。

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

public class Test implements ActionListener, PopupMenuListener, ItemListener {
	public static void main(String args[]) {
		Test listener = new Test();

		JComboBox list = new JComboBox(args);
		list.addActionListener(listener);
		list.addItemListener(listener);
		list.addPopupMenuListener(listener);

		JFrame win = new JFrame();
		win.setDefaultCloseOperation(JFrame.EXIT_ON_CLOSE);
		win.setBounds(10 , 10 , 400 , 300);
		win.getContentPane().setLayout(new FlowLayout());
		win.getContentPane().add(list);
		win.show();
	}

	public void actionPerformed(ActionEvent e) {
		System.out.println("Action performed.");
	}

	public void itemStateChanged(ItemEvent e) {
		System.out.println("Item state changed.");
	}

	public void popupMenuWillBecomeVisible(PopupMenuEvent e) {
		System.out.println("Popup menu will become visible.");
	}
	public void popupMenuWillBecomeInvisible(PopupMenuEvent e) {
		System.out.println("Popup menu will become invisible.");
	}
	public void popupMenuCanceled(PopupMenuEvent e) {
		System.out.println("Popup menu canceled.");
	}
}

実行結果

コード1は、プログラム起動時に指定した引数を項目として表示するコンボボックスを表示します。このプログラムではコンボボックスが通知する主なイベントを実装し、イベントが発生すると標準出力にメソッドが起動されたことをアピールします。

JComboBox クラスのメソッドから新しい項目を追加するなど、ある程度項目を制御することは可能です。しかし、項目を特定の型に制限したり、動的に項目を増やしたり、削除したりするには、やはり項目を管理する javax.swing.ComboBoxModel インタフェースを使ったほうが便利でしょう。このクラスは ListBoxModel を継承しているので、基本的な考え方は ListBoxModel クラスと同じです。コンボボックスの場合は、選択されている項目を制御するメソッドが追加されています。

ComboBoxModel のデフォルトの実装は javax.swing.DefaultComboBoxModel クラスです。このクラスは Object 型の配列や Vector オブジェクトを使って項目を初期化できるほかに、動的に項目を追加したり、削除したりすることができます。

java.lang.Object
  |
  +--javax.swing.AbstractListModel
        |
        +--javax.swing.DefaultComboBoxModel

public class DefaultComboBoxModel extends AbstractListModel implements MutableComboBoxModel, Serializable

DefaultComboBoxModel が実装している javax.swing.MutableComboBoxModel インタフェースは ComboBoxModel を継承する動的に項目を設定できるコンボボックスのモデルであることを保証します。DefaultComboBoxModel は、これらのすべての機能を提供しているのです。

コンボボックスのデータモデルが MutableComboBoxModel を実装しているのであれば、コンボボックスにはデータを可変的に追加したり削除することができることを意味します。逆に、独自にモデルを実装するのであれば、データモデルが動的か静的かで ComboBoxModel を実装するのか、MutableComboBoxModel を実装するのかを判断すると良いでしょう。

コンボボックスにデータモデルを設定するには、コンストラクタのほかに setModel() メソッドがあります。現在、コンボボックスが項目を管理するために利用しているモデルを取得するには getModel() メソッドを使います。

public void setModel(ComboBoxModel aModel)

public ComboBoxModel getModel()

独自に実装した ComboBoxModel を採用したい場合は setModel() メソッドやコンストラクタからオブジェクトを設定すると良いでしょう。

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

public class Test extends JFrame implements ActionListener {
	public static void main(String args[]) {
		JFrame win = new Test();
		win.setDefaultCloseOperation(JFrame.EXIT_ON_CLOSE);
		win.setBounds(10 , 10 , 400 , 300);
		win.show();
	}

	private JComboBox list = new JComboBox();
	private JButton addButton = new JButton("Add Item");
	private JButton removeButton = new JButton("Remove Item");
	public Test() {
		addButton.addActionListener(this);
		removeButton.addActionListener(this);

		getContentPane().setLayout(new FlowLayout());
		getContentPane().add(addButton);
		getContentPane().add(removeButton);
		getContentPane().add(list);
	}

	public void actionPerformed(ActionEvent e) {
		ComboBoxModel cModel = list.getModel();
		MutableComboBoxModel mcModel = null;
		if (cModel instanceof MutableComboBoxModel) {
			mcModel = (MutableComboBoxModel)cModel;
		}
		else return;

		if (e.getSource() == addButton) {
			mcModel.addElement("Item" + cModel.getSize());
		}
		else if (e.getSource() == removeButton) {
			if (cModel.getSize() == 0) return;
			mcModel.removeElementAt(list.getSelectedIndex());
		}
	}
}

実行結果

コード 06_04_01 は ComboBoxModel を利用して動的にコンボボックスの項目を追加したり、削除したりすることができるプログラムです。"Add Item" ボタンを押すと項目が追加され "Remove Item" ボタンを押すと現在選択されているボタンが削除されます。

ボタンが押されると、まず getModel() メソッドを使ってコンボボックスに設定されているデータモデルを取得します。次に instanceof 演算子でこのモデルが可変であるかどうかを調べ MutableComboBoxModel を実装しているようであればキャストします。デフォルトのモデルである DefaultComboBoxModel クラスは MutableComboBoxModel を採用していますが、独自の実装であれば必ずしも MutableComboBoxModel を実装しているとは限りません。

無事にキャストできれば、後はイベントオブジェクトの getSource() メソッドでイベントを発生させたオブジェクトを調べます。このプログラムでは 2 つのボタンが同じ ActionListener を共有しているので、どちらのボタンが押されたのかを識別する必要があるためです。

因みに、コンボボックスの項目もセルレンダラを保有しているため、項目の描画を拡張することができます。コンボボックスのセルを描画するのはリストと同じ ListCellRenderer オブジェクトなので、拡張方法はリストと同じです。レンダラを設定するには setRenderer() メソッドを、取得するには getRenderer() メソッドを使います。

public void setRenderer(ListCellRenderer aRenderer)

public ListCellRenderer getRenderer()

レンダラを独自に実装すれば、アイコンやイメージを項目として描画することができるようになるでしょう。

あまり編集を目的としてコンボボックスが利用されることはないと思われますが、コンボボックスは項目を編集する機能があります。デフォルトでは編集機能は無効とされてますが、JComboBox クラスの setEditable() メソッドを使って切り替えることが可能です。現在、項目を編集することができるかどうかを調べるには isEditable() メソッドを使います。

public void setEditable(boolean aFlag)

public boolean isEditable()

setEditable() メソッドに true を設定すれば、コンボボックスは編集可能となります。このとき編集領域に表示されるのは Swing のテキスト入力コンポーネントです。つまり、項目のテキストを編集することができるのです。

しかし、レンダラやデータモデルを拡張してイメージを列挙している場合、テキストを編集するのは奇妙です。コンボボックスがイメージを扱っているのであれば、テキストではなくイメージを編集する手段を提供するべきかもしれません。すばらしいことに、Swing はエディタを独自に実装する手段を提供してます。

isEditable() が true の状態であれば、コンボボックスは自らに設定されている javax.swing.ComboBoxEditor インタフェースを実装するオブジェクトを使ってエディタを表示します。このインタフェースは編集対象のオブジェクトと、編集を行うコンポーネント、そして編集の終了を通知するイベントを提供します。

Swing のデフォルトの実装は javax.swing.plaf.basic.BasicComboBoxEditor クラスです。 このクラスでは、Swing のテキスト入力フィールドをコンボボックスのエディタとして返します。

ただし、コンボボックスの編集機能はあくまで簡易機能であり、本格的な編集作業を行う必要があれば、専用のコンポーネントを開発したほうがユーザーにとっては使いやすいでしょう。

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

public class Test {
	public static void main(String args[]) {
		JComboBox list = new JComboBox(args);
		list.setEditable(true);

		JFrame win = new JFrame();
		win.setDefaultCloseOperation(JFrame.EXIT_ON_CLOSE);
		win.setBounds(10 , 10 , 400 , 300);
		win.getContentPane().add(list , BorderLayout.NORTH);
		win.show();
	}
}

実行結果

コード 06_04_02 は編集可能なコンボボックスを表示してます。このコンボボックスが表示しているテキスト入力コンポーネントは Swing の JTextField と言うコンポーネントです。テキスト入力について、詳しくは第8章で解説します。