src/jalview/gui/SeqCanvas.java

   1 /*
   2  * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
   3  * Copyright (C) $$Year-Rel$$ The Jalview Authors
   4  *
   5  * This file is part of Jalview.
   6  *
   7  * Jalview is free software: you can redistribute it and/or
   8  * modify it under the terms of the GNU General Public License
   9  * as published by the Free Software Foundation, either version 3
  10  * of the License, or (at your option) any later version.
  11  *
  12  * Jalview is distributed in the hope that it will be useful, but
  13  * WITHOUT ANY WARRANTY; without even the implied warranty
  14  * of MERCHANTABILITY or FITNESS FOR A PARTICULAR
  15  * PURPOSE.  See the GNU General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License
  18  * along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
  19  * The Jalview Authors are detailed in the 'AUTHORS' file.
  20  */
  21 package jalview.gui;
  22
  23 import jalview.datamodel.AlignmentI;
  24 import jalview.datamodel.HiddenColumns;
  25 import jalview.datamodel.SearchResultsI;
  26 import jalview.datamodel.SequenceGroup;
  27 import jalview.datamodel.SequenceI;
  28 import jalview.renderer.ScaleRenderer;
  29 import jalview.renderer.ScaleRenderer.ScaleMark;
  30 import jalview.util.Comparison;
  31 import jalview.viewmodel.ViewportListenerI;
  32 import jalview.viewmodel.ViewportRanges;
  33
  34 import java.awt.AlphaComposite;
  35 import java.awt.BasicStroke;
  36 import java.awt.BorderLayout;
  37 import java.awt.Color;
  38 import java.awt.FontMetrics;
  39 import java.awt.Graphics;
  40 import java.awt.Graphics2D;
  41 import java.awt.RenderingHints;
  42 import java.awt.Shape;
  43 import java.awt.image.BufferedImage;
  44 import java.beans.PropertyChangeEvent;
  45 import java.util.List;
  46
  47 import javax.swing.JComponent;
  48
  49 /**
  50  * The Swing component on which the alignment sequences, and annotations (if
  51  * shown), are drawn. This includes scales above, left and right (if shown) in
  52  * Wrapped mode, but not the scale above in Unwrapped mode.
  53  *
  54  */
  55 public class SeqCanvas extends JComponent implements ViewportListenerI
  56 {
  57   private static final String ZEROS = "0000000000";
  58
  59   final FeatureRenderer fr;
  60
  61   BufferedImage img;
  62
  63   AlignViewport av;
  64
  65   int cursorX = 0;
  66
  67   int cursorY = 0;
  68
  69   private final SequenceRenderer seqRdr;
  70
  71   private boolean fastPaint = false;
  72
  73   private boolean fastpainting = false;
  74
  75   private AnnotationPanel annotations;
  76
  77   /*
  78    * measurements for drawing a wrapped alignment
  79    */
  80   private int labelWidthEast; // label right width in pixels if shown
  81
  82   private int labelWidthWest; // label left width in pixels if shown
  83
  84   private int wrappedSpaceAboveAlignment; // gap between widths
  85
  86   private int wrappedRepeatHeightPx; // height in pixels of wrapped width
  87
  88   private int wrappedVisibleWidths; // number of wrapped widths displayed
  89
  90   private Graphics2D gg;
  91
  92   /**
  93    * Creates a new SeqCanvas object.
  94    *
  95    * @param ap
  96    */
  97   public SeqCanvas(AlignmentPanel ap)
  98   {
  99     this.av = ap.av;
 100     fr = new FeatureRenderer(ap);
 101     seqRdr = new SequenceRenderer(av);
 102     setLayout(new BorderLayout());
 103     PaintRefresher.Register(this, av.getSequenceSetId());
 104     setBackground(Color.white);
 105
 106     av.getRanges().addPropertyChangeListener(this);
 107   }
 108
 109   public SequenceRenderer getSequenceRenderer()
 110   {
 111     return seqRdr;
 112   }
 113
 114   public FeatureRenderer getFeatureRenderer()
 115   {
 116     return fr;
 117   }
 118
 119   /**
 120    * Draws the scale above a region of a wrapped alignment, consisting of a
 121    * column number every major interval (10 columns).
 122    *
 123    * @param g
 124    *          the graphics context to draw on, positioned at the start (bottom
 125    *          left) of the line on which to draw any scale marks
 126    * @param startx
 127    *          start alignment column (0..)
 128    * @param endx
 129    *          end alignment column (0..)
 130    * @param ypos
 131    *          y offset to draw at
 132    */
 133   private void drawNorthScale(Graphics g, int startx, int endx, int ypos)
 134   {
 135     int charHeight = av.getCharHeight();
 136     int charWidth = av.getCharWidth();
 137
 138     /*
 139      * white fill the scale space (for the fastPaint case)
 140      */
 141     g.setColor(Color.white);
 142     g.fillRect(0, ypos - charHeight - charHeight / 2, getWidth(),
 143             charHeight * 3 / 2 + 2);
 144     g.setColor(Color.black);
 145
 146     List<ScaleMark> marks = new ScaleRenderer().calculateMarks(av, startx,
 147             endx);
 148     for (ScaleMark mark : marks)
 149     {
 150       int mpos = mark.column; // (i - startx - 1)
 151       if (mpos < 0)
 152       {
 153         continue;
 154       }
 155       String mstring = mark.text;
 156
 157       if (mark.major)
 158       {
 159         if (mstring != null)
 160         {
 161           g.drawString(mstring, mpos * charWidth, ypos - (charHeight / 2));
 162         }
 163
 164         /*
 165          * draw a tick mark below the column number, centred on the column;
 166          * height of tick mark is 4 pixels less than half a character
 167          */
 168         int xpos = (mpos * charWidth) + (charWidth / 2);
 169         g.drawLine(xpos, (ypos + 2) - (charHeight / 2), xpos, ypos - 2);
 170       }
 171     }
 172   }
 173
 174   /**
 175    * Draw the scale to the left or right of a wrapped alignment
 176    *
 177    * @param g
 178    *          graphics context, positioned at the start of the scale to be drawn
 179    * @param startx
 180    *          first column of wrapped width (0.. excluding any hidden columns)
 181    * @param endx
 182    *          last column of wrapped width (0.. excluding any hidden columns)
 183    * @param ypos
 184    *          vertical offset at which to begin the scale
 185    * @param left
 186    *          if true, scale is left of residues, if false, scale is right
 187    */
 188   void drawVerticalScale(Graphics g, final int startx, final int endx,
 189           final int ypos, final boolean left)
 190   {
 191     int charHeight = av.getCharHeight();
 192     int charWidth = av.getCharWidth();
 193
 194     int yPos = ypos + charHeight;
 195     int startX = startx;
 196     int endX = endx;
 197
 198     if (av.hasHiddenColumns())
 199     {
 200       HiddenColumns hiddenColumns = av.getAlignment().getHiddenColumns();
 201       startX = hiddenColumns.adjustForHiddenColumns(startx);
 202       endX = hiddenColumns.adjustForHiddenColumns(endx);
 203     }
 204     FontMetrics fm = getFontMetrics(av.getFont());
 205
 206     for (int i = 0; i < av.getAlignment().getHeight(); i++)
 207     {
 208       SequenceI seq = av.getAlignment().getSequenceAt(i);
 209
 210       /*
 211        * find sequence position of first non-gapped position -
 212        * to the right if scale left, to the left if scale right
 213        */
 214       int index = left ? startX : endX;
 215       int value = -1;
 216       while (index >= startX && index <= endX)
 217       {
 218         if (!Comparison.isGap(seq.getCharAt(index)))
 219         {
 220           value = seq.findPosition(index);
 221           break;
 222         }
 223         if (left)
 224         {
 225           index++;
 226         }
 227         else
 228         {
 229           index--;
 230         }
 231       }
 232
 233       /*
 234        * white fill the space for the scale
 235        */
 236       g.setColor(Color.white);
 237       int y = (yPos + (i * charHeight)) - (charHeight / 5);
 238       // fillRect origin is top left of rectangle
 239       g.fillRect(0, y - charHeight, left ? labelWidthWest : labelWidthEast,
 240               charHeight + 1);
 241
 242       if (value != -1)
 243       {
 244         /*
 245          * draw scale value, right justified within its width less half a
 246          * character width padding on the right
 247          */
 248         int labelSpace = left ? labelWidthWest : labelWidthEast;
 249         labelSpace -= charWidth / 2; // leave space to the right
 250         String valueAsString = String.valueOf(value);
 251         int labelLength = fm.stringWidth(valueAsString);
 252         int xOffset = labelSpace - labelLength;
 253         g.setColor(Color.black);
 254         g.drawString(valueAsString, xOffset, y);
 255       }
 256     }
 257   }
 258
 259   /**
 260    * Does a fast paint of an alignment in response to a scroll. Most of the
 261    * visible region is simply copied and shifted, and then any newly visible
 262    * columns or rows are drawn. The scroll may be horizontal or vertical, but
 263    * not both at once. Scrolling may be the result of
 264    * <ul>
 265    * <li>dragging a scroll bar</li>
 266    * <li>clicking in the scroll bar</li>
 267    * <li>scrolling by trackpad, middle mouse button, or other device</li>
 268    * <li>by moving the box in the Overview window</li>
 269    * <li>programmatically to make a highlighted position visible</li>
 270    * </ul>
 271    *
 272    * @param horizontal
 273    *          columns to shift right (positive) or left (negative)
 274    * @param vertical
 275    *          rows to shift down (positive) or up (negative)
 276    */
 277   public void fastPaint(int horizontal, int vertical)
 278   {
 279     if (fastpainting || gg == null || img == null)
 280     {
 281       return;
 282     }
 283     fastpainting = true;
 284     fastPaint = true;
 285
 286     try
 287     {
 288       int charHeight = av.getCharHeight();
 289       int charWidth = av.getCharWidth();
 290
 291       ViewportRanges ranges = av.getRanges();
 292       int startRes = ranges.getStartRes();
 293       int endRes = ranges.getEndRes();
 294       int startSeq = ranges.getStartSeq();
 295       int endSeq = ranges.getEndSeq();
 296       int transX = 0;
 297       int transY = 0;
 298
 299     gg.copyArea(horizontal * charWidth, vertical * charHeight,
 300             img.getWidth(), img.getHeight(), -horizontal * charWidth,
 301             -vertical * charHeight);
 302
 303     if (horizontal > 0) // scrollbar pulled right, image to the left
 304     {
 305       transX = (endRes - startRes - horizontal) * charWidth;
 306       startRes = endRes - horizontal;
 307     }
 308     else if (horizontal < 0)
 309     {
 310       endRes = startRes - horizontal;
 311     }
 312     else if (vertical > 0) // scroll down
 313     {
 314       startSeq = endSeq - vertical;
 315
 316       if (startSeq < ranges.getStartSeq())
 317       { // ie scrolling too fast, more than a page at a time
 318         startSeq = ranges.getStartSeq();
 319       }
 320       else
 321       {
 322         transY = img.getHeight() - ((vertical + 1) * charHeight);
 323       }
 324     }
 325     else if (vertical < 0)
 326     {
 327       endSeq = startSeq - vertical;
 328
 329       if (endSeq > ranges.getEndSeq())
 330       {
 331         endSeq = ranges.getEndSeq();
 332       }
 333     }
 334
 335     gg.translate(transX, transY);
 336     drawPanel(gg, startRes, endRes, startSeq, endSeq, 0);
 337     gg.translate(-transX, -transY);
 338
 339     repaint();
 340     } finally
 341     {
 342       fastpainting = false;
 343     }
 344   }
 345
 346   @Override
 347   public void paintComponent(Graphics g)
 348   {
 349     super.paintComponent(g);
 350
 351     int charHeight = av.getCharHeight();
 352     int charWidth = av.getCharWidth();
 353
 354     ViewportRanges ranges = av.getRanges();
 355
 356     int width = getWidth();
 357     int height = getHeight();
 358
 359     width -= (width % charWidth);
 360     height -= (height % charHeight);
 361
 362     // selectImage is the selection group outline image
 363     BufferedImage selectImage = drawSelectionGroup(
 364             ranges.getStartRes(), ranges.getEndRes(),
 365             ranges.getStartSeq(), ranges.getEndSeq());
 366
 367     BufferedImage cursorImage = drawCursor(ranges.getStartRes(),
 368             ranges.getEndRes(), ranges.getStartSeq(), ranges.getEndSeq());
 369
 370     if ((img != null) && (fastPaint
 371             || (getVisibleRect().width != g.getClipBounds().width)
 372             || (getVisibleRect().height != g.getClipBounds().height)))
 373     {
 374       BufferedImage lcimg = buildLocalImage(selectImage, cursorImage);
 375       g.drawImage(lcimg, 0, 0, this);
 376       fastPaint = false;
 377     }
 378     else if ((width > 0) && (height > 0))
 379     {
 380       // img is a cached version of the last view we drew, if any
 381       // if we have no img or the size has changed, make a new one
 382       if (img == null || width != img.getWidth()
 383               || height != img.getHeight())
 384       {
 385         img = setupImage();
 386         if (img == null)
 387         {
 388           return;
 389         }
 390         gg = (Graphics2D) img.getGraphics();
 391         gg.setFont(av.getFont());
 392       }
 393
 394       if (av.antiAlias)
 395       {
 396         gg.setRenderingHint(RenderingHints.KEY_ANTIALIASING,
 397                 RenderingHints.VALUE_ANTIALIAS_ON);
 398       }
 399
 400       gg.setColor(Color.white);
 401       gg.fillRect(0, 0, img.getWidth(), img.getHeight());
 402
 403       if (av.getWrapAlignment())
 404       {
 405         drawWrappedPanel(gg, getWidth(), getHeight(), ranges.getStartRes());
 406       }
 407       else
 408       {
 409         drawPanel(gg, ranges.getStartRes(), ranges.getEndRes(),
 410                 ranges.getStartSeq(), ranges.getEndSeq(), 0);
 411       }
 412
 413       // lcimg is a local *copy* of img which we'll draw selectImage on top of
 414       BufferedImage lcimg = buildLocalImage(selectImage, cursorImage);
 415       g.drawImage(lcimg, 0, 0, this);
 416     }
 417   }
 418
 419   /**
 420    * Draw an alignment panel for printing
 421    *
 422    * @param g1
 423    *          Graphics object to draw with
 424    * @param startRes
 425    *          start residue of print area
 426    * @param endRes
 427    *          end residue of print area
 428    * @param startSeq
 429    *          start sequence of print area
 430    * @param endSeq
 431    *          end sequence of print area
 432    */
 433   public void drawPanelForPrinting(Graphics g1, int startRes, int endRes,
 434           int startSeq, int endSeq)
 435   {
 436     drawPanel(g1, startRes, endRes, startSeq, endSeq, 0);
 437
 438     BufferedImage selectImage = drawSelectionGroup(startRes, endRes,
 439             startSeq, endSeq);
 440     if (selectImage != null)
 441     {
 442       ((Graphics2D) g1).setComposite(AlphaComposite
 443               .getInstance(AlphaComposite.SRC_OVER));
 444       g1.drawImage(selectImage, 0, 0, this);
 445     }
 446   }
 447
 448   /**
 449    * Draw a wrapped alignment panel for printing
 450    *
 451    * @param g
 452    *          Graphics object to draw with
 453    * @param canvasWidth
 454    *          width of drawing area
 455    * @param canvasHeight
 456    *          height of drawing area
 457    * @param startRes
 458    *          start residue of print area
 459    */
 460   public void drawWrappedPanelForPrinting(Graphics g, int canvasWidth,
 461           int canvasHeight, int startRes)
 462   {
 463     SequenceGroup group = av.getSelectionGroup();
 464
 465     drawWrappedPanel(g, canvasWidth, canvasHeight, startRes);
 466
 467     if (group != null)
 468     {
 469       BufferedImage selectImage = null;
 470       try
 471       {
 472         selectImage = new BufferedImage(canvasWidth, canvasHeight,
 473                 BufferedImage.TYPE_INT_ARGB); // ARGB so alpha compositing works
 474       } catch (OutOfMemoryError er)
 475       {
 476         System.gc();
 477         System.err.println("Print image OutOfMemory Error.\n" + er);
 478         new OOMWarning("Creating wrapped alignment image for printing", er);
 479       }
 480       if (selectImage != null)
 481       {
 482         Graphics2D g2 = selectImage.createGraphics();
 483         setupSelectionGroup(g2, selectImage);
 484         drawWrappedSelection(g2, group, canvasWidth, canvasHeight,
 485                 startRes);
 486
 487         g2.setComposite(
 488                 AlphaComposite.getInstance(AlphaComposite.SRC_OVER));
 489         g.drawImage(selectImage, 0, 0, this);
 490         g2.dispose();
 491       }
 492     }
 493   }
 494
 495   /*
 496    * Make a local image by combining the cached image img
 497    * with any selection
 498    */
 499   private BufferedImage buildLocalImage(BufferedImage selectImage,
 500           BufferedImage cursorImage)
 501   {
 502     // clone the cached image
 503     BufferedImage lcimg = new BufferedImage(img.getWidth(), img.getHeight(),
 504             img.getType());
 505     Graphics2D g2d = lcimg.createGraphics();
 506     g2d.drawImage(img, 0, 0, null);
 507
 508     // overlay selection group on lcimg
 509     if (selectImage != null)
 510     {
 511       g2d.setComposite(
 512               AlphaComposite.getInstance(AlphaComposite.SRC_OVER));
 513       g2d.drawImage(selectImage, 0, 0, this);
 514     }
 515     // overlay cursor on lcimg
 516     if (cursorImage != null)
 517     {
 518       g2d.setComposite(AlphaComposite.getInstance(AlphaComposite.SRC_OVER));
 519       g2d.drawImage(cursorImage, 0, 0, this);
 520     }
 521     g2d.dispose();
 522
 523     return lcimg;
 524   }
 525
 526   /*
 527    * Set up a buffered image of the correct height and size for the sequence canvas
 528    */
 529   private BufferedImage setupImage()
 530   {
 531     BufferedImage lcimg = null;
 532
 533     int charWidth = av.getCharWidth();
 534     int charHeight = av.getCharHeight();
 535
 536     int width = getWidth();
 537     int height = getHeight();
 538
 539     width -= (width % charWidth);
 540     height -= (height % charHeight);
 541
 542     if ((width < 1) || (height < 1))
 543     {
 544       return null;
 545     }
 546
 547     try
 548     {
 549       lcimg = new BufferedImage(width, height,
 550               BufferedImage.TYPE_INT_ARGB); // ARGB so alpha compositing works
 551     } catch (OutOfMemoryError er)
 552     {
 553       System.gc();
 554       System.err.println(
 555               "Group image OutOfMemory Redraw Error.\n" + er);
 556       new OOMWarning("Creating alignment image for display", er);
 557
 558       return null;
 559     }
 560
 561     return lcimg;
 562   }
 563
 564   /**
 565    * Returns the visible width of the canvas in residues, after allowing for
 566    * East or West scales (if shown)
 567    *
 568    * @param canvasWidth
 569    *          the width in pixels (possibly including scales)
 570    *
 571    * @return
 572    */
 573   public int getWrappedCanvasWidth(int canvasWidth)
 574   {
 575     int charWidth = av.getCharWidth();
 576
 577     FontMetrics fm = getFontMetrics(av.getFont());
 578
 579     int labelWidth = 0;
 580
 581     if (av.getScaleRightWrapped() || av.getScaleLeftWrapped())
 582     {
 583       labelWidth = getLabelWidth(fm);
 584     }
 585
 586     labelWidthEast = av.getScaleRightWrapped() ? labelWidth : 0;
 587
 588     labelWidthWest = av.getScaleLeftWrapped() ? labelWidth : 0;
 589
 590     return (canvasWidth - labelWidthEast - labelWidthWest) / charWidth;
 591   }
 592
 593   /**
 594    * Returns a pixel width sufficient to show the largest sequence coordinate
 595    * (end position) in the alignment, calculated as the FontMetrics width of
 596    * zeroes "0000000" limited to the number of decimal digits to be shown (3 for
 597    * 1-10, 4 for 11-99 etc). One character width is added to this, to allow for
 598    * half a character width space on either side.
 599    *
 600    * @param fm
 601    * @return
 602    */
 603   protected int getLabelWidth(FontMetrics fm)
 604   {
 605     /*
 606      * find the biggest sequence end position we need to show
 607      * (note this is not necessarily the sequence length)
 608      */
 609     int maxWidth = 0;
 610     AlignmentI alignment = av.getAlignment();
 611     for (int i = 0; i < alignment.getHeight(); i++)
 612     {
 613       maxWidth = Math.max(maxWidth, alignment.getSequenceAt(i).getEnd());
 614     }
 615
 616     int length = 0;
 617     for (int i = maxWidth; i > 0; i /= 10)
 618     {
 619       length++;
 620     }
 621
 622     return fm.stringWidth(ZEROS.substring(0, length)) + av.getCharWidth();
 623   }
 624
 625   /**
 626    * Draws as many widths of a wrapped alignment as can fit in the visible
 627    * window
 628    *
 629    * @param g
 630    * @param canvasWidth
 631    *          available width in pixels
 632    * @param canvasHeight
 633    *          available height in pixels
 634    * @param startColumn
 635    *          the first column (0...) of the alignment to draw
 636    */
 637   public void drawWrappedPanel(Graphics g, int canvasWidth,
 638           int canvasHeight, final int startColumn)
 639   {
 640     int wrappedWidthInResidues = calculateWrappedGeometry(canvasWidth,
 641             canvasHeight);
 642
 643     av.setWrappedWidth(wrappedWidthInResidues);
 644
 645     ViewportRanges ranges = av.getRanges();
 646     ranges.setViewportStartAndWidth(startColumn, wrappedWidthInResidues);
 647
 648     /*
 649      * draw one width at a time (including any scales or annotation shown),
 650      * until we have run out of either alignment or vertical space available
 651      */
 652     int ypos = wrappedSpaceAboveAlignment;
 653     int maxWidth = ranges.getVisibleAlignmentWidth();
 654
 655     int start = startColumn;
 656     int currentWidth = 0;
 657     while ((currentWidth < wrappedVisibleWidths) && (start < maxWidth))
 658     {
 659       int endColumn = Math
 660               .min(maxWidth, start + wrappedWidthInResidues - 1);
 661       drawWrappedWidth(g, ypos, start, endColumn, canvasHeight);
 662       ypos += wrappedRepeatHeightPx;
 663       start += wrappedWidthInResidues;
 664       currentWidth++;
 665     }
 666
 667     drawWrappedDecorators(g, startColumn);
 668   }
 669
 670   /**
 671    * Calculates and saves values needed when rendering a wrapped alignment.
 672    * These depend on many factors, including
 673    * <ul>
 674    * <li>canvas width and height</li>
 675    * <li>number of visible sequences, and height of annotations if shown</li>
 676    * <li>font and character width</li>
 677    * <li>whether scales are shown left, right or above the alignment</li>
 678    * </ul>
 679    *
 680    * @param canvasWidth
 681    * @param canvasHeight
 682    * @return the number of residue columns in each width
 683    */
 684   protected int calculateWrappedGeometry(int canvasWidth, int canvasHeight)
 685   {
 686     int charHeight = av.getCharHeight();
 687
 688     /*
 689      * vertical space in pixels between wrapped widths of alignment
 690      * - one character height, or two if scale above is drawn
 691      */
 692     wrappedSpaceAboveAlignment = charHeight
 693             * (av.getScaleAboveWrapped() ? 2 : 1);
 694
 695     /*
 696      * height in pixels of the wrapped widths
 697      */
 698     wrappedRepeatHeightPx = wrappedSpaceAboveAlignment;
 699     // add sequences
 700     wrappedRepeatHeightPx += av.getRanges().getViewportHeight()
 701             * charHeight;
 702     // add annotations panel height if shown
 703     wrappedRepeatHeightPx += getAnnotationHeight();
 704
 705     /*
 706      * number of visible widths (the last one may be part height),
 707      * ensuring a part height includes at least one sequence
 708      */
 709     ViewportRanges ranges = av.getRanges();
 710     wrappedVisibleWidths = canvasHeight / wrappedRepeatHeightPx;
 711     int remainder = canvasHeight % wrappedRepeatHeightPx;
 712     if (remainder >= (wrappedSpaceAboveAlignment + charHeight))
 713     {
 714       wrappedVisibleWidths++;
 715     }
 716
 717     /*
 718      * compute width in residues; this also sets East and West label widths
 719      */
 720     int wrappedWidthInResidues = getWrappedCanvasWidth(canvasWidth);
 721
 722     /*
 723      *  limit visibleWidths to not exceed width of alignment
 724      */
 725     int xMax = ranges.getVisibleAlignmentWidth();
 726     int startToEnd = xMax - ranges.getStartRes();
 727     int maxWidths = startToEnd / wrappedWidthInResidues;
 728     if (startToEnd % wrappedWidthInResidues > 0)
 729     {
 730       maxWidths++;
 731     }
 732     wrappedVisibleWidths = Math.min(wrappedVisibleWidths, maxWidths);
 733
 734     return wrappedWidthInResidues;
 735   }
 736
 737   /**
 738    * Draws one width of a wrapped alignment, including sequences and
 739    * annnotations, if shown, but not scales or hidden column markers
 740    *
 741    * @param g
 742    * @param ypos
 743    * @param startColumn
 744    * @param endColumn
 745    * @param canvasHeight
 746    */
 747   protected void drawWrappedWidth(Graphics g, int ypos, int startColumn,
 748           int endColumn, int canvasHeight)
 749   {
 750     ViewportRanges ranges = av.getRanges();
 751     int viewportWidth = ranges.getViewportWidth();
 752
 753     int endx = Math.min(startColumn + viewportWidth - 1, endColumn);
 754
 755     /*
 756      * move right before drawing by the width of the scale left (if any)
 757      * plus column offset from left margin (usually zero, but may be non-zero
 758      * when fast painting is drawing just a few columns)
 759      */
 760     int charWidth = av.getCharWidth();
 761     int xOffset = labelWidthWest
 762             + ((startColumn - ranges.getStartRes()) % viewportWidth)
 763             * charWidth;
 764     g.translate(xOffset, 0);
 765
 766     // When printing we have an extra clipped region,
 767     // the Printable page which we need to account for here
 768     Shape clip = g.getClip();
 769
 770     if (clip == null)
 771     {
 772       g.setClip(0, 0, viewportWidth * charWidth, canvasHeight);
 773     }
 774     else
 775     {
 776       g.setClip(0, (int) clip.getBounds().getY(),
 777               viewportWidth * charWidth, (int) clip.getBounds().getHeight());
 778     }
 779
 780     /*
 781      * white fill the region to be drawn (so incremental fast paint doesn't
 782      * scribble over an existing image)
 783      */
 784     gg.setColor(Color.white);
 785     gg.fillRect(0, ypos, (endx - startColumn + 1) * charWidth,
 786             wrappedRepeatHeightPx);
 787
 788     drawPanel(g, startColumn, endx, 0, av.getAlignment().getHeight() - 1,
 789             ypos);
 790
 791     int cHeight = av.getAlignment().getHeight() * av.getCharHeight();
 792
 793     if (av.isShowAnnotation())
 794     {
 795       g.translate(0, cHeight + ypos + 3);
 796       if (annotations == null)
 797       {
 798         annotations = new AnnotationPanel(av);
 799       }
 800
 801       annotations.renderer.drawComponent(annotations, av, g, -1,
 802               startColumn, endx + 1);
 803       g.translate(0, -cHeight - ypos - 3);
 804     }
 805     g.setClip(clip);
 806     g.translate(-xOffset, 0);
 807   }
 808
 809   /**
 810    * Draws scales left, right and above (if shown), and any hidden column
 811    * markers, on all widths of the wrapped alignment
 812    *
 813    * @param g
 814    * @param startColumn
 815    */
 816   protected void drawWrappedDecorators(Graphics g, final int startColumn)
 817   {
 818     int charWidth = av.getCharWidth();
 819
 820     g.setFont(av.getFont());
 821     g.setColor(Color.black);
 822
 823     int ypos = wrappedSpaceAboveAlignment;
 824     ViewportRanges ranges = av.getRanges();
 825     int viewportWidth = ranges.getViewportWidth();
 826     int maxWidth = ranges.getVisibleAlignmentWidth();
 827     int widthsDrawn = 0;
 828     int startCol = startColumn;
 829
 830     while (widthsDrawn < wrappedVisibleWidths)
 831     {
 832       int endColumn = Math.min(maxWidth, startCol + viewportWidth - 1);
 833
 834       if (av.getScaleLeftWrapped())
 835       {
 836         drawVerticalScale(g, startCol, endColumn - 1, ypos, true);
 837       }
 838
 839       if (av.getScaleRightWrapped())
 840       {
 841         int x = labelWidthWest + viewportWidth * charWidth;
 842         g.translate(x, 0);
 843         drawVerticalScale(g, startCol, endColumn, ypos, false);
 844         g.translate(-x, 0);
 845       }
 846
 847       /*
 848        * white fill region of scale above and hidden column markers
 849        * (to support incremental fast paint of image)
 850        */
 851       g.translate(labelWidthWest, 0);
 852       g.setColor(Color.white);
 853       g.fillRect(0, ypos - wrappedSpaceAboveAlignment, viewportWidth
 854               * charWidth + labelWidthWest, wrappedSpaceAboveAlignment);
 855       g.setColor(Color.black);
 856       g.translate(-labelWidthWest, 0);
 857
 858       g.translate(labelWidthWest, 0);
 859
 860       if (av.getScaleAboveWrapped())
 861       {
 862         drawNorthScale(g, startCol, endColumn, ypos);
 863       }
 864
 865       if (av.hasHiddenColumns() && av.getShowHiddenMarkers())
 866       {
 867         drawHiddenColumnMarkers(g, ypos, startCol, endColumn);
 868       }
 869
 870       g.translate(-labelWidthWest, 0);
 871
 872       ypos += wrappedRepeatHeightPx;
 873       startCol += viewportWidth;
 874       widthsDrawn++;
 875     }
 876   }
 877
 878   /**
 879    * Draws markers (triangles) above hidden column positions between startColumn
 880    * and endColumn.
 881    *
 882    * @param g
 883    * @param ypos
 884    * @param startColumn
 885    * @param endColumn
 886    */
 887   protected void drawHiddenColumnMarkers(Graphics g, int ypos,
 888           int startColumn, int endColumn)
 889   {
 890     int charHeight = av.getCharHeight();
 891     int charWidth = av.getCharWidth();
 892
 893     g.setColor(Color.blue);
 894     HiddenColumns hidden = av.getAlignment().getHiddenColumns();
 895     List<Integer> positions = hidden.findHiddenRegionPositions();
 896     for (int pos : positions)
 897     {
 898       int res = pos - startColumn;
 899
 900       if (res < 0 || res > endColumn - startColumn + 1)
 901       {
 902         continue;
 903       }
 904
 905       /*
 906        * draw a downward-pointing triangle at the hidden columns location
 907        * (before the following visible column)
 908        */
 909       int xMiddle = res * charWidth;
 910       int[] xPoints = new int[] { xMiddle - charHeight / 4,
 911           xMiddle + charHeight / 4, xMiddle };
 912       int yTop = ypos - (charHeight / 2);
 913       int[] yPoints = new int[] { yTop, yTop, yTop + 8 };
 914       g.fillPolygon(xPoints, yPoints, 3);
 915     }
 916   }
 917
 918   /*
 919    * Draw a selection group over a wrapped alignment
 920    */
 921   private void drawWrappedSelection(Graphics2D g, SequenceGroup group,
 922           int canvasWidth,
 923           int canvasHeight, int startRes)
 924   {
 925         int charHeight = av.getCharHeight();
 926         int charWidth = av.getCharWidth();
 927
 928     // height gap above each panel
 929     int hgap = charHeight;
 930     if (av.getScaleAboveWrapped())
 931     {
 932       hgap += charHeight;
 933     }
 934
 935     int cWidth = (canvasWidth - labelWidthEast - labelWidthWest)
 936             / charWidth;
 937     int cHeight = av.getAlignment().getHeight() * charHeight;
 938
 939     int startx = startRes;
 940     int endx;
 941     int ypos = hgap; // vertical offset
 942     int maxwidth = av.getAlignment().getWidth();
 943
 944     if (av.hasHiddenColumns())
 945     {
 946       maxwidth = av.getAlignment().getHiddenColumns()
 947               .findColumnPosition(maxwidth);
 948     }
 949
 950     // chop the wrapped alignment extent up into panel-sized blocks and treat
 951     // each block as if it were a block from an unwrapped alignment
 952     while ((ypos <= canvasHeight) && (startx < maxwidth))
 953     {
 954       // set end value to be start + width, or maxwidth, whichever is smaller
 955       endx = startx + cWidth - 1;
 956
 957       if (endx > maxwidth)
 958       {
 959         endx = maxwidth;
 960       }
 961
 962       g.translate(labelWidthWest, 0);
 963
 964       drawUnwrappedSelection(g, group, startx, endx, 0,
 965               av.getAlignment().getHeight() - 1,
 966               ypos);
 967
 968       g.translate(-labelWidthWest, 0);
 969
 970       // update vertical offset
 971       ypos += cHeight + getAnnotationHeight() + hgap;
 972
 973       // update horizontal offset
 974       startx += cWidth;
 975     }
 976   }
 977
 978   int getAnnotationHeight()
 979   {
 980     if (!av.isShowAnnotation())
 981     {
 982       return 0;
 983     }
 984
 985     if (annotations == null)
 986     {
 987       annotations = new AnnotationPanel(av);
 988     }
 989
 990     return annotations.adjustPanelHeight();
 991   }
 992
 993   /**
 994    * Draws the visible region of the alignment on the graphics context. If there
 995    * are hidden column markers in the visible region, then each sub-region
 996    * between the markers is drawn separately, followed by the hidden column
 997    * marker.
 998    *
 999    * @param g1
1000    *          the graphics context, positioned at the first residue to be drawn
1001    * @param startRes
1002    *          offset of the first column to draw (0..)
1003    * @param endRes
1004    *          offset of the last column to draw (0..)
1005    * @param startSeq
1006    *          offset of the first sequence to draw (0..)
1007    * @param endSeq
1008    *          offset of the last sequence to draw (0..)
1009    * @param yOffset
1010    *          vertical offset at which to draw (for wrapped alignments)
1011    */
1012   public void drawPanel(Graphics g1, final int startRes, final int endRes,
1013           final int startSeq, final int endSeq, final int yOffset)
1014   {
1015     int charHeight = av.getCharHeight();
1016     int charWidth = av.getCharWidth();
1017
1018     if (!av.hasHiddenColumns())
1019     {
1020       draw(g1, startRes, endRes, startSeq, endSeq, yOffset);
1021     }
1022     else
1023     {
1024       int screenY = 0;
1025       final int screenYMax = endRes - startRes;
1026       int blockStart = startRes;
1027       int blockEnd = endRes;
1028
1029       for (int[] region : av.getAlignment().getHiddenColumns()
1030               .getHiddenColumnsCopy())
1031       {
1032         int hideStart = region[0];
1033         int hideEnd = region[1];
1034
1035         if (hideStart <= blockStart)
1036         {
1037           blockStart += (hideEnd - hideStart) + 1;
1038           continue;
1039         }
1040
1041         /*
1042          * draw up to just before the next hidden region, or the end of
1043          * the visible region, whichever comes first
1044          */
1045         blockEnd = Math.min(hideStart - 1, blockStart + screenYMax
1046                 - screenY);
1047
1048         g1.translate(screenY * charWidth, 0);
1049
1050         draw(g1, blockStart, blockEnd, startSeq, endSeq, yOffset);
1051
1052         /*
1053          * draw the downline of the hidden column marker (ScalePanel draws the
1054          * triangle on top) if we reached it
1055          */
1056         if (av.getShowHiddenMarkers() && blockEnd == hideStart - 1)
1057         {
1058           g1.setColor(Color.blue);
1059
1060           g1.drawLine((blockEnd - blockStart + 1) * charWidth - 1,
1061                   0 + yOffset, (blockEnd - blockStart + 1) * charWidth - 1,
1062                   (endSeq - startSeq + 1) * charHeight + yOffset);
1063         }
1064
1065         g1.translate(-screenY * charWidth, 0);
1066         screenY += blockEnd - blockStart + 1;
1067         blockStart = hideEnd + 1;
1068
1069         if (screenY > screenYMax)
1070         {
1071           // already rendered last block
1072           return;
1073         }
1074       }
1075
1076       if (screenY <= screenYMax)
1077       {
1078         // remaining visible region to render
1079         blockEnd = blockStart + screenYMax - screenY;
1080         g1.translate(screenY * charWidth, 0);
1081         draw(g1, blockStart, blockEnd, startSeq, endSeq, yOffset);
1082
1083         g1.translate(-screenY * charWidth, 0);
1084       }
1085     }
1086
1087   }
1088
1089   /**
1090    * Draws a region of the visible alignment
1091    *
1092    * @param g1
1093    * @param startRes
1094    *          offset of the first column in the visible region (0..)
1095    * @param endRes
1096    *          offset of the last column in the visible region (0..)
1097    * @param startSeq
1098    *          offset of the first sequence in the visible region (0..)
1099    * @param endSeq
1100    *          offset of the last sequence in the visible region (0..)
1101    * @param yOffset
1102    *          vertical offset at which to draw (for wrapped alignments)
1103    */
1104   private void draw(Graphics g, int startRes, int endRes, int startSeq,
1105           int endSeq, int offset)
1106   {
1107     int charHeight = av.getCharHeight();
1108     int charWidth = av.getCharWidth();
1109
1110     g.setFont(av.getFont());
1111     seqRdr.prepare(g, av.isRenderGaps());
1112
1113     SequenceI nextSeq;
1114
1115     // / First draw the sequences
1116     // ///////////////////////////
1117     for (int i = startSeq; i <= endSeq; i++)
1118     {
1119       nextSeq = av.getAlignment().getSequenceAt(i);
1120       if (nextSeq == null)
1121       {
1122         // occasionally, a race condition occurs such that the alignment row is
1123         // empty
1124         continue;
1125       }
1126       seqRdr.drawSequence(nextSeq, av.getAlignment().findAllGroups(nextSeq),
1127               startRes, endRes, offset + ((i - startSeq) * charHeight));
1128
1129       if (av.isShowSequenceFeatures())
1130       {
1131         fr.drawSequence(g, nextSeq, startRes, endRes,
1132                 offset + ((i - startSeq) * charHeight), false);
1133       }
1134
1135       /*
1136        * highlight search Results once sequence has been drawn
1137        */
1138       if (av.hasSearchResults())
1139       {
1140         SearchResultsI searchResults = av.getSearchResults();
1141         int[] visibleResults = searchResults.getResults(nextSeq,
1142                 startRes, endRes);
1143         if (visibleResults != null)
1144         {
1145           for (int r = 0; r < visibleResults.length; r += 2)
1146           {
1147             seqRdr.drawHighlightedText(nextSeq, visibleResults[r],
1148                     visibleResults[r + 1], (visibleResults[r] - startRes)
1149                             * charWidth, offset
1150                             + ((i - startSeq) * charHeight));
1151           }
1152         }
1153       }
1154
1155       /*      if (av.cursorMode && cursorY == i && cursorX >= startRes
1156               && cursorX <= endRes)
1157       {
1158         seqRdr.drawCursor(nextSeq, cursorX, (cursorX - startRes) * charWidth,
1159                 offset + ((i - startSeq) * charHeight));
1160       }*/
1161     }
1162
1163     if (av.getSelectionGroup() != null
1164             || av.getAlignment().getGroups().size() > 0)
1165     {
1166       drawGroupsBoundaries(g, startRes, endRes, startSeq, endSeq, offset);
1167     }
1168
1169   }
1170
1171   void drawGroupsBoundaries(Graphics g1, int startRes, int endRes,
1172           int startSeq, int endSeq, int offset)
1173   {
1174     Graphics2D g = (Graphics2D) g1;
1175     //
1176     // ///////////////////////////////////
1177     // Now outline any areas if necessary
1178     // ///////////////////////////////////
1179
1180     SequenceGroup group = null;
1181     int groupIndex = -1;
1182
1183     if (av.getAlignment().getGroups().size() > 0)
1184     {
1185       group = av.getAlignment().getGroups().get(0);
1186       groupIndex = 0;
1187     }
1188
1189     if (group != null)
1190     {
1191       g.setStroke(new BasicStroke());
1192       g.setColor(group.getOutlineColour());
1193
1194       do
1195       {
1196         drawPartialGroupOutline(g, group, startRes, endRes, startSeq,
1197                 endSeq, offset);
1198
1199         groupIndex++;
1200
1201         g.setStroke(new BasicStroke());
1202
1203         if (groupIndex >= av.getAlignment().getGroups().size())
1204         {
1205           break;
1206         }
1207
1208         group = av.getAlignment().getGroups().get(groupIndex);
1209
1210       } while (groupIndex < av.getAlignment().getGroups().size());
1211
1212     }
1213
1214   }
1215
1216
1217   /*
1218    * Draw the selection group as a separate image and overlay
1219    */
1220   private BufferedImage drawSelectionGroup(int startRes, int endRes,
1221           int startSeq, int endSeq)
1222   {
1223     // get a new image of the correct size
1224     BufferedImage selectionImage = setupImage();
1225
1226     if (selectionImage == null)
1227     {
1228       return null;
1229     }
1230
1231     SequenceGroup group = av.getSelectionGroup();
1232     if (group == null)
1233     {
1234       // nothing to draw
1235       return null;
1236     }
1237
1238     // set up drawing colour
1239     Graphics2D g = (Graphics2D) selectionImage.getGraphics();
1240
1241     setupSelectionGroup(g, selectionImage);
1242
1243     if (!av.getWrapAlignment())
1244     {
1245       drawUnwrappedSelection(g, group, startRes, endRes, startSeq, endSeq,
1246               0);
1247     }
1248     else
1249     {
1250       drawWrappedSelection(g, group, getWidth(), getHeight(),
1251               av.getRanges().getStartRes());
1252     }
1253
1254     g.dispose();
1255     return selectionImage;
1256   }
1257
1258   /**
1259    * Draw the cursor as a separate image and overlay
1260    *
1261    * @param startRes
1262    *          start residue of area to draw cursor in
1263    * @param endRes
1264    *          end residue of area to draw cursor in
1265    * @param startSeq
1266    *          start sequence of area to draw cursor in
1267    * @param endSeq
1268    *          end sequence of are to draw cursor in
1269    * @return a transparent image of the same size as the sequence canvas, with
1270    *         the cursor drawn on it, if any
1271    */
1272   private BufferedImage drawCursor(int startRes, int endRes, int startSeq,
1273           int endSeq)
1274   {
1275     // define our cursor image
1276     BufferedImage cursorImage = null;
1277
1278     if (av.cursorMode && cursorY >= startSeq && cursorY <= endSeq
1279             && cursorX >= startRes && cursorX <= endRes)
1280     {
1281       // get a new image of the correct size
1282       cursorImage = setupImage();
1283       Graphics2D g = (Graphics2D) cursorImage.getGraphics();
1284
1285       // get the character the cursor is drawn at
1286       SequenceI seq = av.getAlignment().getSequenceAt(cursorY);
1287       char s = seq.getCharAt(cursorX);
1288
1289       int offset = 0;
1290       if (av.getWrapAlignment())
1291       {
1292         // work out the correct offset for the cursor
1293         offset = wrappedSpaceAboveAlignment;
1294         int currentWidth = 0;
1295         while ((currentWidth < wrappedVisibleWidths)
1296                 && (currentWidth < cursorX))
1297         {
1298           offset += wrappedRepeatHeightPx;
1299           currentWidth++;
1300         }
1301       }
1302
1303       seqRdr.drawCursor(g, s,
1304               (cursorX - startRes) * av.getCharWidth(),
1305               offset + ((cursorY - startSeq) * av.getCharHeight()));
1306       g.dispose();
1307     }
1308
1309     return cursorImage;
1310   }
1311
1312   /*
1313    * Set up graphics for selection group
1314    */
1315   private void setupSelectionGroup(Graphics2D g,
1316           BufferedImage selectionImage)
1317   {
1318     // set background to transparent
1319     g.setComposite(AlphaComposite.getInstance(AlphaComposite.CLEAR, 0.0f));
1320     g.fillRect(0, 0, selectionImage.getWidth(), selectionImage.getHeight());
1321
1322     // set up foreground to draw red dashed line
1323     g.setComposite(AlphaComposite.Src);
1324     g.setStroke(new BasicStroke(1, BasicStroke.CAP_BUTT,
1325             BasicStroke.JOIN_ROUND, 3f, new float[]
1326     { 5f, 3f }, 0f));
1327     g.setColor(Color.RED);
1328   }
1329
1330   /*
1331    * Draw a selection group over an unwrapped alignment
1332    * @param g graphics object to draw with
1333    * @param group selection group
1334    * @param startRes start residue of area to draw
1335    * @param endRes end residue of area to draw
1336    * @param startSeq start sequence of area to draw
1337    * @param endSeq end sequence of area to draw
1338    * @param offset vertical offset (used when called from wrapped alignment code)
1339    */
1340   private void drawUnwrappedSelection(Graphics2D g, SequenceGroup group,
1341           int startRes, int endRes, int startSeq, int endSeq, int offset)
1342   {
1343         int charWidth = av.getCharWidth();
1344
1345     if (!av.hasHiddenColumns())
1346     {
1347       drawPartialGroupOutline(g, group, startRes, endRes, startSeq, endSeq,
1348               offset);
1349     }
1350     else
1351     {
1352       // package into blocks of visible columns
1353       int screenY = 0;
1354       int blockStart = startRes;
1355       int blockEnd = endRes;
1356
1357       for (int[] region : av.getAlignment().getHiddenColumns()
1358               .getHiddenColumnsCopy())
1359       {
1360         int hideStart = region[0];
1361         int hideEnd = region[1];
1362
1363         if (hideStart <= blockStart)
1364         {
1365           blockStart += (hideEnd - hideStart) + 1;
1366           continue;
1367         }
1368
1369         blockEnd = hideStart - 1;
1370
1371         g.translate(screenY * charWidth, 0);
1372         drawPartialGroupOutline(g, group,
1373                 blockStart, blockEnd, startSeq, endSeq, offset);
1374
1375         g.translate(-screenY * charWidth, 0);
1376         screenY += blockEnd - blockStart + 1;
1377         blockStart = hideEnd + 1;
1378
1379         if (screenY > (endRes - startRes))
1380         {
1381           // already rendered last block
1382           break;
1383         }
1384       }
1385
1386       if (screenY <= (endRes - startRes))
1387       {
1388         // remaining visible region to render
1389         blockEnd = blockStart + (endRes - startRes) - screenY;
1390         g.translate(screenY * charWidth, 0);
1391         drawPartialGroupOutline(g, group,
1392                 blockStart, blockEnd, startSeq, endSeq, offset);
1393
1394         g.translate(-screenY * charWidth, 0);
1395       }
1396     }
1397   }
1398
1399   /*
1400    * Draw the selection group as a separate image and overlay
1401    */
1402   private void drawPartialGroupOutline(Graphics2D g, SequenceGroup group,
1403           int startRes, int endRes, int startSeq, int endSeq,
1404           int verticalOffset)
1405   {
1406         int charHeight = av.getCharHeight();
1407         int charWidth = av.getCharWidth();
1408
1409     int visWidth = (endRes - startRes + 1) * charWidth;
1410
1411     int oldY = -1;
1412     int i = 0;
1413     boolean inGroup = false;
1414     int top = -1;
1415     int bottom = -1;
1416
1417     int sx = -1;
1418     int sy = -1;
1419     int xwidth = -1;
1420
1421     for (i = startSeq; i <= endSeq; i++)
1422     {
1423       // position of start residue of group relative to startRes, in pixels
1424       sx = (group.getStartRes() - startRes) * charWidth;
1425
1426       // width of group in pixels
1427       xwidth = (((group.getEndRes() + 1) - group.getStartRes()) * charWidth)
1428               - 1;
1429
1430       sy = verticalOffset + (i - startSeq) * charHeight;
1431
1432       if (sx + xwidth < 0 || sx > visWidth)
1433       {
1434         continue;
1435       }
1436
1437       if ((sx <= (endRes - startRes) * charWidth)
1438               && group.getSequences(null)
1439                       .contains(av.getAlignment().getSequenceAt(i)))
1440       {
1441         if ((bottom == -1) && !group.getSequences(null)
1442                 .contains(av.getAlignment().getSequenceAt(i + 1)))
1443         {
1444           bottom = sy + charHeight;
1445         }
1446
1447         if (!inGroup)
1448         {
1449           if (((top == -1) && (i == 0)) || !group.getSequences(null)
1450                   .contains(av.getAlignment().getSequenceAt(i - 1)))
1451           {
1452             top = sy;
1453           }
1454
1455           oldY = sy;
1456           inGroup = true;
1457         }
1458       }
1459       else
1460       {
1461         if (inGroup)
1462         {
1463           // if start position is visible, draw vertical line to left of
1464           // group
1465           if (sx >= 0 && sx < visWidth)
1466           {
1467             g.drawLine(sx, oldY, sx, sy);
1468           }
1469
1470           // if end position is visible, draw vertical line to right of
1471           // group
1472           if (sx + xwidth < visWidth)
1473           {
1474             g.drawLine(sx + xwidth, oldY, sx + xwidth, sy);
1475           }
1476
1477           if (sx < 0)
1478           {
1479             xwidth += sx;
1480             sx = 0;
1481           }
1482
1483           // don't let width extend beyond current block, or group extent
1484           // fixes JAL-2672
1485           if (sx + xwidth >= (endRes - startRes + 1) * charWidth)
1486           {
1487             xwidth = (endRes - startRes + 1) * charWidth - sx;
1488           }
1489
1490           // draw horizontal line at top of group
1491           if (top != -1)
1492           {
1493             g.drawLine(sx, top, sx + xwidth, top);
1494             top = -1;
1495           }
1496
1497           // draw horizontal line at bottom of group
1498           if (bottom != -1)
1499           {
1500             g.drawLine(sx, bottom, sx + xwidth, bottom);
1501             bottom = -1;
1502           }
1503
1504           inGroup = false;
1505         }
1506       }
1507     }
1508
1509     if (inGroup)
1510     {
1511       sy = verticalOffset + ((i - startSeq) * charHeight);
1512       if (sx >= 0 && sx < visWidth)
1513       {
1514         g.drawLine(sx, oldY, sx, sy);
1515       }
1516
1517       if (sx + xwidth < visWidth)
1518       {
1519         g.drawLine(sx + xwidth, oldY, sx + xwidth, sy);
1520       }
1521
1522       if (sx < 0)
1523       {
1524         xwidth += sx;
1525         sx = 0;
1526       }
1527
1528       if (sx + xwidth > visWidth)
1529       {
1530         xwidth = visWidth;
1531       }
1532       else if (sx + xwidth >= (endRes - startRes + 1) * charWidth)
1533       {
1534         xwidth = (endRes - startRes + 1) * charWidth;
1535       }
1536
1537       if (top != -1)
1538       {
1539         g.drawLine(sx, top, sx + xwidth, top);
1540         top = -1;
1541       }
1542
1543       if (bottom != -1)
1544       {
1545         g.drawLine(sx, bottom - 1, sx + xwidth, bottom - 1);
1546         bottom = -1;
1547       }
1548
1549       inGroup = false;
1550     }
1551   }
1552
1553   /**
1554    * Highlights search results in the visible region by rendering as white text
1555    * on a black background. Any previous highlighting is removed. Answers true
1556    * if any highlight was left on the visible alignment (so status bar should be
1557    * set to match), else false.
1558    * <p>
1559    * Currently fastPaint is not implemented for wrapped alignments. If a wrapped
1560    * alignment had to be scrolled to show the highlighted region, then it should
1561    * be fully redrawn, otherwise a fast paint can be performed. This argument
1562    * could be removed if fast paint of scrolled wrapped alignment is coded in
1563    * future (JAL-2609).
1564    *
1565    * @param results
1566    * @param noFastPaint
1567    * @return
1568    */
1569   public boolean highlightSearchResults(SearchResultsI results,
1570           boolean noFastPaint)
1571   {
1572     if (fastpainting)
1573     {
1574       return false;
1575     }
1576     boolean wrapped = av.getWrapAlignment();
1577     try
1578     {
1579       fastPaint = !noFastPaint;
1580       fastpainting = fastPaint;
1581
1582       /*
1583        * to avoid redrawing the whole visible region, we instead
1584        * redraw just the minimal regions to remove previous highlights
1585        * and add new ones
1586        */
1587       SearchResultsI previous = av.getSearchResults();
1588       av.setSearchResults(results);
1589       boolean redrawn = false;
1590       boolean drawn = false;
1591       if (wrapped)
1592       {
1593         redrawn = drawMappedPositionsWrapped(previous);
1594         drawn = drawMappedPositionsWrapped(results);
1595         redrawn |= drawn;
1596       }
1597       else
1598       {
1599         redrawn = drawMappedPositions(previous);
1600         drawn = drawMappedPositions(results);
1601         redrawn |= drawn;
1602       }
1603
1604       /*
1605        * if highlights were either removed or added, repaint
1606        */
1607       if (redrawn)
1608       {
1609         repaint();
1610       }
1611
1612       /*
1613        * return true only if highlights were added
1614        */
1615       return drawn;
1616
1617     } finally
1618     {
1619       fastpainting = false;
1620     }
1621   }
1622
1623   /**
1624    * Redraws the minimal rectangle in the visible region (if any) that includes
1625    * mapped positions of the given search results. Whether or not positions are
1626    * highlighted depends on the SearchResults set on the Viewport. This allows
1627    * this method to be called to either clear or set highlighting. Answers true
1628    * if any positions were drawn (in which case a repaint is still required),
1629    * else false.
1630    *
1631    * @param results
1632    * @return
1633    */
1634   protected boolean drawMappedPositions(SearchResultsI results)
1635   {
1636     if (results == null)
1637     {
1638       return false;
1639     }
1640
1641     /*
1642      * calculate the minimal rectangle to redraw that
1643      * includes both new and existing search results
1644      */
1645     int firstSeq = Integer.MAX_VALUE;
1646     int lastSeq = -1;
1647     int firstCol = Integer.MAX_VALUE;
1648     int lastCol = -1;
1649     boolean matchFound = false;
1650
1651     ViewportRanges ranges = av.getRanges();
1652     int firstVisibleColumn = ranges.getStartRes();
1653     int lastVisibleColumn = ranges.getEndRes();
1654     AlignmentI alignment = av.getAlignment();
1655     if (av.hasHiddenColumns())
1656     {
1657       firstVisibleColumn = alignment.getHiddenColumns()
1658               .adjustForHiddenColumns(firstVisibleColumn);
1659       lastVisibleColumn = alignment.getHiddenColumns()
1660               .adjustForHiddenColumns(lastVisibleColumn);
1661     }
1662
1663     for (int seqNo = ranges.getStartSeq(); seqNo <= ranges
1664             .getEndSeq(); seqNo++)
1665     {
1666       SequenceI seq = alignment.getSequenceAt(seqNo);
1667
1668       int[] visibleResults = results.getResults(seq, firstVisibleColumn,
1669               lastVisibleColumn);
1670       if (visibleResults != null)
1671       {
1672         for (int i = 0; i < visibleResults.length - 1; i += 2)
1673         {
1674           int firstMatchedColumn = visibleResults[i];
1675           int lastMatchedColumn = visibleResults[i + 1];
1676           if (firstMatchedColumn <= lastVisibleColumn
1677                   && lastMatchedColumn >= firstVisibleColumn)
1678           {
1679             /*
1680              * found a search results match in the visible region -
1681              * remember the first and last sequence matched, and the first
1682              * and last visible columns in the matched positions
1683              */
1684             matchFound = true;
1685             firstSeq = Math.min(firstSeq, seqNo);
1686             lastSeq = Math.max(lastSeq, seqNo);
1687             firstMatchedColumn = Math.max(firstMatchedColumn,
1688                     firstVisibleColumn);
1689             lastMatchedColumn = Math.min(lastMatchedColumn,
1690                     lastVisibleColumn);
1691             firstCol = Math.min(firstCol, firstMatchedColumn);
1692             lastCol = Math.max(lastCol, lastMatchedColumn);
1693           }
1694         }
1695       }
1696     }
1697
1698     if (matchFound)
1699     {
1700       if (av.hasHiddenColumns())
1701       {
1702         firstCol = alignment.getHiddenColumns()
1703                 .findColumnPosition(firstCol);
1704         lastCol = alignment.getHiddenColumns().findColumnPosition(lastCol);
1705       }
1706       int transX = (firstCol - ranges.getStartRes()) * av.getCharWidth();
1707       int transY = (firstSeq - ranges.getStartSeq()) * av.getCharHeight();
1708       gg.translate(transX, transY);
1709       drawPanel(gg, firstCol, lastCol, firstSeq, lastSeq, 0);
1710       gg.translate(-transX, -transY);
1711     }
1712
1713     return matchFound;
1714   }
1715
1716   @Override
1717   public void propertyChange(PropertyChangeEvent evt)
1718   {
1719     String eventName = evt.getPropertyName();
1720
1721     if (eventName.equals(SequenceGroup.SEQ_GROUP_CHANGED))
1722     {
1723       fastPaint = true;
1724       repaint();
1725       return;
1726     }
1727
1728     int scrollX = 0;
1729     if (eventName.equals(ViewportRanges.STARTRES))
1730     {
1731       // Make sure we're not trying to draw a panel
1732       // larger than the visible window
1733       ViewportRanges vpRanges = av.getRanges();
1734       scrollX = (int) evt.getNewValue() - (int) evt.getOldValue();
1735       int range = vpRanges.getViewportWidth();
1736       if (scrollX > range)
1737       {
1738         scrollX = range;
1739       }
1740       else if (scrollX < -range)
1741       {
1742         scrollX = -range;
1743       }
1744     }
1745
1746     // Both scrolling and resizing change viewport ranges: scrolling changes
1747     // both start and end points, but resize only changes end values.
1748     // Here we only want to fastpaint on a scroll, with resize using a normal
1749     // paint, so scroll events are identified as changes to the horizontal or
1750     // vertical start value.
1751
1752     // scroll - startres and endres both change
1753     if (eventName.equals(ViewportRanges.STARTRES))
1754     {
1755       if (av.getWrapAlignment())
1756       {
1757         fastPaintWrapped(scrollX);
1758       }
1759       else
1760       {
1761         fastPaint(scrollX, 0);
1762       }
1763     }
1764     else if (eventName.equals(ViewportRanges.STARTSEQ))
1765     {
1766       // scroll
1767       fastPaint(0, (int) evt.getNewValue() - (int) evt.getOldValue());
1768     }
1769   }
1770
1771   /**
1772    * Does a minimal update of the image for a scroll movement. This method
1773    * handles scroll movements of up to one width of the wrapped alignment (one
1774    * click in the vertical scrollbar). Larger movements (for example after a
1775    * scroll to highlight a mapped position) trigger a full redraw instead.
1776    *
1777    * @param scrollX
1778    *          number of positions scrolled (right if positive, left if negative)
1779    */
1780   protected void fastPaintWrapped(int scrollX)
1781   {
1782     ViewportRanges ranges = av.getRanges();
1783
1784     if (Math.abs(scrollX) > ranges.getViewportWidth())
1785     {
1786       /*
1787        * shift of more than one view width is
1788        * overcomplicated to handle in this method
1789        */
1790       fastPaint = false;
1791       repaint();
1792       return;
1793     }
1794
1795     if (fastpainting || gg == null)
1796     {
1797       return;
1798     }
1799
1800     fastPaint = true;
1801     fastpainting = true;
1802
1803     try
1804     {
1805       calculateWrappedGeometry(getWidth(), getHeight());
1806
1807       /*
1808        * relocate the regions of the alignment that are still visible
1809        */
1810       shiftWrappedAlignment(-scrollX);
1811
1812       /*
1813        * add new columns (sequence, annotation)
1814        * - at top left if scrollX < 0
1815        * - at right of last two widths if scrollX > 0
1816        */
1817       if (scrollX < 0)
1818       {
1819         int startRes = ranges.getStartRes();
1820         drawWrappedWidth(gg, wrappedSpaceAboveAlignment, startRes, startRes
1821                 - scrollX - 1, getHeight());
1822       }
1823       else
1824       {
1825         fastPaintWrappedAddRight(scrollX);
1826       }
1827
1828       /*
1829        * draw all scales (if  shown) and hidden column markers
1830        */
1831       drawWrappedDecorators(gg, ranges.getStartRes());
1832
1833       repaint();
1834     } finally
1835     {
1836       fastpainting = false;
1837     }
1838   }
1839
1840   /**
1841    * Draws the specified number of columns at the 'end' (bottom right) of a
1842    * wrapped alignment view, including sequences and annotations if shown, but
1843    * not scales. Also draws the same number of columns at the right hand end of
1844    * the second last width shown, if the last width is not full height (so
1845    * cannot simply be copied from the graphics image).
1846    *
1847    * @param columns
1848    */
1849   protected void fastPaintWrappedAddRight(int columns)
1850   {
1851     if (columns == 0)
1852     {
1853       return;
1854     }
1855
1856     ViewportRanges ranges = av.getRanges();
1857     int viewportWidth = ranges.getViewportWidth();
1858     int charWidth = av.getCharWidth();
1859
1860     /**
1861      * draw full height alignment in the second last row, last columns, if the
1862      * last row was not full height
1863      */
1864     int visibleWidths = wrappedVisibleWidths;
1865     int canvasHeight = getHeight();
1866     boolean lastWidthPartHeight = (wrappedVisibleWidths * wrappedRepeatHeightPx) > canvasHeight;
1867
1868     if (lastWidthPartHeight)
1869     {
1870       int widthsAbove = Math.max(0, visibleWidths - 2);
1871       int ypos = wrappedRepeatHeightPx * widthsAbove
1872               + wrappedSpaceAboveAlignment;
1873       int endRes = ranges.getEndRes();
1874       endRes += widthsAbove * viewportWidth;
1875       int startRes = endRes - columns;
1876       int xOffset = ((startRes - ranges.getStartRes()) % viewportWidth)
1877               * charWidth;
1878
1879       /*
1880        * white fill first to erase annotations
1881        */
1882       gg.translate(xOffset, 0);
1883       gg.setColor(Color.white);
1884       gg.fillRect(labelWidthWest, ypos,
1885               (endRes - startRes + 1) * charWidth, wrappedRepeatHeightPx);
1886       gg.translate(-xOffset, 0);
1887
1888       drawWrappedWidth(gg, ypos, startRes, endRes, canvasHeight);
1889     }
1890
1891     /*
1892      * draw newly visible columns in last wrapped width (none if we
1893      * have reached the end of the alignment)
1894      * y-offset for drawing last width is height of widths above,
1895      * plus one gap row
1896      */
1897     int widthsAbove = visibleWidths - 1;
1898     int ypos = wrappedRepeatHeightPx * widthsAbove
1899             + wrappedSpaceAboveAlignment;
1900     int endRes = ranges.getEndRes();
1901     endRes += widthsAbove * viewportWidth;
1902     int startRes = endRes - columns + 1;
1903
1904     /*
1905      * white fill first to erase annotations
1906      */
1907     int xOffset = ((startRes - ranges.getStartRes()) % viewportWidth)
1908             * charWidth;
1909     gg.translate(xOffset, 0);
1910     gg.setColor(Color.white);
1911     int width = viewportWidth * charWidth - xOffset;
1912     gg.fillRect(labelWidthWest, ypos, width, wrappedRepeatHeightPx);
1913     gg.translate(-xOffset, 0);
1914
1915     gg.setFont(av.getFont());
1916     gg.setColor(Color.black);
1917
1918     if (startRes < ranges.getVisibleAlignmentWidth())
1919     {
1920       drawWrappedWidth(gg, ypos, startRes, endRes, canvasHeight);
1921     }
1922
1923     /*
1924      * and finally, white fill any space below the visible alignment
1925      */
1926     int heightBelow = canvasHeight - visibleWidths * wrappedRepeatHeightPx;
1927     if (heightBelow > 0)
1928     {
1929       gg.setColor(Color.white);
1930       gg.fillRect(0, canvasHeight - heightBelow, getWidth(), heightBelow);
1931     }
1932   }
1933
1934   /**
1935    * Shifts the visible alignment by the specified number of columns - left if
1936    * negative, right if positive. Copies and moves sequences and annotations (if
1937    * shown). Scales, hidden column markers and any newly visible columns must be
1938    * drawn separately.
1939    *
1940    * @param positions
1941    */
1942   protected void shiftWrappedAlignment(int positions)
1943   {
1944     if (positions == 0)
1945     {
1946       return;
1947     }
1948     int charWidth = av.getCharWidth();
1949
1950     int canvasHeight = getHeight();
1951     ViewportRanges ranges = av.getRanges();
1952     int viewportWidth = ranges.getViewportWidth();
1953     int widthToCopy = (ranges.getViewportWidth() - Math.abs(positions))
1954             * charWidth;
1955     int heightToCopy = wrappedRepeatHeightPx - wrappedSpaceAboveAlignment;
1956     int xMax = ranges.getVisibleAlignmentWidth();
1957
1958     if (positions > 0)
1959     {
1960       /*
1961        * shift right (after scroll left)
1962        * for each wrapped width (starting with the last), copy (width-positions)
1963        * columns from the left margin to the right margin, and copy positions
1964        * columns from the right margin of the row above (if any) to the
1965        * left margin of the current row
1966        */
1967
1968       /*
1969        * get y-offset of last wrapped width, first row of sequences
1970        */
1971       int y = canvasHeight / wrappedRepeatHeightPx * wrappedRepeatHeightPx;
1972       y += wrappedSpaceAboveAlignment;
1973       int copyFromLeftStart = labelWidthWest;
1974       int copyFromRightStart = copyFromLeftStart + widthToCopy;
1975
1976       while (y >= 0)
1977       {
1978         gg.copyArea(copyFromLeftStart, y, widthToCopy, heightToCopy,
1979                 positions * charWidth, 0);
1980         if (y > 0)
1981         {
1982           gg.copyArea(copyFromRightStart, y - wrappedRepeatHeightPx,
1983                   positions * charWidth, heightToCopy, -widthToCopy,
1984                   wrappedRepeatHeightPx);
1985         }
1986
1987         y -= wrappedRepeatHeightPx;
1988       }
1989     }
1990     else
1991     {
1992       /*
1993        * shift left (after scroll right)
1994        * for each wrapped width (starting with the first), copy (width-positions)
1995        * columns from the right margin to the left margin, and copy positions
1996        * columns from the left margin of the row below (if any) to the
1997        * right margin of the current row
1998        */
1999       int xpos = av.getRanges().getStartRes();
2000       int y = wrappedSpaceAboveAlignment;
2001       int copyFromRightStart = labelWidthWest - positions * charWidth;
2002
2003       while (y < canvasHeight)
2004       {
2005         gg.copyArea(copyFromRightStart, y, widthToCopy, heightToCopy,
2006                 positions * charWidth, 0);
2007         if (y + wrappedRepeatHeightPx < canvasHeight - wrappedRepeatHeightPx
2008                 && (xpos + viewportWidth <= xMax))
2009         {
2010           gg.copyArea(labelWidthWest, y + wrappedRepeatHeightPx, -positions
2011                   * charWidth, heightToCopy, widthToCopy,
2012                   -wrappedRepeatHeightPx);
2013         }
2014
2015         y += wrappedRepeatHeightPx;
2016         xpos += viewportWidth;
2017       }
2018     }
2019   }
2020
2021
2022   /**
2023    * Redraws any positions in the search results in the visible region of a
2024    * wrapped alignment. Any highlights are drawn depending on the search results
2025    * set on the Viewport, not the <code>results</code> argument. This allows
2026    * this method to be called either to clear highlights (passing the previous
2027    * search results), or to draw new highlights.
2028    *
2029    * @param results
2030    * @return
2031    */
2032   protected boolean drawMappedPositionsWrapped(SearchResultsI results)
2033   {
2034     if (results == null)
2035     {
2036       return false;
2037     }
2038     int charHeight = av.getCharHeight();
2039
2040     boolean matchFound = false;
2041
2042     calculateWrappedGeometry(getWidth(), getHeight());
2043     int wrappedWidth = av.getWrappedWidth();
2044     int wrappedHeight = wrappedRepeatHeightPx;
2045
2046     ViewportRanges ranges = av.getRanges();
2047     int canvasHeight = getHeight();
2048     int repeats = canvasHeight / wrappedHeight;
2049     if (canvasHeight / wrappedHeight > 0)
2050     {
2051       repeats++;
2052     }
2053
2054     int firstVisibleColumn = ranges.getStartRes();
2055     int lastVisibleColumn = ranges.getStartRes() + repeats
2056             * ranges.getViewportWidth() - 1;
2057
2058     AlignmentI alignment = av.getAlignment();
2059     if (av.hasHiddenColumns())
2060     {
2061       firstVisibleColumn = alignment.getHiddenColumns()
2062               .adjustForHiddenColumns(firstVisibleColumn);
2063       lastVisibleColumn = alignment.getHiddenColumns()
2064               .adjustForHiddenColumns(lastVisibleColumn);
2065     }
2066
2067     int gapHeight = charHeight * (av.getScaleAboveWrapped() ? 2 : 1);
2068
2069     for (int seqNo = ranges.getStartSeq(); seqNo <= ranges
2070             .getEndSeq(); seqNo++)
2071     {
2072       SequenceI seq = alignment.getSequenceAt(seqNo);
2073
2074       int[] visibleResults = results.getResults(seq, firstVisibleColumn,
2075               lastVisibleColumn);
2076       if (visibleResults != null)
2077       {
2078         for (int i = 0; i < visibleResults.length - 1; i += 2)
2079         {
2080           int firstMatchedColumn = visibleResults[i];
2081           int lastMatchedColumn = visibleResults[i + 1];
2082           if (firstMatchedColumn <= lastVisibleColumn
2083                   && lastMatchedColumn >= firstVisibleColumn)
2084           {
2085             /*
2086              * found a search results match in the visible region
2087              */
2088             firstMatchedColumn = Math.max(firstMatchedColumn,
2089                     firstVisibleColumn);
2090             lastMatchedColumn = Math.min(lastMatchedColumn,
2091                     lastVisibleColumn);
2092
2093             /*
2094              * draw each mapped position separately (as contiguous positions may
2095              * wrap across lines)
2096              */
2097             for (int mappedPos = firstMatchedColumn; mappedPos <= lastMatchedColumn; mappedPos++)
2098             {
2099               int displayColumn = mappedPos;
2100               if (av.hasHiddenColumns())
2101               {
2102                 displayColumn = alignment.getHiddenColumns()
2103                         .findColumnPosition(displayColumn);
2104               }
2105
2106               /*
2107                * transX: offset from left edge of canvas to residue position
2108                */
2109               int transX = labelWidthWest
2110                       + ((displayColumn - ranges.getStartRes()) % wrappedWidth)
2111                       * av.getCharWidth();
2112
2113               /*
2114                * transY: offset from top edge of canvas to residue position
2115                */
2116               int transY = gapHeight;
2117               transY += (displayColumn - ranges.getStartRes())
2118                       / wrappedWidth * wrappedHeight;
2119               transY += (seqNo - ranges.getStartSeq()) * av.getCharHeight();
2120
2121               /*
2122                * yOffset is from graphics origin to start of visible region
2123                */
2124               int yOffset = 0;// (displayColumn / wrappedWidth) * wrappedHeight;
2125               if (transY < getHeight())
2126               {
2127                 matchFound = true;
2128                 gg.translate(transX, transY);
2129                 drawPanel(gg, displayColumn, displayColumn, seqNo, seqNo,
2130                         yOffset);
2131                 gg.translate(-transX, -transY);
2132               }
2133             }
2134           }
2135         }
2136       }
2137     }
2138
2139     return matchFound;
2140   }
2141
2142   /**
2143    * Answers the width in pixels of the left scale labels (0 if not shown)
2144    *
2145    * @return
2146    */
2147   int getLabelWidthWest()
2148   {
2149     return labelWidthWest;
2150   }
2151 }