Changeset 6992 in josm for trunk/src/org/openstreetmap/josm/gui/NavigatableComponent.java

Timestamp:

2014-04-22T01:06:55+02:00 (10 years ago)

Author:

Don-vip

Message:

cleanup/refactor of NavigatableComponent

File:

• trunk/src/org/openstreetmap/josm/gui/NavigatableComponent.java (modified) (23 diffs)

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

@@ -1 +1 @@
 // License: GPL. See LICENSE file for details.
 package org.openstreetmap.josm.gui;
-
-import static org.openstreetmap.josm.tools.I18n.marktr;
 
 import java.awt.Cursor;
@@ -11 +9 @@
 import java.awt.geom.AffineTransform;
 import java.awt.geom.Point2D;
-import java.text.NumberFormat;
 import java.util.ArrayList;
 import java.util.Collection;
@@ -17 +14 @@
 import java.util.Date;
 import java.util.HashSet;
-import java.util.LinkedHashMap;
 import java.util.LinkedList;
 import java.util.List;
-import java.util.Locale;
 import java.util.Map;
 import java.util.Map.Entry;
@@ -33 +28 @@
 import org.openstreetmap.josm.data.Bounds;
 import org.openstreetmap.josm.data.ProjectionBounds;
+import org.openstreetmap.josm.data.SystemOfMeasurement;
 import org.openstreetmap.josm.data.coor.CachedLatLon;
 import org.openstreetmap.josm.data.coor.EastNorth;
@@ -54 +50 @@
 
 /**
- * An component that can be navigated by a mapmover. Used as map view and for the
+ * A component that can be navigated by a {@link MapMover}. Used as map view and for the
  * zoomer in the download dialog.
  *
  * @author imi
+ * @since 41
  */
 public class NavigatableComponent extends JComponent implements Helpful {
@@ -65 +62 @@
      */
     public interface ZoomChangeListener {
+        /**
+         * Method called when the zoom area has changed.
+         */
         void zoomChanged();
     }
@@ -81 +81 @@
     }
 
-    /**
-     * Simple data class that keeps map center and scale in one object.
-     */
-    public static class ViewportData {
-        private EastNorth center;
-        private Double scale;
-
-        public ViewportData(EastNorth center, Double scale) {
-            this.center = center;
-            this.scale = scale;
-        }
-
-        /**
-         * Return the projected coordinates of the map center
-         * @return the center
-         */
-        public EastNorth getCenter() {
-            return center;
-        }
-
-        /**
-         * Return the scale factor in east-/north-units per pixel.
-         * @return the scale
-         */
-        public Double getScale() {
-            return scale;
-        }
-    }
-
     public static final IntegerProperty PROP_SNAP_DISTANCE = new IntegerProperty("mappaint.node.snap-distance", 10);
 
@@ -146 +117 @@
     }
 
-    /**
-     * the SoM listeners
-     */
     private static final CopyOnWriteArrayList<SoMChangeListener> somChangeListeners = new CopyOnWriteArrayList<SoMChangeListener>();
 
@@ -185 +153 @@
      */
     private double scale = Main.getProjection().getDefaultZoomInPPD();
+
     /**
      * Center n/e coordinate of the desired screen center.
@@ -233 +202 @@
     }
 
-    public String getDist100PixelText()
-    {
+    public String getDist100PixelText() {
         return getDistText(getDist100Pixel());
     }
 
-    public double getDist100Pixel()
-    {
+    public double getDist100Pixel() {
         int w = getWidth()/2;
         int h = getHeight()/2;
@@ -263 +230 @@
      * @param y Y-Pixelposition to get coordinate from
      *
-     * @return Geographic coordinates from a specific pixel coordination
-     *      on the screen.
+     * @return Geographic coordinates from a specific pixel coordination on the screen.
      */
     public EastNorth getEastNorth(int x, int y) {
@@ -549 +515 @@
 
     private class ZoomData {
-        LatLon center;
-        double scale;
+        final LatLon center;
+        final double scale;
 
         public ZoomData(EastNorth center, double scale) {
@@ -731 +697 @@
      *        give the nearest node that is tagged.
      */
-    public final Node getNearestNode(Point p, Predicate<OsmPrimitive> predicate, boolean use_selected) {
-        return getNearestNode(p, predicate, use_selected, null);
+    public final Node getNearestNode(Point p, Predicate<OsmPrimitive> predicate, boolean useSelected) {
+        return getNearestNode(p, predicate, useSelected, null);
     }
 
@@ -811 +777 @@
     /**
      * Convenience method to {@link #getNearestNode(Point, Predicate, boolean)}.
+     * @param p the screen point
+     * @param predicate this parameter imposes a condition on the returned object, e.g.
+     *        give the nearest node that is tagged.
      *
      * @return The nearest node to point p.
@@ -940 +909 @@
      * @param p the point for which to search the nearest segment.
      * @param predicate the returned object has to fulfill certain properties.
-     * @param use_selected whether selected way segments should be preferred.
-     */
-    public final WaySegment getNearestWaySegment(Point p, Predicate<OsmPrimitive> predicate, boolean use_selected) {
+     * @param useSelected whether selected way segments should be preferred.
+     */
+    public final WaySegment getNearestWaySegment(Point p, Predicate<OsmPrimitive> predicate, boolean useSelected) {
         WaySegment wayseg = null, ntsel = null;
 
@@ -959 +928 @@
         }
 
-        return (ntsel != null && use_selected) ? ntsel : wayseg;
+        return (ntsel != null && useSelected) ? ntsel : wayseg;
     }
 
@@ -1017 +986 @@
     /**
      * Convenience method to {@link #getNearestWaySegment(Point, Predicate, boolean)}.
+     * @param p the point for which to search the nearest segment.
+     * @param predicate the returned object has to fulfill certain properties.
      *
      * @return The nearest way segment to point p.
@@ -1177 +1148 @@
      *      that is chosen by the algorithm described.
      * @see #getNearestNode(Point, Predicate)
-     * @see #getNearestNodesImpl(Point, Predicate)
      * @see #getNearestWay(Point, Predicate)
      *
@@ -1223 +1193 @@
     }
 
-    /**
-     * @return o as collection of o's type.
-     */
-    public static <T> Collection<T> asColl(T o) {
-        if (o == null)
-            return Collections.emptySet();
-        return Collections.singleton(o);
-    }
-
     public static double perDist(Point2D pt, Point2D a, Point2D b) {
         if (pt != null && a != null && b != null) {
@@ -1360 +1321 @@
     /**
      * Return a ID which is unique as long as viewport dimensions are the same
+     * @return A unique ID, as long as viewport dimensions are the same
      */
     public int getViewID() {
@@ -1375 +1337 @@
      */
     public static SystemOfMeasurement getSystemOfMeasurement() {
-        SystemOfMeasurement som = SYSTEMS_OF_MEASUREMENT.get(ProjectionPreference.PROP_SYSTEM_OF_MEASUREMENT.get());
+        SystemOfMeasurement som = SystemOfMeasurement.ALL_SYSTEMS.get(ProjectionPreference.PROP_SYSTEM_OF_MEASUREMENT.get());
         if (som == null)
-            return METRIC_SOM;
+            return SystemOfMeasurement.METRIC;
         return som;
     }
@@ -1383 +1345 @@
     /**
      * Sets the current system of measurement.
-     * @param somKey The system of measurement key. Must be defined in {@link NavigatableComponent#SYSTEMS_OF_MEASUREMENT}.
+     * @param somKey The system of measurement key. Must be defined in {@link SystemOfMeasurement#ALL_SYSTEMS}.
      * @since 6056
      * @throws IllegalArgumentException if {@code somKey} is not known
      */
     public static void setSystemOfMeasurement(String somKey) {
-        if (!SYSTEMS_OF_MEASUREMENT.containsKey(somKey)) {
+        if (!SystemOfMeasurement.ALL_SYSTEMS.containsKey(somKey)) {
             throw new IllegalArgumentException("Invalid system of measurement: "+somKey);
         }
@@ -1397 +1359 @@
     }
 
-    /**
-     * A system of units used to express length and area measurements.
-     * @since 3406
-     */
-    public static class SystemOfMeasurement {
-
-        /** First value, in meters, used to translate unit according to above formula. */
-        public final double aValue;
-        /** Second value, in meters, used to translate unit according to above formula. */
-        public final double bValue;
-        /** First unit used to format text. */
-        public final String aName;
-        /** Second unit used to format text. */
-        public final String bName;
-        /** Specific optional area value, in squared meters, between {@code aValue*aValue} and {@code bValue*bValue}. Set to {@code -1} if not used.
-         *  @since 5870 */
-        public final double areaCustomValue;
-        /** Specific optional area unit. Set to {@code null} if not used.
-         *  @since 5870 */
-        public final String areaCustomName;
-
-        /**
-         * System of measurement. Currently covers only length (and area) units.
-         *
-         * If a quantity x is given in m (x_m) and in unit a (x_a) then it translates as
-         * x_a == x_m / aValue
-         *
-         * @param aValue First value, in meters, used to translate unit according to above formula.
-         * @param aName First unit used to format text.
-         * @param bValue Second value, in meters, used to translate unit according to above formula.
-         * @param bName Second unit used to format text.
-         */
-        public SystemOfMeasurement(double aValue, String aName, double bValue, String bName) {
-            this(aValue, aName, bValue, bName, -1, null);
-        }
-
-        /**
-         * System of measurement. Currently covers only length (and area) units.
-         *
-         * If a quantity x is given in m (x_m) and in unit a (x_a) then it translates as
-         * x_a == x_m / aValue
-         *
-         * @param aValue First value, in meters, used to translate unit according to above formula.
-         * @param aName First unit used to format text.
-         * @param bValue Second value, in meters, used to translate unit according to above formula.
-         * @param bName Second unit used to format text.
-         * @param areaCustomValue Specific optional area value, in squared meters, between {@code aValue*aValue} and {@code bValue*bValue}.
-         *                        Set to {@code -1} if not used.
-         * @param areaCustomName Specific optional area unit. Set to {@code null} if not used.
-         *
-         * @since 5870
-         */
-        public SystemOfMeasurement(double aValue, String aName, double bValue, String bName, double areaCustomValue, String areaCustomName) {
-            this.aValue = aValue;
-            this.aName = aName;
-            this.bValue = bValue;
-            this.bName = bName;
-            this.areaCustomValue = areaCustomValue;
-            this.areaCustomName = areaCustomName;
-        }
-
-        /**
-         * Returns the text describing the given distance in this system of measurement.
-         * @param dist The distance in metres
-         * @return The text describing the given distance in this system of measurement.
-         */
-        public String getDistText(double dist) {
-            return getDistText(dist, null, 0.01);
-        }
-
-        /**
-         * Returns the text describing the given distance in this system of measurement.
-         * @param dist The distance in metres
-         * @param format A {@link NumberFormat} to format the area value
-         * @param threshold Values lower than this {@code threshold} are displayed as {@code "< [threshold]"}
-         * @return The text describing the given distance in this system of measurement.
-         * @since 6422
-         */
-        public String getDistText(final double dist, final NumberFormat format, final double threshold) {
-            double a = dist / aValue;
-            if (!Main.pref.getBoolean("system_of_measurement.use_only_lower_unit", false) && a > bValue / aValue)
-                return formatText(dist / bValue, bName, format);
-            else if (a < threshold)
-                return "< " + formatText(threshold, aName, format);
-            else
-                return formatText(a, aName, format);
-        }
-
-        /**
-         * Returns the text describing the given area in this system of measurement.
-         * @param area The area in square metres
-         * @return The text describing the given area in this system of measurement.
-         * @since 5560
-         */
-        public String getAreaText(double area) {
-            return getAreaText(area, null, 0.01);
-        }
-
-        /**
-         * Returns the text describing the given area in this system of measurement.
-         * @param area The area in square metres
-         * @param format A {@link NumberFormat} to format the area value
-         * @param threshold Values lower than this {@code threshold} are displayed as {@code "< [threshold]"}
-         * @return The text describing the given area in this system of measurement.
-         * @since 6422
-         */
-        public String getAreaText(final double area, final NumberFormat format, final double threshold) {
-            double a = area / (aValue*aValue);
-            boolean lowerOnly = Main.pref.getBoolean("system_of_measurement.use_only_lower_unit", false);
-            boolean customAreaOnly = Main.pref.getBoolean("system_of_measurement.use_only_custom_area_unit", false);
-            if ((!lowerOnly && areaCustomValue > 0 && a > areaCustomValue / (aValue*aValue) && a < (bValue*bValue) / (aValue*aValue)) || customAreaOnly)
-                return formatText(area / areaCustomValue, areaCustomName, format);
-            else if (!lowerOnly && a >= (bValue*bValue) / (aValue*aValue))
-                return formatText(area / (bValue * bValue), bName + "\u00b2", format);
-            else if (a < threshold)
-                return "< " + formatText(threshold, aName + "\u00b2", format);
-            else
-                return formatText(a, aName + "\u00b2", format);
-        }
-
-        private static String formatText(double v, String unit, NumberFormat format) {
-            if (format != null) {
-                return format.format(v) + " " + unit;
-            }
-            return String.format(Locale.US, "%." + (v<9.999999 ? 2 : 1) + "f %s", v, unit);
-        }
-    }
-
-    /**
-     * Metric system (international standard).
-     * @since 3406
-     */
-    public static final SystemOfMeasurement METRIC_SOM = new SystemOfMeasurement(1, "m", 1000, "km", 10000, "ha");
-
-    /**
-     * Chinese system.
-     * @since 3406
-     */
-    public static final SystemOfMeasurement CHINESE_SOM = new SystemOfMeasurement(1.0/3.0, "\u5e02\u5c3a" /* chi */, 500, "\u5e02\u91cc" /* li */);
-
-    /**
-     * Imperial system (British Commonwealth and former British Empire).
-     * @since 3406
-     */
-    public static final SystemOfMeasurement IMPERIAL_SOM = new SystemOfMeasurement(0.3048, "ft", 1609.344, "mi", 4046.86, "ac");
-
-    /**
-     * Nautical mile system (navigation, polar exploration).
-     * @since 5549
-     */
-    public static final SystemOfMeasurement NAUTICAL_MILE_SOM = new SystemOfMeasurement(185.2, "kbl", 1852, "NM");
-
-    /**
-     * Known systems of measurement.
-     * @since 3406
-     */
-    public static final Map<String, SystemOfMeasurement> SYSTEMS_OF_MEASUREMENT;
-    static {
-        SYSTEMS_OF_MEASUREMENT = new LinkedHashMap<String, SystemOfMeasurement>();
-        SYSTEMS_OF_MEASUREMENT.put(marktr("Metric"), METRIC_SOM);
-        SYSTEMS_OF_MEASUREMENT.put(marktr("Chinese"), CHINESE_SOM);
-        SYSTEMS_OF_MEASUREMENT.put(marktr("Imperial"), IMPERIAL_SOM);
-        SYSTEMS_OF_MEASUREMENT.put(marktr("Nautical Mile"), NAUTICAL_MILE_SOM);
-    }
-
     private static class CursorInfo {
-        public Cursor cursor;
-        public Object object;
+        final Cursor cursor;
+        final Object object;
         public CursorInfo(Cursor c, Object o) {
             cursor = c;