Reinsert flash in highlighting classes (#1781)

* reinsert flashing support in Highlighting Class

* removed unnecessary constructor

plugins/org.yakindu.base.gmf.runtime/src/org/yakindu/base/gmf/runtime/highlighting/HighlightingParameters.java

@@ -28,6 +28,10 @@ public class HighlightingParameters {
 
 	public Color backgroundFadingColor = new Color(null, 245, 216, 44);
 
+	public int highlightTime = 150;
+
+	public int flashcounter = 0;
+
 	public HighlightingParameters() {
 	}
 
@@ -36,4 +40,12 @@ public class HighlightingParameters {
 		this.backgroundFadingColor = backgroundFadingColor;
 	}
 
+	public HighlightingParameters(Color foregroundFadingColor, Color backgroundFadingColor, int highlightTime,
+			int flashcounter) {
+		this.foregroundFadingColor = foregroundFadingColor;
+		this.backgroundFadingColor = backgroundFadingColor;
+		this.highlightTime = highlightTime;
+		this.flashcounter = flashcounter;
+	}
+
 }

plugins/org.yakindu.base.gmf.runtime/src/org/yakindu/base/gmf/runtime/highlighting/HighlightingSupportAdapter.java

@@ -1,198 +1,284 @@
-/**
- * Copyright (c) 2011 committers of YAKINDU and others.
- * All rights reserved. This program and the accompanying materials
- * are made available under the terms of the Eclipse Public License v1.0
- * which accompanies this distribution, and is available at
- * http://www.eclipse.org/legal/epl-v10.html
- * Contributors:
- * 	committers of YAKINDU - initial API and implementation
- * 
- */
-package org.yakindu.base.gmf.runtime.highlighting;
-
-import java.lang.reflect.Method;
-import java.util.ArrayList;
-import java.util.HashMap;
-import java.util.List;
-import java.util.Map;
-
-import org.eclipse.draw2d.IFigure;
-import org.eclipse.emf.ecore.EObject;
-import org.eclipse.gmf.runtime.diagram.ui.editparts.IGraphicalEditPart;
-import org.eclipse.gmf.runtime.diagram.ui.editparts.IPrimaryEditPart;
-import org.eclipse.gmf.runtime.diagram.ui.figures.BorderedNodeFigure;
-import org.eclipse.gmf.runtime.diagram.ui.parts.IDiagramWorkbenchPart;
-import org.eclipse.gmf.runtime.diagram.ui.resources.editor.parts.DiagramDocumentEditor;
-import org.eclipse.gmf.runtime.gef.ui.figures.DefaultSizeNodeFigure;
-import org.eclipse.swt.graphics.Color;
-import org.eclipse.swt.widgets.Display;
-import org.yakindu.base.gmf.runtime.util.EditPartUtils;
-
-/**
- * 
- * @author Alexander Nyssen
- * @author Andreas Muelder
- * @author Axel Terfloth
- * 
- */
-public class HighlightingSupportAdapter implements IHighlightingSupport {
-
-	private class ColorMemento {
-		private final Color foregroundColor;
-		private final Color backgroundColor;
-		private final IFigure figure;
-
-		protected ColorMemento(IFigure figure) {
-			this.figure = figure;
-			this.foregroundColor = figure.getForegroundColor();
-			this.backgroundColor = figure.getBackgroundColor();
-		}
-
-		protected void restore() {
-			figure.setForegroundColor(foregroundColor);
-			figure.setBackgroundColor(backgroundColor);
-		}
-	}
-
-	private final Map<IFigure, ColorMemento> figureStates = new HashMap<IFigure, ColorMemento>();
-	private boolean locked = false;
-	private final IDiagramWorkbenchPart diagramWorkbenchPart;
-	private Map<EObject, IGraphicalEditPart> object2editPart = new HashMap<EObject, IGraphicalEditPart>();
-
-	public HighlightingSupportAdapter(IDiagramWorkbenchPart diagramWorkbenchPart) {
-		this.diagramWorkbenchPart = diagramWorkbenchPart;
-	}
-
-	private IGraphicalEditPart getEditPartForSemanticElement(EObject semanticElement) {
-		IGraphicalEditPart result = object2editPart.get(semanticElement);
-		if (result != null)
-			return result;
-		result = EditPartUtils.findEditPartForSemanticElement(
-				diagramWorkbenchPart.getDiagramGraphicalViewer().getRootEditPart(), semanticElement);
-		object2editPart.put(semanticElement, result);
-		return result;
-	}
-
-	private IFigure getTargetFigure(IGraphicalEditPart editPart) {
-		IFigure figure = editPart.getFigure();
-		if (figure instanceof BorderedNodeFigure) {
-			figure = (IFigure) figure.getChildren().get(0);
-		}
-		if (figure instanceof DefaultSizeNodeFigure) {
-			figure = (IFigure) figure.getChildren().get(0);
-		}
-		return figure;
-	}
-
-	public synchronized void lockEditor() {
-		if (locked) {
-			throw new IllegalStateException("Editor already locked!");
-		}
-		List<Action> singletonList = new ArrayList<>();
-		singletonList.add(new Action() {
-			@Override
-			public void execute(IHighlightingSupport hs) {
-				lockEditorInternal();
-			}
-		});
-		executeSync(singletonList);
-	}
-
-	private void lockEditorInternal() {
-		setSanityCheckEnablementState(false);
-		for (Object editPart : diagramWorkbenchPart.getDiagramGraphicalViewer().getEditPartRegistry().values()) {
-			if (editPart instanceof IPrimaryEditPart) {
-				IGraphicalEditPart graphicalEditPart = (IGraphicalEditPart) editPart;
-				IFigure figure = getTargetFigure(graphicalEditPart);
-				figureStates.put(figure, new ColorMemento(figure));
-			}
-		}
-		locked = true;
-	}
-
-	private void setSanityCheckEnablementState(boolean state) {
-		try {
-			Method enableMethod = DiagramDocumentEditor.class.getDeclaredMethod("enableSanityChecking",
-					new Class[] { boolean.class });
-			enableMethod.setAccessible(true);
-			enableMethod.invoke(diagramWorkbenchPart, new Object[] { state });
-		} catch (Exception e) {
-			e.printStackTrace();
-		}
-	}
-
-	public synchronized void releaseEditor() {
-		if (!locked) {
-			throw new IllegalStateException("Editor not locked!");
-		}
-		List<Action> singletonList = new ArrayList<>();
-		singletonList.add(new Action() {
-			@Override
-			public void execute(IHighlightingSupport hs) {
-				releaseInternal();
-			}
-		});
-		executeSync(singletonList);
-	}
-
-	protected void releaseInternal() {
-		// restore all elements still being highlighted
-		for (ColorMemento figureState : figureStates.values()) {
-			figureState.restore();
-		}
-		figureStates.clear();
-		diagramWorkbenchPart.getDiagramEditPart().enableEditMode();
-		setSanityCheckEnablementState(true);
-		object2editPart.clear();
-		locked = false;
-	}
-
-	public void highlight(List<? extends EObject> semanticElements, HighlightingParameters parameters) {
-		synchronized (semanticElements) {
-			for (EObject semanticElement : semanticElements) {
-				IGraphicalEditPart editPartForSemanticElement = getEditPartForSemanticElement(semanticElement);
-				if (editPartForSemanticElement != null) {
-					IFigure figure = getTargetFigure(editPartForSemanticElement);
-					if (parameters != null) {
-						figure.setForegroundColor(parameters.foregroundFadingColor);
-						figure.setBackgroundColor(parameters.backgroundFadingColor);
-						figure.invalidate();
-					} else {
-						ColorMemento memento = figureStates.get(figure);
-						if (memento != null)
-							memento.restore();
-					}
-				}
-			}
-		}
-	}
-
-	public boolean isLocked() {
-		return locked;
-	}
-
-	public void executeAsync(final List<Action> actions) {
-		if (actions != null) {
-
-			Display.getDefault().asyncExec(new Runnable() {
-				public void run() {
-					for (Action a : actions) {
-						a.execute(HighlightingSupportAdapter.this);
-					}
-				}
-			});
-		}
-	}
-	protected void executeSync(final List<Action> actions) {
-		if (actions != null) {
-
-			Display.getDefault().syncExec(new Runnable() {
-				public void run() {
-					for (Action a : actions) {
-						a.execute(HighlightingSupportAdapter.this);
-					}
-				}
-			});
-		}
-	}
+/**
+ * Copyright (c) 2011 committers of YAKINDU and others.
+ * All rights reserved. This program and the accompanying materials
+ * are made available under the terms of the Eclipse Public License v1.0
+ * which accompanies this distribution, and is available at
+ * http://www.eclipse.org/legal/epl-v10.html
+ * Contributors:
+ * 	committers of YAKINDU - initial API and implementation
+ * 
+ */
+package org.yakindu.base.gmf.runtime.highlighting;
+
+import java.lang.reflect.Method;
+import java.util.ArrayList;
+import java.util.HashMap;
+import java.util.HashSet;
+import java.util.List;
+import java.util.Map;
+import java.util.Set;
+
+import org.eclipse.draw2d.IFigure;
+import org.eclipse.emf.ecore.EObject;
+import org.eclipse.gmf.runtime.diagram.ui.editparts.IGraphicalEditPart;
+import org.eclipse.gmf.runtime.diagram.ui.editparts.IPrimaryEditPart;
+import org.eclipse.gmf.runtime.diagram.ui.figures.BorderedNodeFigure;
+import org.eclipse.gmf.runtime.diagram.ui.parts.IDiagramWorkbenchPart;
+import org.eclipse.gmf.runtime.diagram.ui.resources.editor.parts.DiagramDocumentEditor;
+import org.eclipse.gmf.runtime.gef.ui.figures.DefaultSizeNodeFigure;
+import org.eclipse.swt.graphics.Color;
+import org.eclipse.swt.widgets.Display;
+import org.yakindu.base.gmf.runtime.util.EditPartUtils;
+
+/**
+ * 
+ * @author Alexander Nyssen
+ * @author Andreas Muelder
+ * @author Axel Terfloth
+ * 
+ */
+public class HighlightingSupportAdapter implements IHighlightingSupport {
+
+	private class ColorMemento {
+		private final Color foregroundColor;
+		private final Color backgroundColor;
+		private final IFigure figure;
+
+		protected ColorMemento(IFigure figure) {
+			this.figure = figure;
+			this.foregroundColor = figure.getForegroundColor();
+			this.backgroundColor = figure.getBackgroundColor();
+		}
+
+		protected void restore() {
+			figure.setForegroundColor(foregroundColor);
+			figure.setBackgroundColor(backgroundColor);
+		}
+	}
+
+	private class Fader implements Runnable {
+
+		private final int fadingTime;
+		private final Color sourceForegroundColor;
+		private final Color targetForegroundColor;
+		private final IFigure figure;
+		private final boolean shouldFadeBack;
+		private final boolean shouldRegister;
+		private final Color sourceBackgroundColor;
+		private final Color targetBackgroundColor;
+		private final int flashCounter;
+		private Fader(IFigure figure, Color sourceForegroundColor, Color targetForegroundColor,
+				Color sourceBackgroundColor, Color targetBackgroundColor, int fadingTime, boolean shouldFadeBack,
+				int flashCounter, boolean shouldRegister) {
+			this.figure = figure;
+			this.sourceForegroundColor = sourceForegroundColor;
+			this.targetForegroundColor = targetForegroundColor;
+			this.sourceBackgroundColor = sourceBackgroundColor;
+			this.targetBackgroundColor = targetBackgroundColor;
+			this.shouldFadeBack = shouldFadeBack;
+			this.fadingTime = fadingTime;
+			this.flashCounter = flashCounter;
+			this.shouldRegister = shouldRegister;
+
+		}
+
+		public void run() {
+
+			if (shouldRegister) {
+				if (flashingFigures.contains(figure))
+					// if we were started as "back-fader" via timer and editor
+					// was released in the meantime, don't perform fading back
+					return;
+				else
+					flashingFigures.add(figure);
+			}
+			if (flashingFigures.contains(figure)) {
+
+				figure.setForegroundColor(targetForegroundColor);
+				figure.setBackgroundColor(targetBackgroundColor);
+				figure.invalidate();
+				if (shouldFadeBack) {
+					if (figure.getForegroundColor() == sourceForegroundColor
+							&& figure.getBackgroundColor() == sourceBackgroundColor) {
+						Fader fader = new Fader(figure, targetForegroundColor, sourceForegroundColor,
+								targetBackgroundColor, sourceBackgroundColor, fadingTime, false, flashCounter - 1,
+								false);
+						Display.getCurrent().timerExec(fadingTime, fader);
+					} else { // color changed between events
+						Fader fader = new Fader(figure, figure.getForegroundColor(), sourceForegroundColor,
+								figure.getBackgroundColor(), sourceBackgroundColor, fadingTime, false, flashCounter - 1,
+								false);
+						Display.getCurrent().timerExec(fadingTime, fader);
+					}
+				} else if (flashCounter > 0) {
+					Display.getCurrent().timerExec(fadingTime,
+							new Fader(figure, targetForegroundColor, sourceForegroundColor, targetBackgroundColor,
+									sourceBackgroundColor, fadingTime, true, flashCounter, false));
+				} else {
+					flashingFigures.remove(figure);
+				}
+
+			}
+		}
+	}
+
+	private final Map<IFigure, ColorMemento> figureStates = new HashMap<IFigure, ColorMemento>();
+	private boolean locked = false;
+	private Set<IFigure> flashingFigures = new HashSet<IFigure>();
+	private final IDiagramWorkbenchPart diagramWorkbenchPart;
+	private Map<EObject, IGraphicalEditPart> object2editPart = new HashMap<EObject, IGraphicalEditPart>();
+
+	public HighlightingSupportAdapter(IDiagramWorkbenchPart diagramWorkbenchPart) {
+		this.diagramWorkbenchPart = diagramWorkbenchPart;
+	}
+
+	private IGraphicalEditPart getEditPartForSemanticElement(EObject semanticElement) {
+		IGraphicalEditPart result = object2editPart.get(semanticElement);
+		if (result != null)
+			return result;
+		result = EditPartUtils.findEditPartForSemanticElement(
+				diagramWorkbenchPart.getDiagramGraphicalViewer().getRootEditPart(), semanticElement);
+		object2editPart.put(semanticElement, result);
+		return result;
+	}
+
+	private IFigure getTargetFigure(IGraphicalEditPart editPart) {
+		IFigure figure = editPart.getFigure();
+		if (figure instanceof BorderedNodeFigure) {
+			figure = (IFigure) figure.getChildren().get(0);
+		}
+		if (figure instanceof DefaultSizeNodeFigure) {
+			figure = (IFigure) figure.getChildren().get(0);
+		}
+		return figure;
+	}
+
+	public synchronized void lockEditor() {
+		if (locked) {
+			throw new IllegalStateException("Editor already locked!");
+		}
+		List<Action> singletonList = new ArrayList<>();
+		singletonList.add(new Action() {
+			@Override
+			public void execute(IHighlightingSupport hs) {
+				lockEditorInternal();
+			}
+		});
+		executeSync(singletonList);
+	}
+
+	private void lockEditorInternal() {
+		setSanityCheckEnablementState(false);
+		for (Object editPart : diagramWorkbenchPart.getDiagramGraphicalViewer().getEditPartRegistry().values()) {
+			if (editPart instanceof IPrimaryEditPart) {
+				IGraphicalEditPart graphicalEditPart = (IGraphicalEditPart) editPart;
+				IFigure figure = getTargetFigure(graphicalEditPart);
+				figureStates.put(figure, new ColorMemento(figure));
+			}
+		}
+		locked = true;
+	}
+
+	private void setSanityCheckEnablementState(boolean state) {
+		try {
+			Method enableMethod = DiagramDocumentEditor.class.getDeclaredMethod("enableSanityChecking",
+					new Class[] { boolean.class });
+			enableMethod.setAccessible(true);
+			enableMethod.invoke(diagramWorkbenchPart, new Object[] { state });
+		} catch (Exception e) {
+			e.printStackTrace();
+		}
+	}
+
+	public synchronized void releaseEditor() {
+		if (!locked) {
+			throw new IllegalStateException("Editor not locked!");
+		}
+		List<Action> singletonList = new ArrayList<>();
+		singletonList.add(new Action() {
+			@Override
+			public void execute(IHighlightingSupport hs) {
+				releaseInternal();
+			}
+		});
+		executeSync(singletonList);
+	}
+
+	protected void releaseInternal() {
+		// restore all elements still being highlighted
+		for (ColorMemento figureState : figureStates.values()) {
+			figureState.restore();
+		}
+		flashingFigures.clear();
+		figureStates.clear();
+		diagramWorkbenchPart.getDiagramEditPart().enableEditMode();
+		setSanityCheckEnablementState(true);
+		object2editPart.clear();
+		locked = false;
+	}
+
+	public void highlight(List<? extends EObject> semanticElements, HighlightingParameters parameters) {
+		synchronized (semanticElements) {
+			for (EObject semanticElement : semanticElements) {
+				IGraphicalEditPart editPartForSemanticElement = getEditPartForSemanticElement(semanticElement);
+				if (editPartForSemanticElement != null) {
+					IFigure figure = getTargetFigure(editPartForSemanticElement);
+					if (parameters != null) {
+						figure.setForegroundColor(parameters.foregroundFadingColor);
+						figure.setBackgroundColor(parameters.backgroundFadingColor);
+						figure.invalidate();
+					} else {
+						flashingFigures.clear();
+						ColorMemento memento = figureStates.get(figure);
+						if (memento != null)
+							memento.restore();
+					}
+				}
+			}
+		}
+	}
+
+	public void flash(List<? extends EObject> semanticElements, HighlightingParameters parameters) {
+		synchronized (semanticElements) {
+			for (EObject semanticElement : semanticElements) {
+				IGraphicalEditPart editPartForSemanticElement = getEditPartForSemanticElement(semanticElement);
+				if (editPartForSemanticElement != null) {
+					IFigure figure = getTargetFigure(editPartForSemanticElement);
+					Fader fader = new Fader(figure, figure.getForegroundColor(), parameters.foregroundFadingColor,
+							figure.getBackgroundColor(), parameters.backgroundFadingColor, parameters.highlightTime,
+							true, parameters.flashcounter, true);
+					Display.getCurrent().asyncExec(fader);
+				}
+			}
+		}
+	}
+
+	public boolean isLocked() {
+		return locked;
+	}
+
+	public void executeAsync(final List<Action> actions) {
+		if (actions != null) {
+
+			Display.getDefault().asyncExec(new Runnable() {
+				public void run() {
+					for (Action a : actions) {
+						a.execute(HighlightingSupportAdapter.this);
+					}
+				}
+			});
+		}
+	}
+	protected void executeSync(final List<Action> actions) {
+		if (actions != null) {
+
+			Display.getDefault().syncExec(new Runnable() {
+				public void run() {
+					for (Action a : actions) {
+						a.execute(HighlightingSupportAdapter.this);
+					}
+				}
+			});
+		}
+	}
 }

plugins/org.yakindu.base.gmf.runtime/src/org/yakindu/base/gmf/runtime/highlighting/IHighlightingSupport.java

@@ -1,85 +1,107 @@
-/**
- * Copyright (c) 2011 committers of YAKINDU and others.
- * All rights reserved. This program and the accompanying materials
- * are made available under the terms of the Eclipse Public License v1.0
- * which accompanies this distribution, and is available at
- * http://www.eclipse.org/legal/epl-v10.html
- * Contributors:
- * 	committers of YAKINDU - initial API and implementation
- * 
- */
-package org.yakindu.base.gmf.runtime.highlighting;
-
-import java.util.Collections;
-import java.util.List;
-
-import org.eclipse.emf.ecore.EObject;
-
-/**
- * @author Alexander Nyssen
- * @author Andreas Muelder
- * 
- */
-public interface IHighlightingSupport {
-
-	void lockEditor();
-
-	boolean isLocked();
-
-	void releaseEditor();
-
-	void highlight(List<? extends EObject> semanticElement, HighlightingParameters parameters);
-
-	void executeAsync(List<Action> actions);
-
-	public static interface Action {
-		public void execute(IHighlightingSupport hs);
-	}
-
-	public static class Highlight implements Action {
-
-		protected List<? extends EObject> semanticElements;
-		protected HighlightingParameters highligtingParams;
-
-		public Highlight(EObject semanticElement, HighlightingParameters parameters) {
-			this(Collections.singletonList(semanticElement), parameters);
-		}
-
-		public Highlight(List<? extends EObject> semanticElements, HighlightingParameters parameters) {
-			this.semanticElements = semanticElements;
-			this.highligtingParams = parameters;
-		}
-
-		public void execute(IHighlightingSupport hs) {
-			hs.highlight(semanticElements, highligtingParams);
-		}
-	}
-
-	public static class HighlightingSupportNullImpl implements IHighlightingSupport {
-
-		@Override
-		public void lockEditor() {
-
-		}
-
-		@Override
-		public boolean isLocked() {
-			return false;
-		}
-
-		@Override
-		public void releaseEditor() {
-
-		}
-
-		@Override
-		public void executeAsync(List<Action> actions) {
-		}
-
-		@Override
-		public void highlight(List<? extends EObject> semanticElement, HighlightingParameters parameters) {
-
-		}
-
-	}
-}
+/**
+ * Copyright (c) 2011 committers of YAKINDU and others.
+ * All rights reserved. This program and the accompanying materials
+ * are made available under the terms of the Eclipse Public License v1.0
+ * which accompanies this distribution, and is available at
+ * http://www.eclipse.org/legal/epl-v10.html
+ * Contributors:
+ * 	committers of YAKINDU - initial API and implementation
+ * 
+ */
+package org.yakindu.base.gmf.runtime.highlighting;
+
+import java.util.Collections;
+import java.util.List;
+
+import org.eclipse.emf.ecore.EObject;
+
+/**
+ * @author Alexander Nyssen
+ * @author Andreas Muelder
+ * 
+ */
+public interface IHighlightingSupport {
+
+	void lockEditor();
+
+	boolean isLocked();
+
+	void releaseEditor();
+
+	void highlight(List<? extends EObject> semanticElement, HighlightingParameters parameters);
+
+	void flash(List<? extends EObject> semanticElemesnt, HighlightingParameters parameters);
+
+	void executeAsync(List<Action> actions);
+
+	public static interface Action {
+		public void execute(IHighlightingSupport hs);
+	}
+
+	public static class Highlight implements Action {
+
+		protected List<? extends EObject> semanticElements;
+		protected HighlightingParameters highligtingParams;
+
+		public Highlight(EObject semanticElement, HighlightingParameters parameters) {
+			this(Collections.singletonList(semanticElement), parameters);
+		}
+
+		public Highlight(List<? extends EObject> semanticElements, HighlightingParameters parameters) {
+			this.semanticElements = semanticElements;
+			this.highligtingParams = parameters;
+		}
+
+		public void execute(IHighlightingSupport hs) {
+			hs.highlight(semanticElements, highligtingParams);
+		}
+	}
+
+	public static class Flash implements Action {
+
+		protected List<? extends EObject> semanticElements;
+		protected HighlightingParameters highligtingParams;
+
+		public Flash(EObject semanticElement, HighlightingParameters parameters) {
+			this(Collections.singletonList(semanticElement), parameters);
+		}
+
+		public Flash(List<? extends EObject> semanticElements, HighlightingParameters parameters) {
+			this.semanticElements = semanticElements;
+			this.highligtingParams = parameters;
+		}
+
+		public void execute(IHighlightingSupport hs) {
+			hs.flash(semanticElements, highligtingParams);
+		}
+
+	}
+
+	public static class HighlightingSupportNullImpl implements IHighlightingSupport {
+
+		@Override
+		public void lockEditor() {
+		}
+
+		@Override
+		public boolean isLocked() {
+			return false;
+		}
+
+		@Override
+		public void releaseEditor() {
+		}
+
+		@Override
+		public void executeAsync(List<Action> actions) {
+		}
+
+		@Override
+		public void highlight(List<? extends EObject> semanticElement, HighlightingParameters parameters) {
+		}
+
+		@Override
+		public void flash(List<? extends EObject> semanticElemesnt, HighlightingParameters parameters) {
+		}
+	}
+}