Merge branch 'features/JAL-2446NCList' into features/JAL-2609fastPaintWrapped
authorgmungoc <g.m.carstairs@dundee.ac.uk>
Thu, 3 Aug 2017 13:29:40 +0000 (15:29 +0200)
committergmungoc <g.m.carstairs@dundee.ac.uk>
Thu, 3 Aug 2017 13:29:40 +0000 (15:29 +0200)
src/jalview/gui/SeqCanvas.java
src/jalview/gui/SeqPanel.java
src/jalview/renderer/ScaleRenderer.java
test/jalview/renderer/ScaleRendererTest.java

index 0e31246..12b426d 100755 (executable)
@@ -27,6 +27,7 @@ import jalview.datamodel.SequenceGroup;
 import jalview.datamodel.SequenceI;
 import jalview.renderer.ScaleRenderer;
 import jalview.renderer.ScaleRenderer.ScaleMark;
+import jalview.util.Comparison;
 import jalview.viewmodel.ViewportListenerI;
 import jalview.viewmodel.ViewportRanges;
 
@@ -70,6 +71,8 @@ public class SeqCanvas extends JComponent implements ViewportListenerI
 
   boolean fastPaint = false;
 
+  boolean fastpainting = false;
+
   int labelWidthWest;
 
   int labelWidthEast;
@@ -116,22 +119,25 @@ public class SeqCanvas extends JComponent implements ViewportListenerI
   }
 
   /**
-   * DOCUMENT ME!
+   * Draws the scale above a region of a wrapped alignment, consisting of a
+   * column number every major interval (10 columns).
    * 
    * @param g
-   *          DOCUMENT ME!
+   *          the graphics context to draw on, positioned at the start (bottom
+   *          left) of the line on which to draw any scale marks
    * @param startx
-   *          DOCUMENT ME!
+   *          start alignment column (0..)
    * @param endx
-   *          DOCUMENT ME!
+   *          end alignment column (0..)
    * @param ypos
-   *          DOCUMENT ME!
+   *          y offset to draw at
    */
   private void drawNorthScale(Graphics g, int startx, int endx, int ypos)
   {
     updateViewport();
-    for (ScaleMark mark : new ScaleRenderer().calculateMarks(av, startx,
-            endx))
+    List<ScaleMark> marks = new ScaleRenderer().calculateMarks(av, startx,
+            endx);
+    for (ScaleMark mark : marks)
     {
       int mpos = mark.column; // (i - startx - 1)
       if (mpos < 0)
@@ -146,138 +152,115 @@ public class SeqCanvas extends JComponent implements ViewportListenerI
         {
           g.drawString(mstring, mpos * charWidth, ypos - (charHeight / 2));
         }
-        g.drawLine((mpos * charWidth) + (charWidth / 2), (ypos + 2)
-                - (charHeight / 2), (mpos * charWidth) + (charWidth / 2),
-                ypos - 2);
+
+        /*
+         * draw a tick mark below the column number, centred on the column;
+         * height of tick mark is 4 pixels less than half a character
+         */
+        int xpos = (mpos * charWidth) + (charWidth / 2);
+        g.drawLine(xpos, (ypos + 2) - (charHeight / 2), xpos, ypos - 2);
       }
     }
   }
 
   /**
-   * DOCUMENT ME!
+   * Draw the scale to the left or right of a wrapped alignment
    * 
    * @param g
-   *          DOCUMENT ME!
    * @param startx
-   *          DOCUMENT ME!
+   *          first column of wrapped width (0.. excluding any hidden columns)
    * @param endx
-   *          DOCUMENT ME!
+   *          last column of wrapped width (0.. excluding any hidden columns)
    * @param ypos
-   *          DOCUMENT ME!
+   *          vertical offset at which to begin the scale
+   * @param left
+   *          if true, scale is left of residues, if false, scale is right
    */
-  void drawWestScale(Graphics g, int startx, int endx, int ypos)
+  void drawVerticalScale(Graphics g, int startx, int endx, int ypos,
+          boolean left)
   {
-    FontMetrics fm = getFontMetrics(av.getFont());
     ypos += charHeight;
 
     if (av.hasHiddenColumns())
     {
-      startx = av.getAlignment().getHiddenColumns()
-              .adjustForHiddenColumns(startx);
-      endx = av.getAlignment().getHiddenColumns()
-              .adjustForHiddenColumns(endx);
-    }
-
-    int maxwidth = av.getAlignment().getWidth();
-    if (av.hasHiddenColumns())
-    {
-      maxwidth = av.getAlignment().getHiddenColumns()
-              .findColumnPosition(maxwidth) - 1;
+      HiddenColumns hiddenColumns = av.getAlignment().getHiddenColumns();
+      startx = hiddenColumns.adjustForHiddenColumns(startx);
+      endx = hiddenColumns.adjustForHiddenColumns(endx);
     }
+    FontMetrics fm = getFontMetrics(av.getFont());
 
-    // WEST SCALE
     for (int i = 0; i < av.getAlignment().getHeight(); i++)
     {
       SequenceI seq = av.getAlignment().getSequenceAt(i);
-      int index = startx;
-      int value = -1;
 
-      while (index < endx)
+      /*
+       * find sequence position of first non-gapped position -
+       * to the right if scale left, to the left if scale right
+       */
+      int index = left ? startx : endx;
+      int value = -1;
+      while (index >= startx && index <= endx)
       {
-        if (jalview.util.Comparison.isGap(seq.getCharAt(index)))
+        if (!Comparison.isGap(seq.getCharAt(index)))
+        {
+          value = seq.findPosition(index);
+          break;
+        }
+        if (left)
         {
           index++;
-
-          continue;
         }
-
-        value = av.getAlignment().getSequenceAt(i).findPosition(index);
-
-        break;
-      }
-
-      if (value != -1)
-      {
-        int x = labelWidthWest - fm.stringWidth(String.valueOf(value))
-                - charWidth / 2;
-        g.drawString(value + "", x, (ypos + (i * charHeight))
-                - (charHeight / 5));
-      }
-    }
-  }
-
-  /**
-   * DOCUMENT ME!
-   * 
-   * @param g
-   *          DOCUMENT ME!
-   * @param startx
-   *          DOCUMENT ME!
-   * @param endx
-   *          DOCUMENT ME!
-   * @param ypos
-   *          DOCUMENT ME!
-   */
-  void drawEastScale(Graphics g, int startx, int endx, int ypos)
-  {
-    ypos += charHeight;
-
-    if (av.hasHiddenColumns())
-    {
-      endx = av.getAlignment().getHiddenColumns()
-              .adjustForHiddenColumns(endx);
-    }
-
-    SequenceI seq;
-    // EAST SCALE
-    for (int i = 0; i < av.getAlignment().getHeight(); i++)
-    {
-      seq = av.getAlignment().getSequenceAt(i);
-      int index = endx;
-      int value = -1;
-
-      while (index > startx)
-      {
-        if (jalview.util.Comparison.isGap(seq.getCharAt(index)))
+        else
         {
           index--;
-
-          continue;
         }
-
-        value = seq.findPosition(index);
-
-        break;
       }
 
       if (value != -1)
       {
-        g.drawString(String.valueOf(value), 0, (ypos + (i * charHeight))
-                - (charHeight / 5));
+        /*
+         * white fill the space for the scale
+         */
+        g.setColor(Color.white);
+        int y = (ypos + (i * charHeight)) - (charHeight / 5);
+        y -= charHeight; // fillRect: origin is top left of rectangle
+        int xpos = left ? 0 : getWidth() - labelWidthEast;
+        g.fillRect(xpos, y, left ? labelWidthWest : labelWidthEast,
+                charHeight + 1);
+        y += charHeight; // drawString: origin is bottom left of text
+
+        /*
+         * draw scale value, right justified, with half a character width
+         * separation from the sequence data
+         */
+        String valueAsString = String.valueOf(value);
+        int justify = fm.stringWidth(valueAsString) + charWidth;
+        xpos = left ? labelWidthWest - justify + charWidth / 2
+                : getWidth() - justify - charWidth / 2;
+
+        g.setColor(Color.black);
+        g.drawString(valueAsString, xpos, y);
       }
     }
   }
 
-  boolean fastpainting = false;
-
   /**
-   * need to make this thread safe move alignment rendering in response to
-   * slider adjustment
+   * Does a fast paint of an alignment in response to a scroll. Most of the
+   * visible region is simply copied and shifted, and then any newly visible
+   * columns or rows are drawn. The scroll may be horizontal or vertical, but
+   * not both at once. Scrolling may be the result of
+   * <ul>
+   * <li>dragging a scroll bar</li>
+   * <li>clicking in the scroll bar</li>
+   * <li>scrolling by trackpad, middle mouse button, or other device</li>
+   * <li>by moving the box in the Overview window</li>
+   * <li>programmatically to make a highlighted position visible</li>
+   * </ul>
    * 
    * @param horizontal
-   *          shift along
+   *          columns to shift right (positive) or left (negative)
    * @param vertical
-   *          shift up or down in repaint
+   *          rows to shift down (positive) or up (negative)
    */
   public void fastPaint(int horizontal, int vertical)
   {
@@ -287,57 +270,63 @@ public class SeqCanvas extends JComponent implements ViewportListenerI
     }
     fastpainting = true;
     fastPaint = true;
-    updateViewport();
 
-    ViewportRanges ranges = av.getRanges();
-    int startRes = ranges.getStartRes();
-    int endRes = ranges.getEndRes();
-    int startSeq = ranges.getStartSeq();
-    int endSeq = ranges.getEndSeq();
-    int transX = 0;
-    int transY = 0;
+    try
+    {
+      updateViewport();
 
-    gg.copyArea(horizontal * charWidth, vertical * charHeight, imgWidth,
-            imgHeight, -horizontal * charWidth, -vertical * charHeight);
+      ViewportRanges ranges = av.getRanges();
+      int startRes = ranges.getStartRes();
+      int endRes = ranges.getEndRes();
+      int startSeq = ranges.getStartSeq();
+      int endSeq = ranges.getEndSeq();
+      int transX = 0;
+      int transY = 0;
 
-    if (horizontal > 0) // scrollbar pulled right, image to the left
-    {
-      transX = (endRes - startRes - horizontal) * charWidth;
-      startRes = endRes - horizontal;
-    }
-    else if (horizontal < 0)
-    {
-      endRes = startRes - horizontal;
-    }
-    else if (vertical > 0) // scroll down
-    {
-      startSeq = endSeq - vertical;
+      gg.copyArea(horizontal * charWidth, vertical * charHeight, imgWidth,
+              imgHeight, -horizontal * charWidth, -vertical * charHeight);
 
-      if (startSeq < ranges.getStartSeq())
-      { // ie scrolling too fast, more than a page at a time
-        startSeq = ranges.getStartSeq();
+      if (horizontal > 0) // scrollbar pulled right, image to the left
+      {
+        transX = (endRes - startRes - horizontal) * charWidth;
+        startRes = endRes - horizontal;
       }
-      else
+      else if (horizontal < 0)
       {
-        transY = imgHeight - ((vertical + 1) * charHeight);
+        endRes = startRes - horizontal;
       }
-    }
-    else if (vertical < 0)
-    {
-      endSeq = startSeq - vertical;
+      else if (vertical > 0) // scroll down
+      {
+        startSeq = endSeq - vertical;
 
-      if (endSeq > ranges.getEndSeq())
+        if (startSeq < ranges.getStartSeq())
+        { // ie scrolling too fast, more than a page at a time
+          startSeq = ranges.getStartSeq();
+        }
+        else
+        {
+          transY = imgHeight - ((vertical + 1) * charHeight);
+        }
+      }
+      else if (vertical < 0)
       {
-        endSeq = ranges.getEndSeq();
+        endSeq = startSeq - vertical;
+
+        if (endSeq > ranges.getEndSeq())
+        {
+          endSeq = ranges.getEndSeq();
+        }
       }
-    }
 
-    gg.translate(transX, transY);
-    drawPanel(gg, startRes, endRes, startSeq, endSeq, 0);
-    gg.translate(-transX, -transY);
+      gg.translate(transX, transY);
+      drawPanel(gg, startRes, endRes, startSeq, endSeq, 0);
+      gg.translate(-transX, -transY);
 
-    repaint();
-    fastpainting = false;
+      repaint();
+    } finally
+    {
+      fastpainting = false;
+    }
   }
 
   @Override
@@ -474,23 +463,21 @@ public class SeqCanvas extends JComponent implements ViewportListenerI
   }
 
   /**
-   * DOCUMENT ME!
+   * Draws as many widths of a wrapped alignment as can fit in the visible
+   * window
    * 
    * @param g
-   *          DOCUMENT ME!
    * @param canvasWidth
-   *          DOCUMENT ME!
+   *          available width in pixels
    * @param canvasHeight
-   *          DOCUMENT ME!
+   *          available height in pixels
    * @param startRes
-   *          DOCUMENT ME!
+   *          the first visible column (0...) of the alignment to draw
    */
   public void drawWrappedPanel(Graphics g, int canvasWidth,
           int canvasHeight, int startRes)
   {
     updateViewport();
-    AlignmentI al = av.getAlignment();
-
     int labelWidth = 0;
     if (av.getScaleRightWrapped() || av.getScaleLeftWrapped())
     {
@@ -508,13 +495,11 @@ public class SeqCanvas extends JComponent implements ViewportListenerI
     }
 
     int cWidth = (canvasWidth - labelWidthEast - labelWidthWest) / charWidth;
-    int cHeight = av.getAlignment().getHeight() * charHeight;
 
     av.setWrappedWidth(cWidth);
 
     av.getRanges().setViewportStartAndWidth(startRes, cWidth);
 
-    int endx;
     int ypos = hgap;
     int maxwidth = av.getAlignment().getWidth();
 
@@ -525,98 +510,137 @@ public class SeqCanvas extends JComponent implements ViewportListenerI
     }
 
     int annotationHeight = getAnnotationHeight();
+    int sequencesHeight = av.getAlignment().getHeight() * charHeight;
 
-    while ((ypos <= canvasHeight) && (startRes < maxwidth))
+    /*
+     * draw one width at a time (including any scales or annotation shown),
+     * until we have run out of alignment or vertical space available
+     * (stop if not enough room left for at least one sequence)
+     */
+    int yposMax = canvasHeight;// - hgap - charHeight + 1;
+    while ((ypos <= yposMax) && (startRes < maxwidth))
     {
-      endx = startRes + cWidth - 1;
-
-      if (endx > maxwidth)
-      {
-        endx = maxwidth;
-      }
+      drawWrappedWidth(g, startRes, canvasHeight, cWidth, maxwidth, ypos);
 
-      g.setFont(av.getFont());
-      g.setColor(Color.black);
+      ypos += sequencesHeight + annotationHeight + hgap;
 
-      if (av.getScaleLeftWrapped())
-      {
-        drawWestScale(g, startRes, endx, ypos);
-      }
+      startRes += cWidth;
+    }
+  }
 
-      if (av.getScaleRightWrapped())
-      {
-        g.translate(canvasWidth - labelWidthEast, 0);
-        drawEastScale(g, startRes, endx, ypos);
-        g.translate(-(canvasWidth - labelWidthEast), 0);
-      }
+  /**
+   * Draws one width of a wrapped alignment, including scales left, right or
+   * above, and annnotations, if shown
+   * 
+   * @param g
+   * @param startRes
+   * @param canvasHeight
+   * @param canvasWidth
+   * @param maxWidth
+   * @param ypos
+   */
+  protected void drawWrappedWidth(Graphics g, int startRes,
+          int canvasHeight, int canvasWidth, int maxWidth, int ypos)
+  {
+    int endx;
+    endx = startRes + canvasWidth - 1;
 
-      g.translate(labelWidthWest, 0);
+    if (endx > maxWidth)
+    {
+      endx = maxWidth;
+    }
 
-      if (av.getScaleAboveWrapped())
-      {
-        drawNorthScale(g, startRes, endx, ypos);
-      }
+    g.setFont(av.getFont());
+    g.setColor(Color.black);
 
-      if (av.hasHiddenColumns() && av.getShowHiddenMarkers())
-      {
-        g.setColor(Color.blue);
-        int res;
-        HiddenColumns hidden = av.getAlignment().getHiddenColumns();
-        List<Integer> positions = hidden.findHiddenRegionPositions();
-        for (int pos : positions)
-        {
-          res = pos - startRes;
+    if (av.getScaleLeftWrapped())
+    {
+      drawVerticalScale(g, startRes, endx, ypos, true);
+    }
 
-          if (res < 0 || res > endx - startRes)
-          {
-            continue;
-          }
+    if (av.getScaleRightWrapped())
+    {
+      drawVerticalScale(g, startRes, endx, ypos, false);
+    }
 
-          gg.fillPolygon(
-                  new int[] { res * charWidth - charHeight / 4,
-                      res * charWidth + charHeight / 4, res * charWidth },
-                  new int[] { ypos - (charHeight / 2),
-                      ypos - (charHeight / 2), ypos - (charHeight / 2) + 8 },
-                  3);
+    drawWrappedRegion(g, startRes, endx, canvasHeight, canvasWidth, ypos);
+  }
 
-        }
-      }
+  /**
+   * Draws columns of a wrapped alignment from startRes to endRes, including
+   * scale above and annotations if shown, but not scale left or right.
+   * 
+   * @param g
+   * @param startRes
+   * @param endRes
+   * @param canvasHeight
+   * @param canvasWidth
+   * @param ypos
+   */
+  protected void drawWrappedRegion(Graphics g, int startRes, int endRes,
+          int canvasHeight, int canvasWidth, int ypos)
+  {
+    g.translate(labelWidthWest, 0);
 
-      // When printing we have an extra clipped region,
-      // the Printable page which we need to account for here
-      Shape clip = g.getClip();
+    if (av.getScaleAboveWrapped())
+    {
+      drawNorthScale(g, startRes, endRes, ypos);
+    }
 
-      if (clip == null)
-      {
-        g.setClip(0, 0, cWidth * charWidth, canvasHeight);
-      }
-      else
+    // todo can we let drawPanel() handle this?
+    if (av.hasHiddenColumns() && av.getShowHiddenMarkers())
+    {
+      g.setColor(Color.blue);
+      HiddenColumns hidden = av.getAlignment().getHiddenColumns();
+      List<Integer> positions = hidden.findHiddenRegionPositions();
+      for (int pos : positions)
       {
-        g.setClip(0, (int) clip.getBounds().getY(), cWidth * charWidth,
-                (int) clip.getBounds().getHeight());
-      }
-
-      drawPanel(g, startRes, endx, 0, al.getHeight() - 1, ypos);
+        int res = pos - startRes;
 
-      if (av.isShowAnnotation())
-      {
-        g.translate(0, cHeight + ypos + 3);
-        if (annotations == null)
+        if (res < 0 || res > endRes - startRes)
         {
-          annotations = new AnnotationPanel(av);
+          continue;
         }
 
-        annotations.renderer.drawComponent(annotations, av, g, -1,
-                startRes, endx + 1);
-        g.translate(0, -cHeight - ypos - 3);
+        gg.fillPolygon(new int[] { res * charWidth - charHeight / 4,
+            res * charWidth + charHeight / 4, res * charWidth }, new int[] {
+            ypos - (charHeight / 2), ypos - (charHeight / 2),
+            ypos - (charHeight / 2) + 8 }, 3);
       }
-      g.setClip(clip);
-      g.translate(-labelWidthWest, 0);
+    }
 
-      ypos += cHeight + annotationHeight + hgap;
+    // When printing we have an extra clipped region,
+    // the Printable page which we need to account for here
+    Shape clip = g.getClip();
 
-      startRes += cWidth;
+    if (clip == null)
+    {
+      g.setClip(0, 0, canvasWidth * charWidth, canvasHeight);
     }
+    else
+    {
+      g.setClip(0, (int) clip.getBounds().getY(), canvasWidth * charWidth,
+              (int) clip.getBounds().getHeight());
+    }
+
+    drawPanel(g, startRes, endRes, 0, av.getAlignment().getHeight() - 1, ypos);
+
+    int cHeight = av.getAlignment().getHeight() * charHeight;
+
+    if (av.isShowAnnotation())
+    {
+      g.translate(0, cHeight + ypos + 3);
+      if (annotations == null)
+      {
+        annotations = new AnnotationPanel(av);
+      }
+
+      annotations.renderer.drawComponent(annotations, av, g, -1, startRes,
+              endRes + 1);
+      g.translate(0, -cHeight - ypos - 3);
+    }
+    g.setClip(clip);
+    g.translate(-labelWidthWest, 0);
   }
 
   AnnotationPanel annotations;
@@ -643,14 +667,15 @@ public class SeqCanvas extends JComponent implements ViewportListenerI
    * marker.
    * 
    * @param g1
+   *          the graphics context, positioned at the first residue to be drawn
    * @param startRes
-   *          offset of the first column in the visible region (0..)
+   *          offset of the first column to draw (0..)
    * @param endRes
-   *          offset of the last column in the visible region (0..)
+   *          offset of the last column to draw (0..)
    * @param startSeq
-   *          offset of the first sequence in the visible region (0..)
+   *          offset of the first sequence to draw (0..)
    * @param endSeq
-   *          offset of the last sequence in the visible region (0..)
+   *          offset of the last sequence to draw (0..)
    * @param yOffset
    *          vertical offset at which to draw (for wrapped alignments)
    */
@@ -1166,47 +1191,401 @@ public class SeqCanvas extends JComponent implements ViewportListenerI
   {
     String eventName = evt.getPropertyName();
 
-    if (av.getWrapAlignment())
+    int scrollX = 0;
+    if (eventName.equals(ViewportRanges.STARTRES))
     {
-      if (eventName.equals(ViewportRanges.STARTRES))
+      // Make sure we're not trying to draw a panel
+      // larger than the visible window
+      ViewportRanges vpRanges = av.getRanges();
+      scrollX = (int) evt.getNewValue() - (int) evt.getOldValue();
+      int range = vpRanges.getEndRes() - vpRanges.getStartRes();
+      if (scrollX > range)
       {
-        repaint();
+        scrollX = range;
+      }
+      else if (scrollX < -range)
+      {
+        scrollX = -range;
       }
     }
-    else
+
+    // Both scrolling and resizing change viewport ranges: scrolling changes
+    // both start and end points, but resize only changes end values.
+    // Here we only want to fastpaint on a scroll, with resize using a normal
+    // paint, so scroll events are identified as changes to the horizontal or
+    // vertical start value.
+    if (eventName.equals(ViewportRanges.STARTRES))
+    {
+      // scroll - startres and endres both change
+      if (av.getWrapAlignment())
+      {
+        fastPaintWrapped(scrollX);
+      }
+      else
+      {
+        fastPaint(scrollX, 0);
+      }
+    }
+    else if (eventName.equals(ViewportRanges.STARTSEQ))
+    {
+      fastPaint(0, (int) evt.getNewValue() - (int) evt.getOldValue());
+    }
+  }
+
+  /**
+   * Does a minimal update of the image for a scroll movement. This method
+   * handles scroll movements of up to one width of the wrapped alignment (one
+   * click in the vertical scrollbar). Larger movements (for example after a
+   * scroll to highlight a mapped position) trigger a full redraw instead.
+   * 
+   * @param scrollX
+   *          number of positions scrolled (right if positive, left if negative)
+   */
+  protected void fastPaintWrapped(int scrollX)
+  {
+    if (Math.abs(scrollX) > av.getRanges().getViewportWidth())
+    {
+      /*
+       * shift of more than one view width is 
+       * overcomplicated to handle in this method
+       */
+      fastPaint = false;
+      repaint();
+      return;
+    }
+
+    if (fastpainting || gg == null)
+    {
+      return;
+    }
+
+    fastPaint = true;
+    fastpainting = true;
+
+    try
     {
-      int scrollX = 0;
-      if (eventName.equals(ViewportRanges.STARTRES))
+      /*
+       * relocate the regions of the alignment that are still visible
+       */
+      shiftWrappedAlignment(-scrollX);
+
+      /*
+       * add new columns (scale above, sequence, annotation)
+       * - at top left if scrollX < 0 
+       * - at right of last two widths if scrollX > 0
+       * also West scale top left or East scale bottom right if shown
+       */
+      if (scrollX < 0)
       {
-        // Make sure we're not trying to draw a panel
-        // larger than the visible window
-        ViewportRanges vpRanges = av.getRanges();
-        scrollX = (int) evt.getNewValue() - (int) evt.getOldValue();
-        int range = vpRanges.getEndRes() - vpRanges.getStartRes();
-        if (scrollX > range)
+        fastPaintWrappedAddLeft(-scrollX);
+      }
+      else
+      {
+        fastPaintWrappedAddRight(scrollX);
+      }
+
+      repaint();
+    } finally
+    {
+      fastpainting = false;
+    }
+  }
+
+  /**
+   * Draws the specified number of columns at the 'end' (bottom right) of a
+   * wrapped alignment view, including scale above and right and annotations if
+   * shown. Also draws the same number of columns at the right hand end of the
+   * second last width shown, if the last width is not full height (so cannot
+   * simply be copied from the graphics image).
+   * 
+   * @param columns
+   */
+  protected void fastPaintWrappedAddRight(int columns)
+  {
+    if (columns == 0)
+    {
+      return;
+    }
+
+    /*
+     * how many widths are visible? we will be adding
+     * columns to the last visible width, right hand end
+     */
+    int repeatHeight = getRepeatHeightWrapped();
+    int canvasHeight = getHeight();
+    int visibleWidths = canvasHeight / repeatHeight;
+    int remainder = canvasHeight % repeatHeight;
+    int hgap = charHeight * (av.getScaleAboveWrapped() ? 2 : 1);
+    boolean lastWidthPartHeight = false;
+    if (remainder >= (hgap + charHeight))
+    {
+      visibleWidths++;
+      lastWidthPartHeight = true;
+    }
+
+    /*
+     * limit visible widths to max widths of alignment, from the
+     * current start residue (we may be scrolled down)
+     */
+    ViewportRanges ranges = av.getRanges();
+    int availableAlignmentWidth = ranges.getVisibleAlignmentWidth()
+            - ranges.getStartRes();
+    int viewportWidth = ranges.getViewportWidth();
+    int maxWidths = availableAlignmentWidth / viewportWidth;
+    if (availableAlignmentWidth % viewportWidth > 0)
+    {
+      maxWidths++;
+    }
+    visibleWidths = Math.min(visibleWidths, maxWidths);
+    int canvasWidth = getWidth();
+    int widthInColumns = (canvasWidth - labelWidthEast - labelWidthWest)
+            / charWidth;
+
+    /**
+     * draw full height alignment in the second last row, last columns, if the
+     * last row was not full height
+     */
+    if (lastWidthPartHeight)
+    {
+      int widthsAbove = visibleWidths - 2;
+      int ypos = repeatHeight * widthsAbove + hgap;
+      int endRes = ranges.getEndRes();
+      endRes += widthsAbove * viewportWidth;
+      int startRes = endRes - columns;
+      int xOffset = ((startRes - ranges.getStartRes()) % viewportWidth)
+              * charWidth;
+      gg.translate(xOffset, 0);
+
+      /*
+       * white fill first to erase annotations
+       */
+      gg.setColor(Color.white);
+      gg.fillRect(labelWidthWest, ypos,
+              (endRes - startRes + 1) * charWidth, repeatHeight);
+
+      drawWrappedRegion(gg, startRes, endRes, canvasHeight, widthInColumns,
+              ypos);
+      gg.translate(-xOffset, 0);
+    }
+
+    /*
+     * y-offset for drawing is height of widths above,
+     * plus one gap row
+     */
+    int widthsAbove = visibleWidths - 1;
+    int ypos = repeatHeight * widthsAbove + hgap;
+    int endRes = ranges.getEndRes();
+    endRes += widthsAbove * viewportWidth;
+    endRes = Math.min(endRes, ranges.getVisibleAlignmentWidth());
+
+    /*
+     * draw one extra column than strictly needed - this is a (harmless)
+     * fudge to ensure scale marks get drawn (JAL-2636)
+     */
+    int startRes = endRes - columns;
+
+    /*
+     * x-offset is x-start modulo viewport start residue;
+     * doesn't include label West (offset is applied in drawWrappedRegion)
+     */
+
+    int leftEndColumn = ranges.getStartRes() + widthsAbove
+            * ranges.getViewportWidth();
+    // startRes = Math.max(startRes - 0, leftEndColumn);
+    int xOffset = ((startRes - ranges.getStartRes()) % viewportWidth)
+            * charWidth;
+    gg.translate(xOffset, 0);
+
+    /*
+     * white fill the region to be drawn including scale left or above;
+     * extend to right hand margin so as to erase scale above when
+     * scrolling right beyond end of alignment
+     */
+    gg.setColor(Color.white);
+    int width = canvasWidth - labelWidthWest - xOffset;
+    gg.fillRect(labelWidthWest, ypos - hgap, width, repeatHeight);
+
+    gg.setFont(av.getFont());
+    gg.setColor(Color.black);
+
+    drawWrappedRegion(gg, startRes, endRes, canvasHeight, widthInColumns,
+            ypos);
+    gg.translate(-xOffset, 0);
+
+    /*
+     * draw scale right if shown, passing in the start/end columns
+     * for the whole line, not just the last few columns
+     */
+    if (av.getScaleRightWrapped())
+    {
+      drawVerticalScale(gg, leftEndColumn, endRes, ypos, false);
+    }
+
+    /*
+     * and finally, white fill any space below the visible alignment
+     * (in case it has wrapped to just the top part of the panel)
+     */
+    int heightBelow = canvasHeight - visibleWidths * repeatHeight;
+    if (heightBelow > 0)
+    {
+      gg.setColor(Color.white);
+      gg.fillRect(0, canvasHeight - heightBelow, canvasWidth, heightBelow);
+    }
+  }
+
+  /**
+   * Draws the specified number of columns at the 'start' (top left) of a
+   * wrapped alignment view, including scale above and left and annotations if
+   * shown
+   * 
+   * @param columns
+   */
+  protected void fastPaintWrappedAddLeft(int columns)
+  {
+    int startRes = av.getRanges().getStartRes();
+
+    /*
+     * draw one extra column than strictly needed - this is a (harmless)
+     * fudge to ensure scale marks get drawn (JAL-2636)
+     */
+    int endx = startRes + columns;
+    int ypos = 0;
+
+    /*
+     * white fill the region to be drawn including scale left or above
+     */
+    gg.setColor(Color.white);
+    int height = getRepeatHeightWrapped();
+    gg.fillRect(0, ypos, labelWidthWest + columns * charWidth, height);
+    ypos += charHeight * (av.getScaleAboveWrapped() ? 2 : 1);
+
+    gg.setFont(av.getFont());
+    gg.setColor(Color.black);
+
+    if (av.getScaleLeftWrapped())
+    {
+      drawVerticalScale(gg, startRes, endx, ypos, true);
+    }
+
+    int cWidth = (getWidth() - labelWidthEast - labelWidthWest) / charWidth;
+
+    drawWrappedRegion(gg, startRes, endx, getHeight(), cWidth, ypos);
+  }
+
+  /**
+   * Shifts the visible alignment by the specified number of columns - left if
+   * negative, right if positive. Includes scale above, left or right and
+   * annotations (if shown). Does not draw newly visible columns.
+   * 
+   * @param positions
+   */
+  protected void shiftWrappedAlignment(int positions)
+  {
+    if (positions == 0)
+    {
+      return;
+    }
+
+    int repeatHeight = getRepeatHeightWrapped();
+    ViewportRanges ranges = av.getRanges();
+    int xMax = ranges.getVisibleAlignmentWidth();
+    int widthToCopy = (ranges.getViewportWidth() - Math.abs(positions))
+            * charWidth;
+    int canvasHeight = getHeight();
+    int visibleWidths = canvasHeight / repeatHeight;
+    if (canvasHeight % repeatHeight > 0)
+    {
+      visibleWidths++;
+    }
+    int viewportWidth = ranges.getViewportWidth();
+    int hgap = charHeight * (av.getScaleAboveWrapped() ? 2 : 1);
+
+    int remainder = canvasHeight % repeatHeight;
+    if (remainder >= (hgap + charHeight))
+    {
+      visibleWidths++;
+    }
+    // todo limit visibleWidths to not exceed width of alignment
+    // (don't process white space below)
+
+    if (positions > 0)
+    {
+      /*
+       * shift right (after scroll left)
+       * for each wrapped width (starting with the last), copy (width-positions) 
+       * columns from the left margin to the right margin, and copy positions 
+       * columns from the right margin of the row above (if any) to the 
+       * left margin of the current row
+       */
+      int xpos = ranges.getStartRes() + (visibleWidths - 1) * viewportWidth;
+
+      /*
+       * get y-offset of last wrapped width
+       */
+      int y = canvasHeight / repeatHeight * repeatHeight;
+      int copyFromLeftStart = labelWidthWest;
+      int copyFromRightStart = copyFromLeftStart + widthToCopy;
+
+      while (y >= 0)
+      {
+        gg.copyArea(copyFromLeftStart, y, widthToCopy, repeatHeight,
+                positions * charWidth, 0);
+        if (y > 0)
+        {
+          gg.copyArea(copyFromRightStart, y - repeatHeight, positions
+                  * charWidth, repeatHeight, -widthToCopy, repeatHeight);
+        }
+
+        if (av.getScaleLeftWrapped())
         {
-          scrollX = range;
+          drawVerticalScale(gg, xpos, xpos + viewportWidth - 1, y + hgap,
+                  true);
         }
-        else if (scrollX < -range)
+        if (av.getScaleRightWrapped())
         {
-          scrollX = -range;
+          drawVerticalScale(gg, xpos, xpos + viewportWidth - 1, y + hgap,
+                  false);
         }
-      }
 
-      // Both scrolling and resizing change viewport ranges: scrolling changes
-      // both start and end points, but resize only changes end values.
-      // Here we only want to fastpaint on a scroll, with resize using a normal
-      // paint, so scroll events are identified as changes to the horizontal or
-      // vertical start value.
-      if (eventName.equals(ViewportRanges.STARTRES))
-      {
-        // scroll - startres and endres both change
-        fastPaint(scrollX, 0);
+        y -= repeatHeight;
+        xpos -= viewportWidth;
       }
-      else if (eventName.equals(ViewportRanges.STARTSEQ))
+    }
+    else
+    {
+      /*
+       * shift left (after scroll right)
+       * for each wrapped width (starting with the first), copy (width-positions) 
+       * columns from the right margin to the left margin, and copy positions 
+       * columns from the left margin of the row below (if any) to the 
+       * right margin of the current row
+       */
+      int xpos = ranges.getStartRes();
+      int y = 0;
+      int copyFromRightStart = labelWidthWest - positions * charWidth;
+
+      while (y < canvasHeight)
       {
-        // scroll
-        fastPaint(0, (int) evt.getNewValue() - (int) evt.getOldValue());
+        gg.copyArea(copyFromRightStart, y, widthToCopy, repeatHeight,
+                positions * charWidth, 0);
+        if (y + repeatHeight < canvasHeight - repeatHeight
+                && (xpos + viewportWidth <= xMax))
+        {
+          gg.copyArea(labelWidthWest, y + repeatHeight, -positions
+                  * charWidth, repeatHeight, widthToCopy, -repeatHeight);
+        }
+
+        if (av.getScaleLeftWrapped())
+        {
+          drawVerticalScale(gg, xpos, xpos + viewportWidth, y + hgap, true);
+        }
+        if (av.getScaleRightWrapped())
+        {
+          drawVerticalScale(gg, xpos, xpos + viewportWidth, y + hgap, false);
+        }
+
+        y += repeatHeight;
+        xpos += viewportWidth;
       }
     }
   }
index d14e908..eedad59 100644 (file)
@@ -215,7 +215,7 @@ public class SeqPanel extends JPanel implements MouseListener,
               + hgap + seqCanvas.getAnnotationHeight();
 
       int y = evt.getY();
-      y -= hgap;
+      y = Math.max(0, y - hgap);
       x = Math.max(0, x - seqCanvas.labelWidthWest);
 
       int cwidth = seqCanvas.getWrappedCanvasWidth(this.getWidth());
index 9fec256..d92608c 100644 (file)
@@ -34,12 +34,24 @@ import java.util.List;
  */
 public class ScaleRenderer
 {
+  /**
+   * Represents one major or minor scale mark
+   */
   public final class ScaleMark
   {
+    /**
+     * true for a major scale mark, false for minor
+     */
     public final boolean major;
 
+    /**
+     * visible column position (0..) e.g. 19
+     */
     public final int column;
 
+    /**
+     * text (if any) to show e.g. "20"
+     */
     public final String text;
 
     ScaleMark(boolean isMajor, int col, String txt)
@@ -48,19 +60,27 @@ public class ScaleRenderer
       column = col;
       text = txt;
     }
+
+    /**
+     * String representation for inspection when debugging only
+     */
+    @Override
+    public String toString()
+    {
+      return String.format("%s:%d:%s", major ? "major" : "minor", column,
+              text);
+    }
   }
 
   /**
-   * calculate positions markers on the alignment ruler
+   * Calculates position markers on the alignment ruler
    * 
    * @param av
    * @param startx
-   *          left-most column in visible view
+   *          left-most column in visible view (0..)
    * @param endx
-   *          - right-most column in visible view
-   * @return List of ScaleMark holding boolean: true/false for major/minor mark,
-   *         marker position in alignment column coords, a String to be rendered
-   *         at the position (or null)
+   *          - right-most column in visible view (0..)
+   * @return
    */
   public List<ScaleMark> calculateMarks(AlignViewportI av, int startx,
           int endx)
@@ -87,41 +107,40 @@ public class ScaleRenderer
       scalestartx += 5;
     }
     List<ScaleMark> marks = new ArrayList<ScaleMark>();
-    String string;
-    int refN, iadj;
     // todo: add a 'reference origin column' to set column number relative to
-    for (int i = scalestartx; i < endx; i += 5)
+    for (int i = scalestartx; i <= endx; i += 5)
     {
       if (((i - refSp) % 10) == 0)
       {
+        String text;
         if (refSeq == null)
         {
-          iadj = av.getAlignment().getHiddenColumns()
+          int iadj = av.getAlignment().getHiddenColumns()
                   .adjustForHiddenColumns(i - 1) + 1;
-          string = String.valueOf(iadj);
+          text = String.valueOf(iadj);
         }
         else
         {
-          iadj = av.getAlignment().getHiddenColumns()
+          int iadj = av.getAlignment().getHiddenColumns()
                   .adjustForHiddenColumns(i - 1);
-          refN = refSeq.findPosition(iadj);
+          int refN = refSeq.findPosition(iadj);
           // TODO show bounds if position is a gap
           // - ie L--R -> "1L|2R" for
           // marker
           if (iadj < refStartI)
           {
-            string = String.valueOf(iadj - refStartI);
+            text = String.valueOf(iadj - refStartI);
           }
           else if (iadj > refEndI)
           {
-            string = "+" + String.valueOf(iadj - refEndI);
+            text = "+" + String.valueOf(iadj - refEndI);
           }
           else
           {
-            string = String.valueOf(refN) + refSeq.getCharAt(iadj);
+            text = String.valueOf(refN) + refSeq.getCharAt(iadj);
           }
         }
-        marks.add(new ScaleMark(true, i - startx - 1, string));
+        marks.add(new ScaleMark(true, i - startx - 1, text));
       }
       else
       {
index cf1039f..0af67cd 100644 (file)
@@ -26,11 +26,11 @@ public class ScaleRendererTest
     AlignViewport av = af.getViewport();
 
     /*
-     * scale has minor ticks at 5 and 15, major at 10 and 20
+     * scale has minor ticks at 5, 15, 25, major at 10 and 20
      * (these are base 1, ScaleMark holds base 0 values)
      */
     List<ScaleMark> marks = new ScaleRenderer().calculateMarks(av, 0, 25);
-    assertEquals(marks.size(), 4);
+    assertEquals(marks.size(), 5);
 
     assertFalse(marks.get(0).major);
     assertEquals(marks.get(0).column, 4);
@@ -48,6 +48,10 @@ public class ScaleRendererTest
     assertEquals(marks.get(3).column, 19);
     assertEquals(marks.get(3).text, "20");
 
+    assertFalse(marks.get(4).major);
+    assertEquals(marks.get(4).column, 24);
+    assertNull(marks.get(4).text);
+
     /*
      * now hide columns 9-11 and 18-20 (base 1)
      * scale marks are now in the same columns as before, but
@@ -56,7 +60,7 @@ public class ScaleRendererTest
     av.hideColumns(8, 10);
     av.hideColumns(17, 19);
     marks = new ScaleRenderer().calculateMarks(av, 0, 25);
-    assertEquals(marks.size(), 4);
+    assertEquals(marks.size(), 5);
     assertFalse(marks.get(0).major);
     assertEquals(marks.get(0).column, 4);
     assertNull(marks.get(0).text);
@@ -69,5 +73,8 @@ public class ScaleRendererTest
     assertTrue(marks.get(3).major);
     assertEquals(marks.get(3).column, 19);
     assertEquals(marks.get(3).text, "26"); // +6 hidden columns
+    assertFalse(marks.get(4).major);
+    assertEquals(marks.get(4).column, 24);
+    assertNull(marks.get(4).text);
   }
 }