JComboBoxで候補一覧を表示
Total: 16330, Today: 4, Yesterday: 0
Posted by aterai at
Last-modified:
概要
JComboBoxに入力候補の一覧表示機能(補完機能、コードアシスト、コンテンツアシスト)を追加します。
Screenshot
Advertisement
サンプルコード
String[] array = {
"aaaa", "aaaabbb", "aaaabbbcc", "aaaabbbccddd",
"abcde", "abefg", "bbb1", "bbb12"};
JComboBox combo = new JComboBox(array);
combo.setEditable(true);
combo.setSelectedIndex(-1);
JTextField field = (JTextField) combo.getEditor().getEditorComponent();
field.setText("");
field.addKeyListener(new ComboKeyHandler(combo));
// ...
class ComboKeyHandler extends KeyAdapter {
private final JComboBox<String> comboBox;
private final List<String> list = new ArrayList<>();
private boolean shouldHide;
public ComboKeyHandler(JComboBox<String> combo) {
super();
this.comboBox = combo;
for (int i = 0; i < comboBox.getModel().getSize(); i++) {
list.add(comboBox.getItemAt(i));
}
}
@Override public void keyTyped(final KeyEvent e) {
EventQueue.invokeLater(new Runnable() {
@Override public void run() {
String text = ((JTextField) e.getComponent()).getText();
ComboBoxModel<String> m;
if (text.isEmpty()) {
String[] array = list.toArray(new String[list.size()]);
m = new DefaultComboBoxModel<String>(array);
setSuggestionModel(comboBox, m, "");
comboBox.hidePopup();
} else {
m = getSuggestedModel(list, text);
if (m.getSize() == 0 || shouldHide) {
comboBox.hidePopup();
} else {
setSuggestionModel(comboBox, m, text);
comboBox.showPopup();
}
}
}
});
}
@Override public void keyPressed(KeyEvent e) {
JTextField textField = (JTextField) e.getComponent();
String text = textField.getText();
shouldHide = false;
switch (e.getKeyCode()) {
case KeyEvent.VK_RIGHT:
for (String s : list) {
if (s.startsWith(text)) {
textField.setText(s);
return;
}
}
break;
case KeyEvent.VK_ENTER:
if (!list.contains(text)) {
list.add(text);
Collections.sort(list);
setSuggestionModel(comboBox, getSuggestedModel(list, text), text);
}
shouldHide = true;
break;
case KeyEvent.VK_ESCAPE:
shouldHide = true;
break;
default:
break;
}
}
private static void setSuggestionModel(
JComboBox<String> comboBox, ComboBoxModel<String> mdl, String str) {
comboBox.setModel(mdl);
comboBox.setSelectedIndex(-1);
((JTextField) comboBox.getEditor().getEditorComponent()).setText(str);
}
private static ComboBoxModel<String> getSuggestedModel(List<String> list, String text) {
DefaultComboBoxModel<String> m = new DefaultComboBoxModel<>();
for (String s : list) {
if (s.startsWith(text)) {
m.addElement(s);
}
}
return m;
}
}
解説
上記のサンプルでは、次のキー操作に対応しています。
- Up, Downキー
- ポップアップ表示
- Escキー
- ポップアップ非表示
- Rightキー
- 補完
- Enterキー
- 選択、または追加
- 文字入力
- 候補をポップアップ
JComboBox#showPopup()とJComboBox#hidePopup()を使って候補のポップアップメニュー表示を制御- 候補を表示するとき
JComboBox#setSelectedIndex(-1)で項目の選択を一旦クリアしないと動作がおかしくなる場合がある
- 候補を表示するとき
JComboBoxではなくSwingSet3のJHistoryTextField.java のようにJTextField+JPopupMenuを使用することも可能だが、画面の下側で候補数が変更された場合のJPopupMenuの位置更新が面倒- 以下のように
ArrowButtonを非表示にしてJTextField風に見せかける方法もある
// UIManager.put("ComboBox.squareButton", Boolean.FALSE);
JComboBox = new JComboBox(model) {
@Override public void updateUI() {
super.updateUI();
setUI(new javax.swing.plaf.basic.BasicComboBoxUI() {
@Override protected JButton createArrowButton() {
JButton button = new JButton() {
@Override public int getWidth() {
return 0;
}
};
button.setBorder(BorderFactory.createEmptyBorder());
button.setVisible(false);
return button;
}
@Override public void configureArrowButton() {}
});
for (MouseListener ml: getMouseListeners()) {
removeMouseListener(ml);
}
}
};