JAL-2608 tidy up OverviewPanel when closed

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

diff --git a/src/jalview/appletgui/OverviewPanel.java b/src/jalview/appletgui/OverviewPanel.java
index 45dfbfc..ccdfee1 100755 (executable)
--- a/src/jalview/appletgui/OverviewPanel.java
+++ b/src/jalview/appletgui/OverviewPanel.java
@@ -23,25 +23,27 @@ package jalview.appletgui;
 import jalview.util.MessageManager;
 import jalview.util.Platform;
 import jalview.viewmodel.OverviewDimensions;
-import jalview.viewmodel.OverviewDimensionsAllVisible;
-import jalview.viewmodel.OverviewDimensionsWithHidden;
+import jalview.viewmodel.OverviewDimensionsHideHidden;
+import jalview.viewmodel.OverviewDimensionsShowHidden;
+import jalview.viewmodel.ViewportListenerI;
 
 import java.awt.BorderLayout;
+import java.awt.CheckboxMenuItem;
 import java.awt.Dimension;
-import java.awt.MenuItem;
 import java.awt.Panel;
 import java.awt.PopupMenu;
-import java.awt.event.ActionEvent;
-import java.awt.event.ActionListener;
 import java.awt.event.ComponentAdapter;
 import java.awt.event.ComponentEvent;
 import java.awt.event.InputEvent;
+import java.awt.event.ItemEvent;
+import java.awt.event.ItemListener;
 import java.awt.event.MouseEvent;
 import java.awt.event.MouseListener;
 import java.awt.event.MouseMotionListener;
+import java.beans.PropertyChangeEvent;
 
 public class OverviewPanel extends Panel implements Runnable,
-        MouseMotionListener, MouseListener
+        MouseMotionListener, MouseListener, ViewportListenerI
 {
   private OverviewDimensions od;
 
@@ -61,7 +63,7 @@ public class OverviewPanel extends Panel implements Runnable,
     this.ap = alPanel;
     setLayout(null);
 
-    od = new OverviewDimensionsWithHidden(av.getRanges(),
+    od = new OverviewDimensionsShowHidden(av.getRanges(),
             (av.isShowAnnotation() && av.getSequenceConsensusHash() != null));
 
     oviewCanvas = new OverviewCanvas(od, av);
@@ -69,6 +71,9 @@ public class OverviewPanel extends Panel implements Runnable,
     add(oviewCanvas, BorderLayout.CENTER);
 
     setSize(new Dimension(od.getWidth(), od.getHeight()));
+
+    av.getRanges().addPropertyChangeListener(this);
+
     addComponentListener(new ComponentAdapter()
     {
 
@@ -146,7 +151,6 @@ public class OverviewPanel extends Panel implements Runnable,
     {
       od.updateViewportFromMouse(evt.getX(), evt.getY(), av.getAlignment()
               .getHiddenSequences(), av.getAlignment().getHiddenColumns());
-      ap.setScrollValues(od.getScrollCol(), od.getScrollRow());
       ap.paintAlignment(false);
     }
   }
@@ -156,6 +160,14 @@ public class OverviewPanel extends Panel implements Runnable,
    */
   public void updateOverviewImage()
   {
+    if (oviewCanvas == null)
+    {
+      /*
+       * panel has been disposed
+       */
+      return;
+    }
+
     if ((getSize().width > 0) && (getSize().height > 0))
     {
       od.setWidth(getSize().width);
@@ -194,7 +206,7 @@ public class OverviewPanel extends Panel implements Runnable,
    * changed
    * 
    */
-  public void setBoxPosition()
+  private void setBoxPosition()
   {
     od.setBoxPosition(av.getAlignment()
 .getHiddenSequences(), av
@@ -208,23 +220,29 @@ public class OverviewPanel extends Panel implements Runnable,
   private void showPopupMenu(MouseEvent e)
   {
     PopupMenu popup = new PopupMenu();
-    ActionListener menuListener = new ActionListener()
+    ItemListener menuListener = new ItemListener()
     {
       @Override
-      public void actionPerformed(ActionEvent event)
+      public void itemStateChanged(ItemEvent e)
       {
-        // switch on/off the hidden columns view
         toggleHiddenColumns();
       }
     };
-    MenuItem item = new MenuItem(
+    CheckboxMenuItem item = new CheckboxMenuItem(
             MessageManager.getString("label.togglehidden"));
+    item.setState(showHidden);
     popup.add(item);
-    item.addActionListener(menuListener);
+    item.addItemListener(menuListener);
     this.add(popup);
     popup.show(this, e.getX(), e.getY());
   }
 
+  @Override
+  public void propertyChange(PropertyChangeEvent evt)
+  {
+    setBoxPosition();
+  }
+
   /*
    * Toggle overview display between showing hidden columns and hiding hidden columns
    */
@@ -233,18 +251,35 @@ public class OverviewPanel extends Panel implements Runnable,
     if (showHidden)
     {
       showHidden = false;
-      od = new OverviewDimensionsAllVisible(av.getRanges(),
+      od = new OverviewDimensionsHideHidden(av.getRanges(),
               (av.isShowAnnotation() && av
                       .getAlignmentConservationAnnotation() != null));
     }
     else
     {
       showHidden = true;
-      od = new OverviewDimensionsWithHidden(av.getRanges(),
+      od = new OverviewDimensionsShowHidden(av.getRanges(),
               (av.isShowAnnotation() && av
                       .getAlignmentConservationAnnotation() != null));
     }
     oviewCanvas.resetOviewDims(od);
     updateOverviewImage();
   }
+
+  /**
+   * 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;
+    }
+  }
 }