Fixed a bug where Onkeypressed in scene was not working (#368)

* changed the documentation of the Key Event onKeyTyped

* reworked the onKeyEvent EventHandler that they now work on the primary Scene that is shown

* Added a consume event to the key events so that they don't get triggered multiple times with elements in the scene

* Updated CHANGELOG.md

* Applied spotless.

---------

Co-authored-by: Vadym.Kosin <Vadym.Kosin@tu-dortmund.de>
Co-authored-by: Amin Bouzerda <amin.bouzerda@tu-dortmund.de>
Co-authored-by: Amin Bouzerda <45982681+heaterscar@users.noreply.github.com>

CHANGELOG.md

@@ -19,13 +19,16 @@
 # Changelog
 All notable changes to this project will be documented in this file.
 
-## [0.8] - 22.05.2022
+## [0.8] - 22.05.2023
 
 ### Added
 - `CameraPane` component.
 - `HexagonView` component.
 - `HexagonGrid` with two coordinate systems. axial and offset coordinates.
 
+### Fixed
+- `onKeyPressed` listener not working on scenes.
+
 ## [0.7.3] - 31.08.2022
 
 ### Added

bgw-gui/src/main/kotlin/tools/aqua/bgw/builder/Frontend.kt

@@ -276,8 +276,16 @@ internal class Frontend : Application() {
             children.clear()
             children.add(backgroundPane)
             children.addAll(activePanes)
+            this.setOnKeyTyped { activePanes.lastOrNull()?.onKeyTyped?.handle(it) }
+            this.setOnKeyReleased { activePanes.lastOrNull()?.onKeyReleased?.handle(it) }
+            this.setOnKeyPressed { activePanes.lastOrNull()?.onKeyPressed?.handle(it) }
           }
 
+      primaryStage?.scene.apply {
+        this?.setOnKeyTyped { scenePane.onKeyTyped?.handle(it) }
+        this?.setOnKeyReleased { scenePane.onKeyReleased?.handle(it) }
+        this?.setOnKeyPressed { scenePane.onKeyPressed?.handle(it) }
+      }
       primaryStage?.scene?.root = scenePane
 
       primaryStage?.forceRefresh()

bgw-gui/src/main/kotlin/tools/aqua/bgw/builder/SceneBuilder.kt

@@ -17,7 +17,6 @@
 
 package tools.aqua.bgw.builder
 
-import javafx.scene.input.KeyEvent
 import javafx.scene.input.MouseEvent
 import javafx.scene.layout.Pane
 import javafx.scene.layout.StackPane
@@ -94,17 +93,20 @@ object SceneBuilder {
           prefHeight = scene.height
           prefWidth = scene.width
 
-          addEventFilter(KeyEvent.KEY_TYPED) {
+          setOnKeyTyped {
             if (scene !is BoardGameScene || !scene.internalLockedProperty.value)
                 scene.onKeyTyped?.invoke(it.toKeyEvent())
+            it.consume()
           }
-          addEventFilter(KeyEvent.KEY_PRESSED) {
+          setOnKeyPressed {
             if (scene !is BoardGameScene || !scene.internalLockedProperty.value)
                 scene.onKeyPressed?.invoke(it.toKeyEvent())
+            it.consume()
           }
-          addEventFilter(KeyEvent.KEY_RELEASED) {
+          setOnKeyReleased {
             if (scene !is BoardGameScene || !scene.internalLockedProperty.value)
                 scene.onKeyReleased?.invoke(it.toKeyEvent())
+            it.consume()
           }
         }
 

bgw-gui/src/main/kotlin/tools/aqua/bgw/components/ComponentView.kt

@@ -527,8 +527,8 @@ internal constructor(posX: Number, posY: Number, width: Number, height: Number,
   var onKeyReleased: ((KeyEvent) -> Unit)? = null
 
   /**
-   * Gets invoked with a [KeyEvent] whenever a key is typed while this [ComponentView] has focus.
-   * Gets invoked after [onKeyPressed].
+   * Gets invoked with a [KeyEvent] whenever a Character is typed while this [ComponentView] has
+   * focus. Gets invoked after [onKeyPressed].
    *
    * @see KeyEvent
    * @see onKeyPressed

bgw-gui/src/main/kotlin/tools/aqua/bgw/core/Scene.kt

@@ -171,7 +171,8 @@ sealed class Scene<T : ComponentView>(width: Number, height: Number, background:
   var onKeyReleased: ((KeyEvent) -> Unit)? = null
 
   /**
-   * Gets invoked with a [KeyEvent] whenever a key is typed. Gets invoked after [onKeyPressed].
+   * Gets invoked with a [KeyEvent] whenever a Character is typed. Gets invoked after [onKeyPressed]
+   * .
    *
    * @see KeyEvent
    * @see onKeyPressed