imported>Jrloria: /* Adding an action provider to the navigator */

2010-03-26T18:36:15Z

Adding an action provider to the navigator

← Older revision		Revision as of 18:36, 26 March 2010
Line 46:		Line 46:
	To add a custom filter you use again the <code>org.eclipse.ui.navigator.navigatorContent</code> extension. There you add a new actionProvider. You have to provide an implementation for <code>org.eclipse.ui.navigator.CommonActionProvider</code>. To decide on what nodes in the tree your action provider should be invoked, use the enablement expression. Finally include your commonFilter in your viewerActionBindings. There is a example project in the SVN repository, that adds an action provider to the navigator.		To add a custom filter you use again the <code>org.eclipse.ui.navigator.navigatorContent</code> extension. There you add a new actionProvider. You have to provide an implementation for <code>org.eclipse.ui.navigator.CommonActionProvider</code>. To decide on what nodes in the tree your action provider should be invoked, use the enablement expression. Finally include your commonFilter in your viewerActionBindings. There is a example project in the SVN repository, that adds an action provider to the navigator.

			==See Also==
			* [[Single View Design]]

	[[Category:Developer documentation]]		[[Category:Developer documentation]]
	[[Category:Design]]		[[Category:Design]]

imported>Jrloria: moved from Single View Design

2010-03-26T18:30:06Z

moved from Single View Design

New page

===Extending Single View Design===
Single View Design uses the [http://wiki.eclipse.org/index.php/Common_Navigator_Framework Common Navigator Framework]. You can add custom filters, content providers and action providers in a plug-in of your own. Add the extension <code>org.eclipse.ui.navigator.viewer</code>. There you can add viewerContentBindings and viewerActionBindings with viewerId <code>fr.systerel.explorer.navigator.view</code>. This binds your custom content, actions and filters to the navigator.

In the picture you can see what types the nodes in the navigator have.

[[Image:Tree.jpg]]

====Adding a content provider to the navigator====
To add a custom content provider you have to use the <code>org.eclipse.ui.navigator.navigatorContent</code> extension. There you add a new navigatorContent. Example: You want to add a new child under the IMachineRoot nodes. Define a navigatorContent and add triggerPoints. There you add a new <code>instanceof</code> with value <code>org.eventb.core.IMachineRoot </code>. The priority of the navigatorContent decides in what order the content is shown with respect to other content providers. (For example the content provider for the variables has a higher priority than the one for invariants, that's why the variables appear before the invariants in the tree.) You need to provide a contentProvider and a labelProvider class. Finally include your navigatorContent in your viewerContentBindings. For more information read the extension point description of [http://help.eclipse.org/help32/index.jsp?topic=/org.eclipse.platform.doc.isv/reference/extension-points/org_eclipse_ui_navigator_navigatorContent.html navigatorContent]. There is a example project in the SVN repository, that adds a content provider to the navigator.

<code>
<extension
point="org.eclipse.ui.navigator.navigatorContent">
<navigatorContent
contentProvider="example.ContentProvider"
id="example.navigatorContent"
labelProvider="example.LabelProvider"
name="Example Content">
<triggerPoints>
<instanceof
value="org.eventb.core.IMachineRoot ">
</instanceof>
</triggerPoints>
</navigatorContent>
</extension>
</code>

<code>
<extension
point="org.eclipse.ui.navigator.viewer">
<viewerContentBinding
viewerId="fr.systerel.explorer.navigator.view">
<includes>
<contentExtension
pattern="example.navigatorContent">
</contentExtension>
</includes>
</viewerContentBinding>
</extension>
</code>

====Adding a filter to the navigator====
To add a custom filter you have to use the <code>org.eclipse.ui.navigator.navigatorContent</code> extension. There you add a new commonFilter. You can either provide an implementation for <code>ViewerFilter</code> or use xml filterExpressions. For more information read the extension point description of [http://help.eclipse.org/help32/index.jsp?topic=/org.eclipse.platform.doc.isv/reference/extension-points/org_eclipse_ui_navigator_navigatorContent.html navigatorContent]. Finally include your commonFilter in your viewerContentBindings. There is a example project in the SVN repository, that adds a filter to the navigator.

====Adding an action provider to the navigator====
To add a custom filter you use again the <code>org.eclipse.ui.navigator.navigatorContent</code> extension. There you add a new actionProvider. You have to provide an implementation for <code>org.eclipse.ui.navigator.CommonActionProvider</code>. To decide on what nodes in the tree your action provider should be invoked, use the enablement expression. Finally include your commonFilter in your viewerActionBindings. There is a example project in the SVN repository, that adds an action provider to the navigator.

[[Category:Developer documentation]]
[[Category:Design]]

Extending Single View Design - Revision history

imported>Jrloria: /* Adding an action provider to the navigator */

imported>Jrloria: moved from Single View Design