Intellij IDEA 插件开发 -- ListPopup

在开发 Intellij IDEA 插件的时候,我们有时候需要类似于上图这样的一个弹出菜单,来让用户在一系列的动作之间进行选择,这个类型的组件,在 Intellij IDEA 里面叫 ListPopup。

创建 ListPopup

要创建一个 ListPopup,只要用 JBPopupFactorycreateActionGroupPopup 方法即可,其主要的参数如下:

  • title:ListPopup 的标题。
  • actionGroup:ListPopup 所需要展示的 ActionGroup。
  • dataContext:用来提供被选中的 Action 数据,如果我们通过一个 AnAction 来创建 ListPopup 的话,可以直接通过 AnActionEventgetDataContext() 方法来获取 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。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 203,547评论 6 477
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 85,399评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 150,428评论 0 337
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,599评论 1 274
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,612评论 5 365
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,577评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,941评论 3 395
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,603评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,852评论 1 297
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,605评论 2 321
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,693评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,375评论 4 318
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,955评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,936评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,172评论 1 259
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 43,970评论 2 349
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,414评论 2 342

推荐阅读更多精彩内容