Changeset 5957 in josm

Timestamp:

2013-05-11T23:40:04+02:00 (11 years ago)

Author:

Don-vip

Message:

New interface MapFrameListener to allow core classes to listen to MapFrame changes (previously only plugins could be notified of these changes)

Location:

trunk/src/org/openstreetmap/josm

Files:

• Main.java (modified) (5 diffs)
• gui/MapFrameListener.java (added)
• plugins/Plugin.java (modified) (3 diffs)
• plugins/PluginHandler.java (modified) (2 diffs)

trunk/src/org/openstreetmap/josm/Main.java

@@ -65 +65 @@
 import org.openstreetmap.josm.gui.MainMenu;
 import org.openstreetmap.josm.gui.MapFrame;
+import org.openstreetmap.josm.gui.MapFrameListener;
 import org.openstreetmap.josm.gui.MapView;
 import org.openstreetmap.josm.gui.NavigatableComponent.ViewportData;
@@ -81 +82 @@
 import org.openstreetmap.josm.gui.util.RedirectInputMap;
 import org.openstreetmap.josm.io.OsmApi;
-import org.openstreetmap.josm.plugins.PluginHandler;
 import org.openstreetmap.josm.tools.CheckParameterUtil;
 import org.openstreetmap.josm.tools.I18n;
@@ -189 +189 @@
     private GettingStarted gettingStarted = new GettingStarted();
 
+    private static final Collection<MapFrameListener> mapFrameListeners = new ArrayList<MapFrameListener>();
+
     /**
      * Logging level (3 = debug, 2 = info, 1 = warn, 0 = none).
@@ -281 +283 @@
         Main.map = map;
 
-        PluginHandler.notifyMapFrameChanged(old, map);
+        for (MapFrameListener listener : mapFrameListeners ) {
+            listener.mapFrameInitialized(old, map);
+        }
         if (map == null && currentProgressMonitor != null) {
             currentProgressMonitor.showForegroundDialog();
@@ -1208 +1212 @@
     }
 
+    /**
+     * Registers a new {@code MapFrameListener} that will be notified of MapFrame changes
+     * @param listener The MapFrameListener
+     * @return {@code true} if the listeners collection changed as a result of the call
+     * @since 5957
+     */
+    public static boolean addMapFrameListener(MapFrameListener listener) {
+        return listener != null ? mapFrameListeners.add(listener) : false;
+    }
+
+    /**
+     * Unregisters the given {@code MapFrameListener} from MapFrame changes
+     * @param listener The MapFrameListener
+     * @return {@code true} if the listeners collection changed as a result of the call
+     * @since 5957
+     */
+    public static boolean removeMapFrameListener(MapFrameListener listener) {
+        return listener != null ? mapFrameListeners.remove(listener) : false;
+    }
 }

trunk/src/org/openstreetmap/josm/plugins/Plugin.java

@@ -13 +13 @@
 import org.openstreetmap.josm.Main;
 import org.openstreetmap.josm.gui.MapFrame;
+import org.openstreetmap.josm.gui.MapFrameListener;
 import org.openstreetmap.josm.gui.download.DownloadSelection;
 import org.openstreetmap.josm.gui.preferences.PreferenceSetting;
@@ -38 +39 @@
  * @author Immanuel.Scholz
  */
-public abstract class Plugin {
+public abstract class Plugin implements MapFrameListener {
 
     /**
@@ -83 +84 @@
     }
 
-    /**
-     * Called after Main.mapFrame is initalized. (After the first data is loaded).
-     * You can use this callback to tweak the newFrame to your needs, as example install
-     * an alternative Painter.
-     */
+    @Override
     public void mapFrameInitialized(MapFrame oldFrame, MapFrame newFrame) {}
 

trunk/src/org/openstreetmap/josm/plugins/PluginHandler.java

@@ -508 +508 @@
             if (klass != null) {
                 System.out.println(tr("loading plugin ''{0}'' (version {1})", plugin.name, plugin.localversion));
-                pluginList.add(plugin.load(klass));
+                PluginProxy pluginProxy = plugin.load(klass);
+                pluginList.add(pluginProxy);
+                Main.addMapFrameListener(pluginProxy);
             }
             msg = null;
@@ -919 +921 @@
     }
 
-    /**
-     * Notified loaded plugins about a new map frame
-     *
-     * @param old the old map frame
-     * @param map the new map frame
-     */
-    public static void notifyMapFrameChanged(MapFrame old, MapFrame map) {
-        for (PluginProxy plugin : pluginList) {
-            plugin.mapFrameInitialized(old, map);
-        }
-    }
-
     public static Object getPlugin(String name) {
         for (PluginProxy plugin : pluginList)