Extending the project explorer - Revision history

imported>Renato: /* Introduction */

2010-05-24T16:33:43Z

Introduction

← Older revision		Revision as of 16:33, 24 May 2010
Line 1:		Line 1:
	{{TOCright}}		{{TOCright}}
	= Introduction =		= Introduction =
	The purpose of this page is to describe how to extend the Event-B project explorer. It covers on the one hand, the definition of the extension, and on the other hand its implementation. The Event-B project explorer is itself an implementation of the extension-point <tt>org.eclipse.ui.views</tt>. The corresponding view id is '''fr.systerel.explorer.navigator.view''' which is defined as a subclass of <tt>org.eclipse.ui.navigator.CommonNavigator</tt> and it is over this view that we extend the project explorer.		The purpose of this page is to describe how to extend the Event-B project explorer. It covers on the one hand, the definition of the extension, and on the other hand its implementation. The Event-B project explorer is itself an implementation of the extension-point <tt>org.eclipse.ui.views</tt>. The corresponding view id is '''fr.systerel.explorer.navigator.view''' which is defined as a subclass of <tt>org.eclipse.ui.navigator.CommonNavigator</tt> and it is over this view that we extend the project explorer. We will describe a simple implementation but the reader should be aware that the extension can have a more complex structure and consequently a more complex implementation.

	[[Image:EventB project explorer.png]]		[[Image:EventB project explorer.png]]

imported>Renato: /* Programmatic usage */

2010-05-24T16:28:48Z

Programmatic usage

← Older revision		Revision as of 16:28, 24 May 2010
Line 102:		Line 102:
	- ...		- ...

	Moreover, a class called ''ModelController'' defined as a singleton controls all the models and contains useful methods. It also implements the interface <tt>org.rodinp.core.IElementChangedListener</tt> that will be called whenever there is a change in one of the model elements. It will clean up the existing elements in the project explorer and reload with the recent changes. The ''ModelController'' instance should be called by implementing the method <tt>org.eclipse.jface.viewers.IContentProvider#inputChanged</tt> (required for classes that implement interface <tt>org.eclipse.jface.viewers.ITreeContentProvider</tt>). Usually an abstract class that implements ITreeContentProvider is created: ''AbstractContentProvider''.		Moreover, a class called ''ModelController'' defined as a singleton controls all the models and contains useful methods. It also implements the interface <tt>org.rodinp.core.IElementChangedListener</tt> that will be called whenever there is a change in one of the model elements. It will clean up the existing elements in the project explorer and reload with the recent changes through a class called ''DeltaProcessor'': processes an IRodinElementDelta for the ''ModelController''. It decides what needs to be refreshed in the model and the viewer and what needs to be removed from the model (see as an example the class <tt>fr.systerel.internal.explorer.model.DeltaProcessor</tt>). The ''ModelController'' instance should be called by implementing the method <tt>org.eclipse.jface.viewers.IContentProvider#inputChanged</tt> (required for classes that implement interface <tt>org.eclipse.jface.viewers.ITreeContentProvider</tt>). Usually an abstract class that implements ITreeContentProvider is created: ''AbstractContentProvider''.

	public abstract class AbstractContentProvider implements ITreeContentProvider {		public abstract class AbstractContentProvider implements ITreeContentProvider {

imported>Renato: /* Example */

2010-05-24T16:16:07Z

Example

← Older revision		Revision as of 16:16, 24 May 2010
Line 281:		Line 281:
	</extension>		</extension>

	The ~~pattern~~ correspond to the ids in the contentProvider and actionProvider extension-points defined above (see the navigatorContent example section).		The contentExtension patterns correspond to the ids in the contentProvider and actionProvider extension-points defined above (see the navigatorContent example section).

	[[Category:Developer documentation]]		[[Category:Developer documentation]]
	[[Category:Rodin Platform]]		[[Category:Rodin Platform]]

imported>Renato: /* Navigator Viewer */

2010-05-24T16:14:02Z

Navigator Viewer

← Older revision		Revision as of 16:14, 24 May 2010
Line 224:		Line 224:
	The viewer element defines the configuration for a common viewer. We define two children of this extension point:		The viewer element defines the configuration for a common viewer. We define two children of this extension point:

	* viewerContentBinding: to define the visibility of ''contentProviders''.		* ''viewerContentBinding'': to define the visibility of ''contentProviders''.
	* viewerActionBinding: to define the visibility of ''actionProviders''.		* ''viewerActionBinding'': to define the visibility of ''actionProviders''.

	== Declaration ==		== Declaration ==

imported>Renato: /* Navigator Viewer */

2010-05-24T16:13:32Z

Navigator Viewer

← Older revision		Revision as of 16:13, 24 May 2010
Line 222:		Line 222:
	= Navigator Viewer =		= Navigator Viewer =

	The viewer element defines the configuration for a common viewer. The extension may provide a custom popup menu id, override whether the viewer provides link with editor support, provides a filter dialog, and/or provides an "Available customizations" dialog. In addition, nested configuration elements give full control over the structure and behavior of the popup context menu. We define two children of this extension point:		The viewer element defines the configuration for a common viewer. We define two children of this extension point:

	* viewerContentBinding: to define the visibility of ''contentProviders''.		* viewerContentBinding: to define the visibility of ''contentProviders''.

imported>Renato: /* Example */

2010-05-24T16:12:31Z

Example

← Older revision		Revision as of 16:12, 24 May 2010
Line 190:		Line 190:
	</extension>		</extension>

	Above we ~~define~~ two navigatorContent elements (''DecompositionContentProvider'' and ''ComponentContentProvider'') using the same class as labelProvider (''DecompositionLabelProvider''). The first is triggered by instances of ''IProject'' and ''IDecompositionRoot'' and the possible children of this element are ''IDecompositionRoot'' as well.		Above we defined two navigatorContent elements (''DecompositionContentProvider'' and ''ComponentContentProvider'') using the same class as labelProvider (''DecompositionLabelProvider''). The first is triggered by instances of ''IProject'' and ''IDecompositionRoot'' and the possible children of this element are ''IDecompositionRoot'' as well.

	An actionProvider example is described below:		An actionProvider example is described below:

imported>Renato: /* Example */

2010-05-24T12:03:12Z

Example

← Older revision		Revision as of 12:03, 24 May 2010
Line 218:		Line 218:
	</actionProvider>		</actionProvider>

	This actionProvider, described by the class <tt>ch.ethz.eventb.decomposition.ui.explorer.actionProvider.DecompositionRootActionProvider</tt> is enabled ~~for~~ instances of IDecompositionRoot, IDecompositionConfiguration, ISubComponent, ISubComponentElement and IComponent.		This actionProvider, described by the class <tt>ch.ethz.eventb.decomposition.ui.explorer.actionProvider.DecompositionRootActionProvider</tt> is enabled by instances of IDecompositionRoot, IDecompositionConfiguration, ISubComponent, ISubComponentElement and IComponent.

	= Navigator Viewer =		= Navigator Viewer =

imported>Renato: /* Example */

2010-05-24T12:02:10Z

Example

← Older revision		Revision as of 12:02, 24 May 2010
Line 189:		Line 189:
	</possibleChildren>		</possibleChildren>
	</extension>		</extension>

			Above we define two navigatorContent elements (''DecompositionContentProvider'' and ''ComponentContentProvider'') using the same class as labelProvider (''DecompositionLabelProvider''). The first is triggered by instances of ''IProject'' and ''IDecompositionRoot'' and the possible children of this element are ''IDecompositionRoot'' as well.

	An actionProvider example is described below:		An actionProvider example is described below:

imported>Renato: /* Programmatic usage */

2010-05-24T11:57:42Z

Programmatic usage

← Older revision		Revision as of 11:57, 24 May 2010
Line 136:		Line 136:
	}		}

	This class is extended by the respective ~~elements~~ contentProviders. For instance:		This class is extended by the respective ''contentProviders''. For instance:

	public class DecompositionContentProvider extends AbstractContentProvider{...}		public class DecompositionContentProvider extends AbstractContentProvider{...}

imported>Renato: /* Programmatic usage */

2010-05-24T11:54:36Z

Programmatic usage

← Older revision		Revision as of 11:54, 24 May 2010
Line 102:		Line 102:
	- ...		- ...

	Moreover, a class called ''ModelController'' defined as a singleton controls all the models and contains useful methods. It also implements the interface <tt>org.rodinp.core.IElementChangedListener</tt> that will be called whenever there is a change in one of the model elements. It will clean up the existing elements in the project explorer and reload with the recent changes. The 'ModelController' instance should be called by implementing the method <tt>org.eclipse.jface.viewers.IContentProvider#inputChanged</tt> (required for classes that implement interface <tt>org.eclipse.jface.viewers.ITreeContentProvider</tt>). Usually an abstract class that implements ITreeContentProvider is created: ''AbstractContentProvider''.		Moreover, a class called ''ModelController'' defined as a singleton controls all the models and contains useful methods. It also implements the interface <tt>org.rodinp.core.IElementChangedListener</tt> that will be called whenever there is a change in one of the model elements. It will clean up the existing elements in the project explorer and reload with the recent changes. The ''ModelController'' instance should be called by implementing the method <tt>org.eclipse.jface.viewers.IContentProvider#inputChanged</tt> (required for classes that implement interface <tt>org.eclipse.jface.viewers.ITreeContentProvider</tt>). Usually an abstract class that implements ITreeContentProvider is created: ''AbstractContentProvider''.

	public abstract class AbstractContentProvider implements ITreeContentProvider {		public abstract class AbstractContentProvider implements ITreeContentProvider {