Merge lp:~tapaal-contributor/tapaal/cancel-arc-draw-fix-1718892 into lp:tapaal

[Mads Johannsen]

The ArcKeyboardEventHandler did not handle the cancellation of drawn arcs consistently, probably due to the loss of focus in the GUI.
This proposal implements the same functionality by using the JComponent inputmap and actionmap.

The unused variable "metaDown" from DrawingSurfaceImpl.java has been removed.

[Jiri Srba (srba)]

Tested and works as expected. Great work!

review: Approve

=== modified file 'src/pipe/gui/DrawingSurfaceImpl.java'
--- src/pipe/gui/DrawingSurfaceImpl.java	2017-07-02 18:03:21 +0000
+++ src/pipe/gui/DrawingSurfaceImpl.java	2017-09-30 14:13:41 +0000
@@ -53,11 +53,6 @@
 
 	private AnimationHandler animationHandler = new AnimationHandler();
 
-	// When i'm using GNU/Linux, isMetaDown() doesn't return true when I press
-	// "Windows key". I don't know if a problem of my configuration or what.
-	// metaDown is used in this case
-	boolean metaDown = false;
-
 	private SelectionManager selection;
 	private UndoManager undoManager;
 	private ArrayList<PetriNetObject> petriNetObjects = new ArrayList<PetriNetObject>();
@@ -384,11 +379,6 @@
 		super.removeAll();
 	}
 
-	//
-	public void setMetaDown(boolean down) {
-		metaDown = down;
-	}
-
 	public Point getPointer() {
 		return getMousePosition();
 	}

=== modified file 'src/pipe/gui/graphicElements/Arc.java'
--- src/pipe/gui/graphicElements/Arc.java	2015-11-23 17:12:41 +0000
+++ src/pipe/gui/graphicElements/Arc.java	2017-09-30 14:13:41 +0000
@@ -1,9 +1,10 @@
 package pipe.gui.graphicElements;
 
 import java.awt.Rectangle;
+import java.awt.event.ActionEvent;
 import java.awt.geom.Point2D;
 
-import javax.swing.JLayeredPane;
+import javax.swing.*;
 
 import pipe.gui.CreateGui;
 import pipe.gui.DrawingSurfaceImpl;
@@ -339,4 +340,48 @@
 		return super.clone();
 	}
 
+	/**
+	 * Handles keyboard input when drawing arcs in the GUI. Keys are bound to action names,
+	 * and action names are mapped to action objects. The key bindings are disabled when the
+	 * arc object is deleted, or the arc is connected to a place/transition.
+	 */
+	public void enableDrawingKeyBindings() {
+		InputMap iMap = this.getInputMap(JComponent.WHEN_IN_FOCUSED_WINDOW);
+		ActionMap aMap = this.getActionMap();
+
+		// Bind keyboard keys to action names.
+		iMap.put(KeyStroke.getKeyStroke("ESCAPE"), "deleteArc");
+		iMap.put(KeyStroke.getKeyStroke("DELETE"), "deleteArc");
+
+		// Associate action names with actions.
+		aMap.put("deleteArc", new DeleteAction(this));
+	}
+
+	public void disableDrawingKeyBindings() {
+		this.getInputMap().clear();
+		this.getActionMap().clear();
+	}
+
+	private class DeleteAction extends AbstractAction {
+		Arc arcBeingDraw;
+
+		DeleteAction(Arc arc) {
+			arcBeingDraw = arc;
+		}
+
+		@Override
+		public void actionPerformed(ActionEvent e) {
+			DrawingSurfaceImpl aView = CreateGui.getView();
+			if (aView.createArc == arcBeingDraw) {
+				aView.createArc = null;
+				delete();
+
+				if ((CreateGui.getApp().getMode() == Pipe.ElementType.FAST_PLACE)
+						|| (CreateGui.getApp().getMode() == Pipe.ElementType.FAST_TRANSITION)) {
+					CreateGui.getApp().endFastMode();
+				}
+				aView.repaint();
+			}
+		}
+	}
 }

=== removed file 'src/pipe/gui/handler/ArcKeyboardEventHandler.java'
--- src/pipe/gui/handler/ArcKeyboardEventHandler.java	2017-05-20 20:13:25 +0000
+++ src/pipe/gui/handler/ArcKeyboardEventHandler.java	1970-01-01 00:00:00 +0000
@@ -1,71 +0,0 @@
-package pipe.gui.handler;
-
-import java.awt.event.KeyAdapter;
-import java.awt.event.KeyEvent;
-
-import pipe.gui.CreateGui;
-import pipe.gui.DrawingSurfaceImpl;
-import pipe.gui.Pipe.ElementType;
-import pipe.gui.graphicElements.Arc;
-
-/**
- * @authors Michael Camacho and Tom Barnwell
- * 
- */
-public class ArcKeyboardEventHandler extends KeyAdapter {
-
-	private Arc arcBeingDrawn;
-
-	public ArcKeyboardEventHandler(Arc anArc) {
-		arcBeingDrawn = anArc;
-	}
-
-	@Override
-	public void keyPressed(KeyEvent e) {
-		switch (e.getKeyCode()) {
-		case KeyEvent.VK_META:
-		case KeyEvent.VK_WINDOWS:
-			// I don't know if it's a java's bug or if I have a configuration
-			// problem with my linux box, but there is an issue with the
-			// Windows key under linux, so the space key is used as a
-			// provisional
-			// solution
-		case KeyEvent.VK_SPACE: // provisional
-			((DrawingSurfaceImpl) arcBeingDrawn.getParent()).setMetaDown(true);
-			break;
-
-		case KeyEvent.VK_ESCAPE:
-		case KeyEvent.VK_DELETE:
-			DrawingSurfaceImpl aView = ((DrawingSurfaceImpl) arcBeingDrawn
-					.getParent());
-			aView.createArc = null;
-			arcBeingDrawn.delete();
-
-			if ((CreateGui.getApp().getMode() == ElementType.FAST_PLACE)
-					|| (CreateGui.getApp().getMode() == ElementType.FAST_TRANSITION)) {
-				CreateGui.getApp().endFastMode();
-			}
-			aView.repaint();
-			break;
-
-		default:
-			break;
-		}
-	}
-
-	@Override
-	public void keyReleased(KeyEvent e) {
-		switch (e.getKeyCode()) {
-		case KeyEvent.VK_META:
-		case KeyEvent.VK_WINDOWS:
-		case KeyEvent.VK_SPACE: // provisional
-			((DrawingSurfaceImpl) arcBeingDrawn.getParent()).setMetaDown(false);
-			break;
-
-		default:
-			break;
-		}
-		e.consume();
-	}
-
-}

=== modified file 'src/pipe/gui/handler/PlaceTransitionObjectHandler.java'
--- src/pipe/gui/handler/PlaceTransitionObjectHandler.java	2011-11-28 15:14:40 +0000
+++ src/pipe/gui/handler/PlaceTransitionObjectHandler.java	2017-09-30 14:13:41 +0000
@@ -46,7 +46,6 @@
 	private static final String ERROR_MSG_TWO_ARCS = "We do not allow two arcs from a place to a transition or a transition to a place.";
 	private DataLayer guiModel;
 	private TimedArcPetriNet model;
-	ArcKeyboardEventHandler keyHandler = null;
 
 	public PlaceTransitionObjectHandler(Container contentpane,
 			PlaceTransitionObject obj, DataLayer guiModel,
@@ -70,15 +69,14 @@
 		CreateGui.getView().createArc = newArc;
 		// addPetriNetObject a handler for shift & esc actions drawing arc
 		// this is removed when the arc is finished drawing:
-		keyHandler = new ArcKeyboardEventHandler(newArc);
-		newArc.addKeyListener(keyHandler);
 		newArc.requestFocusInWindow();
 		newArc.setSelectable(false);
+		newArc.enableDrawingKeyBindings();
 	}
-	// Call this function to cleanup temporary key handlers for an new arc object
+
+	// Disable key bindings that are only available when drawing arcs.
 	private void freeArc(Arc newArc){
-		newArc.removeKeyListener(keyHandler);
-		keyHandler = null;
+		newArc.disableDrawingKeyBindings();
 		CreateGui.getView().createArc = null;
 	}
 
@@ -194,10 +192,7 @@
 					undoManager.addNewEdit(new AddTimedInhibitorArcCommand(
 							createTAPNInhibitorArc, model, guiModel, view));
 
-					// arc is drawn, remove handler:
 					freeArc(createTAPNInhibitorArc);
-					
-					
 				}
 
 			break;
@@ -296,7 +291,6 @@
 						guiModel.addArc((TimedOutputArcComponent) transportArcToCreate);
 						view.addNewPetriNetObject(transportArcToCreate);
 
-						// arc is drawn, remove handlers:
 						freeArc(transportArcToCreate);
 						
 						// Create the next arc
@@ -361,12 +355,9 @@
 										guiModel, 
 										view));
 
-						// arc is drawn, remove handlers:
 						freeArc(transportArcToCreate);
 
 						arc2.setGroupNr(arc1.getGroupNr());
-
-						
 					}
 
 				}
@@ -470,8 +461,7 @@
 								model, guiModel, view));
 
 					}
-					// arc is drawn, remove handler:
-					// arc is drawn, remove handlers:
+
 					freeArc(timedArcToCreate);
 				}
 			break;
@@ -488,7 +478,6 @@
 
 	private void cleanupArc(Arc arc, DrawingSurfaceImpl view) {
 		arc.delete();
-		// arc is drawn, remove handlers:
 		freeArc(arc);
 		
 		view.remove(arc);