Merge branch '4.0.0-develop' of github.com:magento/magento2-phpstorm-plugin into add-resource-to-web-api-dialog-form

anzin · anzin · commit 88bd28b0ff75 · 2021-06-22T18:40:29.000+03:00
diff --git a/src/com/magento/idea/magento2plugin/actions/generation/dialog/AbstractDialog.java b/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) {
+        }
+    }
 }
diff --git a/src/com/magento/idea/magento2plugin/actions/generation/dialog/CreateAPluginDialog.java b/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() {
diff --git a/src/com/magento/idea/magento2plugin/actions/generation/dialog/CreateAnObserverDialog.java b/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()));
     }
 
     /**
diff --git a/src/com/magento/idea/magento2plugin/actions/generation/dialog/InjectAViewModelDialog.java b/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() {
diff --git a/src/com/magento/idea/magento2plugin/actions/generation/dialog/NewBlockDialog.java b/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()));
     }
 
     /**
diff --git a/src/com/magento/idea/magento2plugin/actions/generation/dialog/NewCLICommandDialog.java b/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())
+        );
     }
 
     /**
diff --git a/src/com/magento/idea/magento2plugin/actions/generation/dialog/NewControllerDialog.java b/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() {
diff --git a/src/com/magento/idea/magento2plugin/actions/generation/dialog/NewCronGroupDialog.java b/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())
+        );
     }
 
     /**
diff --git a/src/com/magento/idea/magento2plugin/actions/generation/dialog/NewCronjobDialog.java b/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(() -> cronjobClassNameField.requestFocusInWindow())
+        );
     }
 
     /**
diff --git a/src/com/magento/idea/magento2plugin/actions/generation/dialog/NewDataModelDialog.java b/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()));
     }
 
     /**
diff --git a/src/com/magento/idea/magento2plugin/actions/generation/dialog/NewDbSchemaDialog.java b/src/com/magento/idea/magento2plugin/actions/generation/dialog/NewDbSchemaDialog.java
@@ -123,6 +123,8 @@ public void windowClosing(final WindowEvent event) {
         );
         fillComboBoxes();
         initializeColumnsUiComponentGroup();
+
+        addComponentListener(new FocusOnAFieldListener(() -> tableName.requestFocusInWindow()));
     }
 
     /**
diff --git a/src/com/magento/idea/magento2plugin/actions/generation/dialog/NewEmailTemplateDialog.java b/src/com/magento/idea/magento2plugin/actions/generation/dialog/NewEmailTemplateDialog.java
@@ -98,6 +98,8 @@ public void actionPerformed(final ActionEvent actionEvent) {
                 KeyStroke.getKeyStroke(KeyEvent.VK_ESCAPE, 0),
                 JComponent.WHEN_ANCESTOR_OF_FOCUSED_COMPONENT
         );
+
+        addComponentListener(new FocusOnAFieldListener(() -> identifier.requestFocusInWindow()));
     }
 
     /**
diff --git a/src/com/magento/idea/magento2plugin/actions/generation/dialog/NewGraphQlResolverDialog.java b/src/com/magento/idea/magento2plugin/actions/generation/dialog/NewGraphQlResolverDialog.java
@@ -89,6 +89,10 @@ public void windowClosing(final WindowEvent event) {
                 KeyStroke.getKeyStroke(KeyEvent.VK_ESCAPE, 0),
                 JComponent.WHEN_ANCESTOR_OF_FOCUSED_COMPONENT
         );
+
+        addComponentListener(
+                new FocusOnAFieldListener(() -> graphQlResolverClassName.requestFocusInWindow())
+        );
     }
 
     /**
diff --git a/src/com/magento/idea/magento2plugin/actions/generation/dialog/NewInterfaceForServiceDialog.java b/src/com/magento/idea/magento2plugin/actions/generation/dialog/NewInterfaceForServiceDialog.java
@@ -119,6 +119,8 @@ public void windowClosing(final WindowEvent event) {
         );
 
         fillPredefinedValuesAndDisableInputs();
+
+        addComponentListener(new FocusOnAFieldListener(() -> nameField.requestFocusInWindow()));
     }
 
     /**
diff --git a/src/com/magento/idea/magento2plugin/actions/generation/dialog/NewMessageQueueDialog.java b/src/com/magento/idea/magento2plugin/actions/generation/dialog/NewMessageQueueDialog.java
@@ -200,6 +200,8 @@ protected void textChanged(final @NotNull DocumentEvent event) {
         });
 
         connectionName.addActionListener(e -> toggleConsumer());
+
+        addComponentListener(new FocusOnAFieldListener(() -> topicName.requestFocusInWindow()));
     }
 
     private void toggleConsumer() {
diff --git a/src/com/magento/idea/magento2plugin/actions/generation/dialog/NewModelsDialog.java b/src/com/magento/idea/magento2plugin/actions/generation/dialog/NewModelsDialog.java
@@ -131,6 +131,8 @@ protected void textChanged(final @NotNull DocumentEvent event) {
                 updateText();
             }
         });
+
+        addComponentListener(new FocusOnAFieldListener(() -> modelName.requestFocusInWindow()));
     }
 
     /**
diff --git a/src/com/magento/idea/magento2plugin/actions/generation/dialog/NewModuleDialog.java b/src/com/magento/idea/magento2plugin/actions/generation/dialog/NewModuleDialog.java
@@ -151,6 +151,14 @@ public void windowClosing(final WindowEvent event) {
                 KeyStroke.getKeyStroke(KeyEvent.VK_ESCAPE, 0),
                 JComponent.WHEN_ANCESTOR_OF_FOCUSED_COMPONENT
         );
+
+        addComponentListener(new FocusOnAFieldListener(() -> {
+            if (packageName.isVisible()) {
+                packageName.requestFocusInWindow();
+            } else {
+                moduleName.requestFocusInWindow();
+            }
+        }));
     }
 
     private void detectPackageName(final @NotNull PsiDirectory initialBaseDir) {
diff --git a/src/com/magento/idea/magento2plugin/actions/generation/dialog/NewUiComponentFormDialog.java b/src/com/magento/idea/magento2plugin/actions/generation/dialog/NewUiComponentFormDialog.java
@@ -244,6 +244,8 @@ public void actionPerformed(final ActionEvent event) {
         formAreaSelect.addActionListener(e -> toggleAcl());
         formAreaSelect.setEnabled(false);
         acl.setText(getModuleName() + "::manage");
+
+        addComponentListener(new FocusOnAFieldListener(() -> formName.requestFocusInWindow()));
     }
 
     protected void initButtonsTable() {
diff --git a/src/com/magento/idea/magento2plugin/actions/generation/dialog/NewUiComponentGridDialog.java b/src/com/magento/idea/magento2plugin/actions/generation/dialog/NewUiComponentGridDialog.java
@@ -232,6 +232,10 @@ public void windowClosing(final WindowEvent event) {
 
         dataProviderParentDirectory.setVisible(false);
         dataProviderParentDirectoryLabel.setVisible(false);
+
+        addComponentListener(
+                new FocusOnAFieldListener(() -> uiComponentName.requestFocusInWindow())
+        );
     }
 
     /**
diff --git a/src/com/magento/idea/magento2plugin/actions/generation/dialog/NewViewModelDialog.java b/src/com/magento/idea/magento2plugin/actions/generation/dialog/NewViewModelDialog.java
@@ -97,6 +97,10 @@ public void windowClosing(final WindowEvent event) {
                 KeyStroke.getKeyStroke(KeyEvent.VK_ESCAPE, 0),
                 JComponent.WHEN_ANCESTOR_OF_FOCUSED_COMPONENT
         );
+
+        addComponentListener(
+                new FocusOnAFieldListener(() -> viewModelName.requestFocusInWindow())
+        );
     }
 
     /**
diff --git a/src/com/magento/idea/magento2plugin/actions/generation/dialog/NewWebApiDeclarationDialog.java b/src/com/magento/idea/magento2plugin/actions/generation/dialog/NewWebApiDeclarationDialog.java
@@ -112,6 +112,8 @@ public void windowClosing(final WindowEvent event) {
         );
 
         fillPredefinedValuesAndDisableInputs();
+
+        addComponentListener(new FocusOnAFieldListener(() -> routeUrl.requestFocusInWindow()));
     }
 
     /**
diff --git a/src/com/magento/idea/magento2plugin/actions/generation/dialog/OverrideClassByAPreferenceDialog.java b/src/com/magento/idea/magento2plugin/actions/generation/dialog/OverrideClassByAPreferenceDialog.java
@@ -135,6 +135,10 @@ public void windowClosing(final WindowEvent event) {
                 KeyStroke.getKeyStroke(KeyEvent.VK_ESCAPE, 0),
                 JComponent.WHEN_ANCESTOR_OF_FOCUSED_COMPONENT
         );
+
+        addComponentListener(
+                new FocusOnAFieldListener(() -> preferenceModule.requestFocusInWindow())
+        );
     }
 
     private void suggestPreferenceDirectory(final PhpClass targetClass) {
diff --git a/src/com/magento/idea/magento2plugin/actions/generation/dialog/OverrideInThemeDialog.java b/src/com/magento/idea/magento2plugin/actions/generation/dialog/OverrideInThemeDialog.java
@@ -80,6 +80,8 @@ public void windowClosing(final WindowEvent event) {
                 KeyStroke.getKeyStroke(KeyEvent.VK_ESCAPE, 0),
                 JComponent.WHEN_ANCESTOR_OF_FOCUSED_COMPONENT
         );
+
+        addComponentListener(new FocusOnAFieldListener(() -> theme.requestFocusInWindow()));
     }
 
     private void onOverride() {

Original file line number	Diff line number	Diff line change
`@@ -140,6 +140,8 @@ public void windowClosing(final WindowEvent event) {`
`140`	`140`	`KeyStroke.getKeyStroke(KeyEvent.VK_ESCAPE, 0),`
`141`	`141`	`JComponent.WHEN_ANCESTOR_OF_FOCUSED_COMPONENT`
`142`	`142`	`);`
	`143`	`+`
	`144`	`+ addComponentListener(new FocusOnAFieldListener(() -> pluginModule.requestFocusInWindow()));`
`143`	`145`	`}`
`144`	`146`
`145`	`147`	`private void fillPluginTypeOptions() {`
Original file line number	Diff line number	Diff line change
`@@ -120,6 +120,8 @@ public void windowClosing(final WindowEvent event) {`
`120`	`120`	`KeyStroke.getKeyStroke(KeyEvent.VK_ESCAPE, 0),`
`121`	`121`	`JComponent.WHEN_ANCESTOR_OF_FOCUSED_COMPONENT`
`122`	`122`	`);`
	`123`	`+`
	`124`	`+ addComponentListener(new FocusOnAFieldListener(() -> observerName.requestFocusInWindow()));`
`123`	`125`	`}`
`124`	`126`
`125`	`127`	`/**`
Original file line number	Diff line number	Diff line change
`@@ -93,6 +93,8 @@ public void windowClosing(final WindowEvent event) {`
`93`	`93`	`KeyStroke.getKeyStroke(KeyEvent.VK_ESCAPE, 0),`
`94`	`94`	`JComponent.WHEN_ANCESTOR_OF_FOCUSED_COMPONENT`
`95`	`95`	`);`
	`96`	`+`
	`97`	`+ addComponentListener(new FocusOnAFieldListener(() -> blockName.requestFocusInWindow()));`
`96`	`98`	`}`
`97`	`99`
`98`	`100`	`/**`
Original file line number	Diff line number	Diff line change
`@@ -115,6 +115,8 @@ public void windowClosing(final WindowEvent event) {`
`115`	`115`	`KeyStroke.getKeyStroke(KeyEvent.VK_ESCAPE, 0),`
`116`	`116`	`JComponent.WHEN_ANCESTOR_OF_FOCUSED_COMPONENT`
`117`	`117`	`);`
	`118`	`+`
	`119`	`+ addComponentListener(new FocusOnAFieldListener(() -> modelName.requestFocusInWindow()));`
`118`	`120`	`}`
`119`	`121`
`120`	`122`	`/**`