Package org.eclipse.emf.ecp.view.spi.provider

Interface IViewProvider

All Known Subinterfaces:

IFilteredViewProvider

All Known Implementing Classes:

ExtensionXMIViewModelProvider, PreviewWorkspaceViewProvider, ViewProvider, XMIViewModelProvider

public interface IViewProvider

This interface defines a generic way to provide a VView. First the can render method is called. The provider with the highest priority is then asked to provideViewModel(EObject, VViewModelProperties) a VView.

Since:

1.2

Author:

Eugen Neufeld

Field Summary

Fields

Modifier and Type	Field	Description
static double	NOT_APPLICABLE	Constant indicating, that the provider cannot provide a VView for a specific EObject.

Method Summary

Modifier and Type	Method	Description
double	canProvideViewModel(org.eclipse.emf.ecore.EObject eObject, VViewModelProperties properties)	Called to check whether the provider can provide a VView for an EObject.
VView	provideViewModel(org.eclipse.emf.ecore.EObject eObject, VViewModelProperties properties)	This method is only called if canProvideViewModel(EObject, VViewModelProperties) returned the highest positive number of all IViewProviders.

Field Detail

NOT_APPLICABLE

static final double NOT_APPLICABLE

Constant indicating, that the provider cannot provide a VView for a specific EObject.

See Also:

Constant Field Values

Method Detail

canProvideViewModel

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

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

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 NOT_APPLICABLE if it doesn't fit

Since:

1.7

provideViewModel

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

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

Parameters:

eObject - the EObject to generate the VView for

properties - the properties for providing the view

Returns:

the generated VView

Since:

1.7