Eclipse RCP菜单&动作:配置还是代码?

时间:2011-01-19 15:43:00

标签: eclipse-rcp eclipse-rap plugin.xml

这是一个普遍的问题,但我目前的问题围绕菜单处理。

在具有贡献菜单操作的普通插件中,您将在plugin.xml配置中配置ActionSets等。这显然是明智的。

我正在研究RCP应用程序(实际上是RAP),我想知道是否值得通过plugin.xml配置所有内容。我的插件不必与其他未知的插件交互,所以理论上,我有控制权。我可以通过编程方式添加菜单和操作。

我一直在尝试配置包含子菜单的菜单。我尝试过定义ActionSet并将其中一个链接到另一个但没有成功。某些项目需要根据用户角色禁用。

我想我可以在几分钟内完成所有的编码,但我不确定这是否符合日食的'精神'。

那里有什么意见?应用程序将变得相当大,所以我想从一开始就采用这种方法。也许有人可以给我一个配置嵌套菜单的例子: - )

4 个答案:

答案 0 :(得分:25)

我的观点是plugin.xml实现是要走的路。

使用此方法的主要原因有两个:

  • 在不编写Java代码的情况下,重新配置和重新组织菜单和按钮非常容易。
  • 非常清晰的菜单树分层可视化。

这是一个实现菜单和子菜单的代码片段。在此示例中,它们将添加到主菜单中。

您可以将其粘贴到plugin.xml中:

<extension
         name="Main Menu Contributions"
         point="org.eclipse.ui.menus">
 <menuContribution
        allPopups="false"
        locationURI="menu:org.eclipse.ui.main.menu">
     <menu
           id="fileMenu"
           label="File">
        <command
              commandId="org.eclipse.ui.file.exit"
              label="Exit"
              style="push">
        </command>
     </menu>
     <menu
           label="Edit">
        <command
              commandId="org.eclipse.ui.edit.selectAll"
              label="Select All"
              style="push">
        </command>
        <menu
              label="Submenu">
           <command
                 commandId="org.eclipse.ui.edit.selectAll"
                 label="Select All Submenu"
                 style="push">
           </command>
           <command
                 commandId="org.eclipse.ui.edit.delete"
                 label="Delete submenu"
                 style="push">
           </command>
        </menu>
     </menu>
  </menuContribution>
</extension>

要激活/停用菜单,必须使用Core Expressions启用/禁用命令处理程序。如果命令没有附加任何活动处理程序,它将被禁用。因此,调用该命令的菜单项也将被禁用。

以下代码段显示如何在视图的工具栏上创建按钮,并根据变量的值启用/禁用该按钮。请记住,您必须更改此代码中的某些内容才能使其正常工作。大多数更改都是针对参考名称和类实现。

在工具栏中创建按钮(plugin.xml):

   <extension
         name="View Toolbar Contributions"
         point="org.eclipse.ui.menus">
      <menuContribution
            allPopups="false"
            locationURI="toolbar:myapp.views.MyView">
       <command
             commandId="myapp.commands.PauseSound"
             icon=""
             label="Pause Playback Sound"
             style="push"
             tooltip="Pause">
       </command>
     </menuContribution>
</extension>

创建命令(plugin.xml):

<extension
         id="myapp.commands.PauseSound"
         name="Pause sound command"
         point="org.eclipse.ui.commands">
      <command
            id="myapp.commands.PauseSound"
            name="Pause Sound">
      </command>
</extension> 

创建命令处理程序(plugin.xml):

<extension
         point="org.eclipse.ui.handlers">
      <handler
            commandId="myapp.commands.PauseSound">
         <activeWhen>
            <with
                  variable="myapp.commands.sourceprovider.active">
               <or>
                  <equals
                        value="PLAYING">
                  </equals>
                  <equals
                        value="PAUSED">
                  </equals>
               </or>
            </with>
         </activeWhen>
         <class
               class="myapp.rcp.commands.toolbar.PausePlayback">
         </class>
      </handler>
</extension> 

为命令创建状态变量(plugin.xml):

   <extension
         point="org.eclipse.ui.services">
      <sourceProvider
            provider="myapp.commands.sourceprovider.CommandState">
         <variable
               name="myapp.commands.sourceprovider.active"
               priorityLevel="workbench">
         </variable>
      </sourceProvider>
   </extension>

实现更改变量状态的类:

public class CommandState extends AbstractSourceProvider {
    public final static String STATE = "myapp.commands.sourceprovider.active";
    public final static String STOPPED = "STOPPED";
    public final static String PLAYING = "PLAYING";
    public final static String PAUSED = "PAUSED";
    public final static String NOT_LOADED = "NOT_LOADED";

enum State {
        NOT_LOADED, PLAYING, PAUSED, STOPPED
    };
    private State curState = State.NOT_LOADED;

    @Override
    public void dispose() {
    }

    @Override
    public String[] getProvidedSourceNames() {
        return new String[] { STATE };
    }

    // You cannot return NULL
    @SuppressWarnings("unchecked")
    @Override
    public Map getCurrentState() {
        Map map = new HashMap(1);
        if (curState == State.PLAYING)
            map.put(STATE, PLAYING);
        else if (curState == State.STOPPED)
            map.put(STATE, STOPPED);
        else if (curState == State.PAUSED)
            map.put(STATE, PAUSED);

        return map;
    }

    public void setPlaying() {
        fireSourceChanged(ISources.WORKBENCH, STATE, PLAYING);
    }

    public void setPaused() {
        fireSourceChanged(ISources.WORKBENCH, STATE, PAUSED);
    }

    public void setStopped() {
        fireSourceChanged(ISources.WORKBENCH, STATE, STOPPED);
    }

    public void setNotLoaded() {
        fireSourceChanged(ISources.WORKBENCH, STATE, NOT_LOADED);
    }

}

有关如何实施这些功能的更多详细信息,请访问以下网址:

答案 1 :(得分:1)

对于Eclipse,有两种不同的方式可以为Workbench做贡献:操作和命令。

我绝对建议将命令作为比命令更新,更高级的操作。 这里指定的Actions的缺点是(1):

  • UI和处理始终是并列的。你无法互相分离
  • 虽然可以将动作贡献给工作台的不同部分(弹出菜单/工具栏),但它们都是不同的扩展点,因此您最终会在多个位置复制XML。最糟糕的是,并非所有扩展点都期望相同的配置。
  • 在多个位置指定操作是一项维护噩梦。如果您必须更改操作的图标,则需要更改所有位置。
  • 在plugin.xml中复制Actions的另一个问题是,将在内存中创建相同Actions的多个实例

    (1)Actions vs Commands

答案 2 :(得分:0)

如果您正在编写RCP应用程序,那么最佳做法是在ActionBarAdvisor中创建占位符。虽然这将定义菜单和工具栏的基本结构,但您可以扩展menuContributions并使用命令来提供实际的菜单/工具项。

答案 3 :(得分:0)

要在RCP中添加操作,您还可以使用ApplicationActinBarAcvisor。它比上述解决方案更容易 在这个你只需要首先声明该动作作为IWorkbenchAction的对象,然后在方法“protected void makeActions(IWorkbenchWindow window)”中你可以注册它。 最后一步是将其添加到菜单中。 以下代码将帮助您解决问题。

1.首先宣布行动: -

private IWorkbenchAction newAction

2.注册行动: -

protected void makeActions(IWorkbenchWindow window) {
newAction = ActionFactory.NEW_WIZARD_DROP_DOWN.create(window);
    register(newAction);
    newAction.setText("New");

3.最后一步是在菜单中添加操作: -

MenuManager filemenu = new MenuManager("&File", "file");
    filemenu.add(newAction);

您还可以按如下方式在工具栏中添加操作: -

protected void fillCoolBar(ICoolBarManager coolBar) {
    IToolBarManager toolbar = new ToolBarManager(coolBar.getStyle());
    coolBar.add(toolbar);
    toolbar.add(newAction);