JAL-2811 Add layer for cursor in SeqCanvas
[jalview.git] / src / jalview / gui / SeqCanvas.java
index adc36f9..bd2862a 100755 (executable)
@@ -364,11 +364,14 @@ public class SeqCanvas extends JComponent implements ViewportListenerI
             ranges.getStartRes(), ranges.getEndRes(),
             ranges.getStartSeq(), ranges.getEndSeq());
 
+    BufferedImage cursorImage = drawCursor(ranges.getStartRes(),
+            ranges.getEndRes(), ranges.getStartSeq(), ranges.getEndSeq());
+
     if ((img != null) && (fastPaint
             || (getVisibleRect().width != g.getClipBounds().width)
             || (getVisibleRect().height != g.getClipBounds().height)))
     {
-      BufferedImage lcimg = buildLocalImage(selectImage);
+      BufferedImage lcimg = buildLocalImage(selectImage, cursorImage);
       g.drawImage(lcimg, 0, 0, this);
       fastPaint = false;
     }
@@ -408,7 +411,7 @@ public class SeqCanvas extends JComponent implements ViewportListenerI
       }
 
       // lcimg is a local *copy* of img which we'll draw selectImage on top of
-      BufferedImage lcimg = buildLocalImage(selectImage);
+      BufferedImage lcimg = buildLocalImage(selectImage, cursorImage);
       g.drawImage(lcimg, 0, 0, this);
     }
   }
@@ -493,7 +496,8 @@ public class SeqCanvas extends JComponent implements ViewportListenerI
    * Make a local image by combining the cached image img
    * with any selection
    */
-  private BufferedImage buildLocalImage(BufferedImage selectImage)
+  private BufferedImage buildLocalImage(BufferedImage selectImage,
+          BufferedImage cursorImage)
   {
     // clone the cached image
     BufferedImage lcimg = new BufferedImage(img.getWidth(), img.getHeight(),
@@ -508,6 +512,12 @@ public class SeqCanvas extends JComponent implements ViewportListenerI
               AlphaComposite.getInstance(AlphaComposite.SRC_OVER));
       g2d.drawImage(selectImage, 0, 0, this);
     }
+    // overlay cursor on lcimg
+    if (cursorImage != null)
+    {
+      g2d.setComposite(AlphaComposite.getInstance(AlphaComposite.SRC_OVER));
+      g2d.drawImage(cursorImage, 0, 0, this);
+    }
     g2d.dispose();
 
     return lcimg;
@@ -697,7 +707,6 @@ public class SeqCanvas extends JComponent implements ViewportListenerI
      * ensuring a part height includes at least one sequence
      */
     ViewportRanges ranges = av.getRanges();
-    int xMax = ranges.getVisibleAlignmentWidth();
     wrappedVisibleWidths = canvasHeight / wrappedRepeatHeightPx;
     int remainder = canvasHeight % wrappedRepeatHeightPx;
     if (remainder >= (wrappedSpaceAboveAlignment + charHeight))
@@ -713,8 +722,10 @@ public class SeqCanvas extends JComponent implements ViewportListenerI
     /*
      *  limit visibleWidths to not exceed width of alignment
      */
-    int maxWidths = (xMax - ranges.getStartRes()) / wrappedWidthInResidues;
-    if (xMax % wrappedWidthInResidues > 0)
+    int xMax = ranges.getVisibleAlignmentWidth();
+    int startToEnd = xMax - ranges.getStartRes();
+    int maxWidths = startToEnd / wrappedWidthInResidues;
+    if (startToEnd % wrappedWidthInResidues > 0)
     {
       maxWidths++;
     }
@@ -837,10 +848,12 @@ public class SeqCanvas extends JComponent implements ViewportListenerI
        * white fill region of scale above and hidden column markers
        * (to support incremental fast paint of image)
        */
+      g.translate(labelWidthWest, 0);
       g.setColor(Color.white);
       g.fillRect(0, ypos - wrappedSpaceAboveAlignment, viewportWidth
               * charWidth + labelWidthWest, wrappedSpaceAboveAlignment);
       g.setColor(Color.black);
+      g.translate(-labelWidthWest, 0);
 
       g.translate(labelWidthWest, 0);
 
@@ -863,6 +876,9 @@ public class SeqCanvas extends JComponent implements ViewportListenerI
   }
 
   /**
+   * Draws markers (triangles) above hidden column positions between startColumn
+   * and endColumn.
+   * 
    * @param g
    * @param ypos
    * @param startColumn
@@ -881,7 +897,7 @@ public class SeqCanvas extends JComponent implements ViewportListenerI
     {
       int res = pos - startColumn;
 
-      if (res < 0 || res > endColumn - startColumn)
+      if (res < 0 || res > endColumn - startColumn + 1)
       {
         continue;
       }
@@ -1136,12 +1152,12 @@ public class SeqCanvas extends JComponent implements ViewportListenerI
         }
       }
 
-      if (av.cursorMode && cursorY == i && cursorX >= startRes
+      /*      if (av.cursorMode && cursorY == i && cursorX >= startRes
               && cursorX <= endRes)
       {
         seqRdr.drawCursor(nextSeq, cursorX, (cursorX - startRes) * charWidth,
                 offset + ((i - startSeq) * charHeight));
-      }
+      }*/
     }
 
     if (av.getSelectionGroup() != null
@@ -1239,6 +1255,60 @@ public class SeqCanvas extends JComponent implements ViewportListenerI
     return selectionImage;
   }
 
+  /**
+   * Draw the cursor as a separate image and overlay
+   * 
+   * @param startRes
+   *          start residue of area to draw cursor in
+   * @param endRes
+   *          end residue of area to draw cursor in
+   * @param startSeq
+   *          start sequence of area to draw cursor in
+   * @param endSeq
+   *          end sequence of are to draw cursor in
+   * @return a transparent image of the same size as the sequence canvas, with
+   *         the cursor drawn on it, if any
+   */
+  private BufferedImage drawCursor(int startRes, int endRes, int startSeq,
+          int endSeq)
+  {
+    // define our cursor image
+    BufferedImage cursorImage = null;
+
+    if (av.cursorMode && cursorY >= startSeq && cursorY <= endSeq
+            && cursorX >= startRes && cursorX <= endRes)
+    {
+      // get a new image of the correct size
+      cursorImage = setupImage();
+      Graphics2D g = (Graphics2D) cursorImage.getGraphics();
+
+      // get the character the cursor is drawn at
+      SequenceI seq = av.getAlignment().getSequenceAt(cursorY);
+      char s = seq.getCharAt(cursorX);
+
+      int offset = 0;
+      if (av.getWrapAlignment())
+      {
+        // work out the correct offset for the cursor
+        offset = wrappedSpaceAboveAlignment;
+        int currentWidth = 0;
+        while ((currentWidth < wrappedVisibleWidths)
+                && (currentWidth < cursorX))
+        {
+          offset += wrappedRepeatHeightPx;
+          currentWidth++;
+        }
+      }
+
+      seqRdr.drawCursor(g, s,
+              (cursorX - startRes) * av.getCharWidth(),
+              offset + ((cursorY - startSeq) * av.getCharHeight()));
+      g.dispose();
+    }
+
+    return cursorImage;
+  }
+
   /*
    * Set up graphics for selection group
    */
@@ -1652,48 +1722,50 @@ public class SeqCanvas extends JComponent implements ViewportListenerI
     {
       fastPaint = true;
       repaint();
+      return;
     }
-    else if (eventName.equals(ViewportRanges.STARTRES))
+
+    int scrollX = 0;
+    if (eventName.equals(ViewportRanges.STARTRES))
     {
-      int scrollX = 0;
-      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.getViewportWidth();
+      if (scrollX > range)
       {
-        // 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)
-        {
-          scrollX = range;
-        }
-        else if (scrollX < -range)
-        {
-          scrollX = -range;
-        }
+        scrollX = range;
+      }
+      else if (scrollX < -range)
+      {
+        scrollX = -range;
+      }
+    }
 
-        // 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.
-        
-        // scroll - startres and endres both change
-         if (av.getWrapAlignment())
-        {
-          fastPaintWrapped(scrollX);
-        }
-        else
-        {
-          fastPaint(scrollX, 0);
-        }
+    // 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.
+
+    // scroll - startres and endres both change
+    if (eventName.equals(ViewportRanges.STARTRES))
+    {
+      if (av.getWrapAlignment())
+      {
+        fastPaintWrapped(scrollX);
       }
-      else if (eventName.equals(ViewportRanges.STARTSEQ))
+      else
       {
-        // scroll
-        fastPaint(0, (int) evt.getNewValue() - (int) evt.getOldValue());
+        fastPaint(scrollX, 0);
       }
     }
+    else if (eventName.equals(ViewportRanges.STARTSEQ))
+    {
+      // scroll
+      fastPaint(0, (int) evt.getNewValue() - (int) evt.getOldValue());
+    }
   }
 
   /**