操作体系

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

执行和更新操作

操作体系允许插件向IDEA添加自己的菜单项和工具栏按钮。一个操作就是一个派生自AnAction类的类，当选择菜单项或点击工具栏按钮时，它的actionPerformed方法就会被调用。例如，其中一个操作类就是负责文件|打开文件...菜单项和打开文件 工具栏按钮的。

操作被组织成组，其又可以包含其他组。 一组操作可以形成工具栏或菜单。
组的子组可以形成菜单的子菜单。

每个操作和操作组都有一个唯一的标识符。标准IDEA操作的标识符在IdeActions类中定义。

每个操作都可以包含在多个组中，因此一个操作会出现在IDEA用户界面中的多个位置。操作可以出现的位置由ActionPlaces接口中的常量定义。 操作出现的每个地方都会新建一个Presentation。因此相同的操作在不同位置可以有不同的文本和图标。 操作的不同presentation可以通过复制AnAction.getTemplatePresentation()方法返回的presentation创建。

IDEA通过定期调用AnAction.update()方法更新操作的状态。传递给此方法的AnActionEvent对象携带了操作当前上下文的信息，特别是需要更新的指定presentation。

使用AnActionEvent.getData()方法可以获取当前IDE的信息，包括活动项目、所选文件、编辑器中的选择等。可以传递给此方法的数据键在CommonDataKeys类中定义。

AnActionEvent实例也会传递给actionPerformed方法。

注册操作

目前有两种注册操作的方法：在plugin.xml文件的部分列出或通过Java代码。

在plugin.xml文件中注册操作

以下是在plugin.xml中注册操作的方法，其演示了所有可以在部分使用的元素，并描述了每个元素的含义。

从代码中注册操作

从代码中注册操作，有两个步骤：

• 首先，必须往ActionManager类的registerAction方法传入一个派生自AnAction类的实例，将操作与ID关联；
• 然后，操作需要添加进一个或多个组。要通过ID获取一个操作组的实例，需要调用 ActionManager.getAction()并将返回值转换为DefaultActionGroup类。

你可以使用以下方法创建一个在IDEA启动时注册操作的插件。

在IDEA启动时注册操作

• 新建一个实现ApplicationComponent接口的类；
• 在这个类中重写getComponentName、initComponent和disposeComponent方法；
• 在plugin.xml文件的部分注册这个类。

要阐明以上过程，查看以下实例Java类MyPluginRegistration，它注册了一个由TextBoxes类定义的操作并将其添加到主菜单的Window菜单组：

public class MyPluginRegistration implements ApplicationComponent {
  // 返回组件名称（唯一字符串）
  @NotNull public String getComponentName() {
    return "MyPlugin";
  }


  // 如果你在plugin.xml文件的部分注册了MyPluginRegistration类，
  // 这个方法将在IDEA启动时被调用
  public void initComponent() {
    ActionManager am = ActionManager.getInstance();
    TextBoxes action = new TextBoxes();

    // 将TextBoxes类的实例传入ActionManager类的registerAction方法
    am.registerAction("MyPluginAction", action);

    // 获取WindowMenu操作组的实例
    DefaultActionGroup windowM = (DefaultActionGroup) am.getAction("WindowMenu");

    // 添加一个分隔符和操作到主菜单的WindowMenu操作组
    windowM.addSeparator();
    windowM.add(action);
  }

  // Disposes system resources.
  public void disposeComponent() {
  }
}

注意：TextBoxes类的实现可以查看创建操作.

在plugin.xml文件的部分做以下更改确保你的插件在IDEA启动时被初始化：

  
  
    MypackageName.MyPluginRegistration
  

从操作中构建UI

如果插件需要包括一个工具栏或弹出菜单，它是在自己的UI上从操作组中构建的，可以使用ActionPopupMenu和ActionToolbar类实现。这些对象可以通过调用ActionManager.createActionPopupMenu和ActionManager.createActionToolbar方法创建。要从这样的对象上获取Swing组件可以简单调用getComponent()方法。

如果你对操作工具栏要附加到指定组件上（例如，工具窗口的面板），你通常需要调用ActionToolbar.setTargetComponent() 方法，并将相关组件的实例作为参数传入。这样可以确保工具栏按钮的状态依赖于相关组件而不是IDE框架内当前焦点位置的状态。