JAL-1161 JAL-1160 implement custom mousewheel listener and increased scroll increment...
[jalview.git] / src / jalview / gui / AnnotationPanel.java
index 2faba52..411c244 100755 (executable)
@@ -1,18 +1,18 @@
 /*
  * Jalview - A Sequence Alignment Editor and Viewer (Version 2.7)
  * Copyright (C) 2011 J Procter, AM Waterhouse, J Engelhardt, LM Lui, G Barton, M Clamp, S Searle
- * 
+ *
  * This file is part of Jalview.
- * 
+ *
  * Jalview is free software: you can redistribute it and/or
- * modify it under the terms of the GNU General Public License 
+ * modify it under the terms of the GNU General Public License
  * as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
- * 
- * Jalview is distributed in the hope that it will be useful, but 
- * WITHOUT ANY WARRANTY; without even the implied warranty 
- * of MERCHANTABILITY or FITNESS FOR A PARTICULAR 
+ *
+ * Jalview is distributed in the hope that it will be useful, but
+ * WITHOUT ANY WARRANTY; without even the implied warranty
+ * of MERCHANTABILITY or FITNESS FOR A PARTICULAR
  * PURPOSE.  See the GNU General Public License for more details.
- * 
+ *
  * You should have received a copy of the GNU General Public License along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
  */
 package jalview.gui;
@@ -20,25 +20,20 @@ package jalview.gui;
 import java.awt.*;
 import java.awt.event.*;
 import java.awt.image.*;
-import java.util.Hashtable;
-
 import javax.swing.*;
 
-import jalview.analysis.AAFrequency;
-import jalview.analysis.StructureFrequency;
 import jalview.datamodel.*;
 import jalview.renderer.AnnotationRenderer;
 import jalview.renderer.AwtRenderPanelI;
 
 /**
- * DOCUMENT ME!
- * 
+ * AnnotationPanel displays visible portion of annotation rows below unwrapped alignment 
  * @author $author$
  * @version $Revision$
  */
 public class AnnotationPanel extends JPanel implements AwtRenderPanelI,
-        MouseListener, MouseMotionListener, ActionListener,
-        AdjustmentListener
+        MouseListener, MouseWheelListener, MouseMotionListener,
+        ActionListener, AdjustmentListener, Scrollable
 {
   final String HELIX = "Helix";
 
@@ -70,7 +65,7 @@ public class AnnotationPanel extends JPanel implements AwtRenderPanelI,
 
   public BufferedImage image;
 
-  public BufferedImage fadedImage;
+  public volatile BufferedImage fadedImage;
 
   Graphics2D gg;
 
@@ -100,9 +95,11 @@ public class AnnotationPanel extends JPanel implements AwtRenderPanelI,
 
   public final AnnotationRenderer renderer;
 
+  private MouseWheelListener[] _mwl;
+
   /**
    * Creates a new AnnotationPanel object.
-   * 
+   *
    * @param ap
    *          DOCUMENT ME!
    */
@@ -121,6 +118,10 @@ public class AnnotationPanel extends JPanel implements AwtRenderPanelI,
     addMouseMotionListener(this);
     ap.annotationScroller.getVerticalScrollBar()
             .addAdjustmentListener(this);
+    // save any wheel listeners on the scroller, so we can propagate scroll events to them.
+    _mwl = ap.annotationScroller.getMouseWheelListeners();
+    // and then set our own listener to consume all mousewheel events
+    ap.annotationScroller.addMouseWheelListener(this);
     renderer = new AnnotationRenderer();
   }
 
@@ -130,14 +131,78 @@ public class AnnotationPanel extends JPanel implements AwtRenderPanelI,
     renderer = new AnnotationRenderer();
   }
 
-  /**
-   * DOCUMENT ME!
-   * 
-   * @param evt
-   *          DOCUMENT ME!
+  @Override
+  public void mouseWheelMoved(MouseWheelEvent e)
+  {
+    if (e.isShiftDown())
+    {
+      e.consume();
+      if (e.getWheelRotation() > 0)
+      {
+        ap.scrollRight(true);
+      }
+      else
+      {
+        ap.scrollRight(false);
+      }
+    }
+    else
+    {
+      // TODO: find the correct way to let the event bubble up to ap.annotationScroller
+      for (MouseWheelListener mwl : _mwl)
+      {
+        if (mwl != null)
+        {
+          mwl.mouseWheelMoved(e);
+        }
+        if (e.isConsumed())
+        {
+          break;
+        }
+      }
+    }
+  }
+
+  @Override
+  public Dimension getPreferredScrollableViewportSize()
+  {
+    return getPreferredSize();
+  }
+
+  @Override
+  public int getScrollableBlockIncrement(Rectangle visibleRect,
+          int orientation, int direction)
+  {
+    return 30;
+  }
+
+  @Override
+  public boolean getScrollableTracksViewportHeight()
+  {
+    return false;
+  }
+
+  @Override
+  public boolean getScrollableTracksViewportWidth()
+  {
+    return true;
+  }
+
+  @Override
+  public int getScrollableUnitIncrement(Rectangle visibleRect,
+          int orientation, int direction)
+  {
+    return 30;
+  }
+
+  /*
+   * (non-Javadoc)
+   * @see java.awt.event.AdjustmentListener#adjustmentValueChanged(java.awt.event.AdjustmentEvent)
    */
+  @Override
   public void adjustmentValueChanged(AdjustmentEvent evt)
   {
+    // update annotation label display
     ap.alabels.setScrollOffset(-evt.getValue());
   }
 
@@ -145,11 +210,11 @@ public class AnnotationPanel extends JPanel implements AwtRenderPanelI,
    * Calculates the height of the annotation displayed in the annotation panel.
    * Callers should normally call the ap.adjustAnnotationHeight method to ensure
    * all annotation associated components are updated correctly.
-   * 
+   *
    */
   public int adjustPanelHeight()
   {
-    int height = calcPanelHeight();
+    int height = av.calcPanelHeight();
     this.setPreferredSize(new Dimension(1, height));
     if (ap != null)
     {
@@ -161,70 +226,12 @@ public class AnnotationPanel extends JPanel implements AwtRenderPanelI,
   }
 
   /**
-   * calculate the height for visible annotation, revalidating bounds where
-   * necessary ABSTRACT GUI METHOD
-   * 
-   * @return total height of annotation
-   */
-  public int calcPanelHeight()
-  {
-    // setHeight of panels
-    AlignmentAnnotation[] aa = av.getAlignment().getAlignmentAnnotation();
-    int height = 0;
-
-    if (aa != null)
-    {
-      for (int i = 0; i < aa.length; i++)
-      {
-        if (aa[i] == null)
-        {
-          System.err.println("Null annotation row: ignoring.");
-          continue;
-        }
-        if (!aa[i].visible)
-        {
-          continue;
-        }
-
-        aa[i].height = 0;
-
-        if (aa[i].hasText)
-        {
-          aa[i].height += av.charHeight;
-        }
-
-        if (aa[i].hasIcons)
-        {
-          aa[i].height += 16;
-        }
-
-        if (aa[i].graph > 0)
-        {
-          aa[i].height += aa[i].graphHeight;
-        }
-
-        if (aa[i].height == 0)
-        {
-          aa[i].height = 20;
-        }
-
-        height += aa[i].height;
-      }
-    }
-    if (height == 0)
-    {
-      // set minimum
-      height = 20;
-    }
-    return height;
-  }
-
-  /**
    * DOCUMENT ME!
-   * 
+   *
    * @param evt
    *          DOCUMENT ME!
    */
+  @Override
   public void actionPerformed(ActionEvent evt)
   {
     AlignmentAnnotation[] aa = av.getAlignment().getAlignmentAnnotation();
@@ -365,6 +372,7 @@ public class AnnotationPanel extends JPanel implements AwtRenderPanelI,
     aa[activeRow].validateRangeAndDisplay();
 
     adjustPanelHeight();
+    ap.alignmentChanged();
     repaint();
 
     return;
@@ -418,10 +426,11 @@ public class AnnotationPanel extends JPanel implements AwtRenderPanelI,
 
   /**
    * DOCUMENT ME!
-   * 
+   *
    * @param evt
    *          DOCUMENT ME!
    */
+  @Override
   public void mousePressed(MouseEvent evt)
   {
 
@@ -510,10 +519,11 @@ public class AnnotationPanel extends JPanel implements AwtRenderPanelI,
 
   /**
    * DOCUMENT ME!
-   * 
+   *
    * @param evt
    *          DOCUMENT ME!
    */
+  @Override
   public void mouseReleased(MouseEvent evt)
   {
     graphStretch = -1;
@@ -524,10 +534,11 @@ public class AnnotationPanel extends JPanel implements AwtRenderPanelI,
 
   /**
    * DOCUMENT ME!
-   * 
+   *
    * @param evt
    *          DOCUMENT ME!
    */
+  @Override
   public void mouseEntered(MouseEvent evt)
   {
     ap.scalePanel.mouseEntered(evt);
@@ -535,10 +546,11 @@ public class AnnotationPanel extends JPanel implements AwtRenderPanelI,
 
   /**
    * DOCUMENT ME!
-   * 
+   *
    * @param evt
    *          DOCUMENT ME!
    */
+  @Override
   public void mouseExited(MouseEvent evt)
   {
     ap.scalePanel.mouseExited(evt);
@@ -546,10 +558,11 @@ public class AnnotationPanel extends JPanel implements AwtRenderPanelI,
 
   /**
    * DOCUMENT ME!
-   * 
+   *
    * @param evt
    *          DOCUMENT ME!
    */
+  @Override
   public void mouseDragged(MouseEvent evt)
   {
     if (graphStretch > -1)
@@ -572,10 +585,11 @@ public class AnnotationPanel extends JPanel implements AwtRenderPanelI,
 
   /**
    * DOCUMENT ME!
-   * 
+   *
    * @param evt
    *          DOCUMENT ME!
    */
+  @Override
   public void mouseMoved(MouseEvent evt)
   {
     AlignmentAnnotation[] aa = av.getAlignment().getAlignmentAnnotation();
@@ -618,7 +632,7 @@ public class AnnotationPanel extends JPanel implements AwtRenderPanelI,
     }
 
     if (row > -1 && aa[row].annotations != null
-            && res < (int) aa[row].annotations.length)
+            && res < aa[row].annotations.length)
     {
       if (aa[row].graphGroup > -1)
       {
@@ -671,10 +685,11 @@ public class AnnotationPanel extends JPanel implements AwtRenderPanelI,
 
   /**
    * DOCUMENT ME!
-   * 
+   *
    * @param evt
    *          DOCUMENT ME!
    */
+  @Override
   public void mouseClicked(MouseEvent evt)
   {
     if (activeRow != -1)
@@ -710,13 +725,14 @@ public class AnnotationPanel extends JPanel implements AwtRenderPanelI,
     }
 
   }
-
+  private volatile boolean imageFresh=false;
   /**
    * DOCUMENT ME!
-   * 
+   *
    * @param g
    *          DOCUMENT ME!
    */
+  @Override
   public void paintComponent(Graphics g)
   {
     g.setColor(Color.white);
@@ -752,15 +768,17 @@ public class AnnotationPanel extends JPanel implements AwtRenderPanelI,
       fm = gg.getFontMetrics();
       gg.setColor(Color.white);
       gg.fillRect(0, 0, imgWidth, image.getHeight());
+      imageFresh=true;
     }
 
     drawComponent(gg, av.startRes, av.endRes + 1);
+    imageFresh=false;
     g.drawImage(image, 0, 0, this);
   }
 
   /**
    * non-Thread safe repaint
-   * 
+   *
    * @param horizontal
    *          repaint with horizontal shift in alignment
    */
@@ -801,10 +819,10 @@ public class AnnotationPanel extends JPanel implements AwtRenderPanelI,
     repaint();
 
   }
-
+  private volatile boolean lastImageGood=false;
   /**
    * DOCUMENT ME!
-   * 
+   *
    * @param g
    *          DOCUMENT ME!
    * @param startRes
@@ -814,18 +832,21 @@ public class AnnotationPanel extends JPanel implements AwtRenderPanelI,
    */
   public void drawComponent(Graphics g, int startRes, int endRes)
   {
+    BufferedImage oldFaded=fadedImage;
     if (av.isCalcInProgress())
     {
       if (image == null)
       {
+        lastImageGood=false;
         return;
       }
       // We'll keep a record of the old image,
       // and draw a faded image until the calculation
       // has completed
-      if (fadedImage == null || fadedImage.getWidth() != imgWidth
-              || fadedImage.getHeight() != image.getHeight())
+      if (lastImageGood && (fadedImage == null || fadedImage.getWidth() != imgWidth
+              || fadedImage.getHeight() != image.getHeight()))
       {
+//        System.err.println("redraw faded image ("+(fadedImage==null ? "null image" : "") + " lastGood="+lastImageGood+")");
         fadedImage = new BufferedImage(imgWidth, image.getHeight(),
                 BufferedImage.TYPE_INT_RGB);
 
@@ -839,10 +860,16 @@ public class AnnotationPanel extends JPanel implements AwtRenderPanelI,
         fadedG.drawImage(image, 0, 0, this);
 
       }
+      // make sure we don't overwrite the last good faded image until all calculations have finished
+      lastImageGood=false;
 
     }
     else
     {
+      if (fadedImage!=null)
+      {
+        oldFaded=fadedImage;
+      }
       fadedImage = null;
     }
 
@@ -868,7 +895,11 @@ public class AnnotationPanel extends JPanel implements AwtRenderPanelI,
 
       return;
     }
-    renderer.drawComponent(this, av, g, activeRow, startRes, endRes);
+    lastImageGood = renderer.drawComponent(this, av, g, activeRow, startRes, endRes);
+    if (!lastImageGood && fadedImage==null)
+    {
+      fadedImage=oldFaded;
+    }
   }
 
   @Override