Commands Tutorial

Written by Prakash G. R.
Posted in Tutorials

As you would have seen, there are two different ways to contributing to the Workbench: Actions and Commands. Although Commands are newer and advanced, I've always preferred using Actions, simply because of my comfort level in using them. Now that I've started fixing some bugs in the Command framework, I'm forced to look into the details. The more deeper I look into the Commands, the more I'm loving it. So I decided to write a series of on the Commands and this is the first one in the series. Many of the information presented here is obtained by looking some old bugs, wiki and digging into CVS history. If I'm missing anything or wrong about something let me know.

Lets start with Actions. We are able to contribute to the menus, toolbars, pull down menu, etc. We are able to specify the UI details like label or tooltip in the plugin.xml itself, which helps in lazy loading. So whats wrong with them?

• The UI and handling are always tied. There is no way you can separate each other
• While Actions can be contributed to different parts of the workbench (popup menu/tool bar), all of them were different extension points and so you end up duplicating the XML in multiple places. The worst of it is that not all the extension points expect the same configuration.
• Specifying Actions in multiple places is a maintenance nightmare. If you have to change the icon of an action, you need to change in all the places.
• Another issue with duplicating Actions in plugin.xml is that multiple instance of the same Actions will be created in the memory

Lets see how the Commands Framework eliminates all this. Commands are defined by the org.eclipse.ui.commands extension point. A typical command would look like:

<command 
    id="com.eclipse-tips.commands.someCommand" 
    name="Some Command">
</command>

Yeah thats it. That defines a Command! If you want to place this in a tool bar, you have to use the extension point org.eclipse.ui.menus:

<menuContribution 
         locationURI="toolbar:org.eclipse.ui.main.toolbar">
    <toolbar id="com.eclipse-tips.commands.toolbar1">
         <command 
             commandId="com.eclipse-tips.commands.someCommand"
             id="com.eclipse-tips.commands.someCommandInToolBar"/>
 </toolbar>
</menuContribution>

Now that takes of the placement in the UI. But what about the code that gets executed? That goes into a another extension point, org.eclipse.ui.handlers:

<handler
    class="com.eclipse_tips.commads.SomeCommandHandler"
    commandId="com.eclipse-tips.commands.someCommand">
</handler> 

One last piece is to add an icon to the Command No price for guessing that you need to use another extension point, org.eclipse.ui.commandImages:

<image
    commandId="com.eclipse-tips.commands.someCommand"
    icon="icons/sample.gif">
</image>

All set. Lets see the Command in action: