Changeset 5406 in josm for trunk/src/org/openstreetmap/josm/gui/MapView.java

Timestamp:

2012-08-08T01:25:25+02:00 (12 years ago)

Author:

Don-vip

Message:

see #7280 - Change synchronization mechanism of MapView when being notified of paint preferences change.

The previous mechanism leads to a deadlock when the paint() method triggers itself a paint preference change, such as when a TMS layer wants to paint attribution.
This caused an HMI freeze of 1s and Bing layer to never display tiles at its first display without cached attribution.

File:

• trunk/src/org/openstreetmap/josm/gui/MapView.java (modified) (10 diffs)

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

@@ -29 +29 @@
 
 import javax.swing.AbstractButton;
+import javax.swing.ActionMap;
+import javax.swing.InputMap;
 import javax.swing.JOptionPane;
 import javax.swing.JPanel;
@@ -56 +58 @@
 
 /**
- * This is a component used in the MapFrame for browsing the map. It use is to
- * provide the MapMode's enough capabilities to operate.
+ * This is a component used in the {@link MapFrame} for browsing the map. It use is to
+ * provide the MapMode's enough capabilities to operate.<br/><br/>
  *
- * MapView hold meta-data about the data set currently displayed, as scale level,
+ * {@code MapView} holds meta-data about the data set currently displayed, as scale level,
  * center point viewed, what scrolling mode or editing mode is selected or with
- * what projection the map is viewed etc..
+ * what projection the map is viewed etc..<br/><br/>
  *
- * MapView is able to administrate several layers.
+ * {@code MapView} is able to administrate several layers.
  *
  * @author imi
@@ -70 +72 @@
 
     /**
-     * Interface to notify listeners of the change of the active layer.
+     * Interface to notify listeners of a layer change.
      * @author imi
      */
     public interface LayerChangeListener {
+        
+        /**
+         * Notifies this listener that the active layer has changed.
+         * @param oldLayer The previous active layer
+         * @param newLayer The new activer layer
+         */
         void activeLayerChange(Layer oldLayer, Layer newLayer);
+        
+        /**
+         * Notifies this listener that a layer has been added.
+         * @param newLayer The new added layer
+         */
         void layerAdded(Layer newLayer);
+        
+        /**
+         * Notifies this listener that a layer has been removed.
+         * @param oldLayer The old removed layer
+         */
         void layerRemoved(Layer oldLayer);
     }
@@ -131 +149 @@
     }
 
+    /**
+     * Adds an edit layer change listener
+     *
+     * @param listener the listener. Ignored if null or already registered.
+     */
     public static void addEditLayerChangeListener(EditLayerChangeListener listener) {
         if (listener != null) {
@@ -193 +216 @@
     private Rectangle lastClipBounds = new Rectangle();
 
+    /**
+     * Constructs a new {@code MapView}.
+     * @param contentPane The content pane used to register shortcuts in its {@link InputMap} and {@link ActionMap}
+     */
     public MapView(final JPanel contentPane) {
         Main.pref.addPreferenceChangeListener(this);
@@ -269 +296 @@
      * Add a layer to the current MapView. The layer will be added at topmost
      * position.
+     * @param layer The layer to add
      */
     public void addLayer(Layer layer) {
@@ -357 +385 @@
      * Remove the layer from the mapview. If the layer was in the list before,
      * an LayerChange event is fired.
+     * @param layer The layer to remove
      */
     public void removeLayer(Layer layer) {
@@ -468 +497 @@
      * Draw the component.
      */
-    @Override public synchronized void paint(Graphics g) {
+    @Override public void paint(Graphics g) {
         if (BugReportExceptionHandler.exceptionHandlingInProgress())
             return;
@@ -486 +515 @@
         }
 
-        boolean canUseBuffer = !paintPreferencesChanged && nonChangedLayers.size() <= nonChangedLayersCount &&
+        boolean canUseBuffer;
+        
+        synchronized (this) {
+            canUseBuffer = !paintPreferencesChanged;
+        }
+        canUseBuffer = canUseBuffer && nonChangedLayers.size() <= nonChangedLayersCount &&
         lastViewID == getViewID() && lastClipBounds.contains(g.getClipBounds());
         if (canUseBuffer) {
@@ -841 +875 @@
     }
 
-    public synchronized void preferenceChanged(PreferenceChangeEvent e) {
-        paintPreferencesChanged = true;
+    @Override
+    public void preferenceChanged(PreferenceChangeEvent e) {
+        synchronized (this) {
+            paintPreferencesChanged = true;
+        }
     }