Adding to an existing menu - Revision history

David Geleßus: Update homepage link

2022-11-18T14:39:14Z

Update homepage link

← Older revision		Revision as of 14:39, 18 November 2022
Line 59:		Line 59:
	<parameter		<parameter
	name="de.prob.ui.openwebsite.url"		name="de.prob.ui.openwebsite.url"
	value="~~http~~://~~www~~.~~stups.uni-duesseldorf~~.de/~~ProB~~">		value="https://prob.hhu.de/">
	</parameter>		</parameter>
	</command>		</command>

Jens Bendisposto at 05:50, 6 March 2011

2011-03-06T05:50:33Z

← Older revision		Revision as of 05:50, 6 March 2011
Line 19:		Line 19:
	The example also shows that commands can have parameters. In this case we want to provide different URLs. Section 3 will explain how the command is parameterized.		The example also shows that commands can have parameters. In this case we want to provide different URLs. Section 3 will explain how the command is parameterized.

	2. Create an extension to org.eclipse.ui.handlers and add a handler. The handler will link the command with its implementation, i.e., if the command is triggered the execute method of the handler is being called.		2. Create an extension to org.eclipse.ui.handlers and add a handler. The handler will link the command with its implementation, i.e., when the command is triggered the execute method of the handler is being called.
	<extension		<extension
	point="org.eclipse.ui.handlers">		point="org.eclipse.ui.handlers">

Jens Bendisposto at 16:36, 14 April 2010

2010-04-14T16:36:00Z

← Older revision		Revision as of 16:36, 14 April 2010
Line 1:		Line 1:
			[[Category:Developer Manual]]
	We use the Eclipse Command Framework. This page describes how you can add a menu item "Open Website" to one of the ProB submenus (in this case Contact).If you want to contribute your own menu to the ProB menubar (i.e., the main menu in the standalone version or the ProB menu in the Rodin plug-in version of ProB) see [[Adding an own submenu]]		We use the Eclipse Command Framework. This page describes how you can add a menu item "Open Website" to one of the ProB submenus (in this case Contact).If you want to contribute your own menu to the ProB menubar (i.e., the main menu in the standalone version or the ProB menu in the Rodin plug-in version of ProB) see [[Adding an own submenu]]

Jens Bendisposto at 16:35, 14 April 2010

2010-04-14T16:35:25Z

← Older revision		Revision as of 16:35, 14 April 2010
Line 1:		Line 1:
	We use the Eclipse Command Framework. This ~~document~~ describes how you can add a menu item "Open Website" to one of the ProB submenus (in this case Contact).		We use the Eclipse Command Framework. This page describes how you can add a menu item "Open Website" to one of the ProB submenus (in this case Contact).If you want to contribute your own menu to the ProB menubar (i.e., the main menu in the standalone version or the ProB menu in the Rodin plug-in version of ProB) see [[Adding an own submenu]]

Jens Bendisposto at 16:33, 14 April 2010

2010-04-14T16:33:25Z

← Older revision		Revision as of 16:33, 14 April 2010
Line 30:		Line 30:

	public Object execute(final ExecutionEvent event) throws ExecutionException {		public Object execute(final ExecutionEvent event) throws ExecutionException {
	String url = event.getParameter("de.prob.ui.openwebsite.url");		String url = event.getParameter("de.prob.ui.openwebsite.url");
	try {		try {
	PlatformUI.getWorkbench().getBrowserSupport().getExternalBrowser()		URL u = new URL(url)
	.openURL(~~new URL(url)~~);		PlatformUI.getWorkbench().getBrowserSupport().getExternalBrowser().openURL(u);
	}		}
	catch (PartInitException e) { /* handle exception */ }		catch (PartInitException e) { /* handle exception */ }
	catch (MalformedURLException e) { /* handle exception */ }		catch (MalformedURLException e) { /* handle exception */ }
	return null;		return null;
	}		}

	The event object passed to the method contains the information about parameters, in our case we get a String containing the URL, but the parameters can also be more complex. For more complex types one needs to create a commandParameterType within the command extension.		The event object passed to the method contains the information about parameters, in our case we get a String containing the URL, but the parameters can also be more complex. For more complex types one needs to create a commandParameterType within the command extension.

Jens Bendisposto at 16:31, 14 April 2010

2010-04-14T16:31:35Z

← Older revision		Revision as of 16:31, 14 April 2010
Line 19:		Line 19:

	2. Create an extension to org.eclipse.ui.handlers and add a handler. The handler will link the command with its implementation, i.e., if the command is triggered the execute method of the handler is being called.		2. Create an extension to org.eclipse.ui.handlers and add a handler. The handler will link the command with its implementation, i.e., if the command is triggered the execute method of the handler is being called.
	<extension point="org.eclipse.ui.handlers">		<extension
			point="org.eclipse.ui.handlers">
	<handler		<handler
	class="~~myplugin~~.~~mycontributionCommand~~"		class="de.prob.ui.internal.OpenWebsiteCommand"
	commandId="~~myplugin~~.~~mycontribution~~">		commandId="de.prob.ui.openWebsite">
	</handler>		</handler>
	</extension>		</extension>

			The implementation of the execute method of OpenWebsiteCommand looks like

			public Object execute(final ExecutionEvent event) throws ExecutionException {
			String url = event.getParameter("de.prob.ui.openwebsite.url");
			try {
			PlatformUI.getWorkbench().getBrowserSupport().getExternalBrowser()
			.openURL(new URL(url));
			}
			catch (PartInitException e) { /* handle exception */ }
			catch (MalformedURLException e) { /* handle exception */ }
			return null;
			}

			The event object passed to the method contains the information about parameters, in our case we get a String containing the URL, but the parameters can also be more complex. For more complex types one needs to create a commandParameterType within the command extension.

			Aside: It is quite usefull in User Interfaces to get the IWorkbenchWindow object related to the event (we don't need it in this particular example). This can be done within the execute method using

			IWorkbenchWindow window = HandlerUtil.getActiveWorkbenchWindowChecked(event);

	3. Now we add an instance of the command to the menu bar		3. Now we add an instance of the command to the menu bar
	<extension		<extension

Jens Bendisposto at 16:21, 14 April 2010

2010-04-14T16:21:59Z

@@ Line 40: / Line 40: @@
              </parameter>
           </command>
-This will show a menu item in the contact submenu and it will pass the parameter into the command.
+        </menuContribution>

Jens Bendisposto: Created page with 'We use the Eclipse Command Framework. This document describes how you can add a menu item "Open Website" to one of the ProB submenus (in this case Contact). 1. Create an exten…'

2010-04-14T16:11:27Z

Created page with 'We use the Eclipse Command Framework. This document describes how you can add a menu item "Open Website" to one of the ProB submenus (in this case Contact). 1. Create an exten…'

New page

We use the Eclipse Command Framework. This document describes how you can add a menu item "Open Website" to one of the ProB submenus (in this case Contact).

1. Create an extension to org.eclipse.ui.commands and add a new command. <br>You will end up with something like
<extension point="org.eclipse.ui.commands">
<command
categoryId="de.prob.ui.commands.category"
id="de.prob.ui.openWebsite"
name="Open Website">
<commandParameter
id="de.prob.ui.openwebsite.url"
name="URL"
optional="false">
</commandParameter>
</command>
</extension>

The example also shows that commands can have parameters. In this case we want to provide different URLs. Section 3 will explain how the command is parameterized.

2. Create an extension to org.eclipse.ui.handlers and add a handler. The handler will link the command with its implementation, i.e., if the command is triggered the execute method of the handler is being called.
<extension point="org.eclipse.ui.handlers">
<handler
class="myplugin.mycontributionCommand"
commandId="myplugin.mycontribution">
</handler>
</extension>
3. Now we add an instance of the command to the menu bar
<extension
point="org.eclipse.ui.menus">
<menuContribution
locationURI="menu:contact">
<command
commandId="de.prob.ui.openWebsite"
label="Open ProB Website"
mnemonic="W"
style="push">
<parameter
name="de.prob.ui.openwebsite.url"
value="http://www.stups.uni-duesseldorf.de/ProB">
</parameter>
</command>
This will show a menu item in the contact submenu and it will pass the parameter into the command.