Home > Eclipse > Eclipse 3.5 – Plug-in Spy and menus

Eclipse 3.5 – Plug-in Spy and menus

All plug-in developpers know about the beloved plug-in spy (Alt+Shift+F1).  This great feature allows to inspect various part of the workbench (Editors, Views, Wizards, Dialogs,…) but menus were not include in this list… Until Galileo!!

First we will see how it works and how it looks, then I will briefly make a demo of how it is useful for a cool use case :)
I finally make some comment on this feature.

The Plug-in Spy for menu

Press Alt+Shift+F2, then click on the menu item that you want to inspect.
It will display this kind of pop-up :
plugin Spy popup

We can see such information as:

  • The active contribution item identifier : We know the id of the item, can call it now :)
  • The active contribution location URI : With this path you can easily provide your own menu item in the same group.
  • The active action definition identifier : Useful to reuse this action.
  • The active contribution item class : The responsible class of this Action. A good start point to see what this menu item triggers.
  • The contributing plug-in : To see which plug-in provides this menu item

A quick demo

A demo use case : “I want to add a great menu item which will trigger the display of great information about me!!”
So, I see that a menu item exists to do such kind of thing : “About Eclipse SDK”

menu

And as you guess I will use the Plug-in Spy to grab needed information!
plugin Spy popup

Now I create a new plug-in project and create an extension to the point : org.eclipse.ui.menus and fill the locationURI with the one given by the plug-in spy. To get the locationURI, select the text and right-click on it ;)

extensionPointWithLocationURI

Now create a command and attach it to the menu contribution :

extensions

Set a handler to this command and do what you want in execute method of the class implementing the handler (Open a MessageDialog and display a great text for instance):

handler

Test your plugin :

menuWthContribution

popupAboutMe

All works fine and very quickly!!

Comments

You have to adopt a different point of view with this new feature of the plug-in spy :

  • Make active what you want to inspect then press Alt+SHift+F1 to trigger the plug-in spy
  • Make active the plug-in spy Alt+Shift+F2, then navigate through menu and click on the menu item to inspect

Why? think of mnemonics ;)

sources :

eclipse new and noteworthy (seems to work only in google cache)
and 2 Chris blogpost : here and here

About these ads
Categories: Eclipse Tags: , , ,
  1. Sphax
    June 18, 2009 at 09:00

    Great post :)

  2. May 26, 2011 at 13:37

    Nice article indeed!

  3. Sang
    December 6, 2011 at 20:45

    This was really helpful

  4. vincent
    February 29, 2012 at 18:42

    When I launch an eclipse application from eclipse, the spy only work on the eclipse DEV window but not on my application which is running. Anyway to make spy to work on my eclipse application instead?
    Thanks

  5. hiergiltdiestfu
    March 6, 2012 at 10:46

    Very helpful, thank you!

  1. June 7, 2012 at 16:27

Leave a Reply

Fill in your details below or click an icon to log in:

WordPress.com Logo

You are commenting using your WordPress.com account. Log Out / Change )

Twitter picture

You are commenting using your Twitter account. Log Out / Change )

Facebook photo

You are commenting using your Facebook account. Log Out / Change )

Google+ photo

You are commenting using your Google+ account. Log Out / Change )

Connecting to %s

Follow

Get every new post delivered to your Inbox.

%d bloggers like this: