创建操作

原文链接:
http://www.jetbrains.org/intellij/sdk/docs/basics/getting_started/creating_an_action.html

你的插件可以通过向菜单和工具栏添加新项来自定义IntelliJ平台的UI。IntelliJ平台提供了AnAction类,每当您选择菜单项或单击工具栏按钮时,其actionPerformed方法就会被调用。

要在IntelliJ平台中创建自定义操作,你需要执行两个基本步骤:

  1. 在你的插件中,定义一个操作并将它添加到菜单和工具栏上;
  2. 注册你的操作。

本节概述了上述步骤。更多详情和示例参阅IntelliJ平台操作体系

定义操作

操作类是从AnAction类派生的类。要在你的插件中定义一个操作,需要创建一个从AnAction类派生的Java类。在这个类中重写actionPerformed方法,当菜单项或工具栏按钮被选中时,这个方法就会被调用。

为了阐明这个过程,查看以下代码段,其定义了一个从AnAction类派生的TextBoxes类:

public class TextBoxes extends AnAction { 
    // 如果你使用Java代码注册操作,这个构造方法被用来设置菜单项名称
    // (你也可以指定菜单描述和显示在菜单旁边的图标)。
    // 在plugin.xml文件中注册操作时,你可以省略这个构造方法。
     public TextBoxes() { 
        // 设置菜单项名称
        super("Text _Boxes"); 
        // 设置菜单项名称、描述和图标
        // super("Text _Boxes","Item description",IconLoader.getIcon("/Mypackage/icon.png")); 
    } 
     public void actionPerformed(AnActionEvent event) {
        Project project = event.getData(PlatformDataKeys.PROJECT); 
        String txt= Messages.showInputDialog(project, "What is your name?", "Input your name", Messages.getQuestionIcon()); 
        Messages.showMessageDialog(project, "Hello, " + txt + "!\n I am glad to see you.", "Information", Messages.getInformationIcon()); 
    }
}

注意你可以定义一系列从AnAction类派生的类,这样你的插件就定义了一个操作体系。

注册操作

一旦你定义了一个操作或一个操作体系,你必须注册它们以指定与其相关联的菜单项或工具栏按钮。你可以使用以下方式注册操作:

  • plugin.xml文件中的<action>段中注册操作;
  • 从Java代码中注册操作。

本节提供了一些注册操作的示例。 更多详情参阅IntelliJ平台操作体系

在plugin.xml文件中注册操作

要注册操作,需要对IDEA项目的plugin.xml文件的<actions>部分进行相应的更改。以下plugin.xml文件的代码在主菜单上添加了一个菜单组。点击它你将可以看到Text BoxesShow Dialog 菜单项:

<actions>
    <group id="MyPlugin.SampleMenu" text="_Sample Menu" description="Sample menu"> 
        <add-to-group group-id="MainMenu" anchor="last" /> 
        <action id="Myplugin.Textboxes" class="Mypackage.TextBoxes" text="Text _Boxes" description="A test menu item" /> 
        <action id="Myplugin.Dialogs" class="Mypackage.MyShowDialog" text="Show _Dialog" description="A test menu item" /> 
    </group>
</actions>

这部分代码仅演示了部分你可以在<actions>段中使用的元素。想要了解所有的元素可以参阅IntelliJ平台操作体系

在Java代码中注册操作

你也可以从Java代码注册操作。 从Java代码注册操作的更多信息和示例可以参阅IntelliJ平台操作体系

快速创建操作

IntelliJ平台提供了新建操作向导,其提供了创建操作的简便方法。该向导可以帮助您声明操作类,并自动对plugin.xml文件的<actions>部分进行适当的更改。

注意:使用此向导你仅可以将新操作添加到主菜单或工具栏上的现有操作组。 如果你想要创建新的操作组并向此组添加操作,请参照前述方法进行操作。

使用新建操作向导注册和创建操作
  1. 在你的项目中,在目标包的上下文菜单上点击新建或按Alt + Insert
  2. 新建菜单上点击操作
  3. 在打开的新建操作页面,填写以下字段然后点击确定:
    操作ID: 输入操作的唯一ID。推荐格式: PluginName.ID
    类名: 输入创建的操作的类名。
    名称: 输入操作相关的菜单项名称或工具栏按钮提示。
    描述: 可选,操作的描述。当焦点在操作上时,描述回显示在IDEA的状态栏上。
    添加到组区域的操作Anchor,指定新建操作添加到的操作组和相对于现有操作的位置。
    快捷键区域指定操作的快捷键(可选)。

IntelliJ平台将生成具有指定类名的.java文件,在plugin.xml文件中注册新建的操作,向模块树视图中添加一个节点,并在编辑器中打开创建的操作类文件。

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

推荐阅读更多精彩内容