org.eclipse.emf.ecp.spi.view.template.service

Interface ViewTemplateSupplier

All Known Implementing Classes:

ViewTemplateSupplierImpl

public interface ViewTemplateSupplier

A ViewTemplateSupplier collects and provides any number of VTViewTemplates.

This interface may be implemented by clients to implement custom logic to provide VTViewTemplates and/or VTStyleProperties for given VElements.

Since:

1.18

Author:

Lucas Koehler

Method Summary

Modifier and Type	Method and Description
Map<VTStyleProperty,Double>	getStyleProperties(VElement vElement, ViewModelContext viewModelContext) Return all StyleProperties which are applicable to the provided VElement.
Set<VTViewTemplate>	getViewTemplates() Returns a copy of the view templates known to this supplier.

Method Detail

getStyleProperties

Map<VTStyleProperty,Double> getStyleProperties(VElement vElement,
                                               ViewModelContext viewModelContext)

Return all StyleProperties which are applicable to the provided VElement. The keys of the map are the StyleProperties and the values the corresponding specificities.

The returned values might be cached by the caller. Therefore, for the same arguments, the ViewTemplateSupplier is expected to return the same map of StyleProperties and specificities.

Parameters:

vElement - the VElement to get the StyleProperties for

viewModelContext - the ViewModelContext currently in use

Returns:

the map of all StyleProperties and their specificities for the given VElement or an empty map

getViewTemplates

Set<VTViewTemplate> getViewTemplates()

Returns a copy of the view templates known to this supplier. Modifications on the copies will not influence any future calls on the ViewTemplateSupplier

Returns:

a copy of the VTViewTemplates or an empty set