Skip to main content
Jump to: navigation, search

Difference between revisions of "Menu Contributions"

m (Fixed a typo)
 
(272 intermediate revisions by 15 users not shown)
Line 1: Line 1:
Placement examples that try to descript the old to new way.
+
Placement examples that describe the proposed new way of placing menu items for '''3.3'''.  Please contribute comments and suggestions in the discussion area or on [https://bugs.eclipse.org/bugs/show_bug.cgi?id=154130 Bug 154130 -KeyBindings- Finish re-work of commands and key bindings].  
  
 +
= Placement and visibility =
 +
 +
The 4 extension points that deal with menus now org.eclipse.ui.actionSets, org.eclipse.ui.viewActions, org.eclipse.ui.editorActions, and org.eclipse.ui.popupMenus specify both menu placement and their visibility criteria.  In the new menu mechanism they are separate concepts, placement and visibility.
  
 
= Example Matrix =
 
= Example Matrix =
 +
 +
A (hopefully) growing list of menu contribution examples.
  
 
{| class="wikitable" border="1"
 
{| class="wikitable" border="1"
 
|-
 
|-
! Example !! Location !! visible when !! enabled when !! defined by !! placed by !! handled by !! comments
+
! Example !! comments
 
|-
 
|-
| [[#File->Exit|File->Exit]] || global menu || always || always || ActionFactory || WorkbenchActionBuilder || QuitAction
+
| [[Menu Contributions/Dropdown Command]] || Dropdown tool items can have their menus filled in using menu contributions
 
|-
 
|-
| [[#Edit->Copy|Edit->Copy]] || global menu || always || there is an enabled handler || Workbench || IDEApplication || active part (what about Trim??) || enablement determined by handler
+
| [[Menu Contributions/Problems View Example]] || An example showing how the Problems View might be converted
 
|-
 
|-
| [[#Global toolbar->Save|Global toolbar->Save]] || global toolbar || always || the active part needs saving || Workbench || IDEApplication || Workbench
+
| [[Menu Contributions/Populating a dynamic submenu]] || A menu contribution to populate a Problems View dynamic submenu
 
|-
 
|-
| [[#Global toolbar->Open Type|Global toolbar->Open Type]] || global toolbar || Java Navigation action set is enabled || Java Navigation action set is enabled || JDT UI || JDT UI || JDT UI
+
| [[Menu Contributions/Toggle Mark Occurrences]] || Placing the toggle mark occurrences button
 
|-
 
|-
| [[#Global toolbar->Toggle Mark Occurrences|Global toolbar->Toggle Mark Occurrences]] || global (editor) toolbar || any Java editor is active || any Java editor is active || all Java Editors || all Java Editors || active Java Editor || push button state is updated based on active editor
+
| [[Menu Contributions/Toggle Button Command]] || Contribute a toggle state menu item thru commands
 
|-
 
|-
| [[#Search->Registry Search|Search->Registry Search]] || global menu || Registry Search action set is enabled || Registry Search action set is enabled || plugin || actionSet || RegistrySearchAction
+
| [[Menu Contributions/Radio Button Command]] || Similar to updating toggle state, you can create radio buttons using menu contributions
 
|-
 
|-
| [[#Widget in the main toolbar|Widget in the main toolbar]] || global toolbar || Registry Search action set is enabled || Registry Search action set is enabled || plugin || actionSet || RegistrySearchAction
+
| [[Menu Contributions/Update checked state]] || The active handler can update the checked state (and other attributes) of its button
 
|-
 
|-
| [[#Edit->Undo relabel action|Edit->Undo relabel action]] || global menu || always || always || ActionFactory || WorkbenchActionBuilder || LabelRetargetAction
+
| [[Menu Contributions/Search Menu]] || Adding the Java Search options to the Search menu
 
|-
 
|-
| [[#Search->Registry Search editor action|Search->Registry Search editor action]] || global (editor) menu || any registry editor is active || any registry editor is active || org.eclipse.ui.editorActions || org.eclipse.ui.editorActions || RegistrySearchAction
+
| [[Menu Contributions/IFile objectContribution]] || A menu contribution for context menus when the selection is an IFile
 
|-
 
|-
| [[#Search->Registry Search programmatic editor action|Search->Registry Search programmatic editor action]] || global (editor) menu || any registry editor is active || any registry editor is active || registry editor action bar contributor || registry editor action bar contributor || RegistrySearchAction
+
| [[Menu Contributions/TextEditor viewerContribution]] || A menu contribution for the text editor context menu
 
|-
 
|-
| [[#Add View submenu and item|Add View submenu and item]] || view menu || always || always || org.eclipse.ui.editorActions || org.eclipse.ui.editorActions || SampleViewAction
+
| [[Menu Contributions/Widget in a toolbar]] || A menu contribution adding a control into the main toolbar
 
|-
 
|-
| [[#Text editor popup action|Text editor popup action]] || text editor context menu || always || always || org.eclipse.ui.popupMenus || org.eclipse.ui.popupMenus || SampleContributionAction
+
| [[Menu Contributions/RCP removes the Project menu]] || An RCP application removes the Project menu. Note: this will probably not be in 3.3
 
|-
 
|-
| [[#IFile object contribution|IFile object contribution]] || all context menus || selection is an IFile || always || org.eclipse.ui.popupMenus || org.eclipse.ui.popupMenus || SampleContributionAction
+
| [[Menu Contributions/Workbench wizard contribution]] || Contributing workbench wizards to Menu
 
|-
 
|-
| [[#Product removes Search Registry|Product removes Search Registry]] || global menu || never || always || ApplicationWorkbenchWindowAdvisor || N/A || menu service || this cannot easily be done
 
 
|}
 
|}
  
= File->Exit =
+
= Menu XML =
  
== Current RCP using ActionBarAdvisor ==
+
Declarative information ... this needs to be cleaned up.
  
The ApplicationActionBarAdvisor should add the exit menu.  The QuitAction is already coded and the exit command is already defined.
+
=== Declarative menus - some constraints ===
  
// create the file menu
+
Some constraints on the system:
MenuManager menu = new MenuManager(IDEWorkbenchMessages.Workbench_file, IWorkbenchActionConstants.M_FILE);
+
// ...
+
quitAction = ActionFactory.QUIT.create(window);
+
register(quitAction);
+
ActionContributionItem quitItem = new ActionContributionItem(quitAction);
+
quitItem.setVisible(!"carbon".equals(SWT.getPlatform())); //$NON-NLS-1$
+
menu.add(quitItem);
+
  
== Current RCP or Eclipse plugin using an actionSet ==
+
# Identifiers (id) for <menu/> elements must be globally unique.
 +
# Identifiers (id) for <command/> elements must be globally unique if they are specified.
 +
# You can reference a <menu/> by id.
 +
# If you are just creating menu items for your commands, you can leave them with only a command id.  You don't have to specify an item id.
 +
# You can reference a <command/> for placement options (after, before, etc.) by id.
 +
# <separator/> ids only have to be unique within that menu level.  This is changed to name instead of id in '''3.3M5'''.
 +
# You can provide a <command/> label attribute.  If none is provided, it will take the command name.
 +
# In this design the item contains most of the same rendering information that <action/> did.
 +
# <menu/> and <command/> can have <visibleWhen/> clauses.  If a menu's <visibleWhen/> evaluates to false, we will never ask the items contained in that menu.
 +
# All of the displayable attributes are translatable.
 +
# The mnemonic is specified as you place your <command/> elements in their respective menus, since it is possible that the same command might need a different mnemonic depending on which menu it is placed.  Also, when defaulting to command names, they don't contain any mnemonic information.
  
Using an actionSet, you can also place the action in the main menu.
+
Menus cannot be re-used, and so they have an intrinsic id value.  Separators are unique within one menu level, so they also contain their name.
  
<extension
+
=== Menu URIs ===
      point="org.eclipse.ui.actionSets">
+
    <actionSet
+
          id="org.eclipse.ui.file.exitActions"
+
          label="Exit Actions"
+
          visible="true">
+
      <action
+
            class="org.eclipse.ui.internal.QuitAction"
+
            id="quit"
+
            definitionId="org.eclipse.ui.file.exit"
+
            label="E&amp;amp;xit"
+
            menubarPath="file/fileEnd"
+
            tooltip="Exit Eclipse">
+
      </action>
+
    </actionSet>
+
</extension>
+
  
== Proposed new menu support ==
+
For location placement we need a path and placement modifier, and to specify how the paths are built.  First pass we are going to look at URIs. 
  
With the new structure, you would have to turn the action into a handler.
+
* <scheme>:<menu-id>[?<placement-modifier>]
  
 +
scheme is about how to interpret the URI path.  For example, <code>menu</code>, <code>toolbar</code>, <code>popup</code>, <code>status</code> (although status may be deprecated).
  
<extension
+
==== menu: ====
      point="org.eclipse.ui.handlers">
+
    <handler commandId="org.eclipse.ui.file.exit"
+
          class="org.eclipse.ui.internal.QuitHandler"/>
+
</extension>
+
  
Then you can place it in the menu:
+
For <code>menu:</code> valid root ids will be any viewId for that view's menu, and <b>org.eclipse.ui.main.menu</b> for the main menu.  Then specify the id of the menu this contribution applies to.  The placement modifier helps position the menu contribution.  ex: after=<id>, where <id> can be a separator name, menu id, or item id.  An example of a path: <code>menu:org.eclipse.search.menu?after=contextMenuActionsGroup</code>
  
<extension
+
Since menu ids must be unique, you can specify your menu location relative to an existing id: <code>menu:org.eclipse.search.menu?after=contextMenuActionsGroup</code>
      point="org.eclipse.ui.menus">
+
    <item
+
          commandId="org.eclipse.ui.file.exit"
+
          mnemonic="x"
+
          id="org.eclipse.ui.file.exit.menu">
+
      <location type="menu">
+
          <menu id="file"/>
+
          <order after="fileEnd"/>
+
      </location>
+
    </item>
+
</extension>
+
  
You can globally place your exit menu in the file menu, or tie it to an actionSet using the <visibleWhen/> clause.
+
==== toolbar: ====
  
= Edit-&gt;Copy =
+
For <code>toolbar:</code> valid root ids will be any viewId for that view's toolbar, <b>org.eclipse.ui.main.toolbar</b> for the main toolbar, and any toolbar id that is contained in the main toolbar.  Toolbars can support <b>invisible</b> separators.  Toolbars in the main toolbar (technically a coolbar) can have ids as well as separators, but only one level.  For example: <code>toolbar:org.eclipse.ui.edit.text.actionSet.presentation?after=Presentation</code>
  
Some Copy Stuff.
+
In this example, <b>Presentation</b> is an invisible separator in the <b>org.eclipse.ui.edit.text.actionSet.presentation</b> toolbar.
  
= Global toolbar-&gt;Save =
+
The use of <b>org.eclipse.ui.main.toolbar</b> might change if all "main" toolbars have ids anyway, so the only options for interpretting the toolbar root is 1) the view toolbar or 2) an IDed main toolbar.
  
save
+
==== popup: ====
  
= Global toolbar-&gt;Open Type =
+
For <code>popup:</code> valid root ids are any registered context id (which defaults to the part id if no context menu id was given at registration time) and <b>org.eclipse.ui.popup.any</b> for all registered context menus.  For example, to add to the default Text Editor context menu: <code>popup:#TextEditorContext?after=additions</code>
  
open type
+
Popup submenus are treated like menu submenus, except the form continues to be <code>popup:submenuId</code>.
  
= Global toolbar-&gt;Toggle Mark Occurrences =
+
There will be constants defined for the ids that the eclipse workbench provides, probably in <code>org.eclipse.ui.menus.MenuUtil</code>.
  
toggle
+
=== Using Expressions in &lt;visibleWhen/&gt; ===
  
= Search-&gt;Registry Search =
+
In '''3.3M6''' an org.eclipse.core.expressions.definitions extension point was added. Used to define a [[Platform Expression Framework|core expression]], the definition can then be referenced from other locations.
  
Provide a basic action set. You have 2 actions, Registry Find and Registry Replace, and you want to add them to the "dialog" section of the Search menu.
+
<source lang="xml">
 +
<extension point="org.eclipse.core.expressions.definitions">
 +
  <definition id="com.example.context">
 +
    <with variable="activeContexts">
 +
      <iterate operator="or">
 +
        <equals value="org.eclipse.ui.contexts.actionSet"/>
 +
      </iterate>
 +
    </with>
 +
  </definition>
 +
</extension>
 +
</source>
  
 +
This can be called in a core expression like activeWhen, enabledWhen, visibleWhen, etc using the reference element:
  
== Proposed new menu support ==
+
<source lang="xml">
 +
<reference definitionId="com.example.context"/>
 +
</source>
  
Assume you have 2 commands defined, <code>com.example.registry.search.find</code> (Registry Find) and <code>com.example.registry.search.replace</code> (Registry Replace), and you want to add them to the main Search menu at <code>org.eclipse.search.menu/dialogGroup</code>.  Your commands already have their images defined in the <code>org.eclipse.ui.commandImages</code> extension point.
+
=== Ideas that were considered but not implemented ===
  
Define the action set:
+
These ideas were considered but not implemented.
  
<context
+
==== Menu - JSR198 ====
      description="The collection of registry search actions"
+
      id="com.example.registry.search.actionSet"
+
      name="Registry Search Action Set"
+
      parentId="org.eclipse.ui.contexts.actionSet">
+
</context>
+
  
And here is a possible view of the menus extension point:
+
'''Note:''' for novelty purposes only.
  
<extension
+
For comparison, there is a JSR describing how IDEs can contribute menus.  Below is a sample for 2 items:
      point="org.eclipse.ui.menus">
+
    <item
+
          commandId="com.example.registry.search.find"
+
          mnemonic="d"
+
          id="com.example.registry.search.find.menu">
+
      <location type="menu">
+
          <menu id="org.eclipse.search.menu"/>
+
          <order after="dialogGroup"/>
+
      </location>
+
      <visibleWhen>
+
          <with variable="activeContexts">
+
            <iterator operator="or">
+
                <equals value="com.example.registry.search.actionSet"/>
+
            </iterator>
+
          </with>
+
      </visibleWhen>
+
    </item>
+
    <item
+
          commandId="com.example.registry.search.replace"
+
          mnemonic="p"
+
          id="com.example.registry.search.replace.menu">
+
      <location type="menu">
+
          <menu id="org.eclipse.search.menu"/>
+
          <order after="com.example.registry.search.find.menu"/>
+
      </location>
+
      <visibleWhen>
+
          <with variable="activeContexts">
+
            <iterator operator="or">
+
                <equals value="com.example.registry.search.actionSet"/>
+
            </iterator>
+
          </with>
+
      </visibleWhen>
+
    </item>
+
  </extension>
+
  
Hmmmm, so to programmatically do this, you would have to go through the IMenuService.
+
* org.eclipse.ui.views.problems.sorting.item from menu:org.eclipse.ui.views.ProblemView
 +
* org.eclipse.ui.views.problems.resolveMarker.item from popup:org.eclipse.ui.views.ProblemView
  
 +
<source lang="xml">
 +
<menu-hook>
 +
  <actions>
 +
    <action id="org.eclipse.ui.views.problems.sorting.item">
 +
      <label>Sorting...</label>
 +
      <mnemonic>S</mnemonic>
 +
      <tooltip>Change the Sort order</tooltip>
 +
      <invoke-class>org.eclipse.ui.views.problems.sorting</invoke-class>
 +
    </action>
 +
    <action id="org.eclipse.ui.views.problems.resolveMarker.item">
 +
      <label>Quick Fix</label>
 +
      <mnemonic>Q</mnemonic>
 +
      <iconpath>$nl$/icons/full/elcl16/smartmode_co.gif</iconpath>
 +
      <invoke-class>org.eclipse.jdt.ui.edit.text.java.correction.assist.proposals</invoke-class>
 +
      <update-class>org.eclipse.jdt.ui.edit.text.java.correction.assist.proposals</update-class>
 +
    </action>
 +
  </actions>
 +
  <menus>
 +
    <menubar id="org.eclipse.ui.views.ProblemView">
 +
      <menu id="org.eclipse.ui.views.ProblemView">
 +
        <section id="problem.view.section">
 +
          <command action-ref="org.eclipse.ui.views.problems.sorting.item" />
 +
          <menu id="org.eclipse.ui.views.problems.groupBy.menu">
 +
            <label>Group By</label>
 +
            <mnemonic>G</mnemonic>
 +
          </menu>
 +
        </section>
 +
      </menu>
 +
    </menubar>
 +
    <popup id="org.eclipse.ui.views.ProblemView">
 +
      <section id="group.resolve">
 +
        <command action-ref="org.eclipse.ui.views.problems.resolveMarker.item" />
 +
      </section>
 +
    </popup>
 +
  </menus>
 +
</menu-hook>
 +
</source>
  
ICommandService commandServ = (ICommandService) getSite().getWindow().getService(ICommandService.class);
+
Some thoughts:
IMenuService menuServ = (IMenuService) getSite().getWindow().getService(IMenuService.class);
+
 
+
Command findCmd = commandServ.getCommand("com.example.registry.search.find");
+
SLocation findLocation = new SLocation(SBar.MENU, "org.eclipse.search.menu");
+
findLocation.setOrder(new SOrder(SOrder.AFTER, "dialogGroup"));
+
+
SItem findItem = menuServ.getItem(new SLocation(SBar.MENU, "org.eclipse.search.menu/com.example.registry.search.find.menu"));
+
findItem.define(findCmd, findLocation, "d");
+
menuServ.contribute(findItem, new ActionSetExpression("com.example.registry.search.actionSet"));
+
+
Command replaceCmd = commandServ.getCommand("com.example.registry.search.replace");
+
SLocation replaceLocation = new SLocation(SBar.MENU, "org.eclipse.search.menu");
+
replaceLocation.setOrder(new SOrder(SOrder.AFTER, "com.example.registry.search.find.menu"));
+
+
SItem replaceItem = menuServ.getItem(new SLocation(SBar.MENU, "org.eclipse.search.menu/com.example.registry.search.replace.menu"));
+
replaceItem.define(replaceCmd, replaceLocation, "p");
+
menuServ.contribute(replaceItem, new ActionSetExpression("com.example.registry.search.actionSet"));
+
  
= Widget in the main toolbar =
+
* the actions can only specify one icon
 +
* the actions can't *quite* link to our commands
 +
* the menus can't specify dynamic submenus
  
You can use the extension point to contribute a control to the toolbar.  You use the <widget/> element instead of the <item/> element.
+
==== Menu - XUL ====
  
<extension
+
'''Note:''' for novelty purposes only.
      point="org.eclipse.ui.menus">
+
    <widget
+
          class="com.example.registry.search.SearchBar"
+
          id="com.example.registry.search.find.searchbar">
+
      <location type="toolbar">
+
          <menu id="org.eclipse.search.toolbar"/>
+
      </location>
+
      <visibleWhen>
+
          <with variable="activeContexts">
+
            <iterator operator="or">
+
                <equals value="com.example.registry.search.actionSet"/>
+
            </iterator>
+
          </with>
+
      </visibleWhen>
+
    </widget>
+
</extension>
+
  
The widget class must implement [http://help.eclipse.org/help32/index.jsp?topic=/org.eclipse.platform.doc.isv/reference/api/org/eclipse/ui/menus/IWorkbenchWidget.html org.eclipse.ui.menus.IWorkbenchWidget], and provide <code>fill(Composite parent)</code> for a toolbar.
 
  
I'm not sure how far to go with IWorkbenchWidgetWe already use this interface for adding controls to the trim, and there are open bug requests about adding arbitrary controls to the toolbars.
+
For comparison, with Mozilla everywhere there is the probability eclipse will include xulrunnerMenu definitions that are consistent with XUL look like:
  
Will menus take arbitrary controls?
+
<source lang="xml">
 +
<keyset>
 +
  <key id="paste-key" modifiers="accel" key="V" />
 +
</keyset>
 +
<menubar id="org.eclipse.ui.views.ProblemView">
 +
  <menupopup id="org.eclipse.ui.views.ProblemView">
 +
    <menuitem id="org.eclipse.ui.views.problems.sorting.item"
 +
        accesskey="S"
 +
        key="paste-key"
 +
        label="Sorting..."
 +
        oncommand="invokeCommand('org.eclipse.ui.views.problems.sorting')" />
 +
    <menu id="org.eclipse.ui.views.problems.groupBy.menu"
 +
        label="Group By"
 +
        accesskey="G">
 +
      <menupopup id="groupby.popup">
 +
        <!-- this is where submenu items would go -->
 +
      </menupopup>
 +
    </menu>
 +
  </menupopup>
 +
</menubar>
 +
</source>
  
= Edit-&gt;Undo relabel action =
+
XUL supports everything as a flavour of a DOM, and javascripting can drive your buttons to perform commands.  I suspect the scripting would allow you to dynamically update menus (dynamic menus) on popup, depending on what events the DOM would report to you.
  
Like the Undo action, sometimes menu items would want to allow their label to be updated.  This is currently handled through the Command objects and the handlers.  IMenuStateIds and INamedHandleStateIds define some states that we currently support.
 
  
This can be used to update the menu item label:
+
==== Expression Templates original suggestion  ====
  
<extension
 
      point="org.eclipse.ui.commands">
 
    <command
 
          description="Targetted Undo Command"
 
          id="org.eclipse.ui.commands.targettedUndo"
 
          name="Undo">
 
      <state
 
            class="org.eclipse.jface.menus.TextState"
 
            id="NAME"/>
 
    </command>
 
</extension>
 
  
It's placed in the menus just like any other command:
+
You can see that the <activeWhen/>, <enabledWhen/>, and probably the <visibleWhen/> are likely to be replicated over and over again.  A possible option is some kind of expression template markup ... either in its own extension or supported by our UI extensions that can use core expressions.
  
<extension
+
Here's an example of using expression templates in its own extension point.
      point="org.eclipse.ui.menus">
+
    <item
+
          commandId="org.eclipse.ui.commands.targettedUndo"
+
          mnemonic="u"
+
          id="org.eclipse.ui.commands.undo">
+
      <location type="menu">
+
          <menu id="edit"/>
+
          <order after="edit.ext"/>
+
      </location>
+
    </item>
+
</extension>
+
  
As a handler becomes active and implement IObjectWithState (for example, derives from AbstractHandlerWithState) it is notified about any states that the handler's command contains. The states can be updated at that time.
+
<source lang="xml">
 +
<extension point="org.eclipse.core.expression.templates">
 +
  <expression id="isPartActive">
 +
    <parameter id="partId" />
 +
    <with variable="activePartId">
 +
      <equals value="$partId" />
 +
    </with>
 +
  </expression>
 +
  <expression id="isActionSetActive">
 +
    <parameter id="actionSetId" />
 +
    <with variable="activeContexts">
 +
      <iterator operator="or">
 +
        <equals value="$actionSetId" />
 +
      </iterator>
 +
    </with>
 +
  </expression>
 +
  <expression id="isContextActive">
 +
    <parameter id="contextId" />
 +
    <with variable="activeContexts">
 +
      <iterator operator="or">
 +
        <equals value="$contextId" />
 +
      </iterator>
 +
    </with>
 +
  </expression>
 +
  <expression id="isSelectionAvailable">
 +
    <not>
 +
      <count value="0" />
 +
    </not>
 +
  </expression>
 +
</extension>
 +
</source>
  
class FileDeleteUndoHandler extends AbstractHandlerWithState {
+
This could be used to simplify the handler definitions:
    public final void handleStateChange(final State state, final Object oldValue) {
+
        if (INamedHandleStateIds.NAME.equals(state.getId()) && oldValue==null) {
+
            state.setValue("Undo File Delete");
+
        }
+
    }
+
    public final Object execute(final ExecutionEvent event) {
+
        // undo a file delete using EFS ... very cool
+
        return null;
+
    }
+
}
+
  
= Search-&gt;Registry Search editor action =
+
<source lang="xml">
 +
<extension point="org.eclipse.ui.handlers">
 +
  <handler commandId="org.eclipse.ui.edit.copy"
 +
      class="org.eclipse.ui.views.markers.internal.CopyMarkerHandler">
 +
    <enabledWhen>
 +
      <evaluate ref="isSelectionAvailable" />
 +
    </enabledWhen>
 +
    <activeWhen>
 +
      <evaluate ref="isPartActive">
 +
        <parameter id="partId" value="org.eclipse.ui.views.ProblemView" />
 +
      </evaluate>
 +
    </activeWhen>
 +
  </handler>
 +
</extension>
 +
</source>
  
This should basically be the same as [[#Search-&gt;Registry Search|Search-&gt;Registry Search]] with a different visible when clause.
+
If we allow recursive template definitions, that would allow you to specify the concrete expression once and then reference it throughout your view.
  
      <visibleWhen>
+
<source lang="xml">
          <with variable="activeEditorId">
+
<extension point="org.eclipse.core.expression.templates">
            <equals value="com.example.registry.RegistryEditor"/>
+
  <expression id="isProblemViewActive">
          </with>
+
    <evaluate ref="isPartActive">
      </visibleWhen>
+
      <parameter id="partId" value="org.eclipse.ui.views.ProblemView" />
 +
    </evaluate>
 +
  </expression>
 +
</extension>
 +
<extension point="org.eclipse.ui.handlers">
 +
  <handler commandId="org.eclipse.ui.edit.copy"
 +
      class="org.eclipse.ui.views.markers.internal.CopyMarkerHandler">
 +
    <enabledWhen>
 +
      <evaluate ref="isSelectionAvailable" />
 +
    </enabledWhen>
 +
    <activeWhen>
 +
      <evaluate ref="isProblemViewActive" />
 +
    </activeWhen>
 +
  </handler>
 +
</extension>
 +
</source>
  
So programmatically, that just translates into a different visible when expression:
+
This reduces the handler definition even more.
  
menuServ.contribute(editorFindItem, new ActiveEditorIdExpression("com.example.registry.RegistryEditor"));
 
  
The menu items must be uniquely identified by their idSince they only have one location, they can only have one activation in the service at a time.
+
A similar option to reuse expressions as much as possible without turning them into their own procedural language would be to allow global definitions and then reuse themNo parameters and no expression composition:
  
= Search-&gt;Registry Search programmatic editor action =
+
<source lang="xml">
 +
<extension point="org.eclipse.core.expression.templates">
 +
  <expression id="isProblemViewActive">
 +
    <with variable="activePartId">
 +
      <equals value="org.eclipse.ui.views.ProblemView" />
 +
    </with>
 +
  </expression>
 +
  <expression id="isSelectionAvailable">
 +
    <not>
 +
      <count value="0" />
 +
    </not>
 +
  </expression>
 +
</extension>
 +
<extension point="org.eclipse.ui.handlers">
 +
  <handler commandId="org.eclipse.ui.edit.copy"
 +
      class="org.eclipse.ui.views.markers.internal.CopyMarkerHandler">
 +
    <enabledWhen ref="isSelectionAvailable" />
 +
    <activeWhen ref="isProblemViewActive" />
 +
  </handler>
 +
</extension>
 +
</source>
  
Programmatically we have to take the editor action handlers into account.
+
==== Another Expression Alternative: Specify Context at Extension Level ====
  
One of the advantages of EditorActionBars is the lifecycle of the actions that are added.  They're created when the first editor of that type is loaded and exist until the last editor of that type is closed.
 
  
Our service hierarchy has 2 levels, IWorkbenchWindow and IPartSite.  Handlers registered with IWorkbenchWindow are active as long as the window is active, and are disposed when the window is disposed.  Handlers registered with IPartSite are active and available as long as that specific part is active and available.  When the part is closed, the handlers are disposed.
+
Since <code>enabledWhen</code> and <code>activeWhen</code> specify context and the simple way to specify context in XML is enclosure, how about scoping context to the extension point rather than the handler:
  
Two possibilities are:
+
<source lang="xml">
 +
<extension point="org.eclipse.ui.handlers">
 +
  <enabledWhen>  <!-- context of all  handlers in this extension -->
 +
    <not>
 +
      <count value="0" />
 +
    </not>
 +
  </enabledWhen>
 +
  <activeWhen>
 +
    <with variable="activePartId">
 +
      <equals value="org.eclipse.ui.views.ProblemView" />
 +
    </with>
 +
  </activeWhen>
 +
  <handler commandId="org.eclipse.ui.edit.copy"
 +
      class="org.eclipse.ui.views.markers.internal.CopyMarkerHandler" />
 +
  <handler commandId="org.eclipse.ui.edit.paste"
 +
      class="org.eclipse.ui.views.markers.internal.PasteMarkerHandler" />
 +
  <handler commandId="org.eclipse.ui.edit.delete"
 +
      class="org.eclipse.ui.views.markers.internal.RemoveMarkerHandler" />
 +
  <handler commandId="org.eclipse.jdt.ui.edit.text.java.correction.assist.proposals"
 +
      class="org.eclipse.ui.views.markers.internal.ResolveMarkerHandler" />
 +
  <handler commandId="org.eclipse.ui.edit.selectAll"
 +
      class="org.eclipse.ui.views.markers.internal.SelectAllMarkersHandler" />
 +
  <handler commandId="org.eclipse.ui.file.properties"
 +
      class="org.eclipse.ui.views.markers.internal.ProblemPropertiesHandler" />
 +
</extension>
 +
</source>
  
1. Provide a service locator for the in-between caseTied to a part type.  The service locator expression makes the activation correct and the service locator disposes of them correctly.  Basically, we would make IActionBars returned from each IPartSite a service locator as well.
+
This gives compact markup without inventing a new languageElements nested in the handler element could override the extension-wide settings.
  
2. Move these actions up to the IWorkbenchWindow level.  With the correct expression the handler activation would be correct.  But once created they would live as long as the workbench.
+
= Updating the menu and toolbar appearance =
  
= Add View submenu and item =
 
  
View actions have to specify their menus as they are self contained.
+
It was suggested in 3.2 that state on the command could be used to implement the old contribution story behaviours:
 +
#changing label text and tooltips
 +
#changing icons
 +
#changing enablement
 +
#setting the item state (like checked state)
  
<command id="z.ex.editor.commands.SampleViewAction"
+
In 3.3 the enablement is tied to the command, and for the other behaviours we've decided to go with UIElements approach.
    name="Sample View Action"
+
    description="Sample View Action command"/>
+
  
<extension
+
== UIElements represent each UI visible instance of a command ==
      point="org.eclipse.ui.commandImages">
+
    <image commandId="z.ex.editor.commands.SampleViewAction"
+
          icon="icons/sample.gif"/>
+
</extension>
+
  
Placing the action (which is specifically a menu or button linked to a command) can be accomplished with the org.eclipse.ui.menus
+
The command service keeps a list of registered UI elements, which can be updated by the active handler. The checked state can be updated through <tt>UIElement#setChecked(boolean);</tt> (note that <tt>updateElement</tt> below is from <tt>IElementUpdater</tt>):
extension point.
+
  
<extension
+
<source lang="java">
      point="org.eclipse.ui.menus">
+
private boolean isChecked() {
    <menu
+
    return getStore().getBoolean(
          id="z.ex.view.SampleViewMenu"
+
            PreferenceConstants.EDITOR_MARK_OCCURRENCES);
          mnemonic="M"
+
}
          label="Sample Menu">
+
      <location type="viewMenu">
+
          <part partId="z.ex.view.keybindings.views.SampleView"/>
+
      </location>
+
    </menu>
+
    <group
+
          groupId="z.ex.view.SampleViewGroup"
+
          separatorsVisible="false">
+
      <location type="viewMenu">
+
          <part partId="z.ex.view.keybindings.views.SampleView">
+
            <menu id="z.ex.view.SampleViewMenu"/>
+
          </part>
+
      </location>
+
    </group>
+
    <item
+
          commandId="z.ex.editor.commands.SampleViewAction"
+
          mnemonic="V"
+
          id="z.ex.view.SampleViewAction">
+
      <location type="viewMenu">
+
          <part partId="z.ex.view.keybindings.views.SampleView">
+
            <menu id="z.ex.view.SampleViewMenu"/>
+
          </part>
+
          <order after="z.ex.view.SampleViewGroup"/>
+
      </location>
+
    </item>
+
</extension>
+
 
+
 
+
 
+
Hmmmm, so to programmatically do this, you would have to go through the IMenuService.
+
 
+
 
+
ICommandService commandServ = (ICommandService) getSite().getWindow().getService(ICommandService.class);
+
IMenuService menuServ = (IMenuService) getSite().getWindow().getService(IMenuService.class);
+
+
SMenu viewMenu = menuServ.getMenu(new SLocation(SBar.VIEW_MENU,
+
        "z.ex.view.keybindings.views.SampleView/z.ex.view.SampleViewMenu"));
+
viewMenu.define("Sample Menu", new SLocation(SBar.VIEW_MENU,
+
        "z.ex.view.keybindings.views.SampleView"), "M");
+
SGroup viewGroup = menuServ.getGroup(new SLocation(SBar.VIEW_MENU,
+
        "z.ex.view.keybindings.views.SampleView/z.ex.view.SampleViewMenu/z.ex.view.SampleViewGroup"));
+
viewGroup.define(new SLocation(SBar.VIEW_MENU,
+
        "z.ex.view.keybindings.views.SampleView/z.ex.view.SampleViewMenu", false);
+
 
   
 
   
Command viewCmd = commandServ.getCommand("z.ex.editor.commands.SampleViewAction");
+
public void updateElement(UIElement element, Map parameters) {
SLocation viewLocation = new SLocation(SBar.VIEW_MENU,  
+
    element.setChecked(isChecked());
        "z.ex.view.keybindings.views.SampleView/z.ex.view.SampleViewMenu")
+
}
viewLocation.setOrder(new SOrder(SOrder.AFTER, "z.ex.view.SampleViewGroup"));
+
</source>
SItem viewItem = menuServ.getItem(new SLocation(SBar.VIEW_MENU,
+
        "z.ex.view.keybindings.views.SampleView/z.ex.view.SampleViewMenu/z.ex.view.SampleViewAction.menu"));
+
viewItem.define(viewCmd, viewLocation, "V");
+
menuServ.contribute(viewItem);
+
  
= Text editor popup action =
+
When the toggle handler runs, it can request that any UI elements have their appearance updated from its <tt>execute(*)</tt> method:
  
Popups can be targetted at any registered context menu, or at all of them
+
<source lang="java">
 +
ICommandService service = (ICommandService) serviceLocator
 +
        .getService(ICommandService.class);
 +
service.refreshElements(IJavaEditorActionDefinitionIds.TOGGLE_MARK_OCCURRENCES, null);
 +
</source>
  
<command id="z.ex.view.commands.SampleContributionAction"
+
== State associated with the command is propogated to UI visible elements ==
    name="Sample Context Action"
+
    description="Sample Context Action command"/>
+
  
  <extension
+
First define the toggle mark occurrences command. Pretty straight forward,
      point="org.eclipse.ui.commandImages">
+
although it needs a "STYLE" state since it can be toggled. To allow handlers to
    <image commandId="z.ex.view.commands.SampleContributionAction"
+
update the label for the menu/toolbar items, we also add the "NAME" state.
          icon="icons/sample.gif"/>
+
</extension>
+
  
Placing the action (which is specifically a menu or button linked to a command) can be accomplished with the org.eclipse.ui.menus
+
<source lang="xml">
extension point.
+
<extension point="org.eclipse.ui.commands">
 +
  <command categoryId="org.eclipse.jdt.ui.category.source"
 +
      description="%jdt.ui.ToggleMarkOccurrences.description"
 +
      id="org.eclipse.jdt.ui.edit.text.java.toggleMarkOccurrences"
 +
      name="%jdt.ui.ToggleMarkOccurrences.name">
 +
    <state id="NAME" class="org.eclipse.jface.menus.TextState" />
 +
    <state id="STYLE" class="org.eclipse.jface.commands.ToggleState:true" />
 +
  </command>
 +
</extension>
 +
</source>
  
<extension
+
= Work =
      point="org.eclipse.ui.menus">
+
    <item
+
          commandId="z.ex.view.commands.SampleContributionAction"
+
          mnemonic="C"
+
          id="z.ex.objectContribution.menu">
+
      <location type="contextMenu">
+
          <menu id="#EditorContext"/>
+
          <order after="z.ex.editor.contextGroup"/>
+
      </location>
+
      <visibleWhen>
+
          <with variable="selection">
+
            <adapt type="org.eclipse.ui.handlers.IHandlerActivation"/>
+
        </with>
+
      </visibleWhen>
+
    </item>
+
</extension>
+
  
 +
Progress in 3.3.
  
It's probably that the default variable for core expression evaluations would be <b>selection</b>, so you wouldn't need the <with/> clause. There would probably also be a short-hand to tie the visibility to an active handler.  Maybe <visibleWhen handler="true"/>
+
== Available in 3.3 ==
  
Hmmmm, so to programmatically do this, you would have to go through the IMenuService.
+
* [[Image:Ok_green.gif]] the editor action bar contributor solution.  EditorActionBarContributor will not be deprecated, but is not used in the commands/handler story.  Menu Contributions have visibility tied to an active editor id, and editor specific handlers can be created in the editor init(*) or createPartControl(*) method using the handler service from getPartSite().getService(IHandlerService.class).
 +
* [[Image:Ok_green.gif]] Attributes for <command/>: '''helpContextId''', '''style''' to support radio buttons and check boxes
 +
* [[Image:Ok_green.gif]] action sets as contexts - action sets are still defined using org.eclipse.ui.actionSets, and each actionSet generates an equivalent context.  showing/hiding actionSets activates/deactivates the equivalent context.
 +
* [[Image:Ok_green.gif]] How do we give Trim widgets/toolbar widgets "focus" for command and handlers?  There was an IFocusService added in 3.3 that allows a trim control to register itself.  When that control has focus, the control and the ID it registered with are provided in the global application context to core expressions and handlers.  This is available, but might not be the optimal solution if you just want cut, copy, and paste to work.
 +
* [[Image:Ok_green.gif]] Shortcuts to define reusable core expressions for <activeWhen/>, <enabledWhen/>, and <visibleWhen/>. This has been added as the org.eclipse.core.expressions.definitions extension point and the core expression <reference/> element.
 +
* [[Image:Ok_green.gif]] the mnemonic field for <command/> elements (decorating)
 +
* [[Image:Ok_green.gif]] display any keybinding for <command/> elements (decorating)
 +
* [[Image:Ok_green.gif]] toolbar <visibleWhen/> expressions
  
 +
== Available in 3.3M5 ==
  
Command contextCmd = commandServ.getCommand("z.ex.view.commands.SampleContributionAction");
+
There is an example of the RCP Mail application template updated for 3.3M5 and converted to use the org.eclipse.ui.menus extension point as much as possible at [http://dev.eclipse.org/viewcvs/index.cgi/platform-ui-home/R3_3/contributions-proposal/ Contribution Example].
SLocation contextLocation = new SLocation(SBar.CONTEXT_MENU, "#EditorContext");
+
contextLocation.setOrder(new SOrder(SOrder.AFTER, "z.ex.editor.contextGroup"));
+
SItem contextItem = menuServ.getItem(new SLocation(SBar.CONTEXT_MENU, "#EditorContext/z.ex.objectContribution.menu"));
+
contextItem.define(contextCmd, contextLocation, "C");
+
menuServ.contribute(contextItem, new SelectionAdaptExpression("org.eclipse.ui.handlers.IHandlerActivation"));
+
  
 +
* [[Image:Ok_green.gif]]  changing the menu item or tool item state from a handler, like updating the label or tooltip or checked state.  Commands can contain <state/> elements, but that is not appropriate to use for providing feedback to the user.  This will be done by adapting a callback provided by the UI element.
 +
* [[Image:Ok_green.gif]] the <separator/> element should have a '''name''' not an '''id'''
 +
* [[Image:Ok_green.gif]] support creating radio button or checked menu items
 +
* [[Image:Ok_green.gif]] creating new toolbars in the main coolbar/trim declaratively
 +
* [[Image:Ok_green.gif]] creating new toolbars in the main coolbar/trim programmatically
 +
* [[Image:Ok_green.gif]] org.eclipse.ui.popup.any as a context menu contribution
 +
* [[Image:Ok_green.gif]] Drop down toolbar items
  
= IFile object contribution =
+
We also have action sets activating and de-activating contexts in '''3.3M5''', but we'll need to decide the proper action set story for '''3.3M6'''
  
There will be a reserved popup ID, "org.eclipse.ui.menus.context.any" that will allow contributions to any popup menu.
+
We are still working on the EditorActionBarContributor story.  It seems like we might be able to deprecate it. Editor instances can instantiate handlers upon creation for each command they support.
  
Command contextCmd = commandServ.getCommand("z.ex.view.commands.SampleContributionAction");
+
== Available in 3.3M4 ==
SLocation contextLocation = new SLocation(SBar.CONTEXT_MENU, "org.eclipse.ui.menus.context.any");
+
contextLocation.setOrder(new SOrder(SOrder.AFTER, "additions"));
+
SItem contextItem = menuServ.getItem(new SLocation(SBar.CONTEXT_MENU, "org.eclipse.ui.menus.context.any/z.ex.objectContribution.menu"));
+
contextItem.define(contextCmd, contextLocation, "C");
+
menuServ.contribute(contextItem, new SelectionAdaptExpression("org.eclipse.core.resources.IFile"));
+
  
The contribution should look exactly the same as a normal contribution.
+
The basic menu API will be available in 3.3M4.  It includes both declarative '''org.eclipse.ui.menus''' extension point with core expression support for visibility, and a programmatic interface accessed through the <code>IMenuService</code>.
  
= Product removes Search Registry =
 
  
It should be possible to override the visibility of menu contributions.
+
We support contributing to the main menu, and the view menu, view toolbar, and any IDed context menu.  We support contributing to existing toolbars in the main coolbar, and contributing trim widgets.
  
IMenuService menuService = (IMenuService) PlatformUI.getWorkbench().getService(IMenuService.class);
+
Programmatically we support the following types of contributions:
SItem findItem = menuServ.getItem(new SLocation(SBar.MENU, "org.eclipse.search.menu/com.example.registry.search.find.menu"));
+
*MenuManager
menuService.addOverride(findItem, new OverrideAdapter() {
+
*CommandContributionItem
  public Boolean isVisible() {
+
*CompoundContributionItem
    return Boolean.FALSE;
+
*ControlContribution (in 3.3M5)
  }
+
*Separator
});
+
*GroupMarker
  
The idea is to provide this ability at the product level.  For example, an RCP app should be able to hide any menu items that it doesn't want but picked up through the inclusion of a plugin.
+
There are some specific mappings of elements and attributes on [[Menus Extension Mapping]].
  
That implies that it might not be part of the general IMenuService interface.  Or (taking a page from the IExtensionRegistry) it might use a token that's available from the WorkbenchWindowAdvisor so that products can use the interface, or even expose the ability to their users.
 
 
If it returns <code>null</code> the next level of visibility is evaluated.  The <code>null</code> case is to keep it consistent with other overrides.
 
 
= Dynamic Menu 01 =
 
 
You want to add a dynamic "Previous Searches" submenu to the main Search menu.
 
 
<extension
 
      point="org.eclipse.ui.menus">
 
    <menu
 
          label="Previous Searches"
 
          mnemonic="c"
 
          id="com.example.registry.search.recent.menu">
 
      <dynamic class="com.example.registry.search.RecentMenu"/>
 
      <location type="menu">
 
          <menu id="org.eclipse.search.menu"/>
 
          <order after="additions"/>
 
      </location>
 
    </item>
 
</extension>
 
 
You can programmatically accomplish the same thing:
 
 
ICommandService commandServ = (ICommandService) getSite().getWindow().getService(ICommandService.class);
 
IMenuService menuServ = (IMenuService) getSite().getWindow().getService(IMenuService.class);
 
 
SMenu recentMenu = menuServ.getMenu(new SLocation(SBar.MENU,
 
        "org.eclipse.search.menu/com.example.registry.search.recent.menu"));
 
SLocation menuLocation = new SLocation(SBar.MENU,
 
        "org.eclipse.search.menu");
 
menuLocation.setOrder(new SOrder(SOrder.AFTER, "additions"));
 
recentMenu.define("Previous Searches", menuLocation, "c", new RecentMenu());
 
  
When your menu is about to show, you should get the callback:
+
== Work still to be done ==
  
public class RecentMenu implements IDynamicMenu {
 
    public void aboutToShow(IMenuCollection menu) {
 
        menu.clear();
 
        String[] searchIds = getSearchVew().getPreviousSearches();
 
        Command findCmd = commandServ.getCommand("com.example.registry.search.find");
 
        SLocation findLocation = new SLocation(SBar.MENU, "org.eclipse.search.menu/com.example.registry.search.recent.menu");
 
        for (int i=0; i<searchIds.length && i<4; i++) {
 
            SItem item = menuServ.getItem(new SLocation(SBar.MENU,
 
                "org.eclipse.search.menu/com.example.registry.search.recent.menu/recentItem" + i));
 
            item.undefine();
 
            ParameterizedCommand parmFindCmd = ....; // findCmd + the searchId parameter
 
            item.define(parmFindCmd, findLocation);
 
            menu.add(item);
 
        }
 
    }
 
    public SearchViewPart getSearchView() {
 
        return ....;
 
    }
 
}
 
  
= Dynamic Menu 02 =
+
A list of behaviours not supported or shipped with '''3.3'''.
  
You can have a group dynamically insert elements as a menu is shown.
+
* validate and possibly optimize the context menu population story and lifecycle.  Many context menus set remove all when shown.
 +
* migrate Marker views
 +
* migrate standard workbench actions - a few were done
 +
* Check enabled visibleWhen support
 +
* Shortcuts placed on submenu items (like CTRL+N) (decorating)
 +
* ensure full visibleWhen support in the MenuManagers - i.e. should empty menus display '''(empty)'''
 +
* do we want to manage trim with a TrimContributionManager?  This removes the coolbar, but has RCP implications.
 +
* the menu override capability - does this tie into the Customize Perspective dialog and action sets
 +
* A set of default programmatic core expressions.  For example, ActionContextExpression or ActivePartExpression
 +
* deprecate the 4 extension: actionSets, viewActions, editorActions, popupMenus
 +
* read old extensions in terms of new extension
 +
* convert platform UI extensions to new extension
 +
* migration guide - what are the most common migration paths for Action and IActionDelegate to Command/IHandler.
 +
* Attributes for <command/>:  '''state''' for checkboxes and radio buttons
 +
* possibly provide an plugin.xml converter for actionSets to menus
 +
* possibly provide an Action -> Handler converter
 +
* [[Image:Error.gif]] status manager contributions
  
<extension
 
      point="org.eclipse.ui.menus">
 
    <group
 
          groupId="com.example.registry.search.editors.menu"
 
          separatorsVisible="true">
 
      <dynamic class="com.example.registry.search.RecentSearchEditors"/>
 
      <location type="menu">
 
          <menu id="file"/>
 
          <order after="mru"/>
 
      </location>
 
    </group>
 
  </extension>
 
  
When the File menu is about to show, you will be called with your group IMenuCollection (not the entire File menu). But basically, it looks the same as the dynamic menu case.
+
Legend:
 +
* nothing - TBD
 +
* [[Image:Glass.gif]] - investigating
 +
* [[Image:Progress.gif]] - in progress
 +
* [[Image:Ok_green.gif]] - completed
 +
* [[Image:Error.gif]] - dropped
  
public class RecentSearchEditors implements IDynamicMenu {
+
[[Category:Eclipse Project]]
    public void aboutToShow(IMenuCollection menu) {
+
        menu.clear();
+
        String[] editorIds = getSearchVew().getPreviousOpenEditors();
+
        Command openCmd = commandServ.getCommand("com.example.registry.search.openEditor");
+
        SLocation fileLocation = new SLocation(SBar.MENU, "file");
+
        for (int i=0; i<editorIds.length && i<4; i++) {
+
            SItem item = menuServ.getItem(new SLocation(SBar.MENU,
+
                "file/searchOpenEditor" + i));
+
            item.undefine();
+
            ParameterizedCommand parmOpenCmd = ....; // openCmd + the editorsId parameter
+
            item.define(parmOpenCmd, fileLocation);
+
            menu.add(item);
+
        }
+
    }
+
    public SearchViewPart getSearchView() {
+
        return ....;
+
    }
+
}
+

Latest revision as of 14:48, 24 December 2012

Placement examples that describe the proposed new way of placing menu items for 3.3. Please contribute comments and suggestions in the discussion area or on Bug 154130 -KeyBindings- Finish re-work of commands and key bindings.

Placement and visibility

The 4 extension points that deal with menus now org.eclipse.ui.actionSets, org.eclipse.ui.viewActions, org.eclipse.ui.editorActions, and org.eclipse.ui.popupMenus specify both menu placement and their visibility criteria. In the new menu mechanism they are separate concepts, placement and visibility.

Example Matrix

A (hopefully) growing list of menu contribution examples.

Example comments
Menu Contributions/Dropdown Command Dropdown tool items can have their menus filled in using menu contributions
Menu Contributions/Problems View Example An example showing how the Problems View might be converted
Menu Contributions/Populating a dynamic submenu A menu contribution to populate a Problems View dynamic submenu
Menu Contributions/Toggle Mark Occurrences Placing the toggle mark occurrences button
Menu Contributions/Toggle Button Command Contribute a toggle state menu item thru commands
Menu Contributions/Radio Button Command Similar to updating toggle state, you can create radio buttons using menu contributions
Menu Contributions/Update checked state The active handler can update the checked state (and other attributes) of its button
Menu Contributions/Search Menu Adding the Java Search options to the Search menu
Menu Contributions/IFile objectContribution A menu contribution for context menus when the selection is an IFile
Menu Contributions/TextEditor viewerContribution A menu contribution for the text editor context menu
Menu Contributions/Widget in a toolbar A menu contribution adding a control into the main toolbar
Menu Contributions/RCP removes the Project menu An RCP application removes the Project menu. Note: this will probably not be in 3.3
Menu Contributions/Workbench wizard contribution Contributing workbench wizards to Menu

Menu XML

Declarative information ... this needs to be cleaned up.

Declarative menus - some constraints

Some constraints on the system:

  1. Identifiers (id) for <menu/> elements must be globally unique.
  2. Identifiers (id) for <command/> elements must be globally unique if they are specified.
  3. You can reference a <menu/> by id.
  4. If you are just creating menu items for your commands, you can leave them with only a command id. You don't have to specify an item id.
  5. You can reference a <command/> for placement options (after, before, etc.) by id.
  6. <separator/> ids only have to be unique within that menu level. This is changed to name instead of id in 3.3M5.
  7. You can provide a <command/> label attribute. If none is provided, it will take the command name.
  8. In this design the item contains most of the same rendering information that <action/> did.
  9. <menu/> and <command/> can have <visibleWhen/> clauses. If a menu's <visibleWhen/> evaluates to false, we will never ask the items contained in that menu.
  10. All of the displayable attributes are translatable.
  11. The mnemonic is specified as you place your <command/> elements in their respective menus, since it is possible that the same command might need a different mnemonic depending on which menu it is placed. Also, when defaulting to command names, they don't contain any mnemonic information.

Menus cannot be re-used, and so they have an intrinsic id value. Separators are unique within one menu level, so they also contain their name.

Menu URIs

For location placement we need a path and placement modifier, and to specify how the paths are built. First pass we are going to look at URIs.

  • <scheme>:<menu-id>[?<placement-modifier>]

scheme is about how to interpret the URI path. For example, menu, toolbar, popup, status (although status may be deprecated).

menu:

For menu: valid root ids will be any viewId for that view's menu, and org.eclipse.ui.main.menu for the main menu. Then specify the id of the menu this contribution applies to. The placement modifier helps position the menu contribution. ex: after=<id>, where <id> can be a separator name, menu id, or item id. An example of a path: menu:org.eclipse.search.menu?after=contextMenuActionsGroup

Since menu ids must be unique, you can specify your menu location relative to an existing id: menu:org.eclipse.search.menu?after=contextMenuActionsGroup

toolbar:

For toolbar: valid root ids will be any viewId for that view's toolbar, org.eclipse.ui.main.toolbar for the main toolbar, and any toolbar id that is contained in the main toolbar. Toolbars can support invisible separators. Toolbars in the main toolbar (technically a coolbar) can have ids as well as separators, but only one level. For example: toolbar:org.eclipse.ui.edit.text.actionSet.presentation?after=Presentation

In this example, Presentation is an invisible separator in the org.eclipse.ui.edit.text.actionSet.presentation toolbar.

The use of org.eclipse.ui.main.toolbar might change if all "main" toolbars have ids anyway, so the only options for interpretting the toolbar root is 1) the view toolbar or 2) an IDed main toolbar.

popup:

For popup: valid root ids are any registered context id (which defaults to the part id if no context menu id was given at registration time) and org.eclipse.ui.popup.any for all registered context menus. For example, to add to the default Text Editor context menu: popup:#TextEditorContext?after=additions

Popup submenus are treated like menu submenus, except the form continues to be popup:submenuId.

There will be constants defined for the ids that the eclipse workbench provides, probably in org.eclipse.ui.menus.MenuUtil.

Using Expressions in <visibleWhen/>

In 3.3M6 an org.eclipse.core.expressions.definitions extension point was added. Used to define a core expression, the definition can then be referenced from other locations.

<extension point="org.eclipse.core.expressions.definitions">
  <definition id="com.example.context">
    <with variable="activeContexts">
       <iterate operator="or">
         <equals value="org.eclipse.ui.contexts.actionSet"/>
       </iterate>
    </with>
  </definition>
</extension>

This can be called in a core expression like activeWhen, enabledWhen, visibleWhen, etc using the reference element:

<reference definitionId="com.example.context"/>

Ideas that were considered but not implemented

These ideas were considered but not implemented.

Menu - JSR198

Note: for novelty purposes only.

For comparison, there is a JSR describing how IDEs can contribute menus. Below is a sample for 2 items:

  • org.eclipse.ui.views.problems.sorting.item from menu:org.eclipse.ui.views.ProblemView
  • org.eclipse.ui.views.problems.resolveMarker.item from popup:org.eclipse.ui.views.ProblemView
<menu-hook>
  <actions>
    <action id="org.eclipse.ui.views.problems.sorting.item">
      <label>Sorting...</label>
      <mnemonic>S</mnemonic>
      <tooltip>Change the Sort order</tooltip>
      <invoke-class>org.eclipse.ui.views.problems.sorting</invoke-class>
    </action>
    <action id="org.eclipse.ui.views.problems.resolveMarker.item">
      <label>Quick Fix</label>
      <mnemonic>Q</mnemonic>
      <iconpath>$nl$/icons/full/elcl16/smartmode_co.gif</iconpath>
      <invoke-class>org.eclipse.jdt.ui.edit.text.java.correction.assist.proposals</invoke-class>
      <update-class>org.eclipse.jdt.ui.edit.text.java.correction.assist.proposals</update-class>
    </action>
  </actions>
  <menus>
    <menubar id="org.eclipse.ui.views.ProblemView">
      <menu id="org.eclipse.ui.views.ProblemView">
        <section id="problem.view.section">
          <command action-ref="org.eclipse.ui.views.problems.sorting.item" />
          <menu id="org.eclipse.ui.views.problems.groupBy.menu">
            <label>Group By</label>
            <mnemonic>G</mnemonic>
          </menu>
        </section>
      </menu>
    </menubar>
    <popup id="org.eclipse.ui.views.ProblemView">
      <section id="group.resolve">
        <command action-ref="org.eclipse.ui.views.problems.resolveMarker.item" />
      </section>
    </popup>
  </menus>
</menu-hook>

Some thoughts:

  • the actions can only specify one icon
  • the actions can't *quite* link to our commands
  • the menus can't specify dynamic submenus

Menu - XUL

Note: for novelty purposes only.


For comparison, with Mozilla everywhere there is the probability eclipse will include xulrunner. Menu definitions that are consistent with XUL look like:

<keyset>
  <key id="paste-key" modifiers="accel" key="V" />
</keyset>
<menubar id="org.eclipse.ui.views.ProblemView">
  <menupopup id="org.eclipse.ui.views.ProblemView">
    <menuitem id="org.eclipse.ui.views.problems.sorting.item"
        accesskey="S"
        key="paste-key"
        label="Sorting..."
        oncommand="invokeCommand('org.eclipse.ui.views.problems.sorting')" />
    <menu id="org.eclipse.ui.views.problems.groupBy.menu"
        label="Group By"
        accesskey="G">
      <menupopup id="groupby.popup">
        <!-- this is where submenu items would go -->
      </menupopup>
    </menu>
  </menupopup>
</menubar>

XUL supports everything as a flavour of a DOM, and javascripting can drive your buttons to perform commands. I suspect the scripting would allow you to dynamically update menus (dynamic menus) on popup, depending on what events the DOM would report to you.


Expression Templates original suggestion

You can see that the <activeWhen/>, <enabledWhen/>, and probably the <visibleWhen/> are likely to be replicated over and over again. A possible option is some kind of expression template markup ... either in its own extension or supported by our UI extensions that can use core expressions.

Here's an example of using expression templates in its own extension point.

<extension point="org.eclipse.core.expression.templates">
  <expression id="isPartActive">
    <parameter id="partId" />
    <with variable="activePartId">
      <equals value="$partId" />
    </with>
  </expression>
  <expression id="isActionSetActive">
    <parameter id="actionSetId" />
    <with variable="activeContexts">
      <iterator operator="or">
        <equals value="$actionSetId" />
      </iterator>
    </with>
  </expression>
  <expression id="isContextActive">
    <parameter id="contextId" />
    <with variable="activeContexts">
      <iterator operator="or">
        <equals value="$contextId" />
      </iterator>
    </with>
  </expression>
  <expression id="isSelectionAvailable">
    <not>
      <count value="0" />
    </not>
  </expression>
</extension>

This could be used to simplify the handler definitions:

<extension point="org.eclipse.ui.handlers">
  <handler commandId="org.eclipse.ui.edit.copy"
      class="org.eclipse.ui.views.markers.internal.CopyMarkerHandler">
    <enabledWhen>
      <evaluate ref="isSelectionAvailable" />
    </enabledWhen>
    <activeWhen>
      <evaluate ref="isPartActive">
        <parameter id="partId" value="org.eclipse.ui.views.ProblemView" />
      </evaluate>
    </activeWhen>
  </handler>
</extension>

If we allow recursive template definitions, that would allow you to specify the concrete expression once and then reference it throughout your view.

<extension point="org.eclipse.core.expression.templates">
  <expression id="isProblemViewActive">
    <evaluate ref="isPartActive">
      <parameter id="partId" value="org.eclipse.ui.views.ProblemView" />
    </evaluate>
  </expression>
</extension>
<extension point="org.eclipse.ui.handlers">
  <handler commandId="org.eclipse.ui.edit.copy"
      class="org.eclipse.ui.views.markers.internal.CopyMarkerHandler">
    <enabledWhen>
      <evaluate ref="isSelectionAvailable" />
    </enabledWhen>
    <activeWhen>
      <evaluate ref="isProblemViewActive" />
    </activeWhen>
  </handler>
</extension>

This reduces the handler definition even more.


A similar option to reuse expressions as much as possible without turning them into their own procedural language would be to allow global definitions and then reuse them. No parameters and no expression composition:

<extension point="org.eclipse.core.expression.templates">
  <expression id="isProblemViewActive">
    <with variable="activePartId">
      <equals value="org.eclipse.ui.views.ProblemView" />
    </with>
  </expression>
  <expression id="isSelectionAvailable">
    <not>
      <count value="0" />
    </not>
  </expression>
</extension>
<extension point="org.eclipse.ui.handlers">
  <handler commandId="org.eclipse.ui.edit.copy"
      class="org.eclipse.ui.views.markers.internal.CopyMarkerHandler">
    <enabledWhen ref="isSelectionAvailable" />
    <activeWhen ref="isProblemViewActive" />
  </handler>
</extension>

Another Expression Alternative: Specify Context at Extension Level

Since enabledWhen and activeWhen specify context and the simple way to specify context in XML is enclosure, how about scoping context to the extension point rather than the handler:

<extension point="org.eclipse.ui.handlers">
  <enabledWhen>  <!-- context of all  handlers in this extension -->
    <not>
      <count value="0" />
    </not>
  </enabledWhen>
  <activeWhen>
    <with variable="activePartId">
      <equals value="org.eclipse.ui.views.ProblemView" />
    </with>
  </activeWhen>
  <handler commandId="org.eclipse.ui.edit.copy"
      class="org.eclipse.ui.views.markers.internal.CopyMarkerHandler" />
  <handler commandId="org.eclipse.ui.edit.paste"
      class="org.eclipse.ui.views.markers.internal.PasteMarkerHandler" />
  <handler commandId="org.eclipse.ui.edit.delete"
      class="org.eclipse.ui.views.markers.internal.RemoveMarkerHandler" />
  <handler commandId="org.eclipse.jdt.ui.edit.text.java.correction.assist.proposals"
      class="org.eclipse.ui.views.markers.internal.ResolveMarkerHandler" />
  <handler commandId="org.eclipse.ui.edit.selectAll"
      class="org.eclipse.ui.views.markers.internal.SelectAllMarkersHandler" />
  <handler commandId="org.eclipse.ui.file.properties"
      class="org.eclipse.ui.views.markers.internal.ProblemPropertiesHandler" />
</extension>

This gives compact markup without inventing a new language. Elements nested in the handler element could override the extension-wide settings.

Updating the menu and toolbar appearance

It was suggested in 3.2 that state on the command could be used to implement the old contribution story behaviours:

  1. changing label text and tooltips
  2. changing icons
  3. changing enablement
  4. setting the item state (like checked state)

In 3.3 the enablement is tied to the command, and for the other behaviours we've decided to go with UIElements approach.

UIElements represent each UI visible instance of a command

The command service keeps a list of registered UI elements, which can be updated by the active handler. The checked state can be updated through UIElement#setChecked(boolean); (note that updateElement below is from IElementUpdater):

private boolean isChecked() {
    return getStore().getBoolean(
            PreferenceConstants.EDITOR_MARK_OCCURRENCES);
}
 
public void updateElement(UIElement element, Map parameters) {
    element.setChecked(isChecked());
}

When the toggle handler runs, it can request that any UI elements have their appearance updated from its execute(*) method:

ICommandService service = (ICommandService) serviceLocator
        .getService(ICommandService.class);
service.refreshElements(IJavaEditorActionDefinitionIds.TOGGLE_MARK_OCCURRENCES, null);

State associated with the command is propogated to UI visible elements

First define the toggle mark occurrences command. Pretty straight forward, although it needs a "STYLE" state since it can be toggled. To allow handlers to update the label for the menu/toolbar items, we also add the "NAME" state.

<extension point="org.eclipse.ui.commands">
  <command categoryId="org.eclipse.jdt.ui.category.source"
      description="%jdt.ui.ToggleMarkOccurrences.description"
      id="org.eclipse.jdt.ui.edit.text.java.toggleMarkOccurrences"
      name="%jdt.ui.ToggleMarkOccurrences.name">
    <state id="NAME" class="org.eclipse.jface.menus.TextState" />
    <state id="STYLE" class="org.eclipse.jface.commands.ToggleState:true" />
  </command>
</extension>

Work

Progress in 3.3.

Available in 3.3

  • Ok green.gif the editor action bar contributor solution. EditorActionBarContributor will not be deprecated, but is not used in the commands/handler story. Menu Contributions have visibility tied to an active editor id, and editor specific handlers can be created in the editor init(*) or createPartControl(*) method using the handler service from getPartSite().getService(IHandlerService.class).
  • Ok green.gif Attributes for <command/>: helpContextId, style to support radio buttons and check boxes
  • Ok green.gif action sets as contexts - action sets are still defined using org.eclipse.ui.actionSets, and each actionSet generates an equivalent context. showing/hiding actionSets activates/deactivates the equivalent context.
  • Ok green.gif How do we give Trim widgets/toolbar widgets "focus" for command and handlers? There was an IFocusService added in 3.3 that allows a trim control to register itself. When that control has focus, the control and the ID it registered with are provided in the global application context to core expressions and handlers. This is available, but might not be the optimal solution if you just want cut, copy, and paste to work.
  • Ok green.gif Shortcuts to define reusable core expressions for <activeWhen/>, <enabledWhen/>, and <visibleWhen/>. This has been added as the org.eclipse.core.expressions.definitions extension point and the core expression <reference/> element.
  • Ok green.gif the mnemonic field for <command/> elements (decorating)
  • Ok green.gif display any keybinding for <command/> elements (decorating)
  • Ok green.gif toolbar <visibleWhen/> expressions

Available in 3.3M5

There is an example of the RCP Mail application template updated for 3.3M5 and converted to use the org.eclipse.ui.menus extension point as much as possible at Contribution Example.

  • Ok green.gif changing the menu item or tool item state from a handler, like updating the label or tooltip or checked state. Commands can contain <state/> elements, but that is not appropriate to use for providing feedback to the user. This will be done by adapting a callback provided by the UI element.
  • Ok green.gif the <separator/> element should have a name not an id
  • Ok green.gif support creating radio button or checked menu items
  • Ok green.gif creating new toolbars in the main coolbar/trim declaratively
  • Ok green.gif creating new toolbars in the main coolbar/trim programmatically
  • Ok green.gif org.eclipse.ui.popup.any as a context menu contribution
  • Ok green.gif Drop down toolbar items

We also have action sets activating and de-activating contexts in 3.3M5, but we'll need to decide the proper action set story for 3.3M6

We are still working on the EditorActionBarContributor story. It seems like we might be able to deprecate it. Editor instances can instantiate handlers upon creation for each command they support.

Available in 3.3M4

The basic menu API will be available in 3.3M4. It includes both declarative org.eclipse.ui.menus extension point with core expression support for visibility, and a programmatic interface accessed through the IMenuService.


We support contributing to the main menu, and the view menu, view toolbar, and any IDed context menu. We support contributing to existing toolbars in the main coolbar, and contributing trim widgets.

Programmatically we support the following types of contributions:

  • MenuManager
  • CommandContributionItem
  • CompoundContributionItem
  • ControlContribution (in 3.3M5)
  • Separator
  • GroupMarker

There are some specific mappings of elements and attributes on Menus Extension Mapping.


Work still to be done

A list of behaviours not supported or shipped with 3.3.

  • validate and possibly optimize the context menu population story and lifecycle. Many context menus set remove all when shown.
  • migrate Marker views
  • migrate standard workbench actions - a few were done
  • Check enabled visibleWhen support
  • Shortcuts placed on submenu items (like CTRL+N) (decorating)
  • ensure full visibleWhen support in the MenuManagers - i.e. should empty menus display (empty)
  • do we want to manage trim with a TrimContributionManager? This removes the coolbar, but has RCP implications.
  • the menu override capability - does this tie into the Customize Perspective dialog and action sets
  • A set of default programmatic core expressions. For example, ActionContextExpression or ActivePartExpression
  • deprecate the 4 extension: actionSets, viewActions, editorActions, popupMenus
  • read old extensions in terms of new extension
  • convert platform UI extensions to new extension
  • migration guide - what are the most common migration paths for Action and IActionDelegate to Command/IHandler.
  • Attributes for <command/>: state for checkboxes and radio buttons
  • possibly provide an plugin.xml converter for actionSets to menus
  • possibly provide an Action -> Handler converter
  • Error.gif status manager contributions


Legend:

  • nothing - TBD
  • Glass.gif - investigating
  • Progress.gif - in progress
  • Ok green.gif - completed
  • Error.gif - dropped

Back to the top