Autofocus on a field for all existent dialogs

Author: bohdan-harniuk

src/com/magento/idea/magento2plugin/actions/generation/dialog/AbstractDialog.java

@@ -16,6 +16,8 @@
 import java.awt.Container;
 import java.awt.Dimension;
 import java.awt.Toolkit;
+import java.awt.event.ComponentEvent;
+import java.awt.event.ComponentListener;
 import java.lang.reflect.Field;
 import java.util.LinkedList;
 import java.util.List;
@@ -247,4 +249,60 @@ private int getParentTabPaneForComponent(final @NotNull Container component) {
 
         return getParentTabPaneForComponent(parent);
     }
+
+    /**
+     * Listener that helps focus on a field for dialogues after it is opened.
+     *
+     * <p><b>This inner class designed to simplify focusing on a field for the
+     * implementations of this abstract class.</b></p>
+     * <p><b>To use this listener:</b></p>
+     * <p>1) specify method in which desired field is focused:</p><br/>
+     * <pre>
+     *     public void focusOnTheSampleField() {
+     *             sampleField.requestFocusInWindow();
+     *     }
+     * </pre>
+     *
+     * <p>2) call in the constructor method:</p><br/>
+     * <pre>
+     *     addComponentListener(
+     *             new FocusOnAFieldListener(this::focusOnTheSampleField)
+     *     )
+     * </pre>
+     *
+     * @see #requestFocusInWindow()
+     */
+    public static final class FocusOnAFieldListener implements ComponentListener {
+
+        private final @NotNull Runnable makeAFieldFocusedAction;
+
+        /**
+         * Focus on a field listener constructor.
+         *
+         * @param makeAFieldFocused Runnable method in which desired field is focused.
+         */
+        public FocusOnAFieldListener(final @NotNull Runnable makeAFieldFocused) {
+            makeAFieldFocusedAction = makeAFieldFocused;
+        }
+
+        @Override
+        @SuppressWarnings("PMD.UncommentedEmptyMethodBody")
+        public void componentResized(final ComponentEvent event) {
+        }
+
+        @Override
+        @SuppressWarnings("PMD.UncommentedEmptyMethodBody")
+        public void componentMoved(final ComponentEvent event) {
+        }
+
+        @Override
+        public void componentShown(final ComponentEvent event) {
+            makeAFieldFocusedAction.run();
+        }
+
+        @Override
+        @SuppressWarnings("PMD.UncommentedEmptyMethodBody")
+        public void componentHidden(final ComponentEvent event) {
+        }
+    }
 }

src/com/magento/idea/magento2plugin/actions/generation/dialog/CreateAPluginDialog.java

@@ -140,6 +140,8 @@ public void windowClosing(final WindowEvent event) {
                 KeyStroke.getKeyStroke(KeyEvent.VK_ESCAPE, 0),
                 JComponent.WHEN_ANCESTOR_OF_FOCUSED_COMPONENT
         );
+
+        addComponentListener(new FocusOnAFieldListener(() -> pluginModule.requestFocusInWindow()));
     }
 
     private void fillPluginTypeOptions() {

src/com/magento/idea/magento2plugin/actions/generation/dialog/CreateAnObserverDialog.java

@@ -120,6 +120,8 @@ public void windowClosing(final WindowEvent event) {
                 KeyStroke.getKeyStroke(KeyEvent.VK_ESCAPE, 0),
                 JComponent.WHEN_ANCESTOR_OF_FOCUSED_COMPONENT
         );
+
+        addComponentListener(new FocusOnAFieldListener(() -> observerName.requestFocusInWindow()));
     }
 
     /**

src/com/magento/idea/magento2plugin/actions/generation/dialog/InjectAViewModelDialog.java

@@ -123,6 +123,10 @@ public void windowClosing(final WindowEvent event) {
                 KeyStroke.getKeyStroke(KeyEvent.VK_ESCAPE, 0),
                 JComponent.WHEN_ANCESTOR_OF_FOCUSED_COMPONENT
         );
+
+        addComponentListener(
+                new FocusOnAFieldListener(() -> viewModelClassName.requestFocusInWindow())
+        );
     }
 
     protected void updateArgumentText() {

src/com/magento/idea/magento2plugin/actions/generation/dialog/NewBlockDialog.java

@@ -93,6 +93,8 @@ public void windowClosing(final WindowEvent event) {
                 KeyStroke.getKeyStroke(KeyEvent.VK_ESCAPE, 0),
                 JComponent.WHEN_ANCESTOR_OF_FOCUSED_COMPONENT
         );
+
+        addComponentListener(new FocusOnAFieldListener(() -> blockName.requestFocusInWindow()));
     }
 
     /**

src/com/magento/idea/magento2plugin/actions/generation/dialog/NewCLICommandDialog.java

@@ -107,6 +107,10 @@ public void windowClosing(final WindowEvent event) {
                 KeyStroke.getKeyStroke(KeyEvent.VK_ESCAPE, 0),
                 JComponent.WHEN_ANCESTOR_OF_FOCUSED_COMPONENT
         );
+
+        addComponentListener(
+                new FocusOnAFieldListener(() -> cliCommandClassNameField.requestFocusInWindow())
+        );
     }
 
     /**

src/com/magento/idea/magento2plugin/actions/generation/dialog/NewControllerDialog.java

@@ -107,6 +107,10 @@ public void windowClosing(final WindowEvent event) {
                 KeyStroke.getKeyStroke(KeyEvent.VK_ESCAPE, 0),
                 JComponent.WHEN_ANCESTOR_OF_FOCUSED_COMPONENT
         );
+
+        addComponentListener(
+                new FocusOnAFieldListener(() -> controllerAreaSelect.requestFocusInWindow())
+        );
     }
 
     private String getModuleName() {

src/com/magento/idea/magento2plugin/actions/generation/dialog/NewCronGroupDialog.java

@@ -100,6 +100,10 @@ public void windowClosing(final WindowEvent event) {
                 KeyStroke.getKeyStroke(KeyEvent.VK_ESCAPE, 0),
                 JComponent.WHEN_ANCESTOR_OF_FOCUSED_COMPONENT
         );
+
+        addComponentListener(
+                new FocusOnAFieldListener(() -> cronGroupName.requestFocusInWindow())
+        );
     }
 
     /**

src/com/magento/idea/magento2plugin/actions/generation/dialog/NewCronjobDialog.java

@@ -191,6 +191,10 @@ public void windowClosing(final WindowEvent event) {
                 KeyStroke.getKeyStroke(KeyEvent.VK_ESCAPE, 0),
                 JComponent.WHEN_ANCESTOR_OF_FOCUSED_COMPONENT
         );
+
+        addComponentListener(
+                new FocusOnAFieldListener(() -> cronjobNameField.requestFocusInWindow())
+        );
     }
 
     /**

src/com/magento/idea/magento2plugin/actions/generation/dialog/NewDataModelDialog.java

@@ -115,6 +115,8 @@ public void windowClosing(final WindowEvent event) {
                 KeyStroke.getKeyStroke(KeyEvent.VK_ESCAPE, 0),
                 JComponent.WHEN_ANCESTOR_OF_FOCUSED_COMPONENT
         );
+
+        addComponentListener(new FocusOnAFieldListener(() -> modelName.requestFocusInWindow()));
     }
 
     /**