src/jalview/gui/AnnotationPanel.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.AlignmentAnnotation;
  24 import jalview.datamodel.Annotation;
  25 import jalview.datamodel.ColumnSelection;
  26 import jalview.datamodel.SequenceI;
  27 import jalview.renderer.AnnotationRenderer;
  28 import jalview.renderer.AwtRenderPanelI;
  29 import jalview.schemes.ResidueProperties;
  30 import jalview.util.Comparison;
  31 import jalview.util.MessageManager;
  32
  33 import java.awt.AlphaComposite;
  34 import java.awt.Color;
  35 import java.awt.Dimension;
  36 import java.awt.FontMetrics;
  37 import java.awt.Graphics;
  38 import java.awt.Graphics2D;
  39 import java.awt.Image;
  40 import java.awt.Rectangle;
  41 import java.awt.RenderingHints;
  42 import java.awt.event.ActionEvent;
  43 import java.awt.event.ActionListener;
  44 import java.awt.event.AdjustmentEvent;
  45 import java.awt.event.AdjustmentListener;
  46 import java.awt.event.MouseEvent;
  47 import java.awt.event.MouseListener;
  48 import java.awt.event.MouseMotionListener;
  49 import java.awt.event.MouseWheelEvent;
  50 import java.awt.event.MouseWheelListener;
  51 import java.awt.image.BufferedImage;
  52 import java.util.Collections;
  53 import java.util.List;
  54
  55 import javax.swing.JColorChooser;
  56 import javax.swing.JMenuItem;
  57 import javax.swing.JOptionPane;
  58 import javax.swing.JPanel;
  59 import javax.swing.JPopupMenu;
  60 import javax.swing.Scrollable;
  61 import javax.swing.ToolTipManager;
  62
  63 /**
  64  * AnnotationPanel displays visible portion of annotation rows below unwrapped
  65  * alignment
  66  *
  67  * @author $author$
  68  * @version $Revision$
  69  */
  70 public class AnnotationPanel extends JPanel implements AwtRenderPanelI,
  71         MouseListener, MouseWheelListener, MouseMotionListener,
  72         ActionListener, AdjustmentListener, Scrollable
  73 {
  74   String HELIX = MessageManager.getString("label.helix");
  75
  76   String SHEET = MessageManager.getString("label.sheet");
  77
  78   /**
  79    * For RNA secondary structure "stems" aka helices
  80    */
  81   String STEM = MessageManager.getString("label.rna_helix");
  82
  83   String LABEL = MessageManager.getString("label.label");
  84
  85   String REMOVE = MessageManager.getString("label.remove_annotation");
  86
  87   String COLOUR = MessageManager.getString("action.colour");
  88
  89   public final Color HELIX_COLOUR = Color.red.darker();
  90
  91   public final Color SHEET_COLOUR = Color.green.darker().darker();
  92
  93   public final Color STEM_COLOUR = Color.blue.darker();
  94
  95   /** DOCUMENT ME!! */
  96   public AlignViewport av;
  97
  98   AlignmentPanel ap;
  99
 100   public int activeRow = -1;
 101
 102   public BufferedImage image;
 103
 104   public volatile BufferedImage fadedImage;
 105
 106   Graphics2D gg;
 107
 108   public FontMetrics fm;
 109
 110   public int imgWidth = 0;
 111
 112   boolean fastPaint = false;
 113
 114   // Used For mouse Dragging and resizing graphs
 115   int graphStretch = -1;
 116
 117   int graphStretchY = -1;
 118
 119   int min; // used by mouseDragged to see if user
 120
 121   int max; // used by mouseDragged to see if user
 122
 123   boolean mouseDragging = false;
 124
 125   boolean MAC = false;
 126
 127   // for editing cursor
 128   int cursorX = 0;
 129
 130   int cursorY = 0;
 131
 132   public final AnnotationRenderer renderer;
 133
 134   private MouseWheelListener[] _mwl;
 135
 136   /**
 137    * Creates a new AnnotationPanel object.
 138    *
 139    * @param ap
 140    *          DOCUMENT ME!
 141    */
 142   public AnnotationPanel(AlignmentPanel ap)
 143   {
 144
 145     MAC = jalview.util.Platform.isAMac();
 146
 147     ToolTipManager.sharedInstance().registerComponent(this);
 148     ToolTipManager.sharedInstance().setInitialDelay(0);
 149     ToolTipManager.sharedInstance().setDismissDelay(10000);
 150     this.ap = ap;
 151     av = ap.av;
 152     this.setLayout(null);
 153     addMouseListener(this);
 154     addMouseMotionListener(this);
 155     ap.annotationScroller.getVerticalScrollBar()
 156             .addAdjustmentListener(this);
 157     // save any wheel listeners on the scroller, so we can propagate scroll
 158     // events to them.
 159     _mwl = ap.annotationScroller.getMouseWheelListeners();
 160     // and then set our own listener to consume all mousewheel events
 161     ap.annotationScroller.addMouseWheelListener(this);
 162     renderer = new AnnotationRenderer();
 163   }
 164
 165   public AnnotationPanel(AlignViewport av)
 166   {
 167     this.av = av;
 168     renderer = new AnnotationRenderer();
 169   }
 170
 171   @Override
 172   public void mouseWheelMoved(MouseWheelEvent e)
 173   {
 174     if (e.isShiftDown())
 175     {
 176       e.consume();
 177       if (e.getWheelRotation() > 0)
 178       {
 179         ap.scrollRight(true);
 180       }
 181       else
 182       {
 183         ap.scrollRight(false);
 184       }
 185     }
 186     else
 187     {
 188       // TODO: find the correct way to let the event bubble up to
 189       // ap.annotationScroller
 190       for (MouseWheelListener mwl : _mwl)
 191       {
 192         if (mwl != null)
 193         {
 194           mwl.mouseWheelMoved(e);
 195         }
 196         if (e.isConsumed())
 197         {
 198           break;
 199         }
 200       }
 201     }
 202   }
 203
 204   @Override
 205   public Dimension getPreferredScrollableViewportSize()
 206   {
 207     return getPreferredSize();
 208   }
 209
 210   @Override
 211   public int getScrollableBlockIncrement(Rectangle visibleRect,
 212           int orientation, int direction)
 213   {
 214     return 30;
 215   }
 216
 217   @Override
 218   public boolean getScrollableTracksViewportHeight()
 219   {
 220     return false;
 221   }
 222
 223   @Override
 224   public boolean getScrollableTracksViewportWidth()
 225   {
 226     return true;
 227   }
 228
 229   @Override
 230   public int getScrollableUnitIncrement(Rectangle visibleRect,
 231           int orientation, int direction)
 232   {
 233     return 30;
 234   }
 235
 236   /*
 237    * (non-Javadoc)
 238    *
 239    * @see
 240    * java.awt.event.AdjustmentListener#adjustmentValueChanged(java.awt.event
 241    * .AdjustmentEvent)
 242    */
 243   @Override
 244   public void adjustmentValueChanged(AdjustmentEvent evt)
 245   {
 246     // update annotation label display
 247     ap.getAlabels().setScrollOffset(-evt.getValue());
 248   }
 249
 250   /**
 251    * Calculates the height of the annotation displayed in the annotation panel.
 252    * Callers should normally call the ap.adjustAnnotationHeight method to ensure
 253    * all annotation associated components are updated correctly.
 254    *
 255    */
 256   public int adjustPanelHeight()
 257   {
 258     int height = av.calcPanelHeight();
 259     this.setPreferredSize(new Dimension(1, height));
 260     if (ap != null)
 261     {
 262       // revalidate only when the alignment panel is fully constructed
 263       ap.validate();
 264     }
 265
 266     return height;
 267   }
 268
 269   /**
 270    * DOCUMENT ME!
 271    *
 272    * @param evt
 273    *          DOCUMENT ME!
 274    */
 275   @Override
 276   public void actionPerformed(ActionEvent evt)
 277   {
 278     AlignmentAnnotation[] aa = av.getAlignment().getAlignmentAnnotation();
 279     if (aa == null)
 280     {
 281       return;
 282     }
 283     Annotation[] anot = aa[activeRow].annotations;
 284
 285     if (anot.length < av.getColumnSelection().getMax())
 286     {
 287       Annotation[] temp = new Annotation[av.getColumnSelection().getMax() + 2];
 288       System.arraycopy(anot, 0, temp, 0, anot.length);
 289       anot = temp;
 290       aa[activeRow].annotations = anot;
 291     }
 292
 293     String action = evt.getActionCommand();
 294     if (action.equals(REMOVE))
 295     {
 296       for (int index : av.getColumnSelection().getSelected())
 297       {
 298         if (av.getColumnSelection().isVisible(index))
 299         {
 300           anot[index] = null;
 301         }
 302       }
 303     }
 304     else if (action.equals(LABEL))
 305     {
 306       String exMesg = collectAnnotVals(anot, LABEL);
 307       String label = JOptionPane.showInputDialog(this,
 308               MessageManager.getString("label.enter_label"), exMesg);
 309
 310       if (label == null)
 311       {
 312         return;
 313       }
 314
 315       if ((label.length() > 0) && !aa[activeRow].hasText)
 316       {
 317         aa[activeRow].hasText = true;
 318       }
 319
 320       for (int index : av.getColumnSelection().getSelected())
 321       {
 322         if (!av.getColumnSelection().isVisible(index))
 323         {
 324           continue;
 325         }
 326
 327         if (anot[index] == null)
 328         {
 329           anot[index] = new Annotation(label, "", ' ', 0);
 330         }
 331         else
 332         {
 333           anot[index].displayCharacter = label;
 334         }
 335       }
 336     }
 337     else if (action.equals(COLOUR))
 338     {
 339       Color col = JColorChooser.showDialog(this,
 340               MessageManager.getString("label.select_foreground_colour"),
 341               Color.black);
 342
 343       for (int index : av.getColumnSelection().getSelected())
 344       {
 345         if (!av.getColumnSelection().isVisible(index))
 346         {
 347           continue;
 348         }
 349
 350         if (anot[index] == null)
 351         {
 352           anot[index] = new Annotation("", "", ' ', 0);
 353         }
 354
 355         anot[index].colour = col;
 356       }
 357     }
 358     else
 359     // HELIX, SHEET or STEM
 360     {
 361       char type = 0;
 362       String symbol = "\u03B1"; // alpha
 363
 364       if (action.equals(HELIX))
 365       {
 366         type = 'H';
 367       }
 368       else if (action.equals(SHEET))
 369       {
 370         type = 'E';
 371         symbol = "\u03B2"; // beta
 372       }
 373
 374       // Added by LML to color stems
 375       else if (action.equals(STEM))
 376       {
 377         type = 'S';
 378         int column = av.getColumnSelection().getSelectedRanges().get(0)[0];
 379         symbol = aa[activeRow].getDefaultRnaHelixSymbol(column);
 380       }
 381
 382       if (!aa[activeRow].hasIcons)
 383       {
 384         aa[activeRow].hasIcons = true;
 385       }
 386
 387       String label = JOptionPane.showInputDialog(MessageManager
 388               .getString("label.enter_label_for_the_structure"), symbol);
 389
 390       if (label == null)
 391       {
 392         return;
 393       }
 394
 395       if ((label.length() > 0) && !aa[activeRow].hasText)
 396       {
 397         aa[activeRow].hasText = true;
 398         if (action.equals(STEM))
 399         {
 400           aa[activeRow].showAllColLabels = true;
 401         }
 402       }
 403       for (int index : av.getColumnSelection().getSelected())
 404       {
 405         if (!av.getColumnSelection().isVisible(index))
 406         {
 407           continue;
 408         }
 409
 410         if (anot[index] == null)
 411         {
 412           anot[index] = new Annotation(label, "", type, 0);
 413         }
 414
 415         anot[index].secondaryStructure = type != 'S' ? type : label
 416                 .length() == 0 ? ' ' : label.charAt(0);
 417         anot[index].displayCharacter = label;
 418
 419       }
 420     }
 421
 422     av.getAlignment().validateAnnotation(aa[activeRow]);
 423     ap.alignmentChanged();
 424     ap.alignFrame.setMenusForViewport();
 425     adjustPanelHeight();
 426     repaint();
 427
 428     return;
 429   }
 430
 431   /**
 432    * Returns any existing annotation concatenated as a string. For each
 433    * annotation, takes the description, if any, else the secondary structure
 434    * character (if type is HELIX, SHEET or STEM), else the display character (if
 435    * type is LABEL).
 436    *
 437    * @param anots
 438    * @param type
 439    * @return
 440    */
 441   private String collectAnnotVals(Annotation[] anots, String type)
 442   {
 443     // TODO is this method wanted? why? 'last' is not used
 444
 445     StringBuilder collatedInput = new StringBuilder(64);
 446     String last = "";
 447     ColumnSelection viscols = av.getColumnSelection();
 448     // TODO: refactor and save av.getColumnSelection for efficiency
 449     List<Integer> selected = viscols.getSelected();
 450     Collections.sort(selected);
 451     for (int index : selected)
 452     {
 453       // always check for current display state - just in case
 454       if (!viscols.isVisible(index))
 455       {
 456         continue;
 457       }
 458       String tlabel = null;
 459       if (anots[index] != null)
 460       { // LML added stem code
 461         if (type.equals(HELIX) || type.equals(SHEET)
 462                 || type.equals(STEM) || type.equals(LABEL))
 463         {
 464           tlabel = anots[index].description;
 465           if (tlabel == null || tlabel.length() < 1)
 466           {
 467             if (type.equals(HELIX) || type.equals(SHEET)
 468                     || type.equals(STEM))
 469             {
 470               tlabel = "" + anots[index].secondaryStructure;
 471             }
 472             else
 473             {
 474               tlabel = "" + anots[index].displayCharacter;
 475             }
 476           }
 477         }
 478         if (tlabel != null && !tlabel.equals(last))
 479         {
 480           if (last.length() > 0)
 481           {
 482             collatedInput.append(" ");
 483           }
 484           collatedInput.append(tlabel);
 485         }
 486       }
 487     }
 488     return collatedInput.toString();
 489   }
 490
 491   /**
 492    * DOCUMENT ME!
 493    *
 494    * @param evt
 495    *          DOCUMENT ME!
 496    */
 497   @Override
 498   public void mousePressed(MouseEvent evt)
 499   {
 500
 501     AlignmentAnnotation[] aa = av.getAlignment().getAlignmentAnnotation();
 502     if (aa == null)
 503     {
 504       return;
 505     }
 506
 507     int height = 0;
 508     activeRow = -1;
 509
 510     for (int i = 0; i < aa.length; i++)
 511     {
 512       if (aa[i].visible)
 513       {
 514         height += aa[i].height;
 515       }
 516
 517       if (evt.getY() < height)
 518       {
 519         if (aa[i].editable)
 520         {
 521           activeRow = i;
 522         }
 523         else if (aa[i].graph > 0)
 524         {
 525           // Stretch Graph
 526           graphStretch = i;
 527           graphStretchY = evt.getY();
 528         }
 529
 530         break;
 531       }
 532     }
 533
 534     if (evt.isPopupTrigger() && activeRow != -1)
 535     {
 536       if (av.getColumnSelection() == null
 537               || av.getColumnSelection().isEmpty())
 538       {
 539         return;
 540       }
 541
 542       JPopupMenu pop = new JPopupMenu(
 543               MessageManager.getString("label.structure_type"));
 544       JMenuItem item;
 545       /*
 546        * Just display the needed structure options
 547        */
 548       if (av.getAlignment().isNucleotide())
 549       {
 550         item = new JMenuItem(STEM);
 551         item.addActionListener(this);
 552         pop.add(item);
 553       }
 554       else
 555       {
 556         item = new JMenuItem(HELIX);
 557         item.addActionListener(this);
 558         pop.add(item);
 559         item = new JMenuItem(SHEET);
 560         item.addActionListener(this);
 561         pop.add(item);
 562       }
 563       item = new JMenuItem(LABEL);
 564       item.addActionListener(this);
 565       pop.add(item);
 566       item = new JMenuItem(COLOUR);
 567       item.addActionListener(this);
 568       pop.add(item);
 569       item = new JMenuItem(REMOVE);
 570       item.addActionListener(this);
 571       pop.add(item);
 572       pop.show(this, evt.getX(), evt.getY());
 573
 574       return;
 575     }
 576
 577     ap.getScalePanel().mousePressed(evt);
 578
 579   }
 580
 581   /**
 582    * DOCUMENT ME!
 583    *
 584    * @param evt
 585    *          DOCUMENT ME!
 586    */
 587   @Override
 588   public void mouseReleased(MouseEvent evt)
 589   {
 590     graphStretch = -1;
 591     graphStretchY = -1;
 592     mouseDragging = false;
 593     ap.getScalePanel().mouseReleased(evt);
 594   }
 595
 596   /**
 597    * DOCUMENT ME!
 598    *
 599    * @param evt
 600    *          DOCUMENT ME!
 601    */
 602   @Override
 603   public void mouseEntered(MouseEvent evt)
 604   {
 605     ap.getScalePanel().mouseEntered(evt);
 606   }
 607
 608   /**
 609    * DOCUMENT ME!
 610    *
 611    * @param evt
 612    *          DOCUMENT ME!
 613    */
 614   @Override
 615   public void mouseExited(MouseEvent evt)
 616   {
 617     ap.getScalePanel().mouseExited(evt);
 618   }
 619
 620   /**
 621    * DOCUMENT ME!
 622    *
 623    * @param evt
 624    *          DOCUMENT ME!
 625    */
 626   @Override
 627   public void mouseDragged(MouseEvent evt)
 628   {
 629     if (graphStretch > -1)
 630     {
 631       av.getAlignment().getAlignmentAnnotation()[graphStretch].graphHeight += graphStretchY
 632               - evt.getY();
 633       if (av.getAlignment().getAlignmentAnnotation()[graphStretch].graphHeight < 0)
 634       {
 635         av.getAlignment().getAlignmentAnnotation()[graphStretch].graphHeight = 0;
 636       }
 637       graphStretchY = evt.getY();
 638       adjustPanelHeight();
 639       ap.paintAlignment(true);
 640     }
 641     else
 642     {
 643       ap.getScalePanel().mouseDragged(evt);
 644     }
 645   }
 646
 647   /**
 648    * Constructs the tooltip, and constructs and displays a status message, for
 649    * the current mouse position
 650    *
 651    * @param evt
 652    */
 653   @Override
 654   public void mouseMoved(MouseEvent evt)
 655   {
 656     AlignmentAnnotation[] aa = av.getAlignment().getAlignmentAnnotation();
 657
 658     if (aa == null)
 659     {
 660       this.setToolTipText(null);
 661       return;
 662     }
 663
 664     int row = -1;
 665     int height = 0;
 666
 667     for (int i = 0; i < aa.length; i++)
 668     {
 669       if (aa[i].visible)
 670       {
 671         height += aa[i].height;
 672       }
 673
 674       if (evt.getY() < height)
 675       {
 676         row = i;
 677         break;
 678       }
 679     }
 680
 681     if (row == -1)
 682     {
 683       this.setToolTipText(null);
 684       return;
 685     }
 686
 687     int column = (evt.getX() / av.getCharWidth()) + av.getStartRes();
 688
 689     if (av.hasHiddenColumns())
 690     {
 691       column = av.getColumnSelection().adjustForHiddenColumns(column);
 692     }
 693
 694     AlignmentAnnotation ann = aa[row];
 695     if (row > -1 && ann.annotations != null
 696             && column < ann.annotations.length)
 697     {
 698       buildToolTip(ann, column, aa);
 699       setStatusMessage(column, ann);
 700     }
 701     else
 702     {
 703       this.setToolTipText(null);
 704       ap.alignFrame.statusBar.setText(" ");
 705     }
 706   }
 707
 708   /**
 709    * Builds a tooltip for the annotation at the current mouse position.
 710    *
 711    * @param ann
 712    * @param column
 713    * @param anns
 714    */
 715   void buildToolTip(AlignmentAnnotation ann, int column,
 716           AlignmentAnnotation[] anns)
 717   {
 718     if (ann.graphGroup > -1)
 719     {
 720       StringBuilder tip = new StringBuilder(32);
 721       tip.append("<html>");
 722       for (int i = 0; i < anns.length; i++)
 723       {
 724         if (anns[i].graphGroup == ann.graphGroup
 725                 && anns[i].annotations[column] != null)
 726         {
 727           tip.append(anns[i].label);
 728           String description = anns[i].annotations[column].description;
 729           if (description != null && description.length() > 0)
 730           {
 731             tip.append(" ").append(description);
 732           }
 733           tip.append("<br>");
 734         }
 735       }
 736       if (tip.length() != 6)
 737       {
 738         tip.setLength(tip.length() - 4);
 739         this.setToolTipText(tip.toString() + "</html>");
 740       }
 741     }
 742     else if (ann.annotations[column] != null)
 743     {
 744       String description = ann.annotations[column].description;
 745       if (description != null && description.length() > 0)
 746       {
 747         this.setToolTipText(JvSwingUtils.wrapTooltip(true, description));
 748       }
 749     }
 750     else
 751     {
 752       // clear the tooltip.
 753       this.setToolTipText(null);
 754     }
 755   }
 756
 757   /**
 758    * Constructs and displays the status bar message
 759    *
 760    * @param column
 761    * @param ann
 762    */
 763   void setStatusMessage(int column, AlignmentAnnotation ann)
 764   {
 765     /*
 766      * show alignment column and annotation description if any
 767      */
 768     StringBuilder text = new StringBuilder(32);
 769     text.append(MessageManager.getString("label.column")).append(" ")
 770             .append(column + 1);
 771
 772     if (ann.annotations[column] != null)
 773     {
 774       String description = ann.annotations[column].description;
 775       if (description != null && description.trim().length() > 0)
 776       {
 777         text.append("  ").append(description);
 778       }
 779     }
 780
 781     /*
 782      * if the annotation is sequence-specific, show the sequence number
 783      * in the alignment, and (if not a gap) the residue and position
 784      */
 785     SequenceI seqref = ann.sequenceRef;
 786     if (seqref != null)
 787     {
 788       int seqIndex = av.getAlignment().findIndex(seqref);
 789       if (seqIndex != -1)
 790       {
 791         text.append(", ")
 792                 .append(MessageManager.getString("label.sequence"))
 793                 .append(" ")
 794                 .append(seqIndex + 1);
 795         char residue = seqref.getCharAt(column);
 796         if (!Comparison.isGap(residue))
 797         {
 798           text.append(" ");
 799           String name;
 800           if (av.getAlignment().isNucleotide())
 801           {
 802             name = ResidueProperties.nucleotideName.get(String
 803                     .valueOf(residue));
 804             text.append(" Nucleotide: ").append(
 805                     name != null ? name : residue);
 806           }
 807           else
 808           {
 809             name = 'X' == residue ? "X" : ('*' == residue ? "STOP"
 810                     : ResidueProperties.aa2Triplet.get(String
 811                             .valueOf(residue)));
 812             text.append(" Residue: ").append(name != null ? name : residue);
 813           }
 814           int residuePos = seqref.findPosition(column);
 815           text.append(" (").append(residuePos).append(")");
 816         }
 817       }
 818     }
 819
 820     ap.alignFrame.statusBar.setText(text.toString());
 821   }
 822
 823   /**
 824    * DOCUMENT ME!
 825    *
 826    * @param evt
 827    *          DOCUMENT ME!
 828    */
 829   @Override
 830   public void mouseClicked(MouseEvent evt)
 831   {
 832     // if (activeRow != -1)
 833     // {
 834     // AlignmentAnnotation[] aa = av.getAlignment().getAlignmentAnnotation();
 835     // AlignmentAnnotation anot = aa[activeRow];
 836     // }
 837   }
 838
 839   // TODO mouseClicked-content and drawCursor are quite experimental!
 840   public void drawCursor(Graphics graphics, SequenceI seq, int res, int x1,
 841           int y1)
 842   {
 843     int pady = av.getCharHeight() / 5;
 844     int charOffset = 0;
 845     graphics.setColor(Color.black);
 846     graphics.fillRect(x1, y1, av.getCharWidth(), av.getCharHeight());
 847
 848     if (av.validCharWidth)
 849     {
 850       graphics.setColor(Color.white);
 851
 852       char s = seq.getCharAt(res);
 853
 854       charOffset = (av.getCharWidth() - fm.charWidth(s)) / 2;
 855       graphics.drawString(String.valueOf(s), charOffset + x1,
 856               (y1 + av.getCharHeight()) - pady);
 857     }
 858
 859   }
 860
 861   private volatile boolean imageFresh = false;
 862
 863   /**
 864    * DOCUMENT ME!
 865    *
 866    * @param g
 867    *          DOCUMENT ME!
 868    */
 869   @Override
 870   public void paintComponent(Graphics g)
 871   {
 872     g.setColor(Color.white);
 873     g.fillRect(0, 0, getWidth(), getHeight());
 874
 875     if (image != null)
 876     {
 877       if (fastPaint || (getVisibleRect().width != g.getClipBounds().width)
 878               || (getVisibleRect().height != g.getClipBounds().height))
 879       {
 880         g.drawImage(image, 0, 0, this);
 881         fastPaint = false;
 882         return;
 883       }
 884     }
 885     imgWidth = (av.endRes - av.startRes + 1) * av.getCharWidth();
 886     if (imgWidth < 1)
 887     {
 888       return;
 889     }
 890     if (image == null || imgWidth != image.getWidth(this)
 891             || image.getHeight(this) != getHeight())
 892     {
 893       try
 894       {
 895         image = new BufferedImage(imgWidth, ap.getAnnotationPanel()
 896                 .getHeight(), BufferedImage.TYPE_INT_RGB);
 897       } catch (OutOfMemoryError oom)
 898       {
 899         try
 900         {
 901           System.gc();
 902         } catch (Exception x)
 903         {
 904         }
 905         ;
 906         new OOMWarning(
 907                 "Couldn't allocate memory to redraw screen. Please restart Jalview",
 908                 oom);
 909         return;
 910       }
 911       gg = (Graphics2D) image.getGraphics();
 912
 913       if (av.antiAlias)
 914       {
 915         gg.setRenderingHint(RenderingHints.KEY_ANTIALIASING,
 916                 RenderingHints.VALUE_ANTIALIAS_ON);
 917       }
 918
 919       gg.setFont(av.getFont());
 920       fm = gg.getFontMetrics();
 921       gg.setColor(Color.white);
 922       gg.fillRect(0, 0, imgWidth, image.getHeight());
 923       imageFresh = true;
 924     }
 925
 926     drawComponent(gg, av.startRes, av.endRes + 1);
 927     imageFresh = false;
 928     g.drawImage(image, 0, 0, this);
 929   }
 930
 931   /**
 932    * set true to enable redraw timing debug output on stderr
 933    */
 934   private final boolean debugRedraw = false;
 935
 936   /**
 937    * non-Thread safe repaint
 938    *
 939    * @param horizontal
 940    *          repaint with horizontal shift in alignment
 941    */
 942   public void fastPaint(int horizontal)
 943   {
 944     if ((horizontal == 0) || gg == null
 945             || av.getAlignment().getAlignmentAnnotation() == null
 946             || av.getAlignment().getAlignmentAnnotation().length < 1
 947             || av.isCalcInProgress())
 948     {
 949       repaint();
 950       return;
 951     }
 952     long stime = System.currentTimeMillis();
 953     gg.copyArea(0, 0, imgWidth, getHeight(),
 954             -horizontal * av.getCharWidth(), 0);
 955     long mtime = System.currentTimeMillis();
 956     int sr = av.startRes;
 957     int er = av.endRes + 1;
 958     int transX = 0;
 959
 960     if (horizontal > 0) // scrollbar pulled right, image to the left
 961     {
 962       transX = (er - sr - horizontal) * av.getCharWidth();
 963       sr = er - horizontal;
 964     }
 965     else if (horizontal < 0)
 966     {
 967       er = sr - horizontal;
 968     }
 969
 970     gg.translate(transX, 0);
 971
 972     drawComponent(gg, sr, er);
 973
 974     gg.translate(-transX, 0);
 975     long dtime = System.currentTimeMillis();
 976     fastPaint = true;
 977     repaint();
 978     long rtime = System.currentTimeMillis();
 979     if (debugRedraw)
 980     {
 981       System.err.println("Scroll:\t" + horizontal + "\tCopyArea:\t"
 982               + (mtime - stime) + "\tDraw component:\t" + (dtime - mtime)
 983               + "\tRepaint call:\t" + (rtime - dtime));
 984     }
 985
 986   }
 987
 988   private volatile boolean lastImageGood = false;
 989
 990   /**
 991    * DOCUMENT ME!
 992    *
 993    * @param g
 994    *          DOCUMENT ME!
 995    * @param startRes
 996    *          DOCUMENT ME!
 997    * @param endRes
 998    *          DOCUMENT ME!
 999    */
1000   public void drawComponent(Graphics g, int startRes, int endRes)
1001   {
1002     BufferedImage oldFaded = fadedImage;
1003     if (av.isCalcInProgress())
1004     {
1005       if (image == null)
1006       {
1007         lastImageGood = false;
1008         return;
1009       }
1010       // We'll keep a record of the old image,
1011       // and draw a faded image until the calculation
1012       // has completed
1013       if (lastImageGood
1014               && (fadedImage == null || fadedImage.getWidth() != imgWidth || fadedImage
1015                       .getHeight() != image.getHeight()))
1016       {
1017         // System.err.println("redraw faded image ("+(fadedImage==null ?
1018         // "null image" : "") + " lastGood="+lastImageGood+")");
1019         fadedImage = new BufferedImage(imgWidth, image.getHeight(),
1020                 BufferedImage.TYPE_INT_RGB);
1021
1022         Graphics2D fadedG = (Graphics2D) fadedImage.getGraphics();
1023
1024         fadedG.setColor(Color.white);
1025         fadedG.fillRect(0, 0, imgWidth, image.getHeight());
1026
1027         fadedG.setComposite(AlphaComposite.getInstance(
1028                 AlphaComposite.SRC_OVER, .3f));
1029         fadedG.drawImage(image, 0, 0, this);
1030
1031       }
1032       // make sure we don't overwrite the last good faded image until all
1033       // calculations have finished
1034       lastImageGood = false;
1035
1036     }
1037     else
1038     {
1039       if (fadedImage != null)
1040       {
1041         oldFaded = fadedImage;
1042       }
1043       fadedImage = null;
1044     }
1045
1046     g.setColor(Color.white);
1047     g.fillRect(0, 0, (endRes - startRes) * av.getCharWidth(), getHeight());
1048
1049     g.setFont(av.getFont());
1050     if (fm == null)
1051     {
1052       fm = g.getFontMetrics();
1053     }
1054
1055     if ((av.getAlignment().getAlignmentAnnotation() == null)
1056             || (av.getAlignment().getAlignmentAnnotation().length < 1))
1057     {
1058       g.setColor(Color.white);
1059       g.fillRect(0, 0, getWidth(), getHeight());
1060       g.setColor(Color.black);
1061       if (av.validCharWidth)
1062       {
1063         g.drawString(MessageManager
1064                 .getString("label.alignment_has_no_annotations"), 20, 15);
1065       }
1066
1067       return;
1068     }
1069     lastImageGood = renderer.drawComponent(this, av, g, activeRow,
1070             startRes, endRes);
1071     if (!lastImageGood && fadedImage == null)
1072     {
1073       fadedImage = oldFaded;
1074     }
1075   }
1076
1077   @Override
1078   public FontMetrics getFontMetrics()
1079   {
1080     return fm;
1081   }
1082
1083   @Override
1084   public Image getFadedImage()
1085   {
1086     return fadedImage;
1087   }
1088
1089   @Override
1090   public int getFadedImageWidth()
1091   {
1092     return imgWidth;
1093   }
1094
1095   private int[] bounds = new int[2];
1096
1097   @Override
1098   public int[] getVisibleVRange()
1099   {
1100     if (ap != null && ap.getAlabels() != null)
1101     {
1102       int sOffset = -ap.getAlabels().getScrollOffset();
1103       int visHeight = sOffset + ap.annotationSpaceFillerHolder.getHeight();
1104       bounds[0] = sOffset;
1105       bounds[1] = visHeight;
1106       return bounds;
1107     }
1108     else
1109     {
1110       return null;
1111     }
1112   }
1113 }