Merge branch 'kjvdh/features/PhylogenyViewer_tabbedsupport' into merge/2_11_2/kjvdh...
[jalview.git] / src / jalview / appletgui / OverviewPanel.java
index f339014..09e54e7 100755 (executable)
  */
 package jalview.appletgui;
 
-import jalview.viewmodel.OverviewDimensionsWithHidden;
+import jalview.util.MessageManager;
+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;
 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;
+
+import javax.swing.SwingUtilities;
 
 public class OverviewPanel extends Panel implements Runnable,
-        MouseMotionListener, MouseListener
+        MouseMotionListener, MouseListener, ViewportListenerI
 {
-  private OverviewDimensionsWithHidden od;
+  private OverviewDimensions od;
 
   private OverviewCanvas oviewCanvas;
 
@@ -42,22 +57,30 @@ public class OverviewPanel extends Panel implements Runnable,
 
   private AlignmentPanel ap;
 
+  private boolean showHidden = true;
+
   private boolean updateRunning = false;
 
+  private boolean draggingBox = false;
+
   public OverviewPanel(AlignmentPanel alPanel)
   {
     this.av = alPanel.av;
     this.ap = alPanel;
     setLayout(null);
 
-    od = new OverviewDimensionsWithHidden(av.getRanges(),
-            (av.isShowAnnotation() && av.getSequenceConsensusHash() != null));
+    od = new OverviewDimensionsShowHidden(av.getRanges(),
+            (av.isShowAnnotation()
+                    && av.getSequenceConsensusHash() != null));
 
     oviewCanvas = new OverviewCanvas(od, av);
     setLayout(new BorderLayout());
     add(oviewCanvas, BorderLayout.CENTER);
 
     setSize(new Dimension(od.getWidth(), od.getHeight()));
+
+    av.getRanges().addPropertyChangeListener(this);
+
     addComponentListener(new ComponentAdapter()
     {
 
@@ -93,38 +116,102 @@ public class OverviewPanel extends Panel implements Runnable,
   @Override
   public void mouseClicked(MouseEvent evt)
   {
+    if ((evt.getModifiersEx()
+            & InputEvent.BUTTON3_DOWN_MASK) == InputEvent.BUTTON3_DOWN_MASK)
+    {
+      showPopupMenu(evt);
+    }
   }
 
   @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.getModifiersEx()
+            & InputEvent.BUTTON3_DOWN_MASK) == InputEvent.BUTTON3_DOWN_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);
-  }
+    if (Platform.isWinRightButton(evt))
+    {
+      showPopupMenu(evt);
+      return;
+    }
 
-  private void mouseAction(MouseEvent evt)
-  {
-    od.updateViewportFromMouse(evt.getX(), evt.getY(), av.getAlignment()
-            .getHiddenSequences(), av.getAlignment().getHiddenColumns(), av
-            .getRanges());
-    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);
   }
 
   /**
@@ -132,6 +219,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);
@@ -139,14 +234,17 @@ public class OverviewPanel extends Panel implements Runnable,
     }
     setSize(new Dimension(od.getWidth(), od.getHeight()));
 
-    if (updateRunning)
+    synchronized (this)
     {
-      oviewCanvas.restartDraw();
-      return;
-    }
+      if (updateRunning)
+      {
+        oviewCanvas.restartDraw();
+        return;
+      }
 
-    updateRunning = true;
-    Thread thread = new Thread(this);
+      updateRunning = true;
+    }
+    Thread thread = new Thread(this, "OverviewUpdateThread");
     thread.start();
     repaint();
     updateRunning = false;
@@ -156,8 +254,9 @@ public class OverviewPanel extends Panel implements Runnable,
   public void run()
   {
     oviewCanvas.draw(av.isShowSequenceFeatures(),
-            (av.isShowAnnotation() && av
-                    .getAlignmentConservationAnnotation() != null), ap);
+            (av.isShowAnnotation()
+                    && av.getAlignmentConservationAnnotation() != null),
+            ap.seqPanel.seqCanvas.getFeatureRenderer());
     setBoxPosition();
   }
 
@@ -166,11 +265,86 @@ public class OverviewPanel extends Panel implements Runnable,
    * changed
    * 
    */
-  public void setBoxPosition()
+  private void setBoxPosition()
   {
-    od.setBoxPosition(av.getAlignment()
-.getHiddenSequences(), av
-            .getAlignment().getHiddenColumns(), av.getRanges());
+    od.setBoxPosition(av.getAlignment().getHiddenSequences(),
+            av.getAlignment().getHiddenColumns());
     repaint();
   }
+
+  /*
+   * Displays the popup menu and acts on user input
+   */
+  private void showPopupMenu(MouseEvent e)
+  {
+    PopupMenu popup = new PopupMenu();
+    ItemListener menuListener = new ItemListener()
+    {
+      @Override
+      public void itemStateChanged(ItemEvent e)
+      {
+        toggleHiddenColumns();
+      }
+    };
+    CheckboxMenuItem item = new CheckboxMenuItem(
+            MessageManager.getString("label.togglehidden"));
+    item.setState(showHidden);
+    popup.add(item);
+    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
+   */
+  private void toggleHiddenColumns()
+  {
+    if (showHidden)
+    {
+      showHidden = false;
+      od = new OverviewDimensionsHideHidden(av.getRanges(),
+              (av.isShowAnnotation()
+                      && av.getAlignmentConservationAnnotation() != null));
+    }
+    else
+    {
+      showHidden = true;
+      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);
+      Frame parent = (Frame) getParent();
+      parent.dispose();
+      parent.setVisible(false);
+    } finally
+    {
+      av = null;
+      if (oviewCanvas != null)
+      {
+        oviewCanvas.dispose();
+      }
+      oviewCanvas = null;
+      ap = null;
+      od = null;
+    }
+  }
 }