概要

JComboBoxを使ってスクロール可能なポップアップメニューを表示します。

サンプルコード

class EditorComboPopup extends BasicComboPopup {
  private final JTextComponent textArea;
  private transient MouseAdapter listener;
  protected EditorComboPopup(JTextComponent textArea, JComboBox cb) {
    super(cb);
    this.textArea = textArea;
  }
  @Override protected void installListListeners() {
    super.installListListeners();
    listener = new MouseAdapter() {
      @Override public void mouseClicked(MouseEvent e) {
        hide();
        String str = (String) comboBox.getSelectedItem();
        try {
          Document doc = textArea.getDocument();
          doc.insertString(textArea.getCaretPosition(), str, null);
        } catch (BadLocationException ex) {
          ex.printStackTrace();
        }
      }
    };
    if (Objects.nonNull(list)) {
      list.addMouseListener(listener);
    }
  }
  @Override public void uninstallingUI() {
    if (Objects.nonNull(listener)) {
      list.removeMouseListener(listener);
      listener = null;
    }
    super.uninstallingUI();
  }
  @Override public boolean isFocusable() {
    return true;
  }
}
view all

解説

上記のサンプルでは、Shift+Tabでポップアップメニューが表示され、Up, Downキーで移動、EnterJTextPaneのカーソルの後に選択された文字列が入力されます。

JComboBoxのポップアップ部分のUIを表現するBasicComboPopupを利用することで、スクロールバーをもつポップアップメニューを実現しています。

フォーカスを取得して、キー入力で選択を変更できるように、BasicComboPopup#isFocusableメソッドをオーバーライドしています。また、BasicComboPopup#showしたあと、BasicComboPopup#requestFocusInWindowする必要があります。


JFrameから、ポップアップメニューがはみ出す(親WindowHeavyWeightWindowになる)場合、カーソルキーなどで、アイテムが移動選択できないバグがあったので、SwingUtilities.getWindowAncestor(popup).toFront();を追加するなどの修正(Ubuntuではうまく動作しない?)をしました。

private void popupMenu(ActionEvent e) {
  Rectangle rect = getMyPopupRect();
  popup.show(jtp, rect.x, rect.y + rect.height);
  EventQueue.invokeLater(new Runnable() {
    @Override public void run() {
      SwingUtilities.getWindowAncestor(popup).toFront();
      popup.requestFocusInWindow();
    }
  });
}
BasicComboPopup1.png
  • ただし、バージョン(6uN?)、Web Startなどで実行すると、AccessControlExceptionが発生します。
Exception in thread "AWT-EventQueue-0" java.security.AccessControlException: access denied (java.awt.AWTPermission setWindowAlwaysOnTop)

参考リンク

コメント

  • 大変参考になりました。その上、マウスクリックで文字列を選定できるようにしたいですが、どうすればいかがですか? -- java
    • どうもです。とりあえず(以前は、マウスクリックでも動作していたと思うのですが、勘違いだったのかも…?)、手抜きですが、BasicComboPopup#installListListenersメソッドをオーバーライドしてマウスリスナーを追加してみました。 -- aterai
  • 助かりました!感動です!ご回答ありがとうございました。 -- java
  • こんにちは。いつもこのサイトを参考にさせていただいています。ようやく自分のjavaアプリケーションをリリースしました(http://www.jdbckit.com まだ更新中ですが、)。次回のバージョンアップで、Special Thanksをバージョン情報画面に設けて、Terai Atsuhiro様のサイトを感謝対象にさせてよろしいでしょうか? -- java
    • こんばんは。どうもです。おお、おめでとうございます。リンクの件はご自由にどうぞ。 -- aterai
    • 余談: ドキュメントに何か書く必要があるのって、Apache Software Licenseでしたっけ?基本的(引用先を強調しているTipsを除く)に、このサイトのTipsは、ちいさなサンプルを目指しているため、コピペしても単独ではあまり役に立たないものが多く、完全に無保証なので、ライセンスなどは気しなくても良いです。 -- aterai