org.eclipse.emf.ecp.view.spi.swt.services

Interface ECPSelectionProviderService

All Superinterfaces:

ViewModelService

All Known Implementing Classes:

DefaultSelectionProviderService

public interface ECPSelectionProviderService
extends ViewModelService

A mediator of selection providers for the ViewModelContext, to provide a coherent selection provider for the rendering of a view.

Since:

1.20

Method Summary

Modifier and Type	Method and Description
default IMasterDetailSelectionProvider	createMasterDetailSelectionProvider(org.eclipse.jface.viewers.Viewer master, Supplier<? extends org.eclipse.swt.widgets.Control> detailSupplier) Create a master-detail selection provider on the given master viewer.
org.eclipse.jface.viewers.ISelectionProvider	getSelectionProvider() Obtain a selection provider that aggregates the selection in the view model context.
void	registerSelectionProvider(VElement element, org.eclipse.jface.viewers.ISelectionProvider selectionProvider) Register a selection provider for a given element.

Methods inherited from interface org.eclipse.emf.ecp.view.spi.context.ViewModelService

dispose, getPriority, instantiate

Method Detail

getSelectionProvider

org.eclipse.jface.viewers.ISelectionProvider getSelectionProvider()

Obtain a selection provider that aggregates the selection in the view model context. This should be suitable for use as, for example, the selection provider of an Eclipse workbench part site. The selection provider is never null, but if there are no registered providers to which it can delegate, it may have no useful effect.

Returns:

the selection provider

registerSelectionProvider

void registerSelectionProvider(VElement element,
                               org.eclipse.jface.viewers.ISelectionProvider selectionProvider)

Register a selection provider for a given element. The effect is undefined if the element already has a provider registered. It is probably a good practice that only the renderer of the element be responsible for registering a selection provider for it.

Parameters:

element - an element in the view model

selectionProvider - a selection provider to register for it

Throws:

NullPointerException - if the either the element or the selection provider is null

createMasterDetailSelectionProvider

default IMasterDetailSelectionProvider createMasterDetailSelectionProvider(org.eclipse.jface.viewers.Viewer master,
                                                                           Supplier<? extends org.eclipse.swt.widgets.Control> detailSupplier)

Create a master-detail selection provider on the given master viewer.

Parameters:

master - the master viewer

detailSupplier - the supplier of the detail view currently presented for the selection in the master

Returns:

a master-detail selection provider

Since:

1.21