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