在开发 Intellij IDEA 插件的时候,我们有时候需要类似于上图这样的一个弹出菜单,来让用户在一系列的动作之间进行选择,这个类型的组件,在 Intellij IDEA 里面叫 ListPopup。
创建 ListPopup
要创建一个 ListPopup
,只要用 JBPopupFactory
的 createActionGroupPopup
方法即可,其主要的参数如下:
-
title
:ListPopup 的标题。 -
actionGroup
:ListPopup 所需要展示的 ActionGroup。 -
dataContext
:用来提供被选中的 Action 数据,如果我们通过一个AnAction
来创建 ListPopup 的话,可以直接通过AnActionEvent
的getDataContext()
方法来获取DataContext
。 -
selectionAidMethod
:采用何种方式用键盘选择 ListPopup 里面的 Action,ActionSelectionAid
这个枚举里面定义了所有的可选值,大家可以根据需要进行选择。 -
showDisabledActions
:是否显示已经 Disable 的 Action。
展示 ListPopup
当创建好 ListPopup 之后,可以直接调用 ListPopup 里面的各种 show
开头的方法来显示,几个主要的方法如下:
-
showInCenterOf()
:在一个 Component 的中间弹出 ListPopup。 -
showCenteredInCurrentWindow()
:在当前窗口的中间弹出 ListPopup。 -
showInBestPositionFor()
:根据 DataContext 或者 Editor 来选择最佳位置来展示,经过测试,一般上都会直接根据当前光标的位置来进行显示。
实例
做了简单的介绍之后,我们来搞一个实例来演示这个功能,首先,创建一个如下的类:
public class JBPopupFactoryAction extends AnAction {
@Override
public void actionPerformed(AnActionEvent e) {
DefaultActionGroup actionGroup = (DefaultActionGroup) ActionManager.getInstance().getAction("Sample_JBPopupActionGroup");
actionGroup.removeAll();
actionGroup.add(new AnAction("Sample Action") {
@Override
public void actionPerformed(AnActionEvent e) {
}
});
ListPopup listPopup = JBPopupFactory.getInstance().createActionGroupPopup("ListPopup Sample", actionGroup, e.getDataContext(), JBPopupFactory.ActionSelectionAid.SPEEDSEARCH, false);
listPopup.showInBestPositionFor(e.getDataContext());
}
}
在上面的代码中,我们先通过 ActionManger 来获取一个 ID 为 Sample_JBPopupActionGroup
的 ActionGroup,这个 ActionGroup 是定义在插件的 plugin.xml
里面的 <actions>
标签下的:
<group id="Sample_JBPopupActionGroup"/>
获取到 ActionGroup 之后,我们可以往 ActionGroup 里面去添加 Action 了,如果需要每次都更新 ActionGroup 里面的 Action 的话,可以调用它的 removeAll()
方法来进行清理,再添加新的 Action。
注意:有些时候,我们会直接继承
DefaultActionGroup
,覆盖update(AnActionEvent e)
来达到每次展示 ActionGroup 之前都进行更新的目的,但是这个方法在 ListPopup 里面行不通,ListPopup 每次展示并不会调用它所包含的 ActionGroup 的update(AnActionEvent e)
方法 。
在准备好 ActionGroup 之后,我们就可以直接调用 JBPopupFactory.getInstance().createActionGroupPopup()
来创建出 ListPopup 了,创建完毕以后,调用一个 showInBestPositionFor()
即可展示。
当然,我们的创建的 JBPopupFactoryAction
并没有任何方式去触发它,为了能够触发它,可以在 plugin.xml
里面定义一个 Action,并且给它绑上快捷键,这样就可以通过快捷键来进行触发了:
<action class="com.khotyn.intellij.idea.sample.listpopup.JBPopupFactoryAction"
id="Sample_JBPopupFactoryAction">
<keyboard-shortcut first-keystroke="control alt 1" keymap="Mac OS X 10.5+"/>
</action>
按照上面的代码,我们通过在 Intellij IDEA 里面按下 Ctrl+Alt+1
就能够触发 JBPopupFactoryAction
,从而把创建出来的 ListPopup 弹出来了,效果如题图所示。
注意:上面的 action 标签的
keymap
属性定义的时候快捷键在哪个 Keymap 下生效,我因为用的是Mac OS X 10.5+
的快捷键方案,所以写的是Mac OS X 10.5+
,大家可以在KeymapManager
里面找到所有预定义的 Keymap。
本文的样例代码位于:https://coding.net/u/khotyn/p/intellij_idea_plugin_samples/git,大家可以自行 Clone。