JAL-3364 tweaks to override of FIGURE_FIXEDIDWIDTH for split frame image
[jalview.git] / src / jalview / gui / SeqCanvas.java
index 5c404f0..70afc5a 100755 (executable)
@@ -55,6 +55,11 @@ import javax.swing.JComponent;
  */
 public class SeqCanvas extends JComponent implements ViewportListenerI
 {
+  /**
+   * vertical gap in pixels between sequences and annotations when in wrapped mode
+   */
+  static final int SEQS_ANNOTATION_GAP = 3;
+
   private static final String ZEROS = "0000000000";
 
   final FeatureRenderer fr;
@@ -82,9 +87,9 @@ public class SeqCanvas extends JComponent implements ViewportListenerI
 
   private int labelWidthWest; // label left width in pixels if shown
 
-  private int wrappedSpaceAboveAlignment; // gap between widths
+  int wrappedSpaceAboveAlignment; // gap between widths
 
-  private int wrappedRepeatHeightPx; // height in pixels of wrapped width
+  int wrappedRepeatHeightPx; // height in pixels of wrapped width
 
   private int wrappedVisibleWidths; // number of wrapped widths displayed
 
@@ -445,21 +450,23 @@ public class SeqCanvas extends JComponent implements ViewportListenerI
   }
 
   /**
-   * Draw a wrapped alignment panel for printing
+   * Draws a wrapped alignment panel for printing. After drawing, the graphics
+   * origin is shifted down by the height of the image drawn.
    * 
    * @param g
-   *          Graphics object to draw with
+   *                       Graphics object to draw with
    * @param canvasWidth
-   *          width of drawing area
+   *                       width of drawing area
    * @param canvasHeight
-   *          height of drawing area
+   *                       height of drawing area
    * @param startRes
-   *          start residue of print area
+   *                       start residue of print area
    */
   public void drawWrappedPanelForPrinting(Graphics g, int canvasWidth,
           int canvasHeight, int startRes)
   {
-    drawWrappedPanel(g, canvasWidth, canvasHeight, startRes);
+    int heightDrawn = drawWrappedPanel(g, canvasWidth, canvasHeight,
+            startRes);
 
     SequenceGroup group = av.getSelectionGroup();
     if (group != null)
@@ -467,6 +474,11 @@ public class SeqCanvas extends JComponent implements ViewportListenerI
       drawWrappedSelection((Graphics2D) g, group, canvasWidth, canvasHeight,
                 startRes);
     }
+
+    /*
+     * shift graphics (0, 0) to below the region drawn
+     */
+    g.translate(0, heightDrawn);
   }
 
   /**
@@ -531,23 +543,24 @@ public class SeqCanvas extends JComponent implements ViewportListenerI
   }
 
   /**
-   * Draws as many widths of a wrapped alignment as can fit in the visible
-   * window
+   * Draws as many widths of a wrapped alignment as can fit in the visible window,
+   * and returns the height drawn in pixels
    * 
    * @param g
    * @param canvasWidth
-   *          available width in pixels
+   *                       available width in pixels
    * @param canvasHeight
-   *          available height in pixels
+   *                       available height in pixels
    * @param startColumn
-   *          the first column (0...) of the alignment to draw
+   *                       the first column (0...) of the alignment to draw
+   * 
+   * @return
    */
-  public void drawWrappedPanel(Graphics g, int canvasWidth,
+  public int drawWrappedPanel(Graphics g, int canvasWidth,
           int canvasHeight, final int startColumn)
   {
     int wrappedWidthInResidues = calculateWrappedGeometry(canvasWidth,
             canvasHeight);
-
     av.setWrappedWidth(wrappedWidthInResidues);
 
     ViewportRanges ranges = av.getRanges();
@@ -559,7 +572,7 @@ public class SeqCanvas extends JComponent implements ViewportListenerI
     calculateWrappedGeometry(canvasWidth, canvasHeight);
 
     /*
-     * draw one width at a time (excluding any scales or annotation shown),
+     * draw one width at a time (excluding any scales shown),
      * until we have run out of either alignment or vertical space available
      */
     int ypos = wrappedSpaceAboveAlignment;
@@ -578,6 +591,8 @@ public class SeqCanvas extends JComponent implements ViewportListenerI
     }
 
     drawWrappedDecorators(g, startColumn);
+
+    return ypos;
   }
 
   /**
@@ -606,14 +621,22 @@ public class SeqCanvas extends JComponent implements ViewportListenerI
             * (av.getScaleAboveWrapped() ? 2 : 1);
 
     /*
-     * height in pixels of the wrapped widths
+     * compute height in pixels of the wrapped widths
+     * - start with space above plus sequences
      */
     wrappedRepeatHeightPx = wrappedSpaceAboveAlignment;
-    // add sequences
     wrappedRepeatHeightPx += av.getAlignment().getHeight()
             * charHeight;
-    // add annotations panel height if shown
-    wrappedRepeatHeightPx += getAnnotationHeight();
+
+    /*
+     * add annotations panel height if shown
+     * also gap between sequences and annotations
+     */
+    if (av.isShowAnnotation())
+    {
+      wrappedRepeatHeightPx += getAnnotationHeight();
+      wrappedRepeatHeightPx += SEQS_ANNOTATION_GAP; // 3px
+    }
 
     /*
      * number of visible widths (the last one may be part height),
@@ -657,8 +680,9 @@ public class SeqCanvas extends JComponent implements ViewportListenerI
    * @param endColumn
    * @param canvasHeight
    */
-  protected void drawWrappedWidth(Graphics g, int ypos, int startColumn,
-          int endColumn, int canvasHeight)
+  protected void drawWrappedWidth(Graphics g, final int ypos,
+          final int startColumn, final int endColumn,
+          final int canvasHeight)
   {
     ViewportRanges ranges = av.getRanges();
     int viewportWidth = ranges.getViewportWidth();
@@ -680,11 +704,7 @@ public class SeqCanvas extends JComponent implements ViewportListenerI
     // the Printable page which we need to account for here
     Shape clip = g.getClip();
 
-    if (clip == null)
-    {
-      g.setClip(0, 0, viewportWidth * charWidth, canvasHeight);
-    }
-    else
+    if (clip != null)
     {
       g.setClip(0, (int) clip.getBounds().getY(),
               viewportWidth * charWidth, (int) clip.getBounds().getHeight());
@@ -705,7 +725,8 @@ public class SeqCanvas extends JComponent implements ViewportListenerI
 
     if (av.isShowAnnotation())
     {
-      g.translate(0, cHeight + ypos + 3);
+      final int yShift = cHeight + ypos + SEQS_ANNOTATION_GAP;
+      g.translate(0, yShift);
       if (annotations == null)
       {
         annotations = new AnnotationPanel(av);
@@ -713,9 +734,14 @@ public class SeqCanvas extends JComponent implements ViewportListenerI
 
       annotations.renderer.drawComponent(annotations, av, g, -1,
               startColumn, endx + 1);
-      g.translate(0, -cHeight - ypos - 3);
+      g.translate(0, -yShift);
     }
-    g.setClip(clip);
+
+    if (clip != null)
+    {
+      g.setClip(clip);
+    }
+
     g.translate(-xOffset, 0);
   }
 
@@ -838,41 +864,24 @@ public class SeqCanvas extends JComponent implements ViewportListenerI
           int canvasWidth,
           int canvasHeight, int startRes)
   {
-    int charHeight = av.getCharHeight();
-    int charWidth = av.getCharWidth();
-      
-    // height gap above each panel
-    int hgap = charHeight;
-    if (av.getScaleAboveWrapped())
-    {
-      hgap += charHeight;
-    }
-
-    int cWidth = (canvasWidth - labelWidthEast - labelWidthWest)
-            / charWidth;
-    int cHeight = av.getAlignment().getHeight() * charHeight;
-
-    int startx = startRes;
-    int endx;
-    int ypos = hgap; // vertical offset
-    int maxwidth = av.getAlignment().getWidth();
-
-    if (av.hasHiddenColumns())
-    {
-      maxwidth = av.getAlignment().getHiddenColumns()
-              .absoluteToVisibleColumn(maxwidth);
-    }
-
     // chop the wrapped alignment extent up into panel-sized blocks and treat
     // each block as if it were a block from an unwrapped alignment
     g.setStroke(new BasicStroke(1, BasicStroke.CAP_BUTT,
             BasicStroke.JOIN_ROUND, 3f, new float[]
             { 5f, 3f }, 0f));
     g.setColor(Color.RED);
+
+    int charWidth = av.getCharWidth();
+    int cWidth = (canvasWidth - labelWidthEast - labelWidthWest)
+            / charWidth;
+    int startx = startRes;
+    int maxwidth = av.getAlignment().getVisibleWidth();
+    int ypos = wrappedSpaceAboveAlignment;
+
     while ((ypos <= canvasHeight) && (startx < maxwidth))
     {
       // set end value to be start + width, or maxwidth, whichever is smaller
-      endx = startx + cWidth - 1;
+      int endx = startx + cWidth - 1;
 
       if (endx > maxwidth)
       {
@@ -880,22 +889,24 @@ public class SeqCanvas extends JComponent implements ViewportListenerI
       }
 
       g.translate(labelWidthWest, 0);
-
       drawUnwrappedSelection(g, group, startx, endx, 0,
               av.getAlignment().getHeight() - 1,
               ypos);
-
       g.translate(-labelWidthWest, 0);
 
-      // update vertical offset
-      ypos += cHeight + getAnnotationHeight() + hgap;
+      ypos += wrappedRepeatHeightPx;
 
-      // update horizontal offset
       startx += cWidth;
     }
     g.setStroke(new BasicStroke());
   }
 
+  /**
+   * Answers zero if annotations are not shown, otherwise recalculates and answers
+   * the total height of all annotation rows in pixels
+   * 
+   * @return
+   */
   int getAnnotationHeight()
   {
     if (!av.isShowAnnotation())
@@ -1646,7 +1657,7 @@ public class SeqCanvas extends JComponent implements ViewportListenerI
       }
       ViewportRanges vpRanges = av.getRanges();
 
-      int range = vpRanges.getEndRes() - vpRanges.getStartRes();
+      int range = vpRanges.getEndRes() - vpRanges.getStartRes() + 1;
       if (scrollX > range)
       {
         scrollX = range;
@@ -1715,10 +1726,10 @@ public class SeqCanvas extends JComponent implements ViewportListenerI
   {
     ViewportRanges ranges = av.getRanges();
 
-    if (Math.abs(scrollX) > ranges.getViewportWidth())
+    if (Math.abs(scrollX) >= ranges.getViewportWidth())
     {
       /*
-       * shift of more than one view width is 
+       * shift of one view width or more is 
        * overcomplicated to handle in this method
        */
       fastPaint = false;
@@ -1909,10 +1920,17 @@ public class SeqCanvas extends JComponent implements ViewportListenerI
 
       while (y >= 0)
       {
+        /*
+         * shift 'widthToCopy' residues by 'positions' places to the right
+         */
         gg.copyArea(copyFromLeftStart, y, widthToCopy, heightToCopy,
                 positions * charWidth, 0);
         if (y > 0)
         {
+          /*
+           * copy 'positions' residue from the row above (right hand end)
+           * to this row's left hand end
+           */
           gg.copyArea(copyFromRightStart, y - wrappedRepeatHeightPx,
                   positions * charWidth, heightToCopy, -widthToCopy,
                   wrappedRepeatHeightPx);