Changeset 14221 in josm for trunk/src/org/openstreetmap/josm

Timestamp:

2018-09-03T20:15:11+02:00 (6 years ago)

Author:

Don-vip

Message:

see #16706 - use documented enum for AutoScaleMode instead of undocumented string constants

Location:

trunk/src/org/openstreetmap/josm

Files:

• actions/AutoScaleAction.java (modified) (14 diffs)
• actions/ZoomToAction.java (modified) (2 diffs)
• gui/MainMenu.java (modified) (2 diffs)
• gui/dialogs/CommandStackDialog.java (modified) (2 diffs)
• gui/dialogs/SelectionListDialog.java (modified) (2 diffs)
• gui/dialogs/relation/MemberTable.java (modified) (2 diffs)
• gui/history/NodeListViewer.java (modified) (2 diffs)
• io/remotecontrol/handler/AddNodeHandler.java (modified) (2 diffs)
• io/remotecontrol/handler/AddWayHandler.java (modified) (2 diffs)
• io/remotecontrol/handler/LoadAndZoomHandler.java (modified) (2 diffs)

trunk/src/org/openstreetmap/josm/actions/AutoScaleAction.java

@@ -15 +15 @@
 import java.util.HashSet;
 import java.util.List;
+import java.util.Objects;
 import java.util.concurrent.TimeUnit;
 
@@ -45 +46 @@
  * Toggles the autoScale feature of the mapView
  * @author imi
+ * @since 17
  */
 public class AutoScaleAction extends JosmAction {
@@ -50 +52 @@
     /**
      * A list of things we can zoom to. The zoom target is given depending on the mode.
-     */
+     * @since 14221
+     */
+    public enum AutoScaleMode {
+        /** Zoom the window so that all the data fills the window area */
+        DATA(marktr(/* ICON(dialogs/autoscale/) */ "data")),
+        /** Zoom the window so that all the data on the currently selected layer fills the window area */
+        LAYER(marktr(/* ICON(dialogs/autoscale/) */ "layer")),
+        /** Zoom the window so that only data which is currently selected fills the window area */
+        SELECTION(marktr(/* ICON(dialogs/autoscale/) */ "selection")),
+        /** Zoom to the first selected conflict */
+        CONFLICT(marktr(/* ICON(dialogs/autoscale/) */ "conflict")),
+        /** Zoom the view to last downloaded data */
+        DOWNLOAD(marktr(/* ICON(dialogs/autoscale/) */ "download")),
+        /** Zoom the view to problem */
+        PROBLEM(marktr(/* ICON(dialogs/autoscale/) */ "problem")),
+        /** Zoom to the previous zoomed to scale and location (zoom undo) */
+        PREVIOUS(marktr(/* ICON(dialogs/autoscale/) */ "previous")),
+        /** Zoom to the next zoomed to scale and location (zoom redo) */
+        NEXT(marktr(/* ICON(dialogs/autoscale/) */ "next"));
+
+        private final String label;
+
+        AutoScaleMode(String label) {
+            this.label = label;
+        }
+
+        /**
+         * Returns the English label. Used for retrieving icons.
+         * @return the English label
+         */
+        public String getEnglishLabel() {
+            return label;
+        }
+
+        /**
+         * Returns the localized label. Used for display
+         * @return the localized label
+         */
+        public String getLocalizedLabel() {
+            return tr(label);
+        }
+
+        /**
+         * Returns {@code AutoScaleMode} for a given English label
+         * @param englishLabel English label
+         * @return {@code AutoScaleMode} for given English label
+         * @throws IllegalArgumentException if Engligh label is unknown
+         */
+        public static AutoScaleMode of(String englishLabel) {
+            for (AutoScaleMode v : values()) {
+                if (Objects.equals(v.label, englishLabel)) {
+                    return v;
+                }
+            }
+            throw new IllegalArgumentException(englishLabel);
+        }
+    }
+
+    /**
+     * A list of things we can zoom to. The zoom target is given depending on the mode.
+     * @deprecated Use {@link AutoScaleMode} enum instead
+     */
+    @Deprecated
     public static final Collection<String> MODES = Collections.unmodifiableList(Arrays.asList(
         marktr(/* ICON(dialogs/autoscale/) */ "data"),
@@ -62 +126 @@
 
     /**
-     * One of {@link #MODES}. Defines what we are zooming to.
-     */
-    private final String mode;
+     * One of {@link AutoScaleMode}. Defines what we are zooming to.
+     */
+    private final AutoScaleMode mode;
 
     /** Time of last zoom to bounds action */
@@ -112 +176 @@
      * Performs the auto scale operation of the given mode without the need to create a new action.
      * @param mode One of {@link #MODES}.
-     */
+     * @since 14221
+     */
+    public static void autoScale(AutoScaleMode mode) {
+        new AutoScaleAction(mode, false).autoScale();
+    }
+
+    /**
+     * Performs the auto scale operation of the given mode without the need to create a new action.
+     * @param mode One of {@link #MODES}.
+     * @deprecated Use {@link #autoScale(AutoScaleMode)} instead
+     */
+    @Deprecated
     public static void autoScale(String mode) {
-        new AutoScaleAction(mode, false).autoScale();
+        autoScale(AutoScaleMode.of(mode));
     }
 
@@ -140 +215 @@
     /**
      * Constructs a new {@code AutoScaleAction}.
-     * @param mode The autoscale mode (one of {@link AutoScaleAction#MODES})
+     * @param mode The autoscale mode (one of {@link AutoScaleMode})
      * @param marker Must be set to false. Used only to differentiate from default constructor
      */
-    private AutoScaleAction(String mode, boolean marker) {
+    private AutoScaleAction(AutoScaleMode mode, boolean marker) {
         super(marker);
         this.mode = mode;
@@ -151 +226 @@
      * Constructs a new {@code AutoScaleAction}.
      * @param mode The autoscale mode (one of {@link AutoScaleAction#MODES})
-     */
+     * @deprecated Use {@link #AutoScaleAction(AutoScaleMode)} instead
+     */
+    @Deprecated
     public AutoScaleAction(final String mode) {
-        super(tr("Zoom to {0}", tr(mode)), "dialogs/autoscale/" + mode, tr("Zoom the view to {0}.", tr(mode)),
-                Shortcut.registerShortcut("view:zoom" + mode, tr("View: {0}", tr("Zoom to {0}", tr(mode))),
-                        getModeShortcut(mode), Shortcut.DIRECT), true, null, false);
-        String modeHelp = Character.toUpperCase(mode.charAt(0)) + mode.substring(1);
+        this(AutoScaleMode.of(mode));
+    }
+
+    /**
+     * Constructs a new {@code AutoScaleAction}.
+     * @param mode The autoscale mode (one of {@link AutoScaleAction#MODES})
+     * @since 14221
+     */
+    public AutoScaleAction(final AutoScaleMode mode) {
+        super(tr("Zoom to {0}", mode.getLocalizedLabel()), "dialogs/autoscale/" + mode.getEnglishLabel(),
+              tr("Zoom the view to {0}.", mode.getLocalizedLabel()),
+              Shortcut.registerShortcut("view:zoom" + mode.getEnglishLabel(),
+                        tr("View: {0}", tr("Zoom to {0}", mode.getLocalizedLabel())),
+                        getModeShortcut(mode.getEnglishLabel()), Shortcut.DIRECT), true, null, false);
+        String label = mode.getEnglishLabel();
+        String modeHelp = Character.toUpperCase(label.charAt(0)) + label.substring(1);
         putValue("help", "Action/AutoScale/" + modeHelp);
         this.mode = mode;
         switch (mode) {
-        case "data":
+        case DATA:
             putValue("help", ht("/Action/ZoomToData"));
             break;
-        case "layer":
+        case LAYER:
             putValue("help", ht("/Action/ZoomToLayer"));
             break;
-        case "selection":
+        case SELECTION:
             putValue("help", ht("/Action/ZoomToSelection"));
             break;
-        case "conflict":
+        case CONFLICT:
             putValue("help", ht("/Action/ZoomToConflict"));
             break;
-        case "problem":
+        case PROBLEM:
             putValue("help", ht("/Action/ZoomToProblem"));
             break;
-        case "download":
+        case DOWNLOAD:
             putValue("help", ht("/Action/ZoomToDownload"));
             break;
-        case "previous":
+        case PREVIOUS:
             putValue("help", ht("/Action/ZoomToPrevious"));
             break;
-        case "next":
+        case NEXT:
             putValue("help", ht("/Action/ZoomToNext"));
             break;
@@ -197 +286 @@
             MapView mapView = MainApplication.getMap().mapView;
             switch (mode) {
-            case "previous":
+            case PREVIOUS:
                 mapView.zoomPrevious();
                 break;
-            case "next":
+            case NEXT:
                 mapView.zoomNext();
                 break;
@@ -241 +330 @@
     private BoundingXYVisitor getBoundingBox() {
         switch (mode) {
-        case "problem":
+        case PROBLEM:
             return modeProblem(new ValidatorBoundingXYVisitor());
-        case "data":
+        case DATA:
             return modeData(new BoundingXYVisitor());
-        case "layer":
+        case LAYER:
             return modeLayer(new BoundingXYVisitor());
-        case "selection":
-        case "conflict":
+        case SELECTION:
+        case CONFLICT:
             return modeSelectionOrConflict(new BoundingXYVisitor());
-        case "download":
+        case DOWNLOAD:
             return modeDownload(new BoundingXYVisitor());
         default:
@@ -286 +375 @@
     private BoundingXYVisitor modeSelectionOrConflict(BoundingXYVisitor v) {
         Collection<IPrimitive> sel = new HashSet<>();
-        if ("selection".equals(mode)) {
+        if (AutoScaleMode.SELECTION == mode) {
             OsmData<?, ?, ?, ?> dataSet = getLayerManager().getActiveData();
             if (dataSet != null) {
@@ -303 +392 @@
             JOptionPane.showMessageDialog(
                     MainApplication.getMainFrame(),
-                    "selection".equals(mode) ? tr("Nothing selected to zoom to.") : tr("No conflicts to zoom to"),
+                    AutoScaleMode.SELECTION == mode ? tr("Nothing selected to zoom to.") : tr("No conflicts to zoom to"),
                     tr("Information"),
                     JOptionPane.INFORMATION_MESSAGE);
@@ -357 +446 @@
         MapFrame map = MainApplication.getMap();
         switch (mode) {
-        case "selection":
+        case SELECTION:
             setEnabled(ds != null && !ds.selectionEmpty());
             break;
-        case "layer":
+        case LAYER:
             setEnabled(getFirstSelectedLayer() != null);
             break;
-        case "conflict":
+        case CONFLICT:
             setEnabled(map != null && map.conflictDialog.getSelectedConflict() != null);
             break;
-        case "download":
+        case DOWNLOAD:
             setEnabled(ds != null && !ds.getDataSources().isEmpty());
             break;
-        case "problem":
+        case PROBLEM:
             setEnabled(map != null && map.validatorDialog.getSelectedError() != null);
             break;
-        case "previous":
+        case PREVIOUS:
             setEnabled(MainApplication.isDisplayingMapView() && map.mapView.hasZoomUndoEntries());
             break;
-        case "next":
+        case NEXT:
             setEnabled(MainApplication.isDisplayingMapView() && map.mapView.hasZoomRedoEntries());
             break;
@@ -385 +474 @@
     @Override
     protected void updateEnabledState(Collection<? extends OsmPrimitive> selection) {
-        if ("selection".equals(mode)) {
+        if (AutoScaleMode.SELECTION == mode) {
             setEnabled(selection != null && !selection.isEmpty());
         }
@@ -418 +507 @@
 
         MapFrameAdapter() {
-            if ("conflict".equals(mode)) {
+            if (AutoScaleMode.CONFLICT == mode) {
                 conflictSelectionListener = e -> updateEnabledState();
-            } else if ("problem".equals(mode)) {
+            } else if (AutoScaleMode.PROBLEM == mode) {
                 validatorSelectionListener = e -> updateEnabledState();
             }

trunk/src/org/openstreetmap/josm/actions/ZoomToAction.java

@@ -10 +10 @@
 import javax.swing.event.ListSelectionListener;
 
+import org.openstreetmap.josm.actions.AutoScaleAction.AutoScaleMode;
 import org.openstreetmap.josm.data.osm.OsmPrimitive;
 import org.openstreetmap.josm.gui.MainApplication;
@@ -99 +100 @@
         if (layer != null && primitive != null) {
             layer.data.setSelected(primitive);
-            AutoScaleAction.autoScale("selection");
+            AutoScaleAction.autoScale(AutoScaleMode.SELECTION);
         }
     }

trunk/src/org/openstreetmap/josm/gui/MainMenu.java

@@ -30 +30 @@
 import org.openstreetmap.josm.actions.AlignInLineAction;
 import org.openstreetmap.josm.actions.AutoScaleAction;
+import org.openstreetmap.josm.actions.AutoScaleAction.AutoScaleMode;
 import org.openstreetmap.josm.actions.ChangesetManagerToggleAction;
 import org.openstreetmap.josm.actions.CloseChangesetAction;
@@ -720 +721 @@
         add(viewMenu, new ZoomOutAction());
         viewMenu.addSeparator();
-        for (String mode : AutoScaleAction.MODES) {
+        for (AutoScaleMode mode : AutoScaleMode.values()) {
             AutoScaleAction autoScaleAction = new AutoScaleAction(mode);
-            autoScaleActions.put(mode, autoScaleAction);
+            autoScaleActions.put(mode.getEnglishLabel(), autoScaleAction);
             add(viewMenu, autoScaleAction);
         }

trunk/src/org/openstreetmap/josm/gui/dialogs/CommandStackDialog.java

@@ -38 +38 @@
 
 import org.openstreetmap.josm.actions.AutoScaleAction;
+import org.openstreetmap.josm.actions.AutoScaleAction.AutoScaleMode;
 import org.openstreetmap.josm.command.Command;
 import org.openstreetmap.josm.command.PseudoCommand;
@@ -453 +454 @@
         public void actionPerformed(ActionEvent e) {
             super.actionPerformed(e);
-            AutoScaleAction.autoScale("selection");
+            AutoScaleAction.autoScale(AutoScaleMode.SELECTION);
         }
     }

trunk/src/org/openstreetmap/josm/gui/dialogs/SelectionListDialog.java

@@ -39 +39 @@
 import org.openstreetmap.josm.actions.AbstractSelectAction;
 import org.openstreetmap.josm.actions.AutoScaleAction;
+import org.openstreetmap.josm.actions.AutoScaleAction.AutoScaleMode;
 import org.openstreetmap.josm.actions.relation.DownloadSelectedIncompleteMembersAction;
 import org.openstreetmap.josm.actions.relation.EditRelationAction;
@@ -393 +394 @@
         @Override
         public void actionPerformed(ActionEvent e) {
-            AutoScaleAction.autoScale("selection");
+            AutoScaleAction.autoScale(AutoScaleMode.SELECTION);
         }
 

trunk/src/org/openstreetmap/josm/gui/dialogs/relation/MemberTable.java

@@ -22 +22 @@
 
 import org.openstreetmap.josm.actions.AutoScaleAction;
+import org.openstreetmap.josm.actions.AutoScaleAction.AutoScaleMode;
 import org.openstreetmap.josm.actions.ZoomToAction;
 import org.openstreetmap.josm.data.osm.OsmPrimitive;
@@ -239 +240 @@
                 getLayer().data.setSelected(WayConnectionType.Direction.FORWARD == connectionType.direction
                         ? way.firstNode() : way.lastNode());
-                AutoScaleAction.autoScale("selection");
+                AutoScaleAction.autoScale(AutoScaleMode.SELECTION);
             } else if (!connectionType.linkNext) {
                 getLayer().data.setSelected(WayConnectionType.Direction.FORWARD == connectionType.direction
                         ? way.lastNode() : way.firstNode());
-                AutoScaleAction.autoScale("selection");
+                AutoScaleAction.autoScale(AutoScaleMode.SELECTION);
             }
         }

trunk/src/org/openstreetmap/josm/gui/history/NodeListViewer.java

@@ -22 +22 @@
 
 import org.openstreetmap.josm.actions.AutoScaleAction;
+import org.openstreetmap.josm.actions.AutoScaleAction.AutoScaleMode;
 import org.openstreetmap.josm.data.osm.IPrimitive;
 import org.openstreetmap.josm.data.osm.OsmData;
@@ -253 +254 @@
                 if (ds != null) {
                     ds.setSelected(p.getPrimitiveId());
-                    AutoScaleAction.autoScale("selection");
+                    AutoScaleAction.autoScale(AutoScaleMode.SELECTION);
                 }
             }

trunk/src/org/openstreetmap/josm/io/remotecontrol/handler/AddNodeHandler.java

@@ -9 +9 @@
 
 import org.openstreetmap.josm.actions.AutoScaleAction;
+import org.openstreetmap.josm.actions.AutoScaleAction.AutoScaleMode;
 import org.openstreetmap.josm.command.AddCommand;
 import org.openstreetmap.josm.data.UndoRedoHandler;
@@ -107 +108 @@
         ds.setSelected(node);
         if (PermissionPrefWithDefault.CHANGE_VIEWPORT.isAllowed()) {
-            AutoScaleAction.autoScale("selection");
+            AutoScaleAction.autoScale(AutoScaleMode.SELECTION);
         } else {
             MainApplication.getMap().mapView.repaint();

trunk/src/org/openstreetmap/josm/io/remotecontrol/handler/AddWayHandler.java

@@ -14 +14 @@
 
 import org.openstreetmap.josm.actions.AutoScaleAction;
+import org.openstreetmap.josm.actions.AutoScaleAction.AutoScaleMode;
 import org.openstreetmap.josm.command.AddCommand;
 import org.openstreetmap.josm.command.Command;
@@ -174 +175 @@
         ds.setSelected(way);
         if (PermissionPrefWithDefault.CHANGE_VIEWPORT.isAllowed()) {
-            AutoScaleAction.autoScale("selection");
+            AutoScaleAction.autoScale(AutoScaleMode.SELECTION);
         } else {
             MainApplication.getMap().mapView.repaint();

trunk/src/org/openstreetmap/josm/io/remotecontrol/handler/LoadAndZoomHandler.java

@@ -17 +17 @@
 
 import org.openstreetmap.josm.actions.AutoScaleAction;
+import org.openstreetmap.josm.actions.AutoScaleAction.AutoScaleMode;
 import org.openstreetmap.josm.actions.downloadtasks.DownloadOsmTask;
 import org.openstreetmap.josm.actions.downloadtasks.DownloadParams;
@@ -264 +265 @@
         // zoom_mode=(download|selection), defaults to selection
         if (!"download".equals(args.get("zoom_mode")) && !primitives.isEmpty()) {
-            AutoScaleAction.autoScale("selection");
+            AutoScaleAction.autoScale(AutoScaleMode.SELECTION);
         } else if (MainApplication.isDisplayingMapView()) {
             // make sure this isn't called unless there *is* a MapView