src/jalview/gui/IdCanvas.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.SequenceI;
  24 import jalview.viewmodel.ViewportListenerI;
  25 import jalview.viewmodel.ViewportRanges;
  26
  27 import java.awt.BorderLayout;
  28 import java.awt.Color;
  29 import java.awt.Font;
  30 import java.awt.FontMetrics;
  31 import java.awt.Graphics;
  32 import java.awt.Graphics2D;
  33 import java.awt.RenderingHints;
  34 import java.awt.image.BufferedImage;
  35 import java.beans.PropertyChangeEvent;
  36 import java.util.List;
  37
  38 import javax.swing.JPanel;
  39
  40 /**
  41  * DOCUMENT ME!
  42  *
  43  * @author $author$
  44  * @version $Revision$
  45  */
  46 public class IdCanvas extends JPanel implements ViewportListenerI
  47 {
  48   protected AlignViewport av;
  49
  50   protected boolean showScores = true;
  51
  52   protected int maxIdLength = -1;
  53
  54   protected String maxIdStr = null;
  55
  56   BufferedImage image;
  57
  58   Graphics2D gg;
  59
  60   int imgHeight = 0;
  61
  62   boolean fastPaint = false;
  63
  64   List<SequenceI> searchResults;
  65
  66   AnnotationPanel ap;
  67
  68   private Font idfont;
  69
  70   /**
  71    * Creates a new IdCanvas object.
  72    *
  73    * @param av
  74    *          DOCUMENT ME!
  75    */
  76   public IdCanvas(AlignViewport av)
  77   {
  78     setLayout(new BorderLayout());
  79     this.av = av;
  80     PaintRefresher.Register(this, av.getSequenceSetId());
  81     av.getRanges().addPropertyChangeListener(this);
  82     }
  83
  84   /**
  85    * DOCUMENT ME!
  86    *
  87    * @param g
  88    *          DOCUMENT ME!
  89    * @param hiddenRows
  90    *          true - check and display hidden row marker if need be
  91    * @param s
  92    *          DOCUMENT ME!
  93    * @param i
  94    *          DOCUMENT ME!
  95    * @param starty
  96    *          DOCUMENT ME!
  97    * @param ypos
  98    *          DOCUMENT ME!
  99    */
 100   public void drawIdString(Graphics2D g, boolean hiddenRows, SequenceI s,
 101           int i, int starty, int ypos)
 102   {
 103     int xPos = 0;
 104     int panelWidth = getWidth();
 105     int charHeight = av.getCharHeight();
 106
 107     if ((searchResults != null) && searchResults.contains(s))
 108     {
 109       g.setColor(Color.black);
 110       g.fillRect(0, ((i - starty) * charHeight) + ypos, getWidth(),
 111               charHeight);
 112       g.setColor(Color.white);
 113     }
 114     else if ((av.getSelectionGroup() != null)
 115             && av.getSelectionGroup().getSequences(null).contains(s))
 116     {
 117       g.setColor(Color.lightGray);
 118       g.fillRect(0, ((i - starty) * charHeight) + ypos, getWidth(),
 119               charHeight);
 120       g.setColor(Color.white);
 121     }
 122     else
 123     {
 124       g.setColor(av.getSequenceColour(s));
 125       g.fillRect(0, ((i - starty) * charHeight) + ypos, getWidth(),
 126               charHeight);
 127       g.setColor(Color.black);
 128     }
 129
 130     if (av.isRightAlignIds())
 131     {
 132       FontMetrics fm = g.getFontMetrics();
 133       xPos = panelWidth
 134               - fm.stringWidth(s.getDisplayId(av.getShowJVSuffix())) - 4;
 135     }
 136
 137     g.drawString(s.getDisplayId(av.getShowJVSuffix()), xPos,
 138             (((i - starty + 1) * charHeight) + ypos) - (charHeight / 5));
 139
 140     if (hiddenRows)
 141     {
 142       drawMarker(g, av, i, starty, ypos);
 143     }
 144
 145   }
 146
 147   /**
 148    * DOCUMENT ME!
 149    *
 150    * @param vertical
 151    *          DOCUMENT ME!
 152    */
 153   public void fastPaint(int vertical)
 154   {
 155     /*
 156      * for now, not attempting fast paint of wrapped ids...
 157      */
 158     if (gg == null || av.getWrapAlignment())
 159     {
 160       repaint();
 161
 162       return;
 163     }
 164
 165     ViewportRanges ranges = av.getRanges();
 166
 167     gg.copyArea(0, 0, getWidth(), imgHeight, 0,
 168             -vertical * av.getCharHeight());
 169
 170     int ss = ranges.getStartSeq();
 171     int es = ranges.getEndSeq();
 172     int transY = 0;
 173
 174     if (vertical > 0) // scroll down
 175     {
 176       ss = es - vertical;
 177
 178       if (ss < ranges.getStartSeq())
 179       { // ie scrolling too fast, more than a page at a time
 180         ss = ranges.getStartSeq();
 181       }
 182       else
 183       {
 184         transY = imgHeight - ((vertical + 1) * av.getCharHeight());
 185       }
 186     }
 187     else if (vertical < 0) // scroll up
 188     {
 189       es = ss - vertical;
 190
 191       if (es > ranges.getEndSeq())
 192       {
 193         es = ranges.getEndSeq();
 194       }
 195     }
 196
 197     gg.translate(0, transY);
 198
 199     drawIds(gg, av, ss, es, searchResults);
 200
 201     gg.translate(0, -transY);
 202
 203     fastPaint = true;
 204
 205     // Call repaint on alignment panel so that repaints from other alignment
 206     // panel components can be aggregated. Otherwise performance of the overview
 207     // window and others may be adversely affected.
 208     av.getAlignPanel().repaint();
 209   }
 210
 211   /**
 212    * DOCUMENT ME!
 213    *
 214    * @param g
 215    *          DOCUMENT ME!
 216    */
 217   @Override
 218   public void paintComponent(Graphics g)
 219   {
 220     super.paintComponent(g);
 221
 222     g.setColor(Color.white);
 223     g.fillRect(0, 0, getWidth(), getHeight());
 224
 225     if (fastPaint)
 226     {
 227       fastPaint = false;
 228       g.drawImage(image, 0, 0, this);
 229
 230       return;
 231     }
 232
 233     int oldHeight = imgHeight;
 234
 235     imgHeight = getHeight();
 236     imgHeight -= (imgHeight % av.getCharHeight());
 237
 238     if (imgHeight < 1)
 239     {
 240       return;
 241     }
 242
 243     if (oldHeight != imgHeight || image.getWidth(this) != getWidth())
 244     {
 245         image = new BufferedImage(getWidth(), imgHeight,
 246                 BufferedImage.TYPE_INT_RGB);
 247     }
 248
 249     gg = (Graphics2D) image.getGraphics();
 250
 251     // Fill in the background
 252     gg.setColor(Color.white);
 253     gg.fillRect(0, 0, getWidth(), imgHeight);
 254
 255     drawIds(gg, av, av.getRanges().getStartSeq(), av.getRanges().getEndSeq(), searchResults);
 256
 257     g.drawImage(image, 0, 0, this);
 258   }
 259
 260   /**
 261    * Draws sequence ids from sequence index startSeq to endSeq (inclusive), with
 262    * the font and other display settings configured on the viewport. Ids of
 263    * sequences included in the selection are coloured grey, otherwise the
 264    * current id colour for the sequence id is used.
 265    *
 266    * @param g
 267    * @param alignViewport
 268    * @param startSeq
 269    * @param endSeq
 270    * @param selection
 271    */
 272   void drawIds(Graphics2D g, AlignViewport alignViewport, final int startSeq,
 273           final int endSeq, List<SequenceI> selection)
 274   {
 275     Font font = alignViewport.getFont();
 276     if (alignViewport.isSeqNameItalics())
 277     {
 278       setIdfont(new Font(font.getName(), Font.ITALIC,
 279               font.getSize()));
 280     }
 281     else
 282     {
 283       setIdfont(font);
 284     }
 285
 286     g.setFont(getIdfont());
 287     FontMetrics fm = g.getFontMetrics();
 288
 289     if (alignViewport.antiAlias)
 290     {
 291       g.setRenderingHint(RenderingHints.KEY_ANTIALIASING,
 292               RenderingHints.VALUE_ANTIALIAS_ON);
 293     }
 294
 295     Color currentColor = Color.white;
 296     Color currentTextColor = Color.black;
 297
 298     boolean hasHiddenRows = alignViewport.hasHiddenRows();
 299
 300     if (alignViewport.getWrapAlignment())
 301     {
 302       drawIdsWrapped(g, alignViewport, startSeq, getHeight());
 303       return;
 304     }
 305
 306     // Now draw the id strings
 307     int panelWidth = getWidth();
 308     int xPos = 0;
 309
 310     // Now draw the id strings
 311     for (int i = startSeq; i <= endSeq; i++)
 312     {
 313       SequenceI sequence = alignViewport.getAlignment().getSequenceAt(i);
 314
 315       if (sequence == null)
 316       {
 317         continue;
 318       }
 319
 320       if (hasHiddenRows || alignViewport.isDisplayReferenceSeq())
 321       {
 322         g.setFont(getHiddenFont(sequence, alignViewport));
 323       }
 324
 325       // Selected sequence colours
 326       if (selection != null && selection.contains(sequence))
 327       {
 328         currentColor = Color.black;
 329         currentTextColor = Color.white;
 330       }
 331       else if ((alignViewport.getSelectionGroup() != null) && alignViewport
 332               .getSelectionGroup().getSequences(null).contains(sequence))
 333       {
 334         currentColor = Color.lightGray;
 335         currentTextColor = Color.black;
 336       }
 337       else
 338       {
 339         currentColor = alignViewport.getSequenceColour(sequence);
 340         currentTextColor = Color.black;
 341       }
 342
 343       g.setColor(currentColor);
 344
 345       int charHeight = alignViewport.getCharHeight();
 346       g.fillRect(0, (i - startSeq) * charHeight,
 347               getWidth(), charHeight);
 348
 349       g.setColor(currentTextColor);
 350
 351       String string = sequence
 352               .getDisplayId(alignViewport.getShowJVSuffix());
 353
 354       if (alignViewport.isRightAlignIds())
 355       {
 356         xPos = panelWidth - fm.stringWidth(string) - 4;
 357       }
 358
 359       g.drawString(string, xPos, (((i - startSeq) * charHeight) + charHeight)
 360               - (charHeight / 5));
 361
 362       if (hasHiddenRows)
 363       {
 364         drawMarker(g, alignViewport, i, startSeq, 0);
 365       }
 366     }
 367   }
 368
 369   /**
 370    * Draws sequence ids, and annotation labels if annotations are shown, in
 371    * wrapped mode
 372    *
 373    * @param g
 374    * @param alignViewport
 375    * @param startSeq
 376    */
 377   void drawIdsWrapped(Graphics2D g, AlignViewport alignViewport,
 378           int startSeq, int pageHeight)
 379   {
 380     int alignmentWidth = alignViewport.getAlignment().getWidth();
 381     final int alheight = alignViewport.getAlignment().getHeight();
 382
 383     int annotationHeight = 0;
 384
 385     final int charHeight = alignViewport.getCharHeight();
 386     int hgap = charHeight;
 387     if (alignViewport.getScaleAboveWrapped())
 388     {
 389       hgap += charHeight;
 390     }
 391
 392     AnnotationLabels labels = null;
 393     if (alignViewport.isShowAnnotation())
 394     {
 395       hgap += SeqCanvas.SEQS_ANNOTATION_GAP;
 396       if (ap == null)
 397       {
 398         ap = new AnnotationPanel(alignViewport);
 399       }
 400       annotationHeight = ap.adjustPanelHeight();
 401       labels = new AnnotationLabels(alignViewport);
 402     }
 403
 404     /*
 405      * height of alignment + gap + annotations (if shown)
 406      */
 407     int cHeight = alheight * charHeight + hgap
 408             + annotationHeight;
 409
 410     ViewportRanges ranges = alignViewport.getRanges();
 411
 412     int rowSize = ranges.getViewportWidth();
 413
 414     /*
 415      * draw repeating sequence ids until out of sequence data or
 416      * out of visible space, whichever comes first
 417      */
 418     boolean hasHiddenRows = alignViewport.hasHiddenRows();
 419     int ypos = hgap;
 420     int rowStartRes = ranges.getStartRes();
 421     while ((ypos <= pageHeight) && (rowStartRes < alignmentWidth))
 422     {
 423       for (int i = startSeq; i < alheight; i++)
 424       {
 425         SequenceI s = alignViewport.getAlignment().getSequenceAt(i);
 426         if (hasHiddenRows || alignViewport.isDisplayReferenceSeq())
 427         {
 428           g.setFont(getHiddenFont(s, alignViewport));
 429         }
 430         else
 431         {
 432           g.setFont(getIdfont());
 433         }
 434         drawIdString(g, hasHiddenRows, s, i, 0, ypos);
 435       }
 436
 437       if (labels != null && alignViewport.isShowAnnotation())
 438       {
 439         g.translate(0, ypos + (alheight * charHeight));
 440         labels.drawComponent(g, getWidth());
 441         g.translate(0, -ypos - (alheight * charHeight));
 442       }
 443
 444       ypos += cHeight;
 445       rowStartRes += rowSize;
 446     }
 447   }
 448
 449   /**
 450    * Draws a marker (a blue right-pointing triangle) between sequences to
 451    * indicate hidden sequences.
 452    *
 453    * @param g
 454    * @param alignViewport
 455    * @param seqIndex
 456    * @param starty
 457    * @param yoffset
 458    */
 459   void drawMarker(Graphics2D g, AlignViewport alignViewport, int seqIndex, int starty, int yoffset)
 460   {
 461     SequenceI[] hseqs = alignViewport.getAlignment()
 462             .getHiddenSequences().hiddenSequences;
 463     // Use this method here instead of calling hiddenSeq adjust
 464     // 3 times.
 465     int hSize = hseqs.length;
 466
 467     int hiddenIndex = seqIndex;
 468     int lastIndex = seqIndex - 1;
 469     int nextIndex = seqIndex + 1;
 470
 471     for (int j = 0; j < hSize; j++)
 472     {
 473       if (hseqs[j] != null)
 474       {
 475         if (j - 1 < hiddenIndex)
 476         {
 477           hiddenIndex++;
 478         }
 479         if (j - 1 < lastIndex)
 480         {
 481           lastIndex++;
 482         }
 483         if (j - 1 < nextIndex)
 484         {
 485           nextIndex++;
 486         }
 487       }
 488     }
 489
 490     /*
 491      * are we below or above the hidden sequences?
 492      */
 493     boolean below = (hiddenIndex > lastIndex + 1);
 494     boolean above = (nextIndex > hiddenIndex + 1);
 495
 496     g.setColor(Color.blue);
 497     int charHeight = av.getCharHeight();
 498
 499     /*
 500      * vertices of the triangle, below or above hidden seqs
 501      */
 502     int[] xPoints = new int[]
 503     { getWidth() - charHeight,
 504         getWidth() - charHeight, getWidth() };
 505     int yShift = seqIndex - starty;
 506
 507     if (below)
 508     {
 509       int[] yPoints = new int[] { yShift * charHeight + yoffset,
 510           yShift * charHeight + yoffset + charHeight / 4,
 511           yShift * charHeight + yoffset };
 512       g.fillPolygon(xPoints, yPoints, 3);
 513     }
 514     if (above)
 515     {
 516       yShift++;
 517       int[] yPoints = new int[] { yShift * charHeight + yoffset,
 518           yShift * charHeight + yoffset - charHeight / 4,
 519           yShift * charHeight + yoffset };
 520       g.fillPolygon(xPoints, yPoints, 3);
 521     }
 522   }
 523
 524   /**
 525    * Answers the standard sequence id font, or a bold font if the sequence is
 526    * set as reference or a hidden group representative
 527    *
 528    * @param seq
 529    * @param alignViewport
 530    * @return
 531    */
 532   private Font getHiddenFont(SequenceI seq, AlignViewport alignViewport)
 533   {
 534     if (av.isReferenceSeq(seq) || av.isHiddenRepSequence(seq))
 535     {
 536       return new Font(av.getFont().getName(), Font.BOLD,
 537               av.getFont().getSize());
 538     }
 539     return getIdfont();
 540   }
 541
 542   /**
 543    * DOCUMENT ME!
 544    *
 545    * @param list
 546    *          DOCUMENT ME!
 547    */
 548   public void setHighlighted(List<SequenceI> list)
 549   {
 550     searchResults = list;
 551     repaint();
 552   }
 553
 554   public Font getIdfont()
 555   {
 556     return idfont;
 557   }
 558
 559   public void setIdfont(Font idfont)
 560   {
 561     this.idfont = idfont;
 562   }
 563
 564   /**
 565    * Respond to viewport range changes (e.g. alignment panel was scrolled). Both
 566    * scrolling and resizing change viewport ranges. Scrolling changes both start
 567    * and end points, but resize only changes end values. Here we only want to
 568    * fastpaint on a scroll, with resize using a normal paint, so scroll events
 569    * are identified as changes to the horizontal or vertical start value.
 570    * <p>
 571    * In unwrapped mode, only responds to a vertical scroll, as horizontal scroll
 572    * leaves sequence ids unchanged. In wrapped mode, only vertical scroll is
 573    * provided, but it generates a change of "startres" which does require an
 574    * update here.
 575    */
 576   @Override
 577   public void propertyChange(PropertyChangeEvent evt)
 578   {
 579     String propertyName = evt.getPropertyName();
 580     if (propertyName.equals(ViewportRanges.STARTSEQ)
 581             || (av.getWrapAlignment()
 582                     && propertyName.equals(ViewportRanges.STARTRES)))
 583     {
 584       fastPaint((int) evt.getNewValue() - (int) evt.getOldValue());
 585     }
 586     else if (propertyName.equals(ViewportRanges.STARTRESANDSEQ))
 587     {
 588       fastPaint(((int[]) evt.getNewValue())[1]
 589               - ((int[]) evt.getOldValue())[1]);
 590     }
 591     else if (propertyName.equals(ViewportRanges.MOVE_VIEWPORT))
 592     {
 593       repaint();
 594     }
 595   }
 596 }