Merge pull request #16 from doubleSlashde/feature/fixHotkey

added functionality to reset pressed keys after 1 second. this fixes …

Author: Death111

src/main/java/de/doubleslash/keeptime/Main.java

@@ -47,6 +47,10 @@ public class Main extends Application {
    private Model model;
    private Controller controller;
 
+   private ViewController viewController;
+
+   private GlobalScreenListener globalScreenListener;
+
    @Override
    public void init() throws Exception {
       LOG.info("Starting KeepTime {}", VERSION);
@@ -64,7 +68,6 @@ public void start(final Stage primaryStage) throws Exception {
 
       LOG.debug("Reading configuration");
 
-      // TODO there should just be one instance of settings in the repo
       final List<Settings> settingsList = model.settingsRepository.findAll();
       final Settings settings;
       if (settingsList.isEmpty()) {
@@ -118,17 +121,8 @@ public void start(final Stage primaryStage) throws Exception {
       }
 
       primaryStage.setOnHiding((we) -> {
-         // shutdown();
          popupViewStage.close();
-         globalScreenListener.register(false); // deregister, as this will keep app running
-      });
-
-      Runtime.getRuntime().addShutdownHook(new Thread() {
-         @Override
-         public void run() {
-            // TODO this does not work - spring uses own hooks and may already be shutdown
-            // shutdown();
-         }
+         globalScreenListener.shutdown(); // deregister, as this will keep app running
       });
 
       try {
@@ -144,8 +138,6 @@ public void run() {
       }
    }
 
-   GlobalScreenListener globalScreenListener;
-
    private void initialisePopupUI(final Stage primaryStage) throws IOException {
       // TODO register only if it is enabled
       globalScreenListener = new GlobalScreenListener();
@@ -174,18 +166,8 @@ private void initialisePopupUI(final Stage primaryStage) throws IOException {
       viewControllerPopupController.setStage(popupViewStage, popupScene);
       viewControllerPopupController.setController(controller, model);
       globalScreenListener.setViewController(viewControllerPopupController);
-
    }
 
-   private void shutdown() {
-      LOG.info("Shutting down");
-      // viewController.changeProject(model.idleProject, 0); // TODO not so nice (view has the comments for the current
-      // // job)
-      controller.shutdown();
-   }
-
-   ViewController viewController;
-
    private void initialiseUI(final Stage primaryStage) {
       try {
          Pane mainPane;
@@ -210,17 +192,12 @@ private void initialiseUI(final Stage primaryStage) {
             @Override
             public void handle(final WindowEvent event) {
                LOG.info("On close request");
-               // shutdown();
-               // Platform.exit();
             }
          });
 
          viewController = loader.getController();
          // Give the controller access to the main app.
          viewController.setStage(primaryStage);
-
-         // controller = springContext.getBean(Controller.class, model, new RealDateProvider());
-
          viewController.setController(controller, model);
 
          primaryStage.show();

src/main/java/de/doubleslash/keeptime/viewPopup/GlobalScreenListener.java

@@ -1,6 +1,10 @@
 package de.doubleslash.keeptime.viewPopup;
 
 import java.awt.Point;
+import java.util.concurrent.Executors;
+import java.util.concurrent.ScheduledExecutorService;
+import java.util.concurrent.ScheduledFuture;
+import java.util.concurrent.TimeUnit;
 import java.util.logging.Level;
 import java.util.logging.Logger;
 
@@ -9,30 +13,47 @@
 import org.jnativehook.keyboard.NativeKeyEvent;
 import org.jnativehook.keyboard.NativeKeyListener;
 import org.jnativehook.mouse.NativeMouseEvent;
-import org.jnativehook.mouse.NativeMouseInputListener;
-import org.jnativehook.mouse.NativeMouseWheelEvent;
-import org.jnativehook.mouse.NativeMouseWheelListener;
+import org.jnativehook.mouse.NativeMouseMotionListener;
 import org.slf4j.LoggerFactory;
 
 import javafx.application.Platform;
 
-public class GlobalScreenListener implements NativeKeyListener, NativeMouseInputListener, NativeMouseWheelListener {
-   private static final int LEFT_WINDOWS = 91;
+/**
+ * Class captures all key events and implements a hotkey mechanism. Needs to be stopped by calling shutdown.
+ * 
+ * @author nmutter
+ */
+public class GlobalScreenListener implements NativeKeyListener, NativeMouseMotionListener {
+   private static final int LEFT_WINDOWS_CODE = 91;
 
-   private static final int LEFT_CTRL = 162;
+   private static final int LEFT_CTRL_CODE = 162;
 
    private final org.slf4j.Logger LOG = LoggerFactory.getLogger(this.getClass());
 
    private ViewControllerPopup viewController;
 
+   private final ScheduledExecutorService executor = Executors.newScheduledThreadPool(1);
+
+   private ScheduledFuture<?> resetKeyPressesFuture;
+
+   private final Runnable resetPressedKeysRunnable = () -> {
+      LOG.debug("Resetting pressed keys");
+      controllPressed = false;
+      windowsPressed = false;
+   };
+
+   // TODO find better hotkey - maybe configurable?
+   private boolean controllPressed = false;
+   private boolean windowsPressed = false;
+
+   private Point mouseLocation = new Point(0, 0);
+
    public GlobalScreenListener() {
 
-      setGlobalScreenLogLevel();
+      disableJNativeHookLogger();
 
       GlobalScreen.addNativeKeyListener(this);
-      GlobalScreen.addNativeMouseListener(this);
       GlobalScreen.addNativeMouseMotionListener(this);
-      GlobalScreen.addNativeMouseWheelListener(this);
    }
 
    public void register(final boolean register) {
@@ -49,7 +70,7 @@ public void register(final boolean register) {
       }
    }
 
-   public void setGlobalScreenLogLevel() {
+   private void disableJNativeHookLogger() {
       // Get the logger for "org.jnativehook" and set the level to off.
       final Logger logger = Logger.getLogger(GlobalScreen.class.getPackage().getName());
 
@@ -63,61 +84,55 @@ public void setViewController(final ViewControllerPopup viewController) {
       this.viewController = viewController;
    }
 
-   boolean controllPressed = false;
-   boolean windowsPressed = false;
-
-   private Point mouseLocation = new Point(0, 0);
-
    @Override
    public void nativeKeyPressed(final NativeKeyEvent e) {
-      // TODO find better hotkey - maybe configurable?
-
       switch (e.getRawCode()) {
-      case LEFT_CTRL:
+      case LEFT_CTRL_CODE:
          controllPressed = true;
          break;
-      case LEFT_WINDOWS:
+      case LEFT_WINDOWS_CODE:
          windowsPressed = true;
          break;
       default:
+         return;
       }
 
       if (controllPressed && windowsPressed) {
          Platform.runLater(() -> {
             viewController.show(mouseLocation);
          });
       }
+
+      // Logic to reset key presses if no input for n seconds
+      // if u win+l (lock) windows, the key release events are not received
+      if (resetKeyPressesFuture != null) {
+         resetKeyPressesFuture.cancel(false);
+      }
+      resetKeyPressesFuture = executor.schedule(resetPressedKeysRunnable, 1, TimeUnit.SECONDS);
    }
 
    @Override
    public void nativeKeyReleased(final NativeKeyEvent e) {
       switch (e.getRawCode()) {
-      case LEFT_CTRL:
+      case LEFT_CTRL_CODE:
          controllPressed = false;
          break;
-      case LEFT_WINDOWS:
+      case LEFT_WINDOWS_CODE:
          windowsPressed = false;
          break;
       default:
+         return;
       }
-   }
-
-   @Override
-   public void nativeKeyTyped(final NativeKeyEvent e) {}
-
-   @Override
-   public void nativeMouseClicked(final NativeMouseEvent e) {}
-
-   @Override
-   public void nativeMousePressed(final NativeMouseEvent nativeEvent) {
-      // TODO Auto-generated method stub
 
+      if (!controllPressed && !windowsPressed && resetKeyPressesFuture != null) {
+         // nothing to reset so we can cancel
+         resetKeyPressesFuture.cancel(false);
+      }
    }
 
    @Override
-   public void nativeMouseReleased(final NativeMouseEvent nativeEvent) {
-      // TODO Auto-generated method stub
-
+   public void nativeKeyTyped(final NativeKeyEvent e) {
+      // Not needed
    }
 
    @Override
@@ -127,14 +142,14 @@ public void nativeMouseMoved(final NativeMouseEvent nativeEvent) {
 
    @Override
    public void nativeMouseDragged(final NativeMouseEvent nativeEvent) {
-      // TODO Auto-generated method stub
-
+      // Not needed
    }
 
-   @Override
-   public void nativeMouseWheelMoved(final NativeMouseWheelEvent nativeEvent) {
-      // TODO Auto-generated method stub
-
+   /**
+    * Shuts down the threads and listeners. Instance is not usable anymore after calling this.
+    */
+   public void shutdown() {
+      executor.shutdown();
+      register(false);
    }
-
 }