org.eclipse.emf.ecp.view.model.preview.common

Class PreviewWorkspaceViewProvider

java.lang.Object

org.eclipse.emf.ecp.view.model.preview.common.PreviewWorkspaceViewProvider

All Implemented Interfaces:

IViewProvider

public class PreviewWorkspaceViewProvider
extends Object
implements IViewProvider

The IViewProvider provides views from the workspace.

Author:

Eugen Neufeld

Field Summary

Fields inherited from interface org.eclipse.emf.ecp.view.spi.provider.IViewProvider

NOT_APPLICABLE

Constructor Summary

Constructors

Constructor and Description
PreviewWorkspaceViewProvider() Constructor.

Method Summary

Modifier and Type	Method and Description
void	addViewModel(org.eclipse.core.runtime.IPath path) Add a new view model path to the list of available views in the preview.
double	canProvideViewModel(org.eclipse.emf.ecore.EObject eObject, VViewModelProperties properties) Called to check whether the provider can provide a VView for an EObject.
void	dispose() Clean the used resources.
VView	provideViewModel(org.eclipse.emf.ecore.EObject eObject, VViewModelProperties properties) This method is only called if IViewProvider.canProvideViewModel(EObject, VViewModelProperties) returned the highest positive number of all IViewProviders.
void	removeViewModel(org.eclipse.core.runtime.IPath path) Remove a view model path from the list of available views in the preview.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PreviewWorkspaceViewProvider

public PreviewWorkspaceViewProvider()

Constructor.

Method Detail

addViewModel

public void addViewModel(org.eclipse.core.runtime.IPath path)

Add a new view model path to the list of available views in the preview.

Parameters:

path - The IPath to load

removeViewModel

public void removeViewModel(org.eclipse.core.runtime.IPath path)

Remove a view model path from the list of available views in the preview.

Parameters:

path - The IPath to remove

canProvideViewModel

public double canProvideViewModel(org.eclipse.emf.ecore.EObject eObject,
                                  VViewModelProperties properties)

Description copied from interface: IViewProvider

Called to check whether the provider can provide a VView for an EObject.

Specified by:

canProvideViewModel in interface IViewProvider

Parameters:

eObject - the EObject to create a

properties - the properties for providing the view

Returns:

a positive double indicating how well this provider is fitted to provide a VView for the provided EObject or IViewProvider.NOT_APPLICABLE if it doesn't fit

provideViewModel

public VView provideViewModel(org.eclipse.emf.ecore.EObject eObject,
                              VViewModelProperties properties)

Description copied from interface: IViewProvider

This method is only called if IViewProvider.canProvideViewModel(EObject, VViewModelProperties) returned the highest positive number of all IViewProviders. It must then return a VView to the EObject.

Specified by:

provideViewModel in interface IViewProvider

Parameters:

eObject - the EObject to generate the VView for

properties - the properties for providing the view

Returns:

the generated VView

dispose

public void dispose()

Clean the used resources.