If JavaFX processes a shortcut it is not sent on to the system menu bar

beldenfox · beldenfox · commit 229e996cf855 · 2024-07-27T11:50:51.000-07:00
diff --git a/modules/javafx.graphics/src/main/java/com/sun/glass/ui/View.java b/modules/javafx.graphics/src/main/java/com/sun/glass/ui/View.java
@@ -65,8 +65,9 @@ public abstract class View {
     public static class EventHandler {
         public void handleViewEvent(View view, long time, int type) {
         }
-        public void handleKeyEvent(View view, long time, int action,
+        public boolean handleKeyEvent(View view, long time, int action,
                 int keyCode, char[] keyChars, int modifiers) {
+            return false;
         }
         public void handleMenuEvent(View view, int x, int y, int xAbs,
                 int yAbs, boolean isKeyboardTrigger) {
@@ -545,11 +546,12 @@ private void handleViewEvent(long time, int type) {
         }
     }
 
-    private void handleKeyEvent(long time, int action,
+    private boolean handleKeyEvent(long time, int action,
             int keyCode, char[] keyChars, int modifiers) {
         if (shouldHandleEvent()) {
-            this.eventHandler.handleKeyEvent(this, time, action, keyCode, keyChars, modifiers);
+            return this.eventHandler.handleKeyEvent(this, time, action, keyCode, keyChars, modifiers);
         }
+        return false;
     }
 
     private void handleMouseEvent(long time, int type, int button, int x, int y,
@@ -975,6 +977,10 @@ protected void notifyKey(int type, int keyCode, char[] keyChars, int modifiers)
         handleKeyEvent(System.nanoTime(), type, keyCode, keyChars, modifiers);
     }
 
+    protected boolean notifyKeyAndReturnConsumed(int type, int keyCode, char[] keyChars, int modifiers) {
+        return handleKeyEvent(System.nanoTime(), type, keyCode, keyChars, modifiers);
+    }
+
     protected void notifyInputMethod(String text, int[] clauseBoundary,
         int[] attrBoundary, byte[] attrValue,
         int committedTextLength, int caretPos, int visiblePos) {
diff --git a/modules/javafx.graphics/src/main/java/com/sun/javafx/scene/SceneHelper.java b/modules/javafx.graphics/src/main/java/com/sun/javafx/scene/SceneHelper.java
@@ -53,8 +53,8 @@ public static void enableInputMethodEvents(Scene scene, boolean enable) {
         sceneAccessor.enableInputMethodEvents(scene, enable);
     }
 
-    public static void processKeyEvent(Scene scene, KeyEvent e) {
-        sceneAccessor.processKeyEvent(scene, e);
+    public static boolean processKeyEvent(Scene scene, KeyEvent e) {
+        return sceneAccessor.processKeyEvent(scene, e);
     }
 
     public static void processMouseEvent(Scene scene, MouseEvent e) {
@@ -118,7 +118,7 @@ public static SceneAccessor getSceneAccessor() {
     public interface SceneAccessor {
         void enableInputMethodEvents(Scene scene, boolean enable);
 
-        void processKeyEvent(Scene scene, KeyEvent e);
+        boolean processKeyEvent(Scene scene, KeyEvent e);
 
         void processMouseEvent(Scene scene, MouseEvent e);
 
diff --git a/modules/javafx.graphics/src/main/java/com/sun/javafx/tk/TKSceneListener.java b/modules/javafx.graphics/src/main/java/com/sun/javafx/tk/TKSceneListener.java
@@ -64,7 +64,7 @@ public void mouseEvent(EventType<MouseEvent> type, double x, double y, double sc
     /**
      * Pass a key event to the scene to handle
      */
-    public void keyEvent(KeyEvent keyEvent);
+    public boolean keyEvent(KeyEvent keyEvent);
 
     /**
      * Pass an input method event to the scene to handle
diff --git a/modules/javafx.graphics/src/main/java/com/sun/javafx/tk/quantum/GlassViewEventHandler.java b/modules/javafx.graphics/src/main/java/com/sun/javafx/tk/quantum/GlassViewEventHandler.java
@@ -147,7 +147,7 @@ private static EventType<javafx.scene.input.KeyEvent> keyEventType(int glassType
     }
 
     private final KeyEventNotification keyNotification = new KeyEventNotification();
-    private class KeyEventNotification implements PrivilegedAction<Void> {
+    private class KeyEventNotification implements PrivilegedAction<Boolean> {
         View view;
         long time;
         int type;
@@ -158,11 +158,12 @@ private class KeyEventNotification implements PrivilegedAction<Void> {
         private KeyCode lastKeyCode;
 
         @Override
-        public Void run() {
+        public Boolean run() {
             if (PULSE_LOGGING_ENABLED) {
                 PulseLogger.newInput(keyEventType(type).toString());
             }
             WindowStage stage = scene.getWindowStage();
+            Boolean consumed = false;
             try {
                 boolean shiftDown = (modifiers & KeyEvent.MODIFIER_SHIFT) != 0;
                 boolean controlDown = (modifiers & KeyEvent.MODIFIER_CONTROL) != 0;
@@ -215,7 +216,7 @@ public Void run() {
                             }
                         }
                         if (scene.sceneListener != null) {
-                            scene.sceneListener.keyEvent(keyEvent);
+                            consumed = scene.sceneListener.keyEvent(keyEvent);
                         }
                         break;
                     default:
@@ -231,12 +232,12 @@ public Void run() {
                     PulseLogger.newInput(null);
                 }
             }
-            return null;
+            return consumed;
         }
     }
 
     @SuppressWarnings("removal")
-    @Override public void handleKeyEvent(View view, long time, int type, int key,
+    @Override public boolean handleKeyEvent(View view, long time, int type, int key,
                                          char[] chars, int modifiers)
     {
         keyNotification.view = view;
@@ -246,9 +247,10 @@ public Void run() {
         keyNotification.chars = chars;
         keyNotification.modifiers = modifiers;
 
-        QuantumToolkit.runWithoutRenderLock(() -> {
+        final boolean consumed = QuantumToolkit.runWithoutRenderLock(() -> {
             return AccessController.doPrivileged(keyNotification, scene.getAccessControlContext());
         });
+        return consumed;
     }
 
     private static EventType<javafx.scene.input.MouseEvent> mouseEventType(int glassType) {
diff --git a/modules/javafx.graphics/src/main/java/javafx/scene/Scene.java b/modules/javafx.graphics/src/main/java/javafx/scene/Scene.java
@@ -35,6 +35,7 @@
 import com.sun.javafx.css.StyleManager;
 import com.sun.javafx.cursor.CursorFrame;
 import com.sun.javafx.event.EventQueue;
+import com.sun.javafx.event.EventUtil;
 import com.sun.javafx.geom.PickRay;
 import com.sun.javafx.geom.Vec3d;
 import com.sun.javafx.geom.transform.BaseTransform;
@@ -399,8 +400,8 @@ public void enableInputMethodEvents(Scene scene, boolean enable) {
                         }
 
                         @Override
-                        public void processKeyEvent(Scene scene, KeyEvent e) {
-                            scene.processKeyEvent(e);
+                        public boolean processKeyEvent(Scene scene, KeyEvent e) {
+                            return scene.processKeyEvent(e);
                         }
 
                         @Override
@@ -2181,7 +2182,7 @@ private void focusIneligible(Node node) {
         traverse(node, Direction.NEXT, TraversalMethod.DEFAULT);
     }
 
-    void processKeyEvent(KeyEvent e) {
+    boolean processKeyEvent(KeyEvent e) {
         if (dndGesture != null) {
             if (!dndGesture.processKey(e)) {
                 dndGesture = null;
@@ -2192,9 +2193,11 @@ void processKeyEvent(KeyEvent e) {
         final EventTarget eventTarget =
                 (sceneFocusOwner != null && sceneFocusOwner.getScene() == Scene.this) ? sceneFocusOwner : Scene.this;
 
+        if (eventTarget == null) return false;
+
         // send the key event to the current focus owner or to scene if
         // the focus owner is not set
-        Event.fireEvent(eventTarget, e);
+        return EventUtil.fireEvent(eventTarget, e) == null;
     }
 
     void requestFocus(Node node, boolean focusVisible) {
@@ -2713,9 +2716,9 @@ public void mouseEvent(EventType<MouseEvent> type, double x, double y, double sc
 
 
         @Override
-        public void keyEvent(KeyEvent keyEvent)
+        public boolean keyEvent(KeyEvent keyEvent)
         {
-            processKeyEvent(keyEvent);
+            return processKeyEvent(keyEvent);
         }
 
         @Override
diff --git a/modules/javafx.graphics/src/main/native-glass/mac/GlassStatics.h b/modules/javafx.graphics/src/main/native-glass/mac/GlassStatics.h
@@ -61,7 +61,7 @@ extern jmethodID jWindowNotifyDelegatePtr;
 extern jmethodID jViewNotifyEvent;
 extern jmethodID jViewNotifyRepaint;
 extern jmethodID jViewNotifyResize;
-extern jmethodID jViewNotifyKey;
+extern jmethodID jViewNotifyKeyAndReturnConsumed;
 extern jmethodID jViewNotifyMouse;
 extern jmethodID jViewNotifyMenu;
 extern jmethodID jViewNotifyInputMethod;
diff --git a/modules/javafx.graphics/src/main/native-glass/mac/GlassStatics.m b/modules/javafx.graphics/src/main/native-glass/mac/GlassStatics.m
@@ -63,7 +63,7 @@
 jmethodID jViewNotifyEvent = NULL;
 jmethodID jViewNotifyRepaint = NULL;
 jmethodID jViewNotifyResize = NULL;
-jmethodID jViewNotifyKey = NULL;
+jmethodID jViewNotifyKeyAndReturnConsumed= NULL;
 jmethodID jViewNotifyMouse = NULL;
 jmethodID jViewNotifyMenu = NULL;
 jmethodID jViewNotifyInputMethod = NULL;
diff --git a/modules/javafx.graphics/src/main/native-glass/mac/GlassView.m b/modules/javafx.graphics/src/main/native-glass/mac/GlassView.m
@@ -106,9 +106,9 @@
         if ((*env)->ExceptionCheck(env)) return;
     }
 
-    if (jViewNotifyKey == NULL)
+    if (jViewNotifyKeyAndReturnConsumed == NULL)
     {
-        jViewNotifyKey = (*env)->GetMethodID(env, jViewClass, "notifyKey", "(II[CI)V");
+        jViewNotifyKeyAndReturnConsumed = (*env)->GetMethodID(env, jViewClass, "notifyKeyAndReturnConsumed", "(II[CI)Z");
         if ((*env)->ExceptionCheck(env)) return;
     }
 
diff --git a/modules/javafx.graphics/src/main/native-glass/mac/GlassView3D.m b/modules/javafx.graphics/src/main/native-glass/mac/GlassView3D.m
@@ -486,13 +486,13 @@ - (BOOL)performKeyEquivalent:(NSEvent *)theEvent
             jcharArray jKeyChars = GetJavaKeyChars(env, theEvent);
             jint jModifiers = GetJavaModifiers(theEvent);
 
-            (*env)->CallVoidMethod(env, self->_delegate->jView, jViewNotifyKey,
-                                   com_sun_glass_events_KeyEvent_PRESS,
-                                   uch, jKeyChars, jModifiers);
-            (*env)->CallVoidMethod(env, self->_delegate->jView, jViewNotifyKey,
-                                   com_sun_glass_events_KeyEvent_TYPED,
-                                   uch, jKeyChars, jModifiers);
-            (*env)->CallVoidMethod(env, self->_delegate->jView, jViewNotifyKey,
+            (*env)->CallBooleanMethod(env, self->_delegate->jView, jViewNotifyKeyAndReturnConsumed,
+                                      com_sun_glass_events_KeyEvent_PRESS,
+                                      uch, jKeyChars, jModifiers);
+            (*env)->CallBooleanMethod(env, self->_delegate->jView, jViewNotifyKeyAndReturnConsumed,
+                                      com_sun_glass_events_KeyEvent_TYPED,
+                                      uch, jKeyChars, jModifiers);
+            (*env)->CallBooleanMethod(env, self->_delegate->jView, jViewNotifyKeyAndReturnConsumed,
                                    com_sun_glass_events_KeyEvent_RELEASE,
                                    uch, jKeyChars, jModifiers);
             (*env)->DeleteLocalRef(env, jKeyChars);
@@ -502,9 +502,10 @@ - (BOOL)performKeyEquivalent:(NSEvent *)theEvent
             return YES;
         }
     }
-    [self->_delegate sendJavaKeyEvent:theEvent isDown:YES];
+
+    BOOL result = [self->_delegate sendJavaKeyEvent:theEvent isDown:YES];
     [fsWindow release];
-    return NO; // return NO to allow system-default processing of Cmd+Q, etc.
+    return result;
 }
 
 - (void)keyDown:(NSEvent *)theEvent
diff --git a/modules/javafx.graphics/src/main/native-glass/mac/GlassViewDelegate.h b/modules/javafx.graphics/src/main/native-glass/mac/GlassViewDelegate.h
@@ -89,7 +89,7 @@ typedef enum GestureMaskType {
 - (void)sendJavaMouseEvent:(NSEvent *)theEvent;
 - (void)resetMouseTracking;
 - (void)sendJavaMenuEvent:(NSEvent *)theEvent;
-- (void)sendJavaKeyEvent:(NSEvent *)event isDown:(BOOL)isDown;
+- (BOOL)sendJavaKeyEvent:(NSEvent *)event isDown:(BOOL)isDown;
 - (void)sendJavaModifierKeyEvent:(NSEvent *)theEvent;
 - (void)sendJavaGestureEvent:(NSEvent *)theEvent type:(int)type;
 - (void)sendJavaGestureBeginEvent:(NSEvent *)theEvent;
diff --git a/modules/javafx.graphics/src/main/native-glass/mac/GlassViewDelegate.m b/modules/javafx.graphics/src/main/native-glass/mac/GlassViewDelegate.m
@@ -674,16 +674,16 @@ - (void)resetMouseTracking
 
 // RT-11707: zero out the keycode for TYPED events
 #define SEND_KEY_EVENT(type) \
-    (*env)->CallVoidMethod(env, self->jView, jViewNotifyKey, (type), \
+    jboolean thisEventWasConsumed = (*env)->CallBooleanMethod(env, self->jView, jViewNotifyKeyAndReturnConsumed, (type), \
             (type) == com_sun_glass_events_KeyEvent_TYPED ? 0 : jKeyCode, \
             jKeyChars, jModifiers); \
     GLASS_CHECK_EXCEPTION(env);
 
-- (void)sendJavaKeyEvent:(NSEvent *)theEvent isDown:(BOOL)isDown
+- (BOOL)sendJavaKeyEvent:(NSEvent *)theEvent isDown:(BOOL)isDown
 {
     if (theEvent == s_lastKeyEvent) {
         // this must be a keyDown: generated by performKeyEquivalent: which returns NO by design
-        return;
+        return NO;
     }
     [s_lastKeyEvent release];
     s_lastKeyEvent = [theEvent retain];
@@ -694,13 +694,18 @@ - (void)sendJavaKeyEvent:(NSEvent *)theEvent isDown:(BOOL)isDown
     jcharArray jKeyChars = GetJavaKeyChars(env, theEvent);
     jint jModifiers = GetJavaModifiers(theEvent);
 
+    // This routine returns YES if the PRESS event was consumed. This is
+    // used to ensure that performKeyEquivalent doesn't allow an event
+    // to be processed by both JavaFX and the system menus.
+    jboolean wasConsumed = false;
     if (!isDown)
     {
         SEND_KEY_EVENT(com_sun_glass_events_KeyEvent_RELEASE);
     }
     else
     {
         SEND_KEY_EVENT(com_sun_glass_events_KeyEvent_PRESS);
+        wasConsumed = thisEventWasConsumed;
 
         // TYPED events should only be sent for printable characters. Thus we avoid
         // sending them for navigation keys. Perhaps this logic could be enhanced.
@@ -720,10 +725,12 @@ - (void)sendJavaKeyEvent:(NSEvent *)theEvent isDown:(BOOL)isDown
 
     (*env)->DeleteLocalRef(env, jKeyChars);
     GLASS_CHECK_EXCEPTION(env);
+
+    return wasConsumed ? YES : NO;
 }
 
 #define SEND_MODIFIER_KEY_EVENT_WITH_TYPE(type, vkCode) \
-        (*env)->CallVoidMethod(env, self->jView, jViewNotifyKey, \
+        (*env)->CallBooleanMethod(env, self->jView, jViewNotifyKeyAndReturnConsumed, \
                 (type), \
                 (vkCode), \
                 jKeyChars, jModifiers);

Original file line number	Diff line number	Diff line change
`@@ -65,8 +65,9 @@ public abstract class View {`
`65`	`65`	`public static class EventHandler {`
`66`	`66`	`public void handleViewEvent(View view, long time, int type) {`
`67`	`67`	`}`
`68`		`- public void handleKeyEvent(View view, long time, int action,`
	`68`	`+ public boolean handleKeyEvent(View view, long time, int action,`
`69`	`69`	`int keyCode, char[] keyChars, int modifiers) {`
	`70`	`+ return false;`
`70`	`71`	`}`
`71`	`72`	`public void handleMenuEvent(View view, int x, int y, int xAbs,`
`72`	`73`	`int yAbs, boolean isKeyboardTrigger) {`
`@@ -545,11 +546,12 @@ private void handleViewEvent(long time, int type) {`
`545`	`546`	`}`
`546`	`547`	`}`
`547`	`548`
`548`		`- private void handleKeyEvent(long time, int action,`
	`549`	`+ private boolean handleKeyEvent(long time, int action,`
`549`	`550`	`int keyCode, char[] keyChars, int modifiers) {`
`550`	`551`	`if (shouldHandleEvent()) {`
`551`		`- this.eventHandler.handleKeyEvent(this, time, action, keyCode, keyChars, modifiers);`
	`552`	`+ return this.eventHandler.handleKeyEvent(this, time, action, keyCode, keyChars, modifiers);`
`552`	`553`	`}`
	`554`	`+ return false;`
`553`	`555`	`}`
`554`	`556`
`555`	`557`	`private void handleMouseEvent(long time, int type, int button, int x, int y,`
`@@ -975,6 +977,10 @@ protected void notifyKey(int type, int keyCode, char[] keyChars, int modifiers)`
`975`	`977`	`handleKeyEvent(System.nanoTime(), type, keyCode, keyChars, modifiers);`
`976`	`978`	`}`
`977`	`979`
	`980`	`+ protected boolean notifyKeyAndReturnConsumed(int type, int keyCode, char[] keyChars, int modifiers) {`
	`981`	`+ return handleKeyEvent(System.nanoTime(), type, keyCode, keyChars, modifiers);`
	`982`	`+ }`
	`983`	`+`
`978`	`984`	`protected void notifyInputMethod(String text, int[] clauseBoundary,`
`979`	`985`	`int[] attrBoundary, byte[] attrValue,`
`980`	`986`	`int committedTextLength, int caretPos, int visiblePos) {`
Original file line number	Diff line number	Diff line change
`@@ -53,8 +53,8 @@ public static void enableInputMethodEvents(Scene scene, boolean enable) {`
`53`	`53`	`sceneAccessor.enableInputMethodEvents(scene, enable);`
`54`	`54`	`}`
`55`	`55`
`56`		`- public static void processKeyEvent(Scene scene, KeyEvent e) {`
`57`		`- sceneAccessor.processKeyEvent(scene, e);`
	`56`	`+ public static boolean processKeyEvent(Scene scene, KeyEvent e) {`
	`57`	`+ return sceneAccessor.processKeyEvent(scene, e);`
`58`	`58`	`}`
`59`	`59`
`60`	`60`	`public static void processMouseEvent(Scene scene, MouseEvent e) {`
`@@ -118,7 +118,7 @@ public static SceneAccessor getSceneAccessor() {`
`118`	`118`	`public interface SceneAccessor {`
`119`	`119`	`void enableInputMethodEvents(Scene scene, boolean enable);`
`120`	`120`
`121`		`- void processKeyEvent(Scene scene, KeyEvent e);`
	`121`	`+ boolean processKeyEvent(Scene scene, KeyEvent e);`
`122`	`122`
`123`	`123`	`void processMouseEvent(Scene scene, MouseEvent e);`
`124`	`124`
Original file line number	Diff line number	Diff line change
`@@ -147,7 +147,7 @@ private static EventType<javafx.scene.input.KeyEvent> keyEventType(int glassType`
`147`	`147`	`}`
`148`	`148`
`149`	`149`	`private final KeyEventNotification keyNotification = new KeyEventNotification();`
`150`		`- private class KeyEventNotification implements PrivilegedAction<Void> {`
	`150`	`+ private class KeyEventNotification implements PrivilegedAction<Boolean> {`
`151`	`151`	`View view;`
`152`	`152`	`long time;`
`153`	`153`	`int type;`
`@@ -158,11 +158,12 @@ private class KeyEventNotification implements PrivilegedAction<Void> {`
`158`	`158`	`private KeyCode lastKeyCode;`
`159`	`159`
`160`	`160`	`@Override`
`161`		`- public Void run() {`
	`161`	`+ public Boolean run() {`
`162`	`162`	`if (PULSE_LOGGING_ENABLED) {`
`163`	`163`	`PulseLogger.newInput(keyEventType(type).toString());`
`164`	`164`	`}`
`165`	`165`	`WindowStage stage = scene.getWindowStage();`
	`166`	`+ Boolean consumed = false;`
`166`	`167`	`try {`
`167`	`168`	`boolean shiftDown = (modifiers & KeyEvent.MODIFIER_SHIFT) != 0;`
`168`	`169`	`boolean controlDown = (modifiers & KeyEvent.MODIFIER_CONTROL) != 0;`
`@@ -215,7 +216,7 @@ public Void run() {`
`215`	`216`	`}`
`216`	`217`	`}`
`217`	`218`	`if (scene.sceneListener != null) {`
`218`		`- scene.sceneListener.keyEvent(keyEvent);`
	`219`	`+ consumed = scene.sceneListener.keyEvent(keyEvent);`
`219`	`220`	`}`
`220`	`221`	`break;`
`221`	`222`	`default:`
`@@ -231,12 +232,12 @@ public Void run() {`
`231`	`232`	`PulseLogger.newInput(null);`
`232`	`233`	`}`
`233`	`234`	`}`
`234`		`- return null;`
	`235`	`+ return consumed;`
`235`	`236`	`}`
`236`	`237`	`}`
`237`	`238`
`238`	`239`	`@SuppressWarnings("removal")`
`239`		`- @Override public void handleKeyEvent(View view, long time, int type, int key,`
	`240`	`+ @Override public boolean handleKeyEvent(View view, long time, int type, int key,`
`240`	`241`	`char[] chars, int modifiers)`
`241`	`242`	`{`
`242`	`243`	`keyNotification.view = view;`
`@@ -246,9 +247,10 @@ public Void run() {`
`246`	`247`	`keyNotification.chars = chars;`
`247`	`248`	`keyNotification.modifiers = modifiers;`
`248`	`249`
`249`		`- QuantumToolkit.runWithoutRenderLock(() -> {`
	`250`	`+ final boolean consumed = QuantumToolkit.runWithoutRenderLock(() -> {`
`250`	`251`	`return AccessController.doPrivileged(keyNotification, scene.getAccessControlContext());`
`251`	`252`	`});`
	`253`	`+ return consumed;`
`252`	`254`	`}`
`253`	`255`
`254`	`256`	`private static EventType<javafx.scene.input.MouseEvent> mouseEventType(int glassType) {`
Original file line number	Diff line number	Diff line change
`@@ -106,9 +106,9 @@`
`106`	`106`	`if ((*env)->ExceptionCheck(env)) return;`
`107`	`107`	`}`
`108`	`108`
`109`		`- if (jViewNotifyKey == NULL)`
	`109`	`+ if (jViewNotifyKeyAndReturnConsumed == NULL)`
`110`	`110`	`{`
`111`		`- jViewNotifyKey = (*env)->GetMethodID(env, jViewClass, "notifyKey", "(II[CI)V");`
	`111`	`+ jViewNotifyKeyAndReturnConsumed = (*env)->GetMethodID(env, jViewClass, "notifyKeyAndReturnConsumed", "(II[CI)Z");`
`112`	`112`	`if ((*env)->ExceptionCheck(env)) return;`
`113`	`113`	`}`
`114`	`114`