bundles/org.eclipse.emf.ecp.view.table.ui.nebula.grid/src/org/eclipse/emf/ecp/view/spi/table/nebula/grid/GridControlSWTRenderer.java - emfclient/org.eclipse.emf.ecp.core - Git at Google

 /*******************************************************************************
  * Copyright (c) 2011-2019 EclipseSource Muenchen GmbH and others.
  *
  * All rights reserved. This program and the accompanying materials
  * are made available under the terms of the Eclipse Public License 2.0
  * which accompanies this distribution, and is available at
  * https://www.eclipse.org/legal/epl-2.0/
  *
  * SPDX-License-Identifier: EPL-2.0
  *
  * Contributors:
  * jonas - initial API and implementation
  * Christian W. Damus - bugs 534829, 530314
  ******************************************************************************/
 package org.eclipse.emf.ecp.view.spi.table.nebula.grid;

 import java.util.ArrayList;
 import java.util.Arrays;
 import java.util.LinkedHashMap;
 import java.util.List;
 import java.util.Map;

 import javax.inject.Inject;

 import org.eclipse.core.databinding.observable.IObserving;
 import org.eclipse.core.databinding.observable.list.IObservableList;
 import org.eclipse.core.databinding.observable.value.IObservableValue;
 import org.eclipse.emf.common.command.Command;
 import org.eclipse.emf.common.command.CompoundCommand;
 import org.eclipse.emf.common.util.Diagnostic;
 import org.eclipse.emf.ecore.EObject;
 import org.eclipse.emf.ecore.EStructuralFeature;
 import org.eclipse.emf.ecp.view.internal.table.nebula.grid.GridClearKeyListener;
 import org.eclipse.emf.ecp.view.internal.table.nebula.grid.GridCopyKeyListener;
 import org.eclipse.emf.ecp.view.internal.table.nebula.grid.GridCutKeyListener;
 import org.eclipse.emf.ecp.view.internal.table.nebula.grid.GridPasteKeyListener;
 import org.eclipse.emf.ecp.view.spi.context.ViewModelContext;
 import org.eclipse.emf.ecp.view.spi.model.VDomainModelReference;
 import org.eclipse.emf.ecp.view.spi.table.model.VTableControl;
 import org.eclipse.emf.ecp.view.spi.table.swt.TableControlSWTRenderer;
 import org.eclipse.emf.ecp.view.spi.util.swt.ImageRegistryService;
 import org.eclipse.emf.ecp.view.template.model.VTViewTemplateProvider;
 import org.eclipse.emf.ecp.view.template.style.background.model.VTBackgroundStyleProperty;
 import org.eclipse.emf.ecp.view.template.style.fontProperties.model.VTFontPropertiesStyleProperty;
 import org.eclipse.emf.edit.command.SetCommand;
 import org.eclipse.emf.edit.domain.EditingDomain;
 import org.eclipse.emfforms.spi.common.converter.EStructuralFeatureValueConverterService;
 import org.eclipse.emfforms.spi.common.report.AbstractReport;
 import org.eclipse.emfforms.spi.common.report.ReportService;
 import org.eclipse.emfforms.spi.common.validation.PreSetValidationService;
 import org.eclipse.emfforms.spi.core.services.databinding.DatabindingFailedException;
 import org.eclipse.emfforms.spi.core.services.databinding.emf.EMFFormsDatabindingEMF;
 import org.eclipse.emfforms.spi.core.services.editsupport.EMFFormsEditSupport;
 import org.eclipse.emfforms.spi.core.services.label.EMFFormsLabelProvider;
 import org.eclipse.emfforms.spi.localization.EMFFormsLocalizationService;
 import org.eclipse.emfforms.spi.swt.table.TableConfiguration;
 import org.eclipse.emfforms.spi.swt.table.TableControl;
 import org.eclipse.emfforms.spi.swt.table.TableViewerCompositeBuilder;
 import org.eclipse.emfforms.spi.swt.table.TableViewerCreator;
 import org.eclipse.emfforms.spi.swt.table.TableViewerSWTBuilder;
 import org.eclipse.emfforms.spi.swt.table.action.TableActionBar;
 import org.eclipse.jface.databinding.viewers.ObservableListContentProvider;
 import org.eclipse.jface.viewers.AbstractTableViewer;
 import org.eclipse.jface.viewers.ColumnViewerEditor;
 import org.eclipse.jface.viewers.ColumnViewerEditorActivationEvent;
 import org.eclipse.jface.viewers.ColumnViewerEditorActivationStrategy;
 import org.eclipse.jface.viewers.ISelection;
 import org.eclipse.jface.viewers.ISelectionChangedListener;
 import org.eclipse.jface.viewers.IStructuredSelection;
 import org.eclipse.jface.viewers.SelectionChangedEvent;
 import org.eclipse.jface.viewers.ViewerRow;
 import org.eclipse.nebula.jface.gridviewer.GridTableViewer;
 import org.eclipse.nebula.jface.gridviewer.GridViewerEditor;
 import org.eclipse.nebula.widgets.grid.Grid;
 import org.eclipse.nebula.widgets.grid.GridItem;
 import org.eclipse.swt.SWT;
 import org.eclipse.swt.events.MouseEvent;
 import org.eclipse.swt.events.MouseListener;
 import org.eclipse.swt.events.MouseMoveListener;
 import org.eclipse.swt.graphics.Point;
 import org.eclipse.swt.widgets.Composite;
 import org.eclipse.swt.widgets.Item;
 import org.eclipse.swt.widgets.ScrollBar;
 import org.eclipse.swt.widgets.Widget;
 import org.osgi.framework.BundleContext;
 import org.osgi.framework.FrameworkUtil;
 import org.osgi.framework.ServiceReference;

 /**
  * @author Jonas Helming
  * @since 1.10
  *
  */
 public class GridControlSWTRenderer extends TableControlSWTRenderer {

 	private final EStructuralFeatureValueConverterService converterService;
 	private final EMFFormsLocalizationService localizationService;

 	/**
 	 * Custom Nebula Grid table viewer to expose getViewerRowFromItem() method.
 	 *
 	 * @author Mat Hansen
 	 *
 	 */
 	public class CustomGridTableViewer extends GridTableViewer {

 		/**
 		 * Creates a grid viewer on a newly-created grid control under the given
 		 * parent. The grid control is created using the given SWT style bits. The
 		 * viewer has no input, no content provider, a default label provider, no
 		 * sorter, and no filters.
 		 *
 		 * @param parent
 		 *            the parent control
 		 * @param style
 		 *            the SWT style bits used to create the grid.
 		 */
 		public CustomGridTableViewer(Composite parent, int style) {
 			super(parent, style);
 		}

 		// make method public
 		@Override
 		public ViewerRow getViewerRowFromItem(Widget item) {
 			return super.getViewerRowFromItem(item);
 		}
 	}

 	/**
 	 * Default constructor.
 	 *
 	 * @param vElement the view model element to be rendered
 	 * @param viewContext the view context
 	 * @param emfFormsDatabinding The {@link EMFFormsDatabindingEMF}
 	 * @param emfFormsLabelProvider The {@link EMFFormsLabelProvider}
 	 * @param reportService The {@link ReportService}
 	 * @param vtViewTemplateProvider The {@link VTViewTemplateProvider}
 	 * @param imageRegistryService The {@link ImageRegistryService}
 	 * @param emfFormsEditSupport The {@link EMFFormsEditSupport}
 	 * @param converterService the {@link EStructuralFeatureValueConverterService}
 	 * @param localizationService the {@link EMFFormsLocalizationService}
 	 * @since 1.11
 	 */
 	@Inject
 	// CHECKSTYLE.OFF: ParameterNumber
 	public GridControlSWTRenderer(VTableControl vElement, ViewModelContext viewContext, ReportService reportService,
 		EMFFormsDatabindingEMF emfFormsDatabinding, EMFFormsLabelProvider emfFormsLabelProvider,
 		VTViewTemplateProvider vtViewTemplateProvider, ImageRegistryService imageRegistryService,
 		EMFFormsEditSupport emfFormsEditSupport, EStructuralFeatureValueConverterService converterService,
 		EMFFormsLocalizationService localizationService) {
 		// CHECKSTYLE.ON: ParameterNumber
 		super(vElement, viewContext, reportService, emfFormsDatabinding, emfFormsLabelProvider, vtViewTemplateProvider,
 			imageRegistryService, emfFormsEditSupport);
 		this.converterService = converterService;
 		this.localizationService = localizationService;
 	}

 	/**
 	 * A Mouse and SelectionChanged listener which allows to copy values like in spreadsheets.
 	 *
 	 * @author Eugen Neufeld
 	 *
 	 */
 	private class CopyDragListener implements MouseListener, MouseMoveListener, ISelectionChangedListener {

 		private IStructuredSelection lastSelection;
 		private EObject masterObject;
 		private final PreSetValidationService preSetValidationService;
 		private boolean copyDragActive = false;
 		private GridItem startDragItem;

 		CopyDragListener() {
 			final BundleContext bundleContext = FrameworkUtil
 				.getBundle(getClass())
 				.getBundleContext();

 			final ServiceReference<PreSetValidationService> serviceReference = bundleContext
 				.getServiceReference(PreSetValidationService.class);

 			preSetValidationService = serviceReference != null ? bundleContext.getService(serviceReference) : null;
 		}

 		private boolean isCopyModifierPressed(MouseEvent e) {
 			return (e.stateMask & SWT.MOD2) != 0;
 		}

 		@Override
 		public void mouseMove(MouseEvent e) {
 			copyDragActive = isCopyModifierPressed(e) && lastSelection != null && lastSelection.size() > 1
 				&& masterObject != null;
 		}

 		@Override
 		public void mouseDoubleClick(MouseEvent e) {
 		}

 		@Override
 		public void mouseDown(MouseEvent e) {
 			if (isCopyModifierPressed(e)) {
 				final Grid grid = (Grid) e.widget;
 				startDragItem = grid.getItem(new Point(e.x, e.y));
 			}
 		}

 		@Override
 		public void mouseUp(MouseEvent e) {
 			if (e.button == 1) {

 				final Grid grid = (Grid) e.widget;
 				final GridItem currentItem = grid.getItem(new Point(e.x, e.y));
 				if (isCopyModifierPressed(e) && copyDragActive && startDragItem != currentItem) {
 					final List list = lastSelection.toList();
 					final VDomainModelReference dmr = (VDomainModelReference) grid.getColumn(new Point(e.x, e.y))
 						.getData(TableConfiguration.DMR);

 					Object masterValue = null;
 					EStructuralFeature structuralFeature = null;
 					IObservableValue masterOV = null;
 					try {
 						masterOV = getEMFFormsDatabinding().getObservableValue(dmr, masterObject);
 						masterValue = masterOV.getValue();
 						structuralFeature = (EStructuralFeature) masterOV.getValueType();
 					} catch (final DatabindingFailedException ex) {
 						getReportService().report(new AbstractReport(ex));
 					} finally {
 						if (masterOV != null) {
 							masterOV.dispose();
 						}
 					}
 					final EditingDomain editingDomain = getEditingDomain(masterObject);
 					final CompoundCommand cc = new CompoundCommand();
 					final List<String> invalidValues = new ArrayList<String>();
 					for (int i = 0; i < list.size(); i++) {
 						final EObject eObject = (EObject) list.get(i);
 						if (masterObject == eObject) {
 							continue;
 						}
 						final Diagnostic diagnostic = validate(eObject, dmr, structuralFeature);
 						final boolean valid = diagnostic.getSeverity() == Diagnostic.OK;
 						if (!valid) {
 							invalidValues.add(diagnostic.getChildren().get(0).getMessage());
 						} else {
 							final Command setCommand = SetCommand.create(editingDomain, eObject,
 								structuralFeature, masterValue);
 							cc.append(setCommand);
 						}
 					}
 					editingDomain.getCommandStack().execute(cc);
 				}
 				copyDragActive = false;
 				startDragItem = null;
 			}
 		}

 		private Diagnostic validate(EObject eObject, VDomainModelReference dmr, EStructuralFeature structuralFeature) {
 			IObservableValue value = null;
 			try {
 				if (preSetValidationService != null) {
 					value = getEMFFormsDatabinding().getObservableValue(dmr, eObject);
 					final Map<Object, Object> context = new LinkedHashMap<Object, Object>();
 					context.put("rootEObject", IObserving.class.cast(value).getObserved());//$NON-NLS-1$
 					final Diagnostic diag = preSetValidationService.validate(
 						structuralFeature, value.getValue(), context);
 					return diag;
 				}
 			} catch (final DatabindingFailedException ex) {
 				getReportService().report(new AbstractReport(ex));
 			} finally {
 				if (value != null) {
 					value.dispose();
 				}
 			}
 			return Diagnostic.OK_INSTANCE;
 		}

 		/**
 		 * {@inheritDoc}
 		 *
 		 * @see org.eclipse.jface.viewers.ISelectionChangedListener#selectionChanged(org.eclipse.jface.viewers.SelectionChangedEvent)
 		 */
 		@Override
 		public void selectionChanged(SelectionChangedEvent event) {
 			// was implemented using
 			// lastSelection = event.getStructuredSelection();
 			// this method throws a class cast exception in case no structured selection is present,
 			// so doing below null check should be fine
 			final ISelection selection = event.getSelection();
 			if (!IStructuredSelection.class.isInstance(selection)) {
 				lastSelection = null;
 				return;
 			}
 			lastSelection = (IStructuredSelection) event.getSelection();
 			if (lastSelection.size() == 1) {
 				masterObject = (EObject) lastSelection.getFirstElement();
 			}
 		}

 	}

 	/**
 	 * {@link TableViewerCreator} for the table control swt renderer. It will create a GridTableViewer with the expected
 	 * custom variant data and the correct style properties as defined in the template model.
 	 *
 	 */
 	protected class GridTableControlSWTRendererTableViewerCreator implements TableViewerCreator<GridTableViewer> {

 		@Override
 		public GridTableViewer createTableViewer(Composite parent) {

 			final GridTableViewer tableViewer = new CustomGridTableViewer(parent,
 				SWT.MULTI | SWT.V_SCROLL | SWT.H_SCROLL | SWT.FULL_SELECTION | SWT.BORDER);
 			tableViewer.getGrid().setData(CUSTOM_VARIANT, TABLE_CUSTOM_VARIANT);
 			tableViewer.getGrid().setHeaderVisible(true);
 			tableViewer.getGrid().setLinesVisible(true);
 			tableViewer.getGrid().setCellSelectionEnabled(true);
 			tableViewer.getGrid().setFooterVisible(false);

 			addKeyListener(tableViewer);
 			if (getViewModelContext().getContextValue("enableMultiEdit") == Boolean.TRUE) {
 				final CopyDragListener mdl = new CopyDragListener();
 				tableViewer.addSelectionChangedListener(mdl);
 				tableViewer.getGrid().addMouseMoveListener(mdl);
 				tableViewer.getGrid().addMouseListener(mdl);
 			}

 			/* Set background color */
 			final VTBackgroundStyleProperty backgroundStyleProperty = getBackgroundStyleProperty();
 			if (backgroundStyleProperty.getColor() != null) {
 				tableViewer.getGrid().setBackground(getSWTColor(backgroundStyleProperty.getColor()));
 			}

 			/* Set foreground color */
 			final VTFontPropertiesStyleProperty fontPropertiesStyleProperty = getFontPropertiesStyleProperty();
 			if (fontPropertiesStyleProperty.getColorHEX() != null) {
 				tableViewer.getGrid()
 					.setForeground(getSWTColor(fontPropertiesStyleProperty.getColorHEX()));
 			}

 			tableViewer.getGrid().setData(FIXED_COLUMNS, new Integer(1));

 			/* manage editing support activation */
 			createTableViewerEditor(tableViewer);

 			return tableViewer;
 		}

 		/**
 		 * Add key listener.
 		 *
 		 * @param tableViewer the viewer to add the listeners to
 		 */
 		protected void addKeyListener(final GridTableViewer tableViewer) {
 			tableViewer.getGrid().addKeyListener(new GridCopyKeyListener(tableViewer.getGrid().getDisplay()));
 			tableViewer.getGrid()
 				.addKeyListener(new GridPasteKeyListener(tableViewer.getGrid().getDisplay(), getVElement(),
 					getEMFFormsDatabinding(), getConverterService(), getLocalizationService(), true));
 			tableViewer.getGrid().addKeyListener(new GridClearKeyListener(getVElement(), getEMFFormsDatabinding()));
 			tableViewer.getGrid().addKeyListener(
 				new GridCutKeyListener(tableViewer.getGrid().getDisplay(), getVElement(), getEMFFormsDatabinding()));
 		}

 		/**
 		 * This method creates and initialises a {@link GridViewerEditor} for the given {@link GridTableViewer}.
 		 *
 		 * @param gridTableViewer the table viewer
 		 */
 		protected void createTableViewerEditor(final GridTableViewer gridTableViewer) {
 			// TODO Grid
 			// final TableViewerFocusCellManager focusCellManager = new TableViewerFocusCellManager(tableViewer,
 			// new org.eclipse.emf.ecp.edit.internal.swt.controls.ECPFocusCellDrawHighlighter(tableViewer));

 			// final TableViewer tableViewer = (TableViewer) getTableViewer();
 			// final TableViewerFocusCellManager focusCellManager = new TableViewerFocusCellManager(
 			// (TableViewer) gridTableViewer,
 			// new CustomFocusCellHighlighter(gridTableViewer);

 			final ColumnViewerEditorActivationStrategy actSupport = new GridColumnViewerEditorActivationStrategy(
 				gridTableViewer);
 			actSupport.setEnableEditorActivationWithKeyboard(true);
 			GridViewerEditor.create(
 				gridTableViewer,
 				actSupport,
 				ColumnViewerEditor.TABBING_HORIZONTAL | ColumnViewerEditor.TABBING_MOVE_TO_ROW_NEIGHBOR
 					| ColumnViewerEditor.TABBING_VERTICAL | ColumnViewerEditor.KEYBOARD_ACTIVATION);
 		}
 	}

 	@Override
 	protected TableViewerCreator<GridTableViewer> getTableViewerCreator() {
 		return new GridTableControlSWTRendererTableViewerCreator();
 	}

 	@Override
 	// CHECKSTYLE.OFF: ParameterNumber
 	protected TableViewerSWTBuilder createTableViewerSWTBuilder(Composite parent, IObservableList list,
 		IObservableValue labelText, IObservableValue labelTooltipText, TableViewerCompositeBuilder compositeBuilder,
 		ObservableListContentProvider cp, ECPTableViewerComparator comparator,
 		TableActionBar<? extends AbstractTableViewer> actionBar) {
 		// CHECKSTYLE.ON: ParameterNumber
 		return GridTableViewerFactory.fillDefaults(parent, SWT.NONE, list, labelText, labelTooltipText)
 			.customizeCompositeStructure(compositeBuilder)
 			.customizeActionBar(actionBar)
 			.customizeTableViewerCreation(getTableViewerCreator())
 			.customizeContentProvider(cp)
 			.customizeComparator(comparator)
 			.showHideColumns(true)
 			.columnSubstringFilter(true)
 			.columnRegexFilter(true);
 	}

 	@Override
 	protected int getSelectionIndex() {
 		return ((GridTableViewer) getTableViewer()).getGrid().getSelectionIndex();
 	}

 	@Override
 	protected Item[] getColumns() {
 		return ((GridTableViewer) getTableViewer()).getGrid().getColumns();
 	}

 	@Override
 	protected ScrollBar getHorizontalBar() {
 		return ((GridTableViewer) getTableViewer()).getGrid().getHorizontalBar();
 	}

 	@Override
 	protected ScrollBar getVerticalBar() {
 		return ((GridTableViewer) getTableViewer()).getGrid().getVerticalBar();
 	}

 	@Override
 	protected int computeRequiredHeight(Integer visibleLines) {
 		if (getTableViewer() == null || getTableViewerComposite() == null) {
 			return SWT.DEFAULT;
 		}
 		final TableControl table = getTableViewerComposite().getTableControl();
 		if (table == null) {
 			return SWT.DEFAULT;
 		}
 		if (table.isDisposed()) {
 			return SWT.DEFAULT;
 		}
 		final int itemHeight = table.getItemHeight() + 1;
 		// show one empty row if table does not contain any items or visibleLines < 1
 		int itemCount;
 		if (visibleLines != null) {
 			itemCount = Math.max(visibleLines, 1);
 		} else {
 			itemCount = Math.max(table.getItemCount(), 1);
 		}
 		final int headerHeight = table.getHeaderVisible() ? table.getHeaderHeight() : 0;

 		final int tableHeight = itemHeight * itemCount + headerHeight;
 		return tableHeight;
 	}

 	/**
 	 *
 	 * @return the {@link EStructuralFeatureValueConverterService}
 	 */
 	protected EStructuralFeatureValueConverterService getConverterService() {
 		return converterService;
 	}

 	/**
 	 *
 	 * @return the {@link EMFFormsLocalizationService}
 	 */
 	protected EMFFormsLocalizationService getLocalizationService() {
 		return localizationService;
 	}

 	/**
 	 * EditorActivationStrategy for GridColumns.
 	 *
 	 * @author Stefan Dirix
 	 */
 	private class GridColumnViewerEditorActivationStrategy extends ColumnViewerEditorActivationStrategy {

 		private final GridTableViewer gridTableViewer;

 		/**
 		 * Constructor.
 		 *
 		 * @param viewer the {@link GridTableViewer}.
 		 */
 		GridColumnViewerEditorActivationStrategy(GridTableViewer gridTableViewer) {
 			super(gridTableViewer);
 			this.gridTableViewer = gridTableViewer;
 		}

 		@Override
 		protected boolean isEditorActivationEvent(ColumnViewerEditorActivationEvent event) {
 			if (event.eventType == ColumnViewerEditorActivationEvent.TRAVERSAL
 				|| event.eventType == ColumnViewerEditorActivationEvent.MOUSE_DOUBLE_CLICK_SELECTION
 				|| event.eventType == ColumnViewerEditorActivationEvent.PROGRAMMATIC) {
 				return true;
 			}
 			if (event.eventType == ColumnViewerEditorActivationEvent.MOUSE_CLICK_SELECTION
 				&& gridTableViewer.isCellEditorActive()) {
 				gridTableViewer.applyEditorValue();
 			}
 			if (event.eventType == ColumnViewerEditorActivationEvent.KEY_PRESSED) {
 				for (final int keyCode : Arrays.asList(SWT.CTRL, SWT.ALT)) {
 					if ((event.keyCode & keyCode) != 0 || (event.stateMask & keyCode) != 0) {
 						return false;
 					}
 				}
 				if ((event.keyCode & SWT.SHIFT) != 0) {
 					return false;
 				}
 				return !isDoNotEnterEditorCode(event.keyCode);
 			}
 			return false;
 		}

 		private boolean isDoNotEnterEditorCode(int keyCode) {
 			// BEGIN COMPLEX CODE
 			return keyCode == SWT.ARROW_UP || keyCode == SWT.ARROW_DOWN
 				|| keyCode == SWT.ARROW_LEFT || keyCode == SWT.ARROW_RIGHT
 				|| keyCode == SWT.TAB || keyCode == SWT.DEL;
 			// END COMPLEX CODE
 		}
 	}

 }
	/*******************************************************************************
	* Copyright (c) 2011-2019 EclipseSource Muenchen GmbH and others.
	*
	* All rights reserved. This program and the accompanying materials
	* are made available under the terms of the Eclipse Public License 2.0
	* which accompanies this distribution, and is available at
	* https://www.eclipse.org/legal/epl-2.0/
	*
	* SPDX-License-Identifier: EPL-2.0
	*
	* Contributors:
	* jonas - initial API and implementation
	* Christian W. Damus - bugs 534829, 530314
	******************************************************************************/
	package org.eclipse.emf.ecp.view.spi.table.nebula.grid;

	import java.util.ArrayList;
	import java.util.Arrays;
	import java.util.LinkedHashMap;
	import java.util.List;
	import java.util.Map;

	import javax.inject.Inject;

	import org.eclipse.core.databinding.observable.IObserving;
	import org.eclipse.core.databinding.observable.list.IObservableList;
	import org.eclipse.core.databinding.observable.value.IObservableValue;
	import org.eclipse.emf.common.command.Command;
	import org.eclipse.emf.common.command.CompoundCommand;
	import org.eclipse.emf.common.util.Diagnostic;
	import org.eclipse.emf.ecore.EObject;
	import org.eclipse.emf.ecore.EStructuralFeature;
	import org.eclipse.emf.ecp.view.internal.table.nebula.grid.GridClearKeyListener;
	import org.eclipse.emf.ecp.view.internal.table.nebula.grid.GridCopyKeyListener;
	import org.eclipse.emf.ecp.view.internal.table.nebula.grid.GridCutKeyListener;
	import org.eclipse.emf.ecp.view.internal.table.nebula.grid.GridPasteKeyListener;
	import org.eclipse.emf.ecp.view.spi.context.ViewModelContext;
	import org.eclipse.emf.ecp.view.spi.model.VDomainModelReference;
	import org.eclipse.emf.ecp.view.spi.table.model.VTableControl;
	import org.eclipse.emf.ecp.view.spi.table.swt.TableControlSWTRenderer;
	import org.eclipse.emf.ecp.view.spi.util.swt.ImageRegistryService;
	import org.eclipse.emf.ecp.view.template.model.VTViewTemplateProvider;
	import org.eclipse.emf.ecp.view.template.style.background.model.VTBackgroundStyleProperty;
	import org.eclipse.emf.ecp.view.template.style.fontProperties.model.VTFontPropertiesStyleProperty;
	import org.eclipse.emf.edit.command.SetCommand;
	import org.eclipse.emf.edit.domain.EditingDomain;
	import org.eclipse.emfforms.spi.common.converter.EStructuralFeatureValueConverterService;
	import org.eclipse.emfforms.spi.common.report.AbstractReport;
	import org.eclipse.emfforms.spi.common.report.ReportService;
	import org.eclipse.emfforms.spi.common.validation.PreSetValidationService;
	import org.eclipse.emfforms.spi.core.services.databinding.DatabindingFailedException;
	import org.eclipse.emfforms.spi.core.services.databinding.emf.EMFFormsDatabindingEMF;
	import org.eclipse.emfforms.spi.core.services.editsupport.EMFFormsEditSupport;
	import org.eclipse.emfforms.spi.core.services.label.EMFFormsLabelProvider;
	import org.eclipse.emfforms.spi.localization.EMFFormsLocalizationService;
	import org.eclipse.emfforms.spi.swt.table.TableConfiguration;
	import org.eclipse.emfforms.spi.swt.table.TableControl;
	import org.eclipse.emfforms.spi.swt.table.TableViewerCompositeBuilder;
	import org.eclipse.emfforms.spi.swt.table.TableViewerCreator;
	import org.eclipse.emfforms.spi.swt.table.TableViewerSWTBuilder;
	import org.eclipse.emfforms.spi.swt.table.action.TableActionBar;
	import org.eclipse.jface.databinding.viewers.ObservableListContentProvider;
	import org.eclipse.jface.viewers.AbstractTableViewer;
	import org.eclipse.jface.viewers.ColumnViewerEditor;
	import org.eclipse.jface.viewers.ColumnViewerEditorActivationEvent;
	import org.eclipse.jface.viewers.ColumnViewerEditorActivationStrategy;
	import org.eclipse.jface.viewers.ISelection;
	import org.eclipse.jface.viewers.ISelectionChangedListener;
	import org.eclipse.jface.viewers.IStructuredSelection;
	import org.eclipse.jface.viewers.SelectionChangedEvent;
	import org.eclipse.jface.viewers.ViewerRow;
	import org.eclipse.nebula.jface.gridviewer.GridTableViewer;
	import org.eclipse.nebula.jface.gridviewer.GridViewerEditor;
	import org.eclipse.nebula.widgets.grid.Grid;
	import org.eclipse.nebula.widgets.grid.GridItem;
	import org.eclipse.swt.SWT;
	import org.eclipse.swt.events.MouseEvent;
	import org.eclipse.swt.events.MouseListener;
	import org.eclipse.swt.events.MouseMoveListener;
	import org.eclipse.swt.graphics.Point;
	import org.eclipse.swt.widgets.Composite;
	import org.eclipse.swt.widgets.Item;
	import org.eclipse.swt.widgets.ScrollBar;
	import org.eclipse.swt.widgets.Widget;
	import org.osgi.framework.BundleContext;
	import org.osgi.framework.FrameworkUtil;
	import org.osgi.framework.ServiceReference;

	/**
	* @author Jonas Helming
	* @since 1.10
	*
	*/
	public class GridControlSWTRenderer extends TableControlSWTRenderer {

	private final EStructuralFeatureValueConverterService converterService;
	private final EMFFormsLocalizationService localizationService;

	/**
	* Custom Nebula Grid table viewer to expose getViewerRowFromItem() method.
	*
	* @author Mat Hansen
	*
	*/
	public class CustomGridTableViewer extends GridTableViewer {

	/**
	* Creates a grid viewer on a newly-created grid control under the given
	* parent. The grid control is created using the given SWT style bits. The
	* viewer has no input, no content provider, a default label provider, no
	* sorter, and no filters.
	*
	* @param parent
	* the parent control
	* @param style
	* the SWT style bits used to create the grid.
	*/
	public CustomGridTableViewer(Composite parent, int style) {
	super(parent, style);
	}

	// make method public
	@Override
	public ViewerRow getViewerRowFromItem(Widget item) {
	return super.getViewerRowFromItem(item);
	}
	}

	/**
	* Default constructor.
	*
	* @param vElement the view model element to be rendered
	* @param viewContext the view context
	* @param emfFormsDatabinding The {@link EMFFormsDatabindingEMF}
	* @param emfFormsLabelProvider The {@link EMFFormsLabelProvider}
	* @param reportService The {@link ReportService}
	* @param vtViewTemplateProvider The {@link VTViewTemplateProvider}
	* @param imageRegistryService The {@link ImageRegistryService}
	* @param emfFormsEditSupport The {@link EMFFormsEditSupport}
	* @param converterService the {@link EStructuralFeatureValueConverterService}
	* @param localizationService the {@link EMFFormsLocalizationService}
	* @since 1.11
	*/
	@Inject
	// CHECKSTYLE.OFF: ParameterNumber
	public GridControlSWTRenderer(VTableControl vElement, ViewModelContext viewContext, ReportService reportService,
	EMFFormsDatabindingEMF emfFormsDatabinding, EMFFormsLabelProvider emfFormsLabelProvider,
	VTViewTemplateProvider vtViewTemplateProvider, ImageRegistryService imageRegistryService,
	EMFFormsEditSupport emfFormsEditSupport, EStructuralFeatureValueConverterService converterService,
	EMFFormsLocalizationService localizationService) {
	// CHECKSTYLE.ON: ParameterNumber
	super(vElement, viewContext, reportService, emfFormsDatabinding, emfFormsLabelProvider, vtViewTemplateProvider,
	imageRegistryService, emfFormsEditSupport);
	this.converterService = converterService;
	this.localizationService = localizationService;
	}

	/**
	* A Mouse and SelectionChanged listener which allows to copy values like in spreadsheets.
	*
	* @author Eugen Neufeld
	*
	*/
	private class CopyDragListener implements MouseListener, MouseMoveListener, ISelectionChangedListener {

	private IStructuredSelection lastSelection;
	private EObject masterObject;
	private final PreSetValidationService preSetValidationService;
	private boolean copyDragActive = false;
	private GridItem startDragItem;

	CopyDragListener() {
	final BundleContext bundleContext = FrameworkUtil
	.getBundle(getClass())
	.getBundleContext();

	final ServiceReference<PreSetValidationService> serviceReference = bundleContext
	.getServiceReference(PreSetValidationService.class);

	preSetValidationService = serviceReference != null ? bundleContext.getService(serviceReference) : null;
	}

	private boolean isCopyModifierPressed(MouseEvent e) {
	return (e.stateMask & SWT.MOD2) != 0;
	}

	@Override
	public void mouseMove(MouseEvent e) {
	copyDragActive = isCopyModifierPressed(e) && lastSelection != null && lastSelection.size() > 1
	&& masterObject != null;
	}

	@Override
	public void mouseDoubleClick(MouseEvent e) {
	}

	@Override
	public void mouseDown(MouseEvent e) {
	if (isCopyModifierPressed(e)) {
	final Grid grid = (Grid) e.widget;
	startDragItem = grid.getItem(new Point(e.x, e.y));
	}
	}

	@Override
	public void mouseUp(MouseEvent e) {
	if (e.button == 1) {

	final Grid grid = (Grid) e.widget;
	final GridItem currentItem = grid.getItem(new Point(e.x, e.y));
	if (isCopyModifierPressed(e) && copyDragActive && startDragItem != currentItem) {
	final List list = lastSelection.toList();
	final VDomainModelReference dmr = (VDomainModelReference) grid.getColumn(new Point(e.x, e.y))
	.getData(TableConfiguration.DMR);

	Object masterValue = null;
	EStructuralFeature structuralFeature = null;
	IObservableValue masterOV = null;
	try {
	masterOV = getEMFFormsDatabinding().getObservableValue(dmr, masterObject);
	masterValue = masterOV.getValue();
	structuralFeature = (EStructuralFeature) masterOV.getValueType();
	} catch (final DatabindingFailedException ex) {
	getReportService().report(new AbstractReport(ex));
	} finally {
	if (masterOV != null) {
	masterOV.dispose();
	}
	}
	final EditingDomain editingDomain = getEditingDomain(masterObject);
	final CompoundCommand cc = new CompoundCommand();
	final List<String> invalidValues = new ArrayList<String>();
	for (int i = 0; i < list.size(); i++) {
	final EObject eObject = (EObject) list.get(i);
	if (masterObject == eObject) {
	continue;
	}
	final Diagnostic diagnostic = validate(eObject, dmr, structuralFeature);
	final boolean valid = diagnostic.getSeverity() == Diagnostic.OK;
	if (!valid) {
	invalidValues.add(diagnostic.getChildren().get(0).getMessage());
	} else {
	final Command setCommand = SetCommand.create(editingDomain, eObject,
	structuralFeature, masterValue);
	cc.append(setCommand);
	}
	}
	editingDomain.getCommandStack().execute(cc);
	}
	copyDragActive = false;
	startDragItem = null;
	}
	}

	private Diagnostic validate(EObject eObject, VDomainModelReference dmr, EStructuralFeature structuralFeature) {
	IObservableValue value = null;
	try {
	if (preSetValidationService != null) {
	value = getEMFFormsDatabinding().getObservableValue(dmr, eObject);
	final Map<Object, Object> context = new LinkedHashMap<Object, Object>();
	context.put("rootEObject", IObserving.class.cast(value).getObserved());//$NON-NLS-1$
	final Diagnostic diag = preSetValidationService.validate(
	structuralFeature, value.getValue(), context);
	return diag;
	}
	} catch (final DatabindingFailedException ex) {
	getReportService().report(new AbstractReport(ex));
	} finally {
	if (value != null) {
	value.dispose();
	}
	}
	return Diagnostic.OK_INSTANCE;
	}

	/**
	* {@inheritDoc}
	*
	* @see org.eclipse.jface.viewers.ISelectionChangedListener#selectionChanged(org.eclipse.jface.viewers.SelectionChangedEvent)
	*/
	@Override
	public void selectionChanged(SelectionChangedEvent event) {
	// was implemented using
	// lastSelection = event.getStructuredSelection();
	// this method throws a class cast exception in case no structured selection is present,
	// so doing below null check should be fine
	final ISelection selection = event.getSelection();
	if (!IStructuredSelection.class.isInstance(selection)) {
	lastSelection = null;
	return;
	}
	lastSelection = (IStructuredSelection) event.getSelection();
	if (lastSelection.size() == 1) {
	masterObject = (EObject) lastSelection.getFirstElement();
	}
	}

	}

	/**
	* {@link TableViewerCreator} for the table control swt renderer. It will create a GridTableViewer with the expected
	* custom variant data and the correct style properties as defined in the template model.
	*
	*/
	protected class GridTableControlSWTRendererTableViewerCreator implements TableViewerCreator<GridTableViewer> {

	@Override
	public GridTableViewer createTableViewer(Composite parent) {

	final GridTableViewer tableViewer = new CustomGridTableViewer(parent,
	SWT.MULTI \| SWT.V_SCROLL \| SWT.H_SCROLL \| SWT.FULL_SELECTION \| SWT.BORDER);
	tableViewer.getGrid().setData(CUSTOM_VARIANT, TABLE_CUSTOM_VARIANT);
	tableViewer.getGrid().setHeaderVisible(true);
	tableViewer.getGrid().setLinesVisible(true);
	tableViewer.getGrid().setCellSelectionEnabled(true);
	tableViewer.getGrid().setFooterVisible(false);

	addKeyListener(tableViewer);
	if (getViewModelContext().getContextValue("enableMultiEdit") == Boolean.TRUE) {
	final CopyDragListener mdl = new CopyDragListener();
	tableViewer.addSelectionChangedListener(mdl);
	tableViewer.getGrid().addMouseMoveListener(mdl);
	tableViewer.getGrid().addMouseListener(mdl);
	}

	/* Set background color */
	final VTBackgroundStyleProperty backgroundStyleProperty = getBackgroundStyleProperty();
	if (backgroundStyleProperty.getColor() != null) {
	tableViewer.getGrid().setBackground(getSWTColor(backgroundStyleProperty.getColor()));
	}

	/* Set foreground color */
	final VTFontPropertiesStyleProperty fontPropertiesStyleProperty = getFontPropertiesStyleProperty();
	if (fontPropertiesStyleProperty.getColorHEX() != null) {
	tableViewer.getGrid()
	.setForeground(getSWTColor(fontPropertiesStyleProperty.getColorHEX()));
	}

	tableViewer.getGrid().setData(FIXED_COLUMNS, new Integer(1));

	/* manage editing support activation */
	createTableViewerEditor(tableViewer);

	return tableViewer;
	}

	/**
	* Add key listener.
	*
	* @param tableViewer the viewer to add the listeners to
	*/
	protected void addKeyListener(final GridTableViewer tableViewer) {
	tableViewer.getGrid().addKeyListener(new GridCopyKeyListener(tableViewer.getGrid().getDisplay()));
	tableViewer.getGrid()
	.addKeyListener(new GridPasteKeyListener(tableViewer.getGrid().getDisplay(), getVElement(),
	getEMFFormsDatabinding(), getConverterService(), getLocalizationService(), true));
	tableViewer.getGrid().addKeyListener(new GridClearKeyListener(getVElement(), getEMFFormsDatabinding()));
	tableViewer.getGrid().addKeyListener(
	new GridCutKeyListener(tableViewer.getGrid().getDisplay(), getVElement(), getEMFFormsDatabinding()));
	}

	/**
	* This method creates and initialises a {@link GridViewerEditor} for the given {@link GridTableViewer}.
	*
	* @param gridTableViewer the table viewer
	*/
	protected void createTableViewerEditor(final GridTableViewer gridTableViewer) {
	// TODO Grid
	// final TableViewerFocusCellManager focusCellManager = new TableViewerFocusCellManager(tableViewer,
	// new org.eclipse.emf.ecp.edit.internal.swt.controls.ECPFocusCellDrawHighlighter(tableViewer));

	// final TableViewer tableViewer = (TableViewer) getTableViewer();
	// final TableViewerFocusCellManager focusCellManager = new TableViewerFocusCellManager(
	// (TableViewer) gridTableViewer,
	// new CustomFocusCellHighlighter(gridTableViewer);

	final ColumnViewerEditorActivationStrategy actSupport = new GridColumnViewerEditorActivationStrategy(
	gridTableViewer);
	actSupport.setEnableEditorActivationWithKeyboard(true);
	GridViewerEditor.create(
	gridTableViewer,
	actSupport,
	ColumnViewerEditor.TABBING_HORIZONTAL \| ColumnViewerEditor.TABBING_MOVE_TO_ROW_NEIGHBOR
	\| ColumnViewerEditor.TABBING_VERTICAL \| ColumnViewerEditor.KEYBOARD_ACTIVATION);
	}
	}

	@Override
	protected TableViewerCreator<GridTableViewer> getTableViewerCreator() {
	return new GridTableControlSWTRendererTableViewerCreator();
	}

	@Override
	// CHECKSTYLE.OFF: ParameterNumber
	protected TableViewerSWTBuilder createTableViewerSWTBuilder(Composite parent, IObservableList list,
	IObservableValue labelText, IObservableValue labelTooltipText, TableViewerCompositeBuilder compositeBuilder,
	ObservableListContentProvider cp, ECPTableViewerComparator comparator,
	TableActionBar<? extends AbstractTableViewer> actionBar) {
	// CHECKSTYLE.ON: ParameterNumber
	return GridTableViewerFactory.fillDefaults(parent, SWT.NONE, list, labelText, labelTooltipText)
	.customizeCompositeStructure(compositeBuilder)
	.customizeActionBar(actionBar)
	.customizeTableViewerCreation(getTableViewerCreator())
	.customizeContentProvider(cp)
	.customizeComparator(comparator)
	.showHideColumns(true)
	.columnSubstringFilter(true)
	.columnRegexFilter(true);
	}

	@Override
	protected int getSelectionIndex() {
	return ((GridTableViewer) getTableViewer()).getGrid().getSelectionIndex();
	}

	@Override
	protected Item[] getColumns() {
	return ((GridTableViewer) getTableViewer()).getGrid().getColumns();
	}

	@Override
	protected ScrollBar getHorizontalBar() {
	return ((GridTableViewer) getTableViewer()).getGrid().getHorizontalBar();
	}

	@Override
	protected ScrollBar getVerticalBar() {
	return ((GridTableViewer) getTableViewer()).getGrid().getVerticalBar();
	}

	@Override
	protected int computeRequiredHeight(Integer visibleLines) {
	if (getTableViewer() == null \|\| getTableViewerComposite() == null) {
	return SWT.DEFAULT;
	}
	final TableControl table = getTableViewerComposite().getTableControl();
	if (table == null) {
	return SWT.DEFAULT;
	}
	if (table.isDisposed()) {
	return SWT.DEFAULT;
	}
	final int itemHeight = table.getItemHeight() + 1;
	// show one empty row if table does not contain any items or visibleLines < 1
	int itemCount;
	if (visibleLines != null) {
	itemCount = Math.max(visibleLines, 1);
	} else {
	itemCount = Math.max(table.getItemCount(), 1);
	}
	final int headerHeight = table.getHeaderVisible() ? table.getHeaderHeight() : 0;

	final int tableHeight = itemHeight * itemCount + headerHeight;
	return tableHeight;
	}

	/**
	*
	* @return the {@link EStructuralFeatureValueConverterService}
	*/
	protected EStructuralFeatureValueConverterService getConverterService() {
	return converterService;
	}

	/**
	*
	* @return the {@link EMFFormsLocalizationService}
	*/
	protected EMFFormsLocalizationService getLocalizationService() {
	return localizationService;
	}

	/**
	* EditorActivationStrategy for GridColumns.
	*
	* @author Stefan Dirix
	*/
	private class GridColumnViewerEditorActivationStrategy extends ColumnViewerEditorActivationStrategy {

	private final GridTableViewer gridTableViewer;

	/**
	* Constructor.
	*
	* @param viewer the {@link GridTableViewer}.
	*/
	GridColumnViewerEditorActivationStrategy(GridTableViewer gridTableViewer) {
	super(gridTableViewer);
	this.gridTableViewer = gridTableViewer;
	}

	@Override
	protected boolean isEditorActivationEvent(ColumnViewerEditorActivationEvent event) {
	if (event.eventType == ColumnViewerEditorActivationEvent.TRAVERSAL
	\|\| event.eventType == ColumnViewerEditorActivationEvent.MOUSE_DOUBLE_CLICK_SELECTION
	\|\| event.eventType == ColumnViewerEditorActivationEvent.PROGRAMMATIC) {
	return true;
	}
	if (event.eventType == ColumnViewerEditorActivationEvent.MOUSE_CLICK_SELECTION
	&& gridTableViewer.isCellEditorActive()) {
	gridTableViewer.applyEditorValue();
	}
	if (event.eventType == ColumnViewerEditorActivationEvent.KEY_PRESSED) {
	for (final int keyCode : Arrays.asList(SWT.CTRL, SWT.ALT)) {
	if ((event.keyCode & keyCode) != 0 \|\| (event.stateMask & keyCode) != 0) {
	return false;
	}
	}
	if ((event.keyCode & SWT.SHIFT) != 0) {
	return false;
	}
	return !isDoNotEnterEditorCode(event.keyCode);
	}
	return false;
	}

	private boolean isDoNotEnterEditorCode(int keyCode) {
	// BEGIN COMPLEX CODE
	return keyCode == SWT.ARROW_UP \|\| keyCode == SWT.ARROW_DOWN
	\|\| keyCode == SWT.ARROW_LEFT \|\| keyCode == SWT.ARROW_RIGHT
	\|\| keyCode == SWT.TAB \|\| keyCode == SWT.DEL;
	// END COMPLEX CODE
	}
	}

	}