Merge branch 'bug/JAL-2934proportionalScrolling' into develop
[jalview.git] / src / jalview / gui / AnnotationPanel.java
index 2177a26..ea32684 100755 (executable)
@@ -68,10 +68,12 @@ import jalview.renderer.AwtRenderPanelI;
 import jalview.renderer.ContactGeometry;
 import jalview.schemes.ResidueProperties;
 import jalview.util.Comparison;
+import jalview.util.Format;
 import jalview.util.MessageManager;
 import jalview.util.Platform;
 import jalview.viewmodel.ViewportListenerI;
 import jalview.viewmodel.ViewportRanges;
+import jalview.ws.datamodel.MappableContactMatrixI;
 import jalview.ws.datamodel.alphafold.PAEContactMatrix;
 
 /**
@@ -190,21 +192,27 @@ public class AnnotationPanel extends JPanel implements AwtRenderPanelI,
     renderer = new AnnotationRenderer();
   }
 
+  /**
+   * Responds to a mouse wheel movement by scrolling the annotations up or down.
+   * Annotation labels are scrolled via method adjustmentValueChanged when the
+   * vertical scrollbar is adjusted.
+   * <p>
+   * If shift is pressed, then scrolling is left or right instead, and is
+   * delegated to AlignmentPanel, so that both sequences and annotations are
+   * scrolled together.
+   * <p>
+   * This object is a MouseWheelListener to AnnotationLabels, so mouse wheel
+   * events over the labels are delegated to this method.
+   * <p>
+   * Note that this method may also be fired by scrolling with a gesture on a
+   * trackpad.
+   */
   @Override
   public void mouseWheelMoved(MouseWheelEvent e)
   {
     if (e.isShiftDown())
     {
-      e.consume();
-      double wheelRotation = e.getPreciseWheelRotation();
-      if (wheelRotation > 0)
-      {
-        av.getRanges().scrollRight(true);
-      }
-      else if (wheelRotation < 0)
-      {
-        av.getRanges().scrollRight(false);
-      }
+      ap.getSeqPanel().mouseWheelMoved(e);
     }
     else
     {
@@ -605,7 +613,8 @@ public class AnnotationPanel extends JPanel implements AwtRenderPanelI,
     }
     else
     {
-      // no row (or row that can be adjusted) was pressed. Simulate a ruler click
+      // no row (or row that can be adjusted) was pressed. Simulate a ruler
+      // click
       ap.getScalePanel().mousePressed(evt);
     }
   }
@@ -628,7 +637,13 @@ public class AnnotationPanel extends JPanel implements AwtRenderPanelI,
       return false;
     }
     int yOffset = rowIndex[1];
-
+    AlignmentAnnotation[] allAnnotation = av.getAlignment()
+            .getAlignmentAnnotation();
+    if (allAnnotation == null || rowIndex[0] < 0
+            || rowIndex[0] >= allAnnotation.length)
+    {
+      return false;
+    }
     AlignmentAnnotation clicked = av.getAlignment()
             .getAlignmentAnnotation()[rowIndex[0]];
     if (clicked.graph != AlignmentAnnotation.CONTACT_MAP)
@@ -645,100 +660,130 @@ public class AnnotationPanel extends JPanel implements AwtRenderPanelI,
     {
       ContactGeometry cXcgeom = new ContactGeometry(forCurrentX,
               clicked.graphHeight);
-      ContactGeometry.contactInterval cXci = cXcgeom.mapFor(yOffset,
-              yOffset);
-      /**
-       * start and end range corresponding to the row range under the mouse at
-       * column currentX
-       */
-      int fr, to;
-      fr = Math.min(cXci.cStart, cXci.cEnd);
-      to = Math.max(cXci.cStart, cXci.cEnd);
-
-      // double click selects the whole group
-      if (evt.getClickCount() == 2)
+      ContactGeometry.contactInterval cXci = cXcgeom.mapFor(yOffset);
+      if (cXci != null)
       {
-        ContactMatrixI matrix = av.getContactMatrix(clicked);
+        /**
+         * start and end range corresponding to the row range under the mouse at
+         * column currentX
+         */
+        int fr, to;
+        fr = Math.min(cXci.cStart, cXci.cEnd);
+        to = Math.max(cXci.cStart, cXci.cEnd);
 
-        if (matrix != null)
+        // double click selects the whole group
+        if (evt.getClickCount() == 2)
         {
-          // simplest approach is to select all group containing column
-          if (matrix.hasGroups())
+          ContactMatrixI matrix = av.getContactMatrix(clicked);
+
+          if (matrix != null)
           {
-            SequenceI rseq = clicked.sequenceRef;
-            BitSet grp = matrix.getGroupsFor(currentX);
-            // TODO: cXci needs to be mapped to real groups
-            for (int c = fr; c <= to; c++)
+            // simplest approach is to select all group containing column
+            if (matrix.hasGroups())
             {
-              BitSet additionalGrp = matrix.getGroupsFor(c);
-              grp.or(additionalGrp);
-            }
-            HiddenColumns hc = av.getAlignment().getHiddenColumns();
-            for (int p = grp.nextSetBit(0); p >= 0; p = grp
-                    .nextSetBit(p + 1))
-            {
-              int offp = (rseq != null)
-                      ? rseq.findIndex(rseq.getStart() - 1 + p)
-                      : p;
+              SequenceI rseq = clicked.sequenceRef;
+              BitSet grp = new BitSet();
+              grp.or(matrix.getGroupsFor(forCurrentX.getPosition()));
+              // TODO: cXci needs to be mapped to real groups
+              for (int c = fr; c <= to; c++)
+              {
+                BitSet additionalGrp = matrix.getGroupsFor(c);
+                grp.or(additionalGrp);
+              }
 
-              if (!av.hasHiddenColumns() || hc.isVisible(offp))
+              HiddenColumns hc = av.getAlignment().getHiddenColumns();
+              ColumnSelection cs = av.getColumnSelection();
+
+              for (int p = grp.nextSetBit(0); p >= 0; p = grp
+                      .nextSetBit(p + 1))
               {
-                av.getColumnSelection().addElement(offp);
+                if (matrix instanceof MappableContactMatrixI)
+                {
+                  // find the end of this run of set bits
+                  int nextp = grp.nextClearBit(p) - 1;
+                  int[] pos = ((MappableContactMatrixI) matrix)
+                          .getMappedPositionsFor(rseq, p, nextp);
+                  p = nextp;
+
+                  if (pos != null)
+                  {
+                    for (int pos_p = pos[0]; pos_p <= pos[1]; pos_p++)
+                    {
+                      int col = rseq.findIndex(pos_p) - 1;
+                      if (col >= 0 && (!av.hasHiddenColumns()
+                              || hc.isVisible(col)))
+                      {
+                        cs.addElement(col);
+                      }
+                    }
+                  }
+                }
+                else
+                {
+                  int offp = (rseq != null)
+                          ? rseq.findIndex(rseq.getStart() - 1 + p)
+                          : p;
+
+                  if (!av.hasHiddenColumns() || hc.isVisible(offp))
+                  {
+                    cs.addElement(offp);
+                  }
+                }
               }
             }
-          }
-          // possible alternative for interactive selection - threshold
-          // gives 'ceiling' for forming a cluster
-          // when a row+column is selected, farthest common ancestor less
-          // than thr is used to compute cluster
+            // possible alternative for interactive selection - threshold
+            // gives 'ceiling' for forming a cluster
+            // when a row+column is selected, farthest common ancestor less
+            // than thr is used to compute cluster
 
+          }
         }
-      }
-      else
-      {
-        // select corresponding range in segment under mouse
+        else
         {
-          int[] rng = forCurrentX.getMappedPositionsFor(fr, to);
-          if (rng != null)
+          // select corresponding range in segment under mouse
           {
-            av.getColumnSelection().addRangeOfElements(rng, true);
+            int[] rng = forCurrentX.getMappedPositionsFor(fr, to);
+            if (rng != null)
+            {
+              av.getColumnSelection().addRangeOfElements(rng, true);
+            }
+            av.getColumnSelection().addElement(currentX);
           }
-          av.getColumnSelection().addElement(currentX);
-        }
-        // PAE SPECIFIC
-        // and also select everything lower than the max range adjacent
-        // (kind of works)
-        if (evt.isControlDown()
-                && PAEContactMatrix.PAEMATRIX.equals(clicked.getCalcId()))
-        {
-          int c = fr - 1;
-          ContactRange cr = forCurrentX.getRangeFor(fr, to);
-          double cval;
-          // TODO: could use GraphLine instead of arbitrary picking
-          // TODO: could report mean/median/variance for partitions
-          // (contiguous selected vs unselected regions and inter-contig
-          // regions)
-          // controls feathering - what other elements in row/column
-          // should we select
-          double thresh = cr.getMean() + (cr.getMax() - cr.getMean()) * .15;
-          while (c > 0)
+          // PAE SPECIFIC
+          // and also select everything lower than the max range adjacent
+          // (kind of works)
+          if (evt.isControlDown()
+                  && PAEContactMatrix.PAEMATRIX.equals(clicked.getCalcId()))
           {
-            cval = forCurrentX.getContactAt(c);
-            if (// cr.getMin() <= cval &&
-            cval <= thresh)
+            int c = fr;
+            ContactRange cr = forCurrentX.getRangeFor(fr, to);
+            double cval;
+            // TODO: could use GraphLine instead of arbitrary picking
+            // TODO: could report mean/median/variance for partitions
+            // (contiguous selected vs unselected regions and inter-contig
+            // regions)
+            // controls feathering - what other elements in row/column
+            // should we select
+            double thresh = cr.getMean()
+                    + (cr.getMax() - cr.getMean()) * .15;
+            while (c >= 0)
             {
-              int[] cols = forCurrentX.getMappedPositionsFor(c, c);
-              if (cols != null)
-              {
-                av.getColumnSelection().addRangeOfElements(cols, true);
-              }
-              else
+              cval = forCurrentX.getContactAt(c);
+              if (// cr.getMin() <= cval &&
+              cval <= thresh)
               {
-                break;
+                int[] cols = forCurrentX.getMappedPositionsFor(c, c);
+                if (cols != null)
+                {
+                  av.getColumnSelection().addRangeOfElements(cols, true);
+                }
+                else
+                {
+                  break;
+                }
               }
+              c--;
             }
-            c--;
-          }
             c = to;
             while (c < forCurrentX.getContactHeight())
             {
@@ -760,6 +805,8 @@ public class AnnotationPanel extends JPanel implements AwtRenderPanelI,
 
             }
           }
+
+        }
       }
     }
     ap.paintAlignment(false, false);
@@ -767,6 +814,7 @@ public class AnnotationPanel extends JPanel implements AwtRenderPanelI,
     av.sendSelection();
     return true;
   }
+
   /**
    * Construct and display a context menu at the right-click position
    * 
@@ -1031,7 +1079,8 @@ public class AnnotationPanel extends JPanel implements AwtRenderPanelI,
     }
     if (rowIndex[0] != toRowIndex[0])
     {
-      jalview.bin.Console.trace("Drag went to another row. needs to be clipped");
+      jalview.bin.Console
+              .trace("Drag went to another row. needs to be clipped");
     }
 
     // rectangular selection on matrix style annotation
@@ -1047,23 +1096,22 @@ public class AnnotationPanel extends JPanel implements AwtRenderPanelI,
 
     if (forFromX != null && forToX != null)
     {
-      ContactGeometry lastXcgeom = new ContactGeometry(forFromX,
+      // FIXME will need two ContactGeometry objects when handling contact
+      // matrices with differing numbers of rows at each
+      // column
+      ContactGeometry xcgeom = new ContactGeometry(forFromX,
               cma.graphHeight);
-      ContactGeometry.contactInterval lastXci = lastXcgeom
-              .mapFor(rowIndex[1], rowIndex[1] - deltaY);
-
-      ContactGeometry cXcgeom = new ContactGeometry(forToX,
-              cma.graphHeight);
-      ContactGeometry.contactInterval cXci = cXcgeom.mapFor(rowIndex[1],
-              rowIndex[1] - deltaY);
+      ContactGeometry.contactInterval lastXci = xcgeom.mapFor(rowIndex[1]);
+      ContactGeometry.contactInterval cXci = xcgeom
+              .mapFor(rowIndex[1] + deltaY);
 
       // mark rectangular region formed by drag
       jalview.bin.Console.trace("Matrix Selection from last(" + fromXc
               + ",[" + lastXci.cStart + "," + lastXci.cEnd + "]) to cur("
               + toXc + ",[" + cXci.cStart + "," + cXci.cEnd + "])");
       int fr, to;
-      fr = Math.min(lastXci.cStart, lastXci.cEnd);
-      to = Math.max(lastXci.cStart, lastXci.cEnd);
+      fr = Math.min(lastXci.cStart, cXci.cStart);
+      to = Math.max(lastXci.cEnd, cXci.cEnd);
       int[] mappedPos = forFromX.getMappedPositionsFor(fr, to);
       if (mappedPos != null)
       {
@@ -1073,40 +1121,15 @@ public class AnnotationPanel extends JPanel implements AwtRenderPanelI,
         for (int pair = 0; pair < mappedPos.length; pair += 2)
         {
           for (int c = mappedPos[pair]; c <= mappedPos[pair + 1]; c++)
-//          {
-//            if (cma.sequenceRef != null)
-//            {
-//              int col = cma.sequenceRef.findIndex(cma.sequenceRef.getStart()+c);
-//              av.getColumnSelection().addElement(col);
-//            }
-//            else
-            {
-              av.getColumnSelection().addElement(c);
-            }
-        }
-      }
-      // and again for most recent corner of drag
-      fr = Math.min(cXci.cStart, cXci.cEnd);
-      to = Math.max(cXci.cStart, cXci.cEnd);
-      mappedPos = forFromX.getMappedPositionsFor(fr, to);
-      if (mappedPos != null)
-      {
-        for (int pair = 0; pair < mappedPos.length; pair += 2)
-        {
-          jalview.bin.Console.trace("Marking " + fr + " to " + to
-                  + " mapping to sequence positions " + mappedPos[pair] + " to "
-                  + mappedPos[pair+1]);
-          for (int c = mappedPos[pair]; c <= mappedPos[pair + 1]; c++)
+          // {
+          // if (cma.sequenceRef != null)
+          // {
+          // int col = cma.sequenceRef.findIndex(cma.sequenceRef.getStart()+c);
+          // av.getColumnSelection().addElement(col);
+          // }
+          // else
           {
-//            if (cma.sequenceRef != null)
-//            {
-//              int col = cma.sequenceRef.findIndex(cma.sequenceRef.getStart()+c);
-//              av.getColumnSelection().addElement(col);
-//            }
-//            else
-            {
-              av.getColumnSelection().addElement(c);
-            }
+            av.getColumnSelection().addElement(c - 1);
           }
         }
       }
@@ -1218,7 +1241,7 @@ public class AnnotationPanel extends JPanel implements AwtRenderPanelI,
       {
         row = i;
         res[0] = row;
-        res[1] = height - yPos;
+        res[1] = yPos - lheight;
         break;
       }
     }
@@ -1272,15 +1295,22 @@ public class AnnotationPanel extends JPanel implements AwtRenderPanelI,
     // TODO abstract tooltip generator so different implementations can be built
     if (ann.graph == AlignmentAnnotation.CONTACT_MAP)
     {
+      if (rowAndOffset >= ann.graphHeight)
+      {
+        return null;
+      }
       ContactListI clist = av.getContactList(ann, column);
       if (clist != null)
       {
         ContactGeometry cgeom = new ContactGeometry(clist, ann.graphHeight);
         ContactGeometry.contactInterval ci = cgeom.mapFor(rowAndOffset);
         ContactRange cr = clist.getRangeFor(ci.cStart, ci.cEnd);
-        tooltip = "Contact from " + clist.getPosition() + ", [" + ci.cStart
-                + " - " + ci.cEnd + "]" + "<br/>Mean:" + cr.getMean();
-        
+        StringBuilder tooltipb = new StringBuilder();
+        tooltipb.append("Contact from ").append(clist.getPosition())
+                .append(", [").append(ci.cStart).append(" - ")
+                .append(ci.cEnd).append("]").append("<br/>Mean:");
+        Format.appendPercentage(tooltipb, (float) cr.getMean(), 2);
+        tooltip = tooltipb.toString();
         int col = ann.sequenceRef.findPosition(column);
         int[][] highlightPos;
         int[] mappedPos = clist.getMappedPositionsFor(ci.cStart, ci.cEnd);
@@ -1453,8 +1483,7 @@ public class AnnotationPanel extends JPanel implements AwtRenderPanelI,
         return;
       }
     }
-    imgWidth = (av.getRanges().getEndRes() - av.getRanges().getStartRes()
-            + 1) * av.getCharWidth();
+    updateFadedImageWidth();
     if (imgWidth < 1)
     {
       return;
@@ -1475,7 +1504,7 @@ public class AnnotationPanel extends JPanel implements AwtRenderPanelI,
           tried = true;
         } catch (IllegalArgumentException exc)
         {
-          System.err.println(
+          jalview.bin.Console.errPrintln(
                   "Serious issue with viewport geometry imgWidth requested was "
                           + imgWidth);
           return;
@@ -1522,6 +1551,13 @@ public class AnnotationPanel extends JPanel implements AwtRenderPanelI,
     g.drawImage(image, 0, 0, this);
   }
 
+  public void updateFadedImageWidth()
+  {
+    imgWidth = (av.getRanges().getEndRes() - av.getRanges().getStartRes()
+            + 1) * av.getCharWidth();
+
+  }
+
   /**
    * set true to enable redraw timing debug output on stderr
    */
@@ -1611,7 +1647,8 @@ public class AnnotationPanel extends JPanel implements AwtRenderPanelI,
               && (fadedImage == null || fadedImage.getWidth() != imgWidth
                       || fadedImage.getHeight() != image.getHeight()))
       {
-        // System.err.println("redraw faded image ("+(fadedImage==null ?
+        // jalview.bin.Console.errPrintln("redraw faded image
+        // ("+(fadedImage==null ?
         // "null image" : "") + " lastGood="+lastImageGood+")");
         fadedImage = new BufferedImage(imgWidth, image.getHeight(),
                 BufferedImage.TYPE_INT_RGB);
@@ -1697,6 +1734,7 @@ public class AnnotationPanel extends JPanel implements AwtRenderPanelI,
   @Override
   public int getFadedImageWidth()
   {
+    updateFadedImageWidth();
     return imgWidth;
   }