JAL-2608 tidy up OverviewPanel when closed

[jalview.git] / src / jalview / gui / OverviewPanel.java

diff --git a/src/jalview/gui/OverviewPanel.java b/src/jalview/gui/OverviewPanel.java
index 7750374..7a4456e 100755 (executable)
--- a/src/jalview/gui/OverviewPanel.java
+++ b/src/jalview/gui/OverviewPanel.java
@@ -25,6 +25,7 @@ import jalview.util.Platform;
 import jalview.viewmodel.OverviewDimensions;
 import jalview.viewmodel.OverviewDimensionsHideHidden;
 import jalview.viewmodel.OverviewDimensionsShowHidden;
+import jalview.viewmodel.ViewportListenerI;
 
 import java.awt.BorderLayout;
 import java.awt.Dimension;
@@ -35,8 +36,9 @@ import java.awt.event.ComponentEvent;
 import java.awt.event.MouseAdapter;
 import java.awt.event.MouseEvent;
 import java.awt.event.MouseMotionAdapter;
+import java.beans.PropertyChangeEvent;
 
-import javax.swing.JMenuItem;
+import javax.swing.JCheckBoxMenuItem;
 import javax.swing.JPanel;
 import javax.swing.JPopupMenu;
 import javax.swing.SwingUtilities;
@@ -48,7 +50,8 @@ import javax.swing.SwingUtilities;
  * @author $author$
  * @version $Revision$
  */
-public class OverviewPanel extends JPanel implements Runnable
+public class OverviewPanel extends JPanel implements Runnable,
+        ViewportListenerI
 {
   private OverviewDimensions od;
 
@@ -58,6 +61,8 @@ public class OverviewPanel extends JPanel implements Runnable
 
   private AlignmentPanel ap;
 
+  private JCheckBoxMenuItem displayToggle;
+
   private boolean showHidden = true;
 
   /**
@@ -75,10 +80,14 @@ public class OverviewPanel extends JPanel implements Runnable
             (av.isShowAnnotation() && av
                     .getAlignmentConservationAnnotation() != null));
 
+    setSize(od.getWidth(), od.getHeight());
+
     oviewCanvas = new OverviewCanvas(od, av);
     setLayout(new BorderLayout());
     add(oviewCanvas, BorderLayout.CENTER);
 
+    av.getRanges().addPropertyChangeListener(this);
+
     addComponentListener(new ComponentAdapter()
     {
       @Override
@@ -88,6 +97,7 @@ public class OverviewPanel extends JPanel implements Runnable
                 || (getHeight() != (od.getHeight())))
         {
           updateOverviewImage();
+          setBoxPosition();
         }
       }
     });
@@ -97,13 +107,11 @@ public class OverviewPanel extends JPanel implements Runnable
       @Override
       public void mouseDragged(MouseEvent evt)
       {
-        if (!SwingUtilities.isRightMouseButton(evt)
-                && !av.getWrapAlignment())
+        if (!SwingUtilities.isRightMouseButton(evt))
         {
           od.updateViewportFromMouse(evt.getX(), evt.getY(), av
                   .getAlignment().getHiddenSequences(), av.getAlignment()
                   .getHiddenColumns());
-          ap.setScrollValues(od.getScrollCol(), od.getScrollRow());
         }
       }
     });
@@ -120,12 +128,12 @@ public class OverviewPanel extends JPanel implements Runnable
             showPopupMenu(evt);
           }
         }
-        else if (!av.getWrapAlignment())
+        else
+        // if (!av.getWrapAlignment())
         {
           od.updateViewportFromMouse(evt.getX(), evt.getY(), av
                   .getAlignment().getHiddenSequences(), av.getAlignment()
                   .getHiddenColumns());
-          ap.setScrollValues(od.getScrollCol(), od.getScrollRow());
         }
       }
 
@@ -139,7 +147,6 @@ public class OverviewPanel extends JPanel implements Runnable
       }
     });
 
-
     updateOverviewImage();
   }
 
@@ -156,12 +163,15 @@ public class OverviewPanel extends JPanel implements Runnable
       {
         // switch on/off the hidden columns view
         toggleHiddenColumns();
+        displayToggle.setSelected(showHidden);
       }
     };
-    JMenuItem item = new JMenuItem(
+    displayToggle = new JCheckBoxMenuItem(
             MessageManager.getString("label.togglehidden"));
-    popup.add(item);
-    item.addActionListener(menuListener);
+    displayToggle.setEnabled(true);
+    displayToggle.setSelected(showHidden);
+    popup.add(displayToggle);
+    displayToggle.addActionListener(menuListener);
     popup.show(this, e.getX(), e.getY());
   }
 
@@ -186,6 +196,7 @@ public class OverviewPanel extends JPanel implements Runnable
     }
     oviewCanvas.resetOviewDims(od);
     updateOverviewImage();
+    setBoxPosition();
   }
 
   /**
@@ -193,6 +204,14 @@ public class OverviewPanel extends JPanel implements Runnable
    */
   public void updateOverviewImage()
   {
+    if (oviewCanvas == null)
+    {
+      /*
+       * panel has been disposed
+       */
+      return;
+    }
+
     if ((getWidth() > 0) && (getHeight() > 0))
     {
       od.setWidth(getWidth());
@@ -209,7 +228,6 @@ public class OverviewPanel extends JPanel implements Runnable
     Thread thread = new Thread(this);
     thread.start();
     repaint();
-
   }
 
   @Override
@@ -227,10 +245,33 @@ public class OverviewPanel extends JPanel implements Runnable
    * changed
    * 
    */
-  public void setBoxPosition()
+  private void setBoxPosition()
   {
     od.setBoxPosition(av.getAlignment().getHiddenSequences(), av
             .getAlignment().getHiddenColumns());
     repaint();
   }
+
+  @Override
+  public void propertyChange(PropertyChangeEvent evt)
+  {
+    setBoxPosition();
+  }
+
+  /**
+   * Removes this object as a property change listener, and nulls references
+   */
+  protected void dispose()
+  {
+    try
+    {
+      av.getRanges().removePropertyChangeListener(this);
+    } finally
+    {
+      av = null;
+      oviewCanvas = null;
+      ap = null;
+      od = null;
+    }
+  }
 }