Skip to main content

Notice: this Wiki will be going read only early in 2024 and edits will no longer be possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.

Jump to: navigation, search

Difference between revisions of "Menu Contributions"

(Add ProblemView menus)
(Example Matrix)
Line 105: Line 105:
 
|-
 
|-
 
|}
 
|}
 +
 +
 +
= Menu XML =
 +
 +
Declarative information ... this needs to be cleaned up.
 +
 +
=== Declarative menus - some constraints ===
 +
 +
Some constraints on the system:
 +
 +
# 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 an <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 an <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 display-able 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.
 +
 +
 +
 +
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, <code>menu</code>, <code>toolbar</code>, <code>popup</code>, <code>status</code> (although status may be deprecated).
 +
 +
 +
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>
 +
 +
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>
 +
 +
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>
 +
 +
In this example, <b>Presentation</b> is an invisible separator in the <b>org.eclipse.ui.edit.text.actionSet.presentation</b> toolbar.
 +
 +
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.
 +
 +
 +
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>
 +
 +
Popup submenus are treated like menu submenus, except the form continues to be <code>popup:submenuId</code>.
 +
 +
There will be constants defined for the ids that the eclipse workbench provides.
 +
 +
=== 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.
  
  
Line 239: Line 373:
  
 
This gives compact markup without inventing a new language.  Elements nested in the handler element could override the extension-wide settings.
 
This gives compact markup without inventing a new language.  Elements nested in the handler element could override the extension-wide settings.
 
=== Declarative menus - some constraints ===
 
 
Some constraints on the system:
 
 
# 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 an <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 an <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 display-able 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.
 
 
 
 
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, <code>menu</code>, <code>toolbar</code>, <code>popup</code>, <code>status</code> (although status may be deprecated).
 
 
 
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>
 
 
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>
 
 
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>
 
 
In this example, <b>Presentation</b> is an invisible separator in the <b>org.eclipse.ui.edit.text.actionSet.presentation</b> toolbar.
 
 
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.
 
 
 
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>
 
 
Popup submenus are treated like menu submenus, except the form continues to be <code>popup:submenuId</code>.
 
 
There will be constants defined for the ids that the eclipse workbench provides.
 
 
=== 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.
 
  
 
= Add Toggle Mark Occurrences to main toolbar =
 
= Add Toggle Mark Occurrences to main toolbar =

Revision as of 11:19, 28 February 2007

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.

Work

This is a work list Eric and I threw together.

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.

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.


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.

Work still to be done

A list of behaviours not supported or shipped with the 3.3M5 API.

  • http://www.eclipse.org/eclipse/platform-core/images/small_progress.gif the editor action bar contributor solution
  • http://www.eclipse.org/eclipse/platform-core/images/small_progress.gif Attributes for <command/>: helpContextId, style to support radio buttons and check boxes, state for checkboxes and radio buttons
  • http://www.eclipse.org/eclipse/platform-core/images/small_progress.gif action sets as contexts
  • http://www.eclipse.org/eclipse/platform-core/images/small_progress.gif validate and possibly optimize the context menu population story and lifecycle. Many context menus set remove all when shown.
  • migrate Marker views
  • How do we give Trim widgets/toolbar widgets "focus" for command and handlers?
  • http://www.eclipse.org/eclipse/platform-core/images/glass.gif migrate standard workbench actions
  • Shortcuts to define reusable core expressions for <activeWhen/>, <enabledWhen/>, and <visibleWhen/>
  • Check enabled visibleWhen support
  • the mnemonic field for <command/> elements (decorating)
  • display any keybinding for <command/> elements (decorating)
  • 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
  • toolbar <visibleWhen/> expressions
  • 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.
  • possibly provide an plugin.xml converter for actionSets to menus
  • possibly provide an Action -> Handler converter
  • ensure expressions can be reused
  • http://www.eclipse.org/eclipse/platform-core/images/small_x.gif status manager contributions


Legend:


Example Matrix

This will be updated later.

Example comments
Menu Contributions/Problems View Example An example showing how the Problems View might be converted


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 an <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 an <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 display-able 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).


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

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.


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.

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">
       </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 Sidebar

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 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>  
       <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.

Add Toggle Mark Occurrences to main toolbar

We can provide the Toggle Mark Occurrences toolbar button. It's normally contributed through an actionSet as a retargettable action, and the Java and Class File editors *EditorActionBarContributors provide the implementation ToggleMarkOccurrencesAction through IActionBars#setGlobalActionHandler(*).

Commands

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 option 1.

Option 1:

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);

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);


Option 2:

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>

Handlers

This command doesn't have a default handler, as it only applies to specific editors that are provided. So we would provide the handler for the java editor.

<extension
      point="org.eclipse.ui.handlers">
   <handler
         class="org.eclipse.jdt.internal.ui.javaeditor.ToggleMarkOccurrencesHandler"
         commandId="org.eclipse.jdt.ui.edit.text.java.toggleMarkOccurrences"
         helpContextId="org.eclipse.jdt.ui.toggle_mark_occurrences_action_context">
      <activeWhen>
         <with
               variable="activeEditorId">
            <or>
               <equals
                     value="org.eclipse.jdt.ui.CompilationUnitEditor">
               </equals>
               <equals
                     value="org.eclipse.jdt.ui.ClassFileEditor">
               </equals>
            </or>
         </with>
      </activeWhen>
   </handler>
</extension>


We're active for both the Java editor and the Class File editor. There is also the option to programmatically install the handler.

AndExpression expr = new AndExperssion();
expr.add(new ActivePartIdExpression("org.eclipse.jdt.ui.CompilationUnitEditor"));
expr.add(new ActivePartIdExpression("org.eclipse.jdt.ui.ClassFileEditor"));
IHandlerService handlerServ = (IHandlerService)getSite().getWorkbenchWindow().getService(IHandlerService.class);
toggleOccurrencesHandler = new ToggleMarkOccurrencesHandler();
handlerServ.activateHandler("org.eclipse.jdt.ui.edit.text.java.toggleMarkOccurrences", toggleOccurrencesHandler, expr);

Since the same handler is valid for both editors, we install it with a specific expression and don't tie the activation to the part site. But as written, the toggleOccurrencesHandler will exist as long as the workbench window exists.

Menus

In 3.3M5 ActionSets generate and update active contexts.


  <extension
        point="org.eclipse.ui.menus">
     <menuContribution
           locationURI="toolbar:org.eclipse.ui.main.toolbar?after=additions">
        <toolbar
              id="org.eclipse.ui.edit.text.actionSet.presentation">
           <command
                 commandId="org.eclipse.jdt.ui.edit.text.java.toggleMarkOccurrences"
                 disabledIcon="$nl$/icons/full/dtool16/mark_occurrences.gif"
                 helpContextId="toggle_mark_occurrences_action_context"
                 icon="$nl$/icons/full/etool16/mark_occurrences.gif"
                 id="org.eclipse.jdt.ui.edit.text.java.toggleMarkOccurrences"
                 label="%toggleMarkOccurrences.label"
                 style="toggle"
                 tooltip="%toggleMarkOccurrences.tooltip">
              <visibleWhen
                    checkEnabled="false">
                 <with
                       variable="activeContexts">
                    <iterate
                          operator="or">
                       <equals
                             value="org.eclipse.jdt.ui.text.java.actionSet.presentation">
                       </equals>
                    </iterate>
                 </with>
              </visibleWhen>
           </command>
        </toolbar>
     </menuContribution>
  </extension>


This item is also tied to an actionSet.

Menus API

The above XML can be done using the menus API:

public static void createToggleMarkOccurrences() {
    final IMenuService menuService = (IMenuService) PlatformUI
            .getWorkbench().getService(IMenuService.class);
    final ImageDescriptor markOccurDesc = AbstractUIPlugin
            .imageDescriptorFromPlugin("org.eclise.ui.tests",
                    "icons/full/etool16/mark_occurrences.gif");
    final ImageDescriptor disabledMarkOccurDesc = AbstractUIPlugin
            .imageDescriptorFromPlugin("org.eclise.ui.tests",
                    "icons/full/dtool16/mark_occurrences.gif");

    AbstractContributionFactory contribution = new AbstractContributionFactory(
            "toolbar:org.eclipse.ui.edit.text.actionSet.presentation?after=Presentation") {
        public void createContributionItems(IMenuService menuService,
                List additions) {
            IContributionItem item = new CommandContributionItem(
                    null,
                    "org.eclipse.jdt.ui.edit.text.java.toggleMarkOccurrences",
                    null, markOccurDesc, disabledMarkOccurDesc, null, null,
                    null, "Toggle Mark Occurrences", CommandContributionItem.STYLE_CHECK);
            menuService
                    .registerVisibleWhen(
                            item,
                            new ActiveActionSetExpression(
                                    "org.eclipse.jdt.ui.text.java.actionSet.presentation"));
            additions.add(item);
        }

        public void releaseContributionItems(IMenuService menuService,
                List items) {
        }
    };
    menuService.addContributionFactory(contribution);
}


This asks for a toolbar root in the org.eclipse.ui.edit.text.actionSet.presentation toolbar after the Presentation id.

It's contributed with a visibleWhen clause ActiveActionSetExpression("org.eclipse.jdt.ui.text.java.actionSet.presentation"), so it will be visible when the actionSet is active.

Possible Java Search Menu Example

The java search menu items are added through a Java Search action set. They have code that enables/disables the action set depending on the active editor.

ActionSet context

For something to go in an actionSet, then we would define the actionSet context. This hasn't be worked out for 3.3M5, we still define an actionSet using org.eclipse.ui.actionSets.

 <extension point="org.eclipse.ui.contexts">
   <context description="%JavaSearchActionSet.description"
            id="org.eclipse.jdt.ui.SearchActionSet"
            name="%JavaSearchActionSet.label"
            parentId="org.eclipse.ui.contexts.actionSet">
   </context>
 </extension>

Commands

Also, a number of the items were retargetable actions that allow label updates. The active handler can update their appearance with an ICommandService@refreshElements(*) call.

 <extension point="org.eclipse.ui.commands">
   <command name="%ActionDefinition.readAccessInworkspace.name"
            description="%ActionDefinition.readAccessInWorkspace.description"
            categoryId="org.eclipse.search.ui.category.search"
            id="org.eclipse.jdt.ui.edit.text.java.search.read.access.in.workspace">
   </command>
   <command name="%ActionDefinition.readAccessInProject.name"
            description="%ActionDefinition.readAccessInProject.description"
            categoryId="org.eclipse.search.ui.category.search"
            id="org.eclipse.jdt.ui.edit.text.java.search.read.access.in.project">
   </command>
   <command name="%ActionDefinition.readAccessInHierarchy.name"
            description="%ActionDefinition.readAccessInHierarchy.description"
            categoryId="org.eclipse.search.ui.category.search"
            id="org.eclipse.jdt.ui.edit.text.java.search.read.access.in.hierarchy">
   </command>
   <command name="%ActionDefinition.readAccessInWorkingSet.name"
            description="%ActionDefinition.readAccessInWorkingSet.description"
            categoryId="org.eclipse.search.ui.category.search"
            id="org.eclipse.jdt.ui.edit.text.java.search.read.access.in.working.set">
   </command>
   <command name="%ActionDefinition.writeAccessInWorkspace.name"
            description="%ActionDefinition.writeAccessInWorkspace.description"
            categoryId="org.eclipse.search.ui.category.search"
            id="org.eclipse.jdt.ui.edit.text.java.search.write.access.in.workspace">
   </command>
   <command name="%ActionDefinition.writeAccessInProject.name"
            description="%ActionDefinition.writeAccessInProject.description"
            categoryId="org.eclipse.search.ui.category.search"
            id="org.eclipse.jdt.ui.edit.text.java.search.write.access.in.project">
   </command>
   <command name="%ActionDefinition.writeAccessInHierarchy.name"
            description="%ActionDefinition.writeAccessInHierarchy.description"
            categoryId="org.eclipse.search.ui.category.search"
            id="org.eclipse.jdt.ui.edit.text.java.search.write.access.in.hierarchy">
   </command>
   <command name="%ActionDefinition.writeAccessInWorkingSet.name"
            description="%ActionDefinition.writeAccessInWorkingSet.description"
            categoryId="org.eclipse.search.ui.category.search"
            id="org.eclipse.jdt.ui.edit.text.java.search.write.access.in.working.set">
   </command>
 </extension>

Menus

We'll assume that the Search menu is globally defined elsewhere by the org.eclipse.search plugin.

  <extension point="org.eclipse.ui.menus">
     <menuContribution locationURI="menu:org.eclipse.ui.main.menu?after=navigate">
        <menu label="%searchMenu.label"
              mnemonic="%searchMenu.mnemonic"
              id="org.eclipse.search.menu">
           <separator name="internalDialogGroup" visible="false" />
           <separator name="dialogGroup" visible="false" />
           <separator name="fileSearchContextMenuActionsGroup"
                      visible="true" />
           <separator name="contextMenuActionsGroup" visible="true" />
           <separator name="occurencesActionsGroup" visible="true" />
           <separator name="extraSearchGroup" visible="true" />
        </menu>
     </menuContribution>
  </extension>

Then the JDT plugin would contribute the menu items to search, where the menuContribution location specifies the starting point for adding the menus. For groups of actions like the Write Access or Read Access shown here, they can just be specified in order. The <visibleWhen/> clauses must be specified on the items contributed if they want to belong to the actionSet, but if the contribute items are contain in a contributed menu, it can just be specified on the <menu/> element.


  <extension point="org.eclipse.ui.menus">
     <menuContribution locationURI="menu:org.eclipse.search.menu?after=dialogGroup">
        <command commandId="org.eclipse.jdt.internal.ui.search.openJavaSearchPage"
                 label="%openJavaSearchPageAction.label"
                 mnemonic="%openJavaSearchPageAction.mnemonic"
                 icon="$nl$/icons/full/obj16/jsearch_obj.gif"
                 helpContextId="java_search_action_context">
           <visibleWhen>
              <with variable="activeContexts">
                 <iterate operator="or">
                    <equals value="org.eclipse.jdt.ui.SearchActionSet">
                    </equals>
                 </iterate>
              </with>
           </visibleWhen>
        </command>
     </menuContribution>
     <menuContribution locationURI="menu:org.eclipse.search.menu?after=contextMenuActionsGroup">
        <menu id="readAccessSubMenu"
              label="%readAccessSubMenu.label"
              mnemonic="%readAccessSubMenu.mnemonic">
           <separator name="group1" visible="false" />
           <command commandId="org.eclipse.jdt.ui.edit.text.java.search.read.access.in.workspace"
                    label="%InWorkspace.label"
                    mnemonic="%InWorkspace.mnemonic">
           </command>
           <command commandId="org.eclipse.jdt.ui.edit.text.java.search.read.access.in.project"
                    label="%InProject.label"
                    mnemonic="%InProject.mnemonic">
           </command>
           <command commandId="org.eclipse.jdt.ui.edit.text.java.search.read.access.in.hierarchy"
                    label="%InHierarchy.label"
                    mnemonic="%InHierarchy.mnemonic">
           </command>
           <command commandId="org.eclipse.jdt.ui.edit.text.java.search.read.access.in.working.set"
                    label="%InWorkingSet.label"
                    mnemonic="%InWorkingSet.mnemonic">
           </command>
           <visibleWhen>
              <with variable="activeContexts">
                 <iterate operator="or">
                    <equals value="org.eclipse.jdt.ui.SearchActionSet">
                    </equals>
                 </iterate>
              </with>
           </visibleWhen>
        </menu>
        <menu id="writeAccessSubMenu"
              label="%writeAccessSubMenu.label"
              mnemonic="%writeAccessSubMenu.mnemonic">
           <separator name="group1" visible="false" />
           <command commandId="org.eclipse.jdt.ui.edit.text.java.search.write.access.in.workspace"
                    label="%InWorkspace.label"
                    mnemonic="%InWorkspace.mnemonic">
           </command>
           <command commandId="org.eclipse.jdt.ui.edit.text.java.search.write.access.in.project"
                    label="%InProject.label"
                    mnemonic="%InProject.mnemonic">
           </command>
           <command commandId="org.eclipse.jdt.ui.edit.text.java.search.write.access.in.hierarchy"
                    label="%InHierarchy.label"
                    mnemonic="%InHierarchy.mnemonic">
           </command>
           <command commandId="org.eclipse.jdt.ui.edit.text.java.search.write.access.in.working.set"
                    label="%InWorkingSet.label"
                    mnemonic="%InWorkingSet.mnemonic">
           </command>
           <visibleWhen>
              <with variable="activeContexts">
                 <iterate operator="or">
                    <equals value="org.eclipse.jdt.ui.SearchActionSet">
                    </equals>
                 </iterate>
              </with>
           </visibleWhen>
        </menu>
     </menuContribution>
     <menuContribution locationURI="menu:org.eclipse.search.menu?after=occurencesActionsGroup">
        <command commandId="org.eclipse.jdt.ui.edit.text.java.search.occurrences.in.file.quickMenu"
                 label="%occurrencesSubMenu.label">
           <visibleWhen>
              <with variable="activeContexts">
                 <iterate operator="or">
                    <equals value="org.eclipse.jdt.ui.SearchActionSet">
                    </equals>
                 </iterate>
              </with>
           </visibleWhen>
        </command>
     </menuContribution>
  </extension>


Currently, the java search menus are in the Java Search actionSet, that is dynamically enabled/disabled. This could also be done by specifying a visibleWhen like:

<visibleWhen>
  <with variable="activeEditorId">
    <or>
      <equals value="org.eclipse.jdt.ui.CompilationUnitEditor" />
      <equals value="org.eclipse.jdt.ui.ClassFileEditor" />
    </or>
  </with>
</visibleWhen>

This would make the visible if either the Java or Class File editor was the active editor, and they would disappear otherwise.

Menus API

The API can be used to contribute to the main menu bar:

   public static void addSearchMenu() {
       IMenuService menuService = (IMenuService) PlatformUI.getWorkbench()
               .getService(IMenuService.class);

       AbstractContributionFactory searchContribution = new AbstractContributionFactory(
               "menu:org.eclipse.ui.main.menu?after=navigate") {
           public void createContributionItems(IMenuService menuService,
                   List additions) {
               MenuManager search = new MenuManager("Se&arch",
                       "org.eclipse.search.menu");

               search.add(new GroupMarker("internalDialogGroup"));
               search.add(new GroupMarker("dialogGroup"));
               search.add(new Separator("fileSearchContextMenuActionsGroup"));
               search.add(new Separator("contextMenuActionsGroup"));
               search.add(new Separator("occurencesActionsGroup"));
               search.add(new Separator("extraSearchGroup"));

               additions.add(search);
           }

           public void releaseContributionItems(IMenuService menuService,
                   List items) {
               // nothing to do here
           }
       };

       menuService.addContributionFactory(searchContribution);
   }


It's just a menu inserted at the menu root location.


Then another plugin can contribute to the search menu:

   public static void addToSearchMenu() {
       final IMenuService menuService = (IMenuService) PlatformUI
               .getWorkbench().getService(IMenuService.class);
       final ActiveActionSetExpression activeSearchActionSet = new ActiveActionSetExpression(
               "org.eclipse.jdt.ui.SearchActionSet");

       final ImageDescriptor searchIcon = AbstractUIPlugin
               .imageDescriptorFromPlugin("org.eclise.ui.tests",
                       "icons/full/obj16/jsearch_obj.gif");
       AbstractContributionFactory factory = new AbstractContributionFactory(
               "menu:org.eclipse.search.menu?after=dialogGroup") {
           public void createContributionItems(IMenuService menuService,
                   List additions) {
               CommandContributionItem item = new CommandContributionItem(
                       "org.eclipse.jdt.internal.ui.search.openJavaSearchPage",
                       "org.eclipse.jdt.internal.ui.search.openJavaSearchPage",
                       null, searchIcon, null, null, null, null, null,
                       CommandContributionItem.STYLE_PUSH);
               menuService.registerVisibleWhen(item, activeSearchActionSet);
               additions.add(item);
           }

           public void releaseContributionItems(IMenuService menuService,
                   List items) {
           }
       };
       menuService.addContributionFactory(factory);

       factory = new AbstractContributionFactory(
               "menu:org.eclipse.search.menu?after=contextMenuActionsGroup") {
           public void createContributionItems(IMenuService menuService,
                   List additions) {
               MenuManager readMenu = new MenuManager("&Read Access",
                       "readAccessSubMenu");
               menuService
                       .registerVisibleWhen(readMenu, activeSearchActionSet);
               additions.add(readMenu);

               readMenu.add(new GroupMarker("group1"));

               CommandContributionItem item = new CommandContributionItem(
                       "org.eclipse.jdt.ui.edit.text.java.search.read.access.in.workspace",
                       "org.eclipse.jdt.ui.edit.text.java.search.read.access.in.workspace",
                       null, null, null, null, null, "W", null,
                       CommandContributionItem.STYLE_PUSH);
               readMenu.add(item);
               item = new CommandContributionItem(
                       "org.eclipse.jdt.ui.edit.text.java.search.read.access.in.project",
                       "org.eclipse.jdt.ui.edit.text.java.search.read.access.in.project",
                       null, null, null, null, null, "P", null,
                       CommandContributionItem.STYLE_PUSH);
               readMenu.add(item);
               item = new CommandContributionItem(
                       "org.eclipse.jdt.ui.edit.text.java.search.read.access.in.hierarchy",
                       "org.eclipse.jdt.ui.edit.text.java.search.read.access.in.hierarchy",
                       null, null, null, null, null, "H", null,
                       CommandContributionItem.STYLE_PUSH);
               readMenu.add(item);
               item = new CommandContributionItem(
                       "org.eclipse.jdt.ui.edit.text.java.search.read.access.in.working.set",
                       "org.eclipse.jdt.ui.edit.text.java.search.read.access.in.working.set",
                       null, null, null, null, null, "S", null,
                       CommandContributionItem.STYLE_PUSH);
               readMenu.add(item);

               MenuManager writeMenu = new MenuManager("&Write Access",
                       "writeAccessSubMenu");
               menuService.registerVisibleWhen(writeMenu,
                       activeSearchActionSet);
               additions.add(writeMenu);

               writeMenu.add(new GroupMarker("group1"));

               item = new CommandContributionItem(
                       "org.eclipse.jdt.ui.edit.text.java.search.write.access.in.workspace",
                       "org.eclipse.jdt.ui.edit.text.java.search.write.access.in.workspace",
                       null, null, null, null, null, "W", null,
                       CommandContributionItem.STYLE_PUSH);
               writeMenu.add(item);
               item = new CommandContributionItem(
                       "org.eclipse.jdt.ui.edit.text.java.search.write.access.in.project",
                       "org.eclipse.jdt.ui.edit.text.java.search.write.access.in.project",
                       null, null, null, null, null, "P", null,
                       CommandContributionItem.STYLE_PUSH);
               writeMenu.add(item);
               item = new CommandContributionItem(
                       "org.eclipse.jdt.ui.edit.text.java.search.write.access.in.hierarchy",
                       "org.eclipse.jdt.ui.edit.text.java.search.write.access.in.hierarchy",
                       null, null, null, null, null, "H", null,
                       CommandContributionItem.STYLE_PUSH);
               writeMenu.add(item);
               item = new CommandContributionItem(
                       "org.eclipse.jdt.ui.edit.text.java.search.write.access.in.working.set",
                       "org.eclipse.jdt.ui.edit.text.java.search.write.access.in.working.set",
                       null, null, null, null, null, "S", null,
                       CommandContributionItem.STYLE_PUSH);
               writeMenu.add(item);
           }

           public void releaseContributionItems(IMenuService menuService,
                   List items) {
           }
       };
       menuService.addContributionFactory(factory);
   }


When the main menu is populated, these contribution factories will be called.

IFile object contribution

We also have to provide object contributions (which in the past were scoped by objectClass).

Menus

There will be a reserved popup ID, "org.eclipse.ui.popup.any" that will allow contributions to any popup menu.

 <extension point="org.eclipse.ui.menus">
   <menuContribution locationURI="popup:org.eclipse.ui.popup.any?after=additions">
     <command commandId="org.eclipse.ui.examples.wiki.post"
           mnemonic="%WikiExample.post.mnemonic"
           icon="$nl$/icons/full/elcl16/post_wiki.gif">
       <visibleWhen>
         <with variable="selection">
            <!-- do something with an ISelection -->
         </with>
       </visibleWhen>
     </command>
     <command commandId="org.eclipse.ui.examples.wiki.load"
           mnemonic="%WikiExample.load.mnemonic"
           icon="$nl$/icons/full/elcl16/load_wiki.gif">
        <visibleWhen
              checkEnabled="false">
           <!-- the default variable is a Collection holding the ISelection,
                   or the objects from an IStructuredSelection -->
           <iterate>
              <adapt
                    type="org.eclipse.core.resources.IResource">
              </adapt>
           </iterate>
        </visibleWhen>
     </command>
   </menuContribution>
 </extension>


It's probably that the default variable for core expression evaluations would be selection, so you wouldn't need the <with/> clause like in the second item above.

There would probably also be a short-hand to tie the visibility to an active handler. Maybe <visibleWhen handler="true"/> This is still conjecture.

Menus API

So programmatically it is similar to all other menu contributions.

public static void addFileContribution() {
    final IMenuService menuService = (IMenuService) PlatformUI
            .getWorkbench().getService(IMenuService.class);
    // an expression that walks the selection looking for objectclasses
    final ObjectClassExpression ifileExpression = new ObjectClassExpression(
            "org.eclipse.core.resources.IFile");

    final ImageDescriptor postIcon = AbstractUIPlugin
            .imageDescriptorFromPlugin("org.eclise.ui.tests",
                    "icons/full/elcl16/post_wiki.gif");
    final ImageDescriptor loadIcon = AbstractUIPlugin
            .imageDescriptorFromPlugin("org.eclise.ui.tests",
                    "icons/full/elcl16/load_wiki.gif");
    AbstractContributionFactory factory = new AbstractContributionFactory(
            "popup:org.eclipse.ui.popup.any?after=additions") {
        public void createContributionItems(IMenuService menuService,
                List additions) {
            CommandContributionItem item = new CommandContributionItem(
                    "org.eclipse.ui.examples.wiki.post",
                    "org.eclipse.ui.examples.wiki.post", null, postIcon,
                    null, null, null, "P", null,
                    CommandContributionItem.STYLE_PUSH);
            menuService.registerVisibleWhen(item, ifileExpression);
            additions.add(item);

            item = new CommandContributionItem(
                    "org.eclipse.ui.examples.wiki.load",
                    "org.eclipse.ui.examples.wiki.load", null, loadIcon,
                    null, null, null, "L", null,
                    CommandContributionItem.STYLE_PUSH);
            menuService.registerVisibleWhen(item, ifileExpression);
            additions.add(item);
        }

        public void releaseContributionItems(IMenuService menuService,
                List items) {
        }
    };
    menuService.addContributionFactory(factory);
}


The location of org.eclipse.ui.popup.any specifies any context menu, and the expression ties it to a specific objectClass. Using the new expression syntax you can make your conditions more complex.

You can set your visibleWhen expression on each item as you create it.

Text editor popup action

Popups can be targetted at any registered context menu, or at all of them. This is the Scramble Text command to be added the the standard text editor.

Commands

First define the command and its handler.

 <extension point="org.eclipse.ui.commands">
   <command id="org.eclipse.ui.examples.menus.scramble.text"
            defaultHandler="org.eclipse.ui.examples.menus.internal.ScrambleTextHandler"
            name="%ScrambleText.name"
            description="%ScrambleText.description" />
 </extension>

Menus

Placing the action (which is specifically a menu or button linked to a command) can be accomplished with the org.eclipse.ui.menus extension point.

 <extension point="org.eclipse.ui.menus">
   <menuContribution locationURI="popup:#TextEditorContext?after=additions">
     <command commandId="org.eclipse.ui.examples.menus.scramble.text"
           mnemonic="%ScrambleText.mnemonic"
           icon="$nl$/icons/full/eobj16/scramble.gif" />
   </menuContribution>
 </extension>

Menus API

Programmatically do this, you would have to go through the IMenuService.


public static void addTextMenuContribition() {
    final IMenuService menuService = (IMenuService) PlatformUI
            .getWorkbench().getService(IMenuService.class);

    final ImageDescriptor scrambleIcon = AbstractUIPlugin
            .imageDescriptorFromPlugin("org.eclise.ui.tests",
                    "icons/full/eobj16/scramble.gif");
    AbstractContributionFactory factory = new AbstractContributionFactory(
            "popup:#TextEditorContext?after=additions") {
        public void createContributionItems(IMenuService menuService,
                List additions) {
            CommandContributionItem item = new CommandContributionItem(
                    "org.eclipse.ui.examples.menus.scramble.text",
                    "org.eclipse.ui.examples.menus.scramble.text",
                    null, scrambleIcon, null, null, null, "c", null,
                    CommandContributionItem.STYLE_PUSH);
            additions.add(item);
        }

        public void releaseContributionItems(IMenuService menuService,
                List items) {
        }
    };
    menuService.addContributionFactory(factory);
}

Product removes the Project menu

Note: this might not make it into 3.3

An RCP product wishes to remove the Project menu. It should be possible to override the visibility of menu contributions.

   public void addOverride() {
       // the RCP app would already have its product key
       Object productKey = null;

       IMenuService menuServ = (IMenuService) PlatformUI.getWorkbench()
               .getActiveWorkbenchWindow().getService(IMenuService.class);
       menuServ.addOverride(productKey, "menu:project", new OverrideAdapter() {
           public Boolean getVisible() {
               return Boolean.FALSE;
           }
       });
   }


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.

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 null the next level of visibility is evaluated. The null case is to keep it consistent with other overrides.

The override service is ID based. For items which haven't specified their ID, the override will be applied to the commandId (which is required on every item).


Widget in the main toolbar

You can use the extension point to contribute a control to the toolbar. You use the <control/> element instead of the <command/> element.

 <extension point="org.eclipse.ui.menus">
   <menuContribution locationURI="toolbar:org.eclipse.search.toolbar">
     <control id="org.eclipse.ui.examples.menus.searchBar"
             class="org.eclipse.ui.examples.menus.internal.SearchBar">
       <visibleWhen>
         <with variable="activeContexts">
           <iterator operator="or">
             <equals value="org.eclipse.jdt.ui.SearchActionSet" />
           </iterator>
         </with>
       </visibleWhen>
     </control>
   </menuContribution>
 </extension>


The control class must implement WorkbenchWindowControlContribution as of 3.3M5.


I'm not sure how far to go with IWorkbenchWidget. We already use this interface for adding controls to the trim, and there are open bug requests about adding arbitrary controls to the toolbars. It looks like we'll deprecate it in favour of WorkbenchWindowControlContribution.

Also, there are risks associated with this like eager plugin activation. Maybe we allow widget activation but restrict it to programmatic API only (after the plugin has been instantiated) or still allow declarative contributions but only with certain types of <visibleWhen/> clauses.

--Hudsonr.us.ibm.com 09:02, 13 February 2007 (EST) There are two separate reasons to use an extension point to contribute to the toolbar. One reason is to defer plug-in activation. But the other, is to allow a plug-in to contribute to another plug-in even though it depends on that plug-in, or it ships as additional, add-on function. In either case, the plug-in owning the toolbar can not depend on the contributing plug-in. While in general, one wants plug-in activation to occur as late as possible, there are cases where you just don't care. It's great to see that I can now contribute anything I want to another plug-in's toolbar.

I think this flexibility needs to be supported. Isn't it possible for a bundle to specify exceptions that would prevent the bundle from being started even though the contribution's classes are loaded to create the Control?

While we're still looking at this in 3.3M6 the preliminary implementation will probably be our standard proxy pattern. That means that contributing a control to the main toolbar will just start the contributing plugin (so we'll just ask people to be careful :-). But as an aside, I'm pretty sure that an exception that prevents a bundle from being started will also prevent us from getting the plugin control contribution from IConfigurationElement#createExecutableExtension(*)
--Pwebster.ca.ibm.com 10:34, 13 February 2007 (EST)

Edit->Undo relabel action

The active handler can update any UI elements registered against the its command. It does this by requesting the ICommandService to refresh any registered UIElements.

Like the Undo action, sometimes menu items would want to allow their label to be updated. The active handler can update the menu item.

<extension
      point="org.eclipse.ui.commands">
 <extension point="org.eclipse.ui.menus">
   <menuContribution locationURI="menu:edit?after=undo.ext">
     <command commandId="org.eclipse.ui.examples.menus.targettedUndo"
           mnemonic="%TargettedUndo.mnemonic" />
   </menuContribution>
 </extension>

As a handler becomes active and implement IElementUpdater like org.eclipse.ui.tests.menus.ToggleContextHandler, the command service calls public void updateElement(UIElement element, Map parameters) for every UIElement registered against the command.

public class ToggleContextHandler extends AbstractHandler implements
	IElementUpdater {
private static final String TOGGLE_ID = "toggleContext.contextId";
// ...
public void updateElement(UIElement element, Map parameters) {
	// the checked state depends on if we have an activation for that
	// context ID or not
	String contextId = (String) parameters.get(TOGGLE_ID);
	element.setChecked(contextActivations.get(contextId) != null);
}
}


Adding programmatic menus and handlers tied to an editor

In 3.3M6 we'll be investigating deprecating EditorActionBarContributors. The command and menu contributions are declared (and the handler can be as well).

But each editor could instantiate handlers with specific editor instance knowledge and activate them through the part site handler service. This would take care of activating them and cleaning them up when the part goes away.


Add a dynamic submenu to the ProblemView menu

In Add ProblemView menus we added 2 dynamic menus. You then have to implement CompoundContributionItem in your provided class.

     <menu id="org.eclipse.ui.views.problems.groupBy.menu"
           label="%ProblemView.GroupBy.label"
           mnemonic="%ProblemView.GroupBy.mnemonic">
       <dynamic class="org.eclipse.ui.views.markers.internal.GroupByItems"
                id="org.eclipse.ui.views.problems.groupBy.items"/>
     </menu>


When your menu is populated, you'll have your getContributionItems() method called:


protected IContributionItem[] getContributionItems() {
     IContributionItem[] list = new IContributionItem[2];
     Map parms = new HashMap();
     parms.put("groupBy", "Severity");
     list[0] = new CommandContributionItem(null,
             "org.eclipse.ui.views.problems.grouping",
             parms, null, null, null, "Severity", null,
             null, CommandContributionItem.STYLE_PUSH);

     parms = new HashMap();
     parms.put("groupBy", "None");
     list[1] = new CommandContributionItem(null,
             "org.eclipse.ui.views.problems.grouping",
             parms, null, null, null, "None", null, null,
             CommandContributionItem.STYLE_PUSH);
     return list;
}


Dynamic item replacement

See Add_a_dynamic_submenu_to_the_ProblemView_menu

A dynamic contribution item is expanded in place. It disposes the provided IContributionItems and requests new ones on every show.

Example Matrix

This will be updated later.

Example Location visible when enabled when defined by placed by handled by comments
Add ProblemView menus view menu always always ViewPart & IActionBars ViewPart & IActionBars SampleViewAction

Copyright © Eclipse Foundation, Inc. All Rights Reserved.