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