Changeset 18285 in josm for trunk/src/org

Timestamp:

2021-10-18T22:05:17+02:00 (3 years ago)

Author:

Don-vip

Message:

see #21443 - Extract shortcut disablement to interface, with default implementations for focusGained/focusLost (patch by taylor.smock)

Location:

trunk/src/org/openstreetmap/josm/gui/widgets

Files:

• DisableShortcutsOnFocusGainedComponent.java (added)
• DisableShortcutsOnFocusGainedTextField.java (modified) (5 diffs)

trunk/src/org/openstreetmap/josm/gui/widgets/DisableShortcutsOnFocusGainedTextField.java

@@ -3 +3 @@
 
 import java.awt.event.FocusEvent;
-import java.awt.event.InputEvent;
-import java.awt.event.KeyEvent;
 import java.util.ArrayList;
 import java.util.HashSet;
@@ -11 +9 @@
 
 import javax.swing.Action;
-import javax.swing.JMenu;
-import javax.swing.JMenuItem;
-import javax.swing.KeyStroke;
 import javax.swing.text.Document;
 
 import org.openstreetmap.josm.actions.JosmAction;
-import org.openstreetmap.josm.gui.MainApplication;
 import org.openstreetmap.josm.tools.Pair;
 import org.openstreetmap.josm.tools.Shortcut;
@@ -27 +21 @@
  * @since 5696
  */
-public class DisableShortcutsOnFocusGainedTextField extends JosmTextField {
+public class DisableShortcutsOnFocusGainedTextField extends JosmTextField implements DisableShortcutsOnFocusGainedComponent {
 
     /**
@@ -98 +92 @@
     public void focusGained(FocusEvent e) {
         super.focusGained(e);
-        disableMenuActions();
-        unregisterActionShortcuts();
+        DisableShortcutsOnFocusGainedComponent.super.focusGained(e);
     }
 
@@ -105 +98 @@
     public void focusLost(FocusEvent e) {
         super.focusLost(e);
-        restoreActionShortcuts();
-        restoreMenuActions();
+        DisableShortcutsOnFocusGainedComponent.super.focusLost(e);
     }
 
-    /**
-     * Disables all relevant menu actions.
-     * @see #hasToBeDisabled
-     */
-    protected void disableMenuActions() {
-        disabledMenuActions.clear();
-        for (int i = 0; i < MainApplication.getMenu().getMenuCount(); i++) {
-            JMenu menu = MainApplication.getMenu().getMenu(i);
-            if (menu != null) {
-                for (int j = 0; j < menu.getItemCount(); j++) {
-                    JMenuItem item = menu.getItem(j);
-                    if (item != null) {
-                        Action action = item.getAction();
-                        if (action instanceof JosmAction && action.isEnabled()) {
-                            Shortcut shortcut = ((JosmAction) action).getShortcut();
-                            if (shortcut != null) {
-                                KeyStroke ks = shortcut.getKeyStroke();
-                                if (hasToBeDisabled(ks)) {
-                                    action.setEnabled(false);
-                                    disabledMenuActions.add((JosmAction) action);
-                                }
-                            }
-                        }
-                    }
-                }
-            }
-        }
+    @Override
+    public List<Pair<Action, Shortcut>> getUnregisteredActionShortcuts() {
+        return this.unregisteredActionShortcuts;
     }
 
-    /**
-     * Unregisters all relevant action shortcuts.
-     * @see #hasToBeDisabled
-     */
-    protected void unregisterActionShortcuts() {
-        unregisteredActionShortcuts.clear();
-        // Unregister all actions with Shift modifier or without modifiers to avoid them to be triggered by typing in this text field
-        for (Shortcut shortcut : Shortcut.listAll()) {
-            KeyStroke ks = shortcut.getKeyStroke();
-            if (hasToBeDisabled(ks)) {
-                Action action = MainApplication.getRegisteredActionShortcut(shortcut);
-                if (action != null) {
-                    MainApplication.unregisterActionShortcut(action, shortcut);
-                    unregisteredActionShortcuts.add(new Pair<>(action, shortcut));
-                }
-            }
-        }
-    }
-
-    /**
-     * Returns true if the given shortcut has Shift modifier or no modifier and is not an actions key.
-     * @param ks key stroke
-     * @return {@code true} if the given shortcut has to be disabled
-     * @see KeyEvent#isActionKey()
-     */
-    protected boolean hasToBeDisabled(KeyStroke ks) {
-        return ks != null && (ks.getModifiers() == 0 || isOnlyShift(ks.getModifiers())) && !new KeyEvent(
-                this, KeyEvent.KEY_PRESSED, 0, ks.getModifiers(), ks.getKeyCode(), ks.getKeyChar()).isActionKey();
-    }
-
-    private static boolean isOnlyShift(int modifiers) {
-        return (modifiers & InputEvent.SHIFT_DOWN_MASK) != 0
-                && (modifiers & InputEvent.CTRL_DOWN_MASK) == 0
-                && (modifiers & InputEvent.ALT_DOWN_MASK) == 0
-                && (modifiers & InputEvent.ALT_GRAPH_DOWN_MASK) == 0
-                && (modifiers & InputEvent.META_DOWN_MASK) == 0;
-    }
-
-    /**
-     * Restore all actions previously disabled
-     */
-    protected void restoreMenuActions() {
-        for (JosmAction a : disabledMenuActions) {
-            a.setEnabled(true);
-        }
-        disabledMenuActions.clear();
-    }
-
-    /**
-     * Restore all action shortcuts previously unregistered
-     */
-    protected void restoreActionShortcuts() {
-        for (Pair<Action, Shortcut> p : unregisteredActionShortcuts) {
-            MainApplication.registerActionShortcut(p.a, p.b);
-        }
-        unregisteredActionShortcuts.clear();
+    @Override
+    public Set<JosmAction> getDisabledMenuActions() {
+        return this.disabledMenuActions;
     }
 }