JAL-3369 JAL-3253-applet adds embedded dim checking for overview frame
[jalview.git] / src / jalview / appletgui / OverviewPanel.java
index b933d30..ef684f7 100755 (executable)
@@ -25,10 +25,13 @@ 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.CheckboxMenuItem;
+import java.awt.Cursor;
 import java.awt.Dimension;
+import java.awt.Frame;
 import java.awt.Panel;
 import java.awt.PopupMenu;
 import java.awt.event.ComponentAdapter;
@@ -39,22 +42,28 @@ import java.awt.event.ItemListener;
 import java.awt.event.MouseEvent;
 import java.awt.event.MouseListener;
 import java.awt.event.MouseMotionListener;
+import java.beans.PropertyChangeEvent;
 
+import javax.swing.SwingUtilities;
+
+@SuppressWarnings("serial")
 public class OverviewPanel extends Panel implements Runnable,
-        MouseMotionListener, MouseListener
+        MouseMotionListener, MouseListener, ViewportListenerI
 {
-  private OverviewDimensions od;
+  OverviewDimensions od;
 
-  private OverviewCanvas oviewCanvas;
+  OverviewCanvas canvas;
 
   private AlignViewport av;
 
-  private AlignmentPanel ap;
+  AlignmentPanel ap;
 
   private boolean showHidden = true;
 
   private boolean updateRunning = false;
 
+  private boolean draggingBox = false;
+
   public OverviewPanel(AlignmentPanel alPanel)
   {
     this.av = alPanel.av;
@@ -62,13 +71,17 @@ public class OverviewPanel extends Panel implements Runnable,
     setLayout(null);
 
     od = new OverviewDimensionsShowHidden(av.getRanges(),
-            (av.isShowAnnotation() && av.getSequenceConsensusHash() != null));
+            (av.isShowAnnotation()
+                    && av.getSequenceConsensusHash() != null));
 
-    oviewCanvas = new OverviewCanvas(od, av);
+    canvas = new OverviewCanvas(this, od, av);
     setLayout(new BorderLayout());
-    add(oviewCanvas, BorderLayout.CENTER);
+    add(canvas, BorderLayout.CENTER);
 
     setSize(new Dimension(od.getWidth(), od.getHeight()));
+
+    av.getRanges().addPropertyChangeListener(this);
+
     addComponentListener(new ComponentAdapter()
     {
 
@@ -104,7 +117,8 @@ public class OverviewPanel extends Panel implements Runnable,
   @Override
   public void mouseClicked(MouseEvent evt)
   {
-    if ((evt.getModifiers() & InputEvent.BUTTON3_MASK) == InputEvent.BUTTON3_MASK)
+    if ((evt.getModifiers()
+            & InputEvent.BUTTON3_MASK) == InputEvent.BUTTON3_MASK)
     {
       showPopupMenu(evt);
     }
@@ -113,42 +127,93 @@ public class OverviewPanel extends Panel implements Runnable,
   @Override
   public void mouseMoved(MouseEvent evt)
   {
+    if (od.isPositionInBox(evt.getX(), evt.getY()))
+    {
+      this.getParent()
+              .setCursor(Cursor.getPredefinedCursor(Cursor.HAND_CURSOR));
+    }
+    else
+    {
+      this.getParent()
+              .setCursor(
+                      Cursor.getPredefinedCursor(Cursor.CROSSHAIR_CURSOR));
+    }
   }
 
   @Override
   public void mousePressed(MouseEvent evt)
   {
-    mouseAction(evt);
+    if ((evt.getModifiers()
+            & InputEvent.BUTTON3_MASK) == InputEvent.BUTTON3_MASK)
+    {
+      if (!Platform.isMac()) // BH was excluding JavaScript
+      {
+        showPopupMenu(evt);
+      }
+    }
+    else
+    {
+      // don't do anything if the mouse press is in the overview's box
+      // (wait to see if it's a drag instead)
+      // otherwise update the viewport
+      if (!od.isPositionInBox(evt.getX(), evt.getY()))
+      { 
+       draggingBox = false;
+
+        // display drag cursor at mouse position
+        setCursor(Cursor.getPredefinedCursor(Cursor.MOVE_CURSOR));
+
+        od.updateViewportFromMouse(evt.getX(), evt.getY(),
+                av.getAlignment().getHiddenSequences(),
+                av.getAlignment().getHiddenColumns());
+        getParent()
+                .setCursor(Cursor.getPredefinedCursor(Cursor.HAND_CURSOR));
+      }
+      else
+      {
+        draggingBox = true;
+        od.setDragPoint(evt.getX(), evt.getY(),
+                av.getAlignment().getHiddenSequences(),
+                av.getAlignment().getHiddenColumns());
+      }
+    }
   }
 
   @Override
   public void mouseReleased(MouseEvent evt)
   {
-    mouseAction(evt);
+    draggingBox = false;
   }
 
   @Override
   public void mouseDragged(MouseEvent evt)
   {
-    mouseAction(evt);
-  }
-
-  private void mouseAction(MouseEvent evt)
-  {
-    if ((evt.getModifiers() & InputEvent.BUTTON3_MASK) == InputEvent.BUTTON3_MASK)
+    if (Platform.isWinRightButton(evt)) 
     {
-      if (!Platform.isAMac())
-      {
-        showPopupMenu(evt);
-      }
+       showPopupMenu(evt);
+       return;
     }
-    else
-    {
-      od.updateViewportFromMouse(evt.getX(), evt.getY(), av.getAlignment()
-              .getHiddenSequences(), av.getAlignment().getHiddenColumns());
-      ap.setScrollValues(od.getScrollCol(), od.getScrollRow());
-      ap.paintAlignment(false);
+
+    if (SwingUtilities.isRightMouseButton(evt))
+    { 
+       return;
     }
+    
+         if (draggingBox)
+         {
+           // set the mouse position as a fixed point in the box
+           // and drag relative to that position
+           od.adjustViewportFromMouse(evt.getX(), evt.getY(),
+                   av.getAlignment().getHiddenSequences(),
+                   av.getAlignment().getHiddenColumns());
+         }
+         else
+         {
+           od.updateViewportFromMouse(evt.getX(), evt.getY(),
+                   av.getAlignment().getHiddenSequences(),
+                   av.getAlignment().getHiddenColumns());
+         }
+         ap.paintAlignment(false, false);
   }
 
   /**
@@ -156,6 +221,14 @@ public class OverviewPanel extends Panel implements Runnable,
    */
   public void updateOverviewImage()
   {
+    if (canvas == null)
+    {
+      /*
+       * panel has been disposed
+       */
+      return;
+    }
+
     if ((getSize().width > 0) && (getSize().height > 0))
     {
       od.setWidth(getSize().width);
@@ -167,7 +240,7 @@ public class OverviewPanel extends Panel implements Runnable,
     {
       if (updateRunning)
       {
-        oviewCanvas.restartDraw();
+        canvas.restartDraw();
         return;
       }
 
@@ -182,9 +255,9 @@ public class OverviewPanel extends Panel implements Runnable,
   @Override
   public void run()
   {
-    oviewCanvas.draw(av.isShowSequenceFeatures(),
-            (av.isShowAnnotation() && av
-                    .getAlignmentConservationAnnotation() != null),
+    canvas.draw(av.isShowSequenceFeatures(),
+            (av.isShowAnnotation()
+                    && av.getAlignmentConservationAnnotation() != null),
             ap.seqPanel.seqCanvas.getFeatureRenderer());
     setBoxPosition();
   }
@@ -194,11 +267,10 @@ public class OverviewPanel extends Panel implements Runnable,
    * changed
    * 
    */
-  public void setBoxPosition()
+  private void setBoxPosition()
   {
-    od.setBoxPosition(av.getAlignment()
-.getHiddenSequences(), av
-            .getAlignment().getHiddenColumns());
+    od.setBoxPosition(av.getAlignment().getHiddenSequences(),
+            av.getAlignment().getHiddenColumns());
     repaint();
   }
 
@@ -225,6 +297,12 @@ public class OverviewPanel extends Panel implements Runnable,
     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
    */
@@ -234,17 +312,41 @@ public class OverviewPanel extends Panel implements Runnable,
     {
       showHidden = false;
       od = new OverviewDimensionsHideHidden(av.getRanges(),
-              (av.isShowAnnotation() && av
-                      .getAlignmentConservationAnnotation() != null));
+              (av.isShowAnnotation()
+                      && av.getAlignmentConservationAnnotation() != null));
     }
     else
     {
       showHidden = true;
       od = new OverviewDimensionsShowHidden(av.getRanges(),
-              (av.isShowAnnotation() && av
-                      .getAlignmentConservationAnnotation() != null));
+              (av.isShowAnnotation()
+                      && av.getAlignmentConservationAnnotation() != null));
     }
-    oviewCanvas.resetOviewDims(od);
+    canvas.resetOviewDims(od);
     updateOverviewImage();
   }
+
+  /**
+   * Removes this object as a property change listener, and nulls references
+   */
+  protected void dispose()
+  {
+    try
+    {
+      av.getRanges().removePropertyChangeListener(this);
+      Frame parent = (Frame) getParent();
+      parent.dispose();
+      parent.setVisible(false);
+    } finally
+    {
+      av = null;
+      if (canvas != null)
+      {
+        canvas.dispose();
+      }
+      canvas = null;
+      ap = null;
+      od = null;
+    }
+  }
 }