[JAL-3226] problem that JavaScript (or Java) may consolidate multiple
[jalview.git] / src / jalview / gui / SeqCanvas.java
index 2139b6b..88d6db7 100755 (executable)
@@ -38,6 +38,7 @@ import java.awt.Color;
 import java.awt.FontMetrics;
 import java.awt.Graphics;
 import java.awt.Graphics2D;
+import java.awt.Rectangle;
 import java.awt.RenderingHints;
 import java.awt.image.BufferedImage;
 import java.beans.PropertyChangeEvent;
@@ -52,6 +53,7 @@ import javax.swing.JPanel;
  * Wrapped mode, but not the scale above in Unwrapped mode.
  * 
  */
+@SuppressWarnings("serial")
 public class SeqCanvas extends JPanel implements ViewportListenerI
 {
   /*
@@ -73,7 +75,7 @@ public class SeqCanvas extends JPanel implements ViewportListenerI
 
   private final SequenceRenderer seqRdr;
 
-  private boolean fastPaint = false;
+  boolean fastPaint = false;
 
   private boolean fastpainting = false;
 
@@ -275,6 +277,7 @@ public class SeqCanvas extends JPanel implements ViewportListenerI
    * <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>
+   * <li>pasting a block of sequences</li>
    * </ul>
    * 
    * @param horizontal
@@ -284,18 +287,21 @@ public class SeqCanvas extends JPanel implements ViewportListenerI
    */
   public void fastPaint(int horizontal, int vertical)
   {
-    if (fastpainting  || img == null)
+
+    // effectively:
+    // if (horizontal != 0 && vertical != 0)
+    // throw new InvalidArgumentException();
+    if (fastpainting || img == null)
     {
       return;
     }
     fastpainting = true;
     fastPaint = true;
-
     try
     {
       int charHeight = av.getCharHeight();
       int charWidth = av.getCharWidth();
-    
+
       ViewportRanges ranges = av.getRanges();
       int startRes = ranges.getStartRes();
       int endRes = ranges.getEndRes();
@@ -303,11 +309,6 @@ public class SeqCanvas extends JPanel implements ViewportListenerI
       int endSeq = ranges.getEndSeq();
       int transX = 0;
       int transY = 0;
-      
-      Graphics gg = img.getGraphics();
-      gg.copyArea(horizontal * charWidth, vertical * charHeight,
-              img.getWidth(), img.getHeight(), -horizontal * charWidth,
-              -vertical * charHeight);
 
       if (horizontal > 0) // scrollbar pulled right, image to the left
       {
@@ -342,14 +343,27 @@ public class SeqCanvas extends JPanel implements ViewportListenerI
         }
       }
 
+
+      // System.err.println(">>> FastPaint to " + transX + " " + transY + " "
+      // + horizontal + " " + vertical + " " + startRes + " " + endRes
+      // + " " + startSeq + " " + endSeq);
+
+      Graphics gg = img.getGraphics();
+      gg.copyArea(horizontal * charWidth, vertical * charHeight,
+              img.getWidth(), img.getHeight(), -horizontal * charWidth,
+              -vertical * charHeight);
+
+      /** @j2sNative xxi = this.img */
+
       gg.translate(transX, transY);
       drawPanel(gg, startRes, endRes, startSeq, endSeq, 0);
       gg.translate(-transX, -transY);
       gg.dispose();
-      
+
       // Call repaint on alignment panel so that repaints from other alignment
       // panel components can be aggregated. Otherwise performance of the
       // overview window and others may be adversely affected.
+      // System.out.println("SeqCanvas fastPaint() repaint() request...");
       av.getAlignPanel().repaint();
     } finally
     {
@@ -360,43 +374,77 @@ public class SeqCanvas extends JPanel implements ViewportListenerI
   @Override
   public void paintComponent(Graphics g)
   {
-    //super.paintComponent(g); // BH 2019
 
     int charHeight = av.getCharHeight();
     int charWidth = av.getCharWidth();
 
-    ViewportRanges ranges = av.getRanges();
-
     int width = getWidth();
     int height = getHeight();
 
     width -= (width % charWidth);
     height -= (height % charHeight);
 
-    
-    if ((img != null) && (fastPaint
-            || (getVisibleRect().width != g.getClipBounds().width)
-            || (getVisibleRect().height != g.getClipBounds().height)))
-    {
-      g.drawImage(img, 0, 0, this);
+    // BH 2019 can't possibly fastPaint if either width or height is 0
 
-      drawSelectionGroup((Graphics2D) g, ranges.getStartRes(),
-              ranges.getEndRes(), ranges.getStartSeq(), ranges.getEndSeq());
+    if (width == 0 || height == 0)
+    {
+      return;
+    }
 
+    ViewportRanges ranges = av.getRanges();
+    int startRes = ranges.getStartRes();
+    int startSeq = ranges.getStartSeq();
+    int endRes = ranges.getEndRes();
+    int endSeq = ranges.getEndSeq();
+
+    // [JAL-3226] problem that JavaScript (or Java) may consolidate multiple
+    // repaint() requests in unpredictable ways. In this case, the issue was
+    // that in response to a CTRL-C/CTRL-V paste request, in Java a fast
+    // repaint request preceded two full requests, thus resulting
+    // in a full request for paint. In constrast, in JavaScript, the three
+    // requests were bundled together into one, so the fastPaint flag was
+    // still present for the second and third request.
+    //
+    // This resulted in incomplete painting.
+    //
+    // The solution was to set seqCanvas.fastPaint and idCanvas.fastPaint false
+    // in PaintRefresher when the target to be painted is one of those two
+    // components.
+    //
+    // BH 2019.04.22
+    //
+    // An initial idea; can be removed once we determine this issue is closed:
+    // if (av.isFastPaintDisabled())
+    // {
+    // fastPaint = false;
+    // }
+
+    Rectangle vis, clip;
+    if (img != null
+            && (fastPaint
+                    || (vis = getVisibleRect()).width != (clip = g
+                            .getClipBounds()).width
+                    || vis.height != clip.height))
+    {
+      g.drawImage(img, 0, 0, this);
+      drawSelectionGroup((Graphics2D) g, startRes, endRes, startSeq,
+              endSeq);
       fastPaint = false;
+      // System.out.println("SeqCanvas fast paint");
     }
-    else if (width > 0 && height > 0)
+    else
     {
-      /*
-       * img is a cached version of the last view we drew, if any
-       * if we have no img or the size has changed, make a new one
-       */
+      // System.out.println("SeqCanvas full paint");
+
+      // img is a cached version of the last view we drew.
+      // If we have no img or the size has changed, make a new one.
+      //
       if (img == null || width != img.getWidth()
               || height != img.getHeight())
       {
         img = new BufferedImage(width, height, BufferedImage.TYPE_INT_RGB);
       }
-      
+
       Graphics2D gg = (Graphics2D) img.getGraphics();
       gg.setFont(av.getFont());
 
@@ -411,16 +459,14 @@ public class SeqCanvas extends JPanel implements ViewportListenerI
 
       if (av.getWrapAlignment())
       {
-        drawWrappedPanel(gg, getWidth(), getHeight(), ranges.getStartRes());
+        drawWrappedPanel(gg, width, height, ranges.getStartRes());
       }
       else
       {
-        drawPanel(gg, ranges.getStartRes(), ranges.getEndRes(),
-                ranges.getStartSeq(), ranges.getEndSeq(), 0);
+        drawPanel(gg, startRes, endRes, startSeq, endSeq, 0);
       }
 
-      drawSelectionGroup(gg, ranges.getStartRes(),
-              ranges.getEndRes(), ranges.getStartSeq(), ranges.getEndSeq());
+      drawSelectionGroup(gg, startRes, endRes, startSeq, endSeq);
 
       g.drawImage(img, 0, 0, this);
       gg.dispose();
@@ -428,8 +474,7 @@ public class SeqCanvas extends JPanel implements ViewportListenerI
 
     if (av.cursorMode)
     {
-      drawCursor(g, ranges.getStartRes(), ranges.getEndRes(),
-              ranges.getStartSeq(), ranges.getEndSeq());
+      drawCursor(g, startRes, endRes, startSeq, endSeq);
     }
   }
   
@@ -1637,7 +1682,7 @@ public class SeqCanvas extends JPanel implements ViewportListenerI
   public void propertyChange(PropertyChangeEvent evt)
   {
     String eventName = evt.getPropertyName();
-
+    // System.err.println(">>SeqCanvas propertyChange " + eventName);
     if (eventName.equals(SequenceGroup.SEQ_GROUP_CHANGED))
     {
       fastPaint = true;
@@ -1647,6 +1692,7 @@ public class SeqCanvas extends JPanel implements ViewportListenerI
     else if (eventName.equals(ViewportRanges.MOVE_VIEWPORT))
     {
       fastPaint = false;
+      // System.err.println("!!!! fastPaint false from MOVE_VIEWPORT");
       repaint();
       return;
     }
@@ -1678,37 +1724,37 @@ public class SeqCanvas extends JPanel implements ViewportListenerI
         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.
-      if (eventName.equals(ViewportRanges.STARTRES))
+    // 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))
+    {
+      if (av.getWrapAlignment())
       {
-         if (av.getWrapAlignment())
-          {
-            fastPaintWrapped(scrollX);
-          }
-          else
-          {
-            fastPaint(scrollX, 0);
-          }
+        fastPaintWrapped(scrollX);
+      }
+      else
+      {
+        fastPaint(scrollX, 0);
       }
-      else if (eventName.equals(ViewportRanges.STARTSEQ))
+    }
+    else if (eventName.equals(ViewportRanges.STARTSEQ))
+    {
+      // scroll
+      fastPaint(0, (int) evt.getNewValue() - (int) evt.getOldValue());
+    }
+    else if (eventName.equals(ViewportRanges.STARTRESANDSEQ))
+    {
+      if (av.getWrapAlignment())
       {
-        // scroll
-        fastPaint(0, (int) evt.getNewValue() - (int) evt.getOldValue());
+        fastPaintWrapped(scrollX);
       }
-      else if (eventName.equals(ViewportRanges.STARTRESANDSEQ))
+      else
       {
-        if (av.getWrapAlignment())
-        {
-          fastPaintWrapped(scrollX);
-        }
-        else
-        {
-          fastPaint(scrollX, 0);
-        }
+        fastPaint(scrollX, 0);
+      }
     }
     else if (eventName.equals(ViewportRanges.STARTSEQ))
     {
@@ -2130,4 +2176,5 @@ public class SeqCanvas extends JPanel implements ViewportListenerI
   {
     return labelWidthWest;
   }
+
 }