Swing/ComponentPopupMenu のバックアップ(No.18)

category: swing folder: ComponentPopupMenu title: JPopupMenuをコンポーネントに追加 tags: [JPopupMenu, JTextComponent, PopupMenuListener, DefaultEditorKit] author: aterai pubdate: 2008-03-10T01:39:57+09:00 description: コンポーネントに右クリックなどでポップアップするJPopupMenuを追加します。 image:

概要

コンポーネントに右クリックなどでポップアップするJPopupMenuを追加します。

Screenshot

Download

サンプルコード

JTextArea textArea = new JTextArea("ComponentPopupMenu Test");
textArea.setComponentPopupMenu(new TextComponentPopupMenu());

View in GitHub: Java, Kotlin

class TextComponentPopupMenu extends JPopupMenu {
  private final Action cutAction = new DefaultEditorKit.CutAction();
  private final Action copyAction = new DefaultEditorKit.CopyAction();
  private final Action pasteAction = new DefaultEditorKit.PasteAction();
  private final Action deleteAction;
  private final Action selectAllAction;
  public TextComponentPopupMenu() {
    super();
    add(cutAction);
    add(copyAction);
    add(pasteAction);
    addSeparator();
    add(deleteAction = new AbstractAction("delete") {
      @Override public void actionPerformed(ActionEvent evt) {
        ((JTextComponent) getInvoker()).replaceSelection(null);
      }
    });
    addSeparator();
    add(selectAllAction = new AbstractAction("select all") {
      @Override public void actionPerformed(ActionEvent evt) {
        ((JTextComponent) getInvoker()).selectAll();
      }
    });
    //ActionMap am = textArea.getActionMap();
    //add(cutAction = am.get("cut-to-clipboard"));
    //add(copyAction = am.get("copy-to-clipboard"));
    //add(am.get("paste-from-clipboard"));
    //addSeparator();
    //add(deleteAction = am.get("delete-next"));
    //addSeparator();
    //add(am.get("select-all"));
  }
  @Override public void show(Component c, int x, int y) {
    JTextComponent textArea = (JTextComponent) c;
    boolean flg = textArea.getSelectedText() != null;
    cutAction.setEnabled(flg);
    copyAction.setEnabled(flg);
    deleteAction.setEnabled(flg);
    super.show(c, x, y);
  }
}

解説

上記のサンプルでは、JTextAreaにsetComponentPopupMenu(JPopupMenu)メソッドで、ポップアップメニューを追加しています。

JDK 1.5でこのメソッドが追加されたため、各コンポーネントにマウスリスナーを設定して、e.isPopupTrigger()でポップアップを表示するクリックかを判断するといったコードを書く必要が無くなりました。

ポップアップメニューを表示するときに、コンポーネントの状態(例えばJTableやJListなどでの行選択の有無や、テキストが選択されてるかとどうかなどの条件)で、メニューが実行可か不可かを変更したい場合は、JPopupMenu#show(Component, int, int)メソッドをオーバーライドして使用します。

このサンプルでは、テキストが選択されている場合だけ、カット、コピー、削除メニューが有効になるよう設定しています。

JPopupMenu#show(Component, int, int)のオーバーライドではなく、PopupMenuListenerを使用する方法もあります。

JPopupMenu popup = new JPopupMenu();
final Action cutAction = new DefaultEditorKit.CutAction();
final Action copyAction = new DefaultEditorKit.CopyAction();
final Action pasteAction = new DefaultEditorKit.PasteAction();
final Action deleteAction = new AbstractAction("delete") {
  @Override public void actionPerformed(ActionEvent e) {
    ((JTextComponent) getInvoker()).replaceSelection(null);
  }
};
final Action selectAllAction = new AbstractAction("select all") {
  @Override public void actionPerformed(ActionEvent e) {
    JPopupMenu p = (JPopupMenu) e.getSource();
    ((JTextComponent) p.getInvoker()).selectAll();
  }
};
popup.add(cutAction);
popup.add(copyAction);
popup.add(pasteAction);
popup.addSeparator();
popup.add(deleteAction);
popup.addSeparator();
popup.add(selectAllAction);
popup.addPopupMenuListener(new PopupMenuListener() {
  @Override public void popupMenuCanceled(PopupMenuEvent e) {}
  @Override public void popupMenuWillBecomeInvisible(PopupMenuEvent e) {}
  @Override public void popupMenuWillBecomeVisible(PopupMenuEvent e) {
    JPopupMenu p = (JPopupMenu) e.getSource();
    JTextComponent c = (JTextComponent) p.getInvoker();
    boolean flg = c.getSelectedText() != null;
    cutAction.setEnabled(flg);
    copyAction.setEnabled(flg);
    deleteAction.setEnabled(flg);
  }
});
textArea.setComponentPopupMenu(popup);

注: PopupMenuEventからはマウスでクリックした位置を取得できない
- このため、JTabbedPaneなどでどのタブの上でポップアップが表示されるかなどを取得したい場合はJPopupMenu#show(...)をオーバーライドする必要がある
- 参考: JTabbedPaneでタブを追加削除

Swing/ComponentPopupMenu のバックアップ(No.18)

概要

Screenshot

Download

Advertisement

サンプルコード

解説

参考リンク

コメント