Combine almost identical methods; clearer name

Author: garfieldnate

src/main/java/edu/umich/soar/visualsoar/dialogs/AboutDialog.java

@@ -53,7 +53,7 @@ public AboutDialog(final Frame owner) {
         pack();
         getRootPane().setDefaultButton(buttonPanel.greatButton);
 
-        DialogUtils.closeOnEscapeKey(this, owner);
+        DialogUtils.setUpDialogFocus(this, owner, null);
 
         addWindowListener(new WindowAdapter() {
             public void windowActivated(WindowEvent we) {

src/main/java/edu/umich/soar/visualsoar/dialogs/CommentDialog.java

@@ -50,7 +50,7 @@ public CommentDialog(final Frame owner, String oldComment) {
         pack();
         getRootPane().setDefaultButton(buttonPanel.okButton);
 
-        DialogUtils.closeOnEscapeKey(this, owner);
+        DialogUtils.setUpDialogFocus(this, owner, null);
         addWindowListener(new WindowAdapter() {
             public void windowOpened(WindowEvent we) {
                 setLocationRelativeTo(owner);

src/main/java/edu/umich/soar/visualsoar/dialogs/DialogUtils.java

@@ -7,62 +7,23 @@
 import java.awt.event.WindowEvent;
 
 public class DialogUtils {
-  /**
-   * Register a listener for the {@link KeyEvent#VK_ESCAPE escape key} to close {@code dialog}. The listener is global, so
-   * even if the dialog has lost focus, it will close when the key is pressed.
-   * <p>
-   * The dialog's default close operation will be set to {@link JDialog#DISPOSE_ON_CLOSE}
-   *
-   * @param dialog to close
-   * @param owner  of the dialog box
-   */
-  public static void closeOnEscapeKey(final JDialog dialog, final Component owner) {
-    // Add a global KeyEventDispatcher for ESC key
-    KeyboardFocusManager focusManager = KeyboardFocusManager.getCurrentKeyboardFocusManager();
-    KeyEventDispatcher escDispatcher =
-        e -> {
-          if (e.getID() == KeyEvent.KEY_PRESSED && e.getKeyCode() == KeyEvent.VK_ESCAPE) {
-            dialog.dispatchEvent(new WindowEvent(dialog, WindowEvent.WINDOW_CLOSING));
-            return true; // Consume the event
-          }
-          return false; // Let other events proceed
-        };
-
-    // Ensure the dialog's default close operation is set to dispose; without this, the key handler
-    // would work once but then never work again for subsequent dialog opens
-    dialog.setDefaultCloseOperation(JDialog.DISPOSE_ON_CLOSE);
-    // Register the dispatcher when the dialog is shown
-    dialog.addWindowListener(
-        new WindowAdapter() {
-          @Override
-          public void windowOpened(WindowEvent we) {
-            dialog.setLocationRelativeTo(owner);
-            // Use SwingUtilities.invokeLater for better Windows compatibility
-            SwingUtilities.invokeLater(() -> {
-              dialog.toFront();
-              dialog.requestFocusInWindow();
-            });
-            focusManager.addKeyEventDispatcher(escDispatcher);
-          }
-
-          @Override
-          public void windowClosed(WindowEvent we) {
-            // Remove the dispatcher when the dialog is closed
-            focusManager.removeKeyEventDispatcher(escDispatcher);
-          }
-        });
-  }
 
   /**
-   * Register a listener for the {@link KeyEvent#VK_ESCAPE escape key} to close {@code dialog} and
-   * automatically focus a specific component when the dialog opens. This provides better Windows
-   * compatibility by using proper focus management techniques.
+   * Bring the dialog to the front and give it focus. If {@code focusComponent} is not null, give it
+   * the focus within the dialog.
+   *
+   * <p>Register a listener for the {@link KeyEvent#VK_ESCAPE escape key} to close {@code dialog}.
+   * The listener is global, so even if the dialog has lost focus, it will close when the key is
+   * pressed.
+   *
+   * <p>Set the dialog's default close operation to {@link JDialog#DISPOSE_ON_CLOSE}.
    *
    * @param dialog to close
-   * @param owner  of the dialog box
+   * @param owner of the dialog box
    * @param focusComponent component to receive focus when dialog opens (can be null)
    */
-  public static void closeOnEscapeKeyWithFocus(final JDialog dialog, final Component owner, final Component focusComponent) {
+  public static void setUpDialogFocus(
+      final JDialog dialog, final Component owner, final Component focusComponent) {
     // Add a global KeyEventDispatcher for ESC key
     KeyboardFocusManager focusManager = KeyboardFocusManager.getCurrentKeyboardFocusManager();
     KeyEventDispatcher escDispatcher =
@@ -74,7 +35,8 @@ public static void closeOnEscapeKeyWithFocus(final JDialog dialog, final Compone
           return false; // Let other events proceed
         };
 
-    // Ensure the dialog's default close operation is set to dispose
+    // Ensure the dialog's default close operation is set to dispose; without this, the key handler
+    // would work once but then never work again for subsequent dialog opens
     dialog.setDefaultCloseOperation(JDialog.DISPOSE_ON_CLOSE);
     // Register the dispatcher when the dialog is shown
     dialog.addWindowListener(

src/main/java/edu/umich/soar/visualsoar/dialogs/DirectorySelectionDialog.java

@@ -48,7 +48,7 @@ public DirectorySelectionDialog(Frame owner) {
         createButtonPanel();
         contentPane.add(buttonPanel, BorderLayout.SOUTH);
 
-        DialogUtils.closeOnEscapeKey(this, owner);
+        DialogUtils.setUpDialogFocus(this, owner, null);
 
         pack();
     }

src/main/java/edu/umich/soar/visualsoar/dialogs/EditCustomTemplatesDialog.java

@@ -95,7 +95,7 @@ public void windowActivated(WindowEvent we) {
         dirButton.addActionListener(this);
         closeButton.addActionListener(this);
 
-        DialogUtils.closeOnEscapeKey(this, owner);
+        DialogUtils.setUpDialogFocus(this, owner, null);
 
     }//ctor
 

src/main/java/edu/umich/soar/visualsoar/dialogs/EditEnumerationDialog.java

@@ -50,7 +50,7 @@ public EditEnumerationDialog(final Frame owner, Vector<String> theSet) {
         pack();
         getRootPane().setDefaultButton(buttonPanel.addButton);
 
-        DialogUtils.closeOnEscapeKey(this, owner);
+        DialogUtils.setUpDialogFocus(this, owner, null);
 
         //Special handling for the Enter key
         KeyStroke enter = KeyStroke.getKeyStroke(KeyEvent.VK_ENTER, 0);

src/main/java/edu/umich/soar/visualsoar/dialogs/EditNumberDialog.java

@@ -74,7 +74,7 @@ public EditNumberDialog(final Frame owner, String type) {
         pack();
         getRootPane().setDefaultButton(buttonPanel.okButton);
 
-        DialogUtils.closeOnEscapeKey(this, owner);
+        DialogUtils.setUpDialogFocus(this, owner, null);
 
         addWindowListener(new WindowAdapter() {
             public void windowActivated(WindowEvent we) {

src/main/java/edu/umich/soar/visualsoar/dialogs/EnumerationDialog.java

@@ -65,7 +65,7 @@ public EnumerationDialog(final Frame owner) {
         contentPane.add(buttonPanel, c);
         pack();
 
-        DialogUtils.closeOnEscapeKey(this, owner);
+        DialogUtils.setUpDialogFocus(this, owner, null);
 
         KeyStroke enter = KeyStroke.getKeyStroke(KeyEvent.VK_ENTER, 0);
 

src/main/java/edu/umich/soar/visualsoar/dialogs/FileAlreadyExistsDialog.java

@@ -42,7 +42,7 @@ public FileAlreadyExistsDialog(final Frame owner, String file) {
         contentPane.add(buttonPanel, c);
         pack();
 
-        DialogUtils.closeOnEscapeKey(this, owner);
+        DialogUtils.setUpDialogFocus(this, owner, null);
 
         addWindowListener(new WindowAdapter() {
             public void windowOpened(WindowEvent we) {

src/main/java/edu/umich/soar/visualsoar/dialogs/IdentifierDialog.java

@@ -53,7 +53,7 @@ public IdentifierDialog(final Frame owner) {
         pack();
         getRootPane().setDefaultButton(buttonPanel.okButton);
 
-        DialogUtils.closeOnEscapeKeyWithFocus(this, owner, namePanel);
+        DialogUtils.setUpDialogFocus(this, owner, namePanel);
 
         addWindowListener(new WindowAdapter() {
             public void windowOpened(WindowEvent we) {