Package: EMFFormsSpreadsheetRendererFactory

EMFFormsSpreadsheetRendererFactory

Coverage

1: /*******************************************************************************
2: * Copyright (c) 2011-2015 EclipseSource Muenchen GmbH and others.
3: *
4: * All rights reserved. This program and the accompanying materials
5: * are made available under the terms of the Eclipse Public License 2.0
6: * which accompanies this distribution, and is available at
7: * https://www.eclipse.org/legal/epl-2.0/
8: *
9: * SPDX-License-Identifier: EPL-2.0
10: *
11: * Contributors:
12: * Eugen Neufeld - initial API and implementation
13: ******************************************************************************/
14: package org.eclipse.emfforms.spi.spreadsheet.core;
15:
16: import org.eclipse.emf.ecp.view.spi.context.ViewModelContext;
17: import org.eclipse.emf.ecp.view.spi.model.VElement;
18:
19: /**
20: * This is the factory which selects the most fitting renderer for the provided {@link VElement} and
21: * {@link ViewModelContext}.
22: *
23: * @author Eugen Neufeld
24: * @noimplement This interface is not intended to be implemented by clients.
25: * @noextend This interface is not intended to be extended by clients.
26: */
27: public interface EMFFormsSpreadsheetRendererFactory {
28:
29:         /**
30:          * Adds an {@link EMFFormsSpreadsheetRendererService} to the list of available renderer.
31:          *
32:          * @param spreadsheetRendererService The EMFFormsSpreadsheetRendererService to add
33:          */
34:         void addEMFFormsSpreadsheetRendererService(EMFFormsSpreadsheetRendererService<VElement> spreadsheetRendererService);
35:
36:         /**
37:          * Removes an {@link EMFFormsSpreadsheetRendererService} from the list of available renderer.
38:          *
39:          * @param spreadsheetRendererService The EMFFormsSpreadsheetRendererService to remove
40:          */
41:         void removeEMFFormsSpreadsheetRendererService(
42:                 EMFFormsSpreadsheetRendererService<VElement> spreadsheetRendererService);
43:
44:         /**
45:          * Returns the renderer which fits the provided {@link VElement} and {@link ViewModelContext} the most.
46:          *
47:          * @param vElement the {@link VElement} to find the renderer for
48:          * @param viewModelContext the {@link ViewModelContext} to find the renderer for
49:          * @param <VELEMENT> The VElement type
50:          * @return the renderer
51:          * @throws EMFFormsNoRendererException is thrown when no renderer can be found
52:          */
53:         <VELEMENT extends VElement> EMFFormsAbstractSpreadsheetRenderer<VElement> getRendererInstance(VELEMENT vElement,
54:                 ViewModelContext viewModelContext) throws EMFFormsNoRendererException;
55:
56: }