Changeset 18972 in josm for trunk/src/org/openstreetmap/josm/gui/preferences/projection/CustomProjectionChoice.java

Timestamp:

2024-02-09T15:26:06+01:00 (10 months ago)

Author:

taylor.smock

Message:

See #23465: Add additional javadoc comments

This also fixes some sonarlint issues

File:

• trunk/src/org/openstreetmap/josm/gui/preferences/projection/CustomProjectionChoice.java (modified) (4 diffs)

trunk/src/org/openstreetmap/josm/gui/preferences/projection/CustomProjectionChoice.java

@@ -5 +5 @@
 
 import java.awt.BorderLayout;
+import java.awt.GridBagConstraints;
 import java.awt.GridBagLayout;
 import java.awt.Insets;
@@ -120 +121 @@
             this.setLayout(new GridBagLayout());
             JPanel p2 = new JPanel(new GridBagLayout());
-            p2.add(cbInput, GBC.std().fill(GBC.HORIZONTAL).insets(0, 20, 5, 5));
+            p2.add(cbInput, GBC.std().fill(GridBagConstraints.HORIZONTAL).insets(0, 20, 5, 5));
             p2.add(btnCheck, GBC.eol().insets(0, 20, 0, 5));
-            this.add(p2, GBC.eol().fill(GBC.HORIZONTAL));
+            this.add(p2, GBC.eol().fill(GridBagConstraints.HORIZONTAL));
             p2 = new JPanel(new GridBagLayout());
-            p2.add(valStatus, GBC.std().anchor(GBC.WEST).weight(0.0001, 0));
-            p2.add(errorsPanel, GBC.eol().fill(GBC.HORIZONTAL));
-            this.add(p2, GBC.eol().fill(GBC.HORIZONTAL));
+            p2.add(valStatus, GBC.std().anchor(GridBagConstraints.WEST).weight(0.0001, 0));
+            p2.add(errorsPanel, GBC.eol().fill(GridBagConstraints.HORIZONTAL));
+            this.add(p2, GBC.eol().fill(GridBagConstraints.HORIZONTAL));
             p2 = new JPanel(new GridBagLayout());
             p2.add(btnInfo, GBC.std().insets(0, 20, 0, 0));
-            p2.add(GBC.glue(1, 0), GBC.eol().fill(GBC.HORIZONTAL));
-            this.add(p2, GBC.eol().fill(GBC.HORIZONTAL));
-        }
-
+            p2.add(GBC.glue(1, 0), GBC.eol().fill(GridBagConstraints.HORIZONTAL));
+            this.add(p2, GBC.eol().fill(GridBagConstraints.HORIZONTAL));
+        }
+
+        /**
+         * Remember the current input
+         */
         public void rememberHistory() {
             cbInput.addCurrentItemToHistory();
@@ -139 +143 @@
     }
 
+    /**
+     * A dialog for the available parameters of the custom projection
+     */
     public static class ParameterInfoDialog extends ExtendedDialog {
 
@@ -212 +219 @@
         }
         PreferencePanel prefPanel = (PreferencePanel) panel;
-        String pref = prefPanel.cbInput.getEditorComponent().getText();
+        String savePreferences = prefPanel.cbInput.getEditorComponent().getText();
         prefPanel.rememberHistory();
-        return Collections.singleton(pref);
+        return Collections.singleton(savePreferences);
     }