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     final int y = evt.getY();
 511     for (int i = 0; i < aa.length; i++)
 512     {
 513       if (aa[i].visible)
 514       {
 515         height += aa[i].height;
 516       }
 517
 518       if (y < height)
 519       {
 520         if (aa[i].editable)
 521         {
 522           activeRow = i;
 523         }
 524         else if (aa[i].graph > 0)
 525         {
 526           // Stretch Graph
 527           graphStretch = i;
 528           graphStretchY = y;
 529         }
 530
 531         break;
 532       }
 533     }
 534
 535     if (evt.isPopupTrigger() && activeRow != -1)
 536     {
 537       showPopupMenu(y, evt.getX());
 538       return;
 539     }
 540
 541     ap.getScalePanel().mousePressed(evt);
 542
 543   }
 544
 545   /**
 546    * Construct and display a context menu at the right-click position
 547    *
 548    * @param y
 549    * @param x
 550    */
 551   void showPopupMenu(final int y, int x)
 552   {
 553     if (av.getColumnSelection() == null
 554             || av.getColumnSelection().isEmpty())
 555     {
 556       return;
 557     }
 558
 559     JPopupMenu pop = new JPopupMenu(
 560             MessageManager.getString("label.structure_type"));
 561     JMenuItem item;
 562     /*
 563      * Just display the needed structure options
 564      */
 565     if (av.getAlignment().isNucleotide())
 566     {
 567       item = new JMenuItem(STEM);
 568       item.addActionListener(this);
 569       pop.add(item);
 570     }
 571     else
 572     {
 573       item = new JMenuItem(HELIX);
 574       item.addActionListener(this);
 575       pop.add(item);
 576       item = new JMenuItem(SHEET);
 577       item.addActionListener(this);
 578       pop.add(item);
 579     }
 580     item = new JMenuItem(LABEL);
 581     item.addActionListener(this);
 582     pop.add(item);
 583     item = new JMenuItem(COLOUR);
 584     item.addActionListener(this);
 585     pop.add(item);
 586     item = new JMenuItem(REMOVE);
 587     item.addActionListener(this);
 588     pop.add(item);
 589     pop.show(this, x, y);
 590   }
 591
 592   /**
 593    * DOCUMENT ME!
 594    *
 595    * @param evt
 596    *          DOCUMENT ME!
 597    */
 598   @Override
 599   public void mouseReleased(MouseEvent evt)
 600   {
 601     graphStretch = -1;
 602     graphStretchY = -1;
 603     mouseDragging = false;
 604     ap.getScalePanel().mouseReleased(evt);
 605
 606     if (evt.isPopupTrigger() && activeRow != -1)
 607     {
 608       showPopupMenu(evt.getY(), evt.getX());
 609     }
 610
 611   }
 612
 613   /**
 614    * DOCUMENT ME!
 615    *
 616    * @param evt
 617    *          DOCUMENT ME!
 618    */
 619   @Override
 620   public void mouseEntered(MouseEvent evt)
 621   {
 622     ap.getScalePanel().mouseEntered(evt);
 623   }
 624
 625   /**
 626    * DOCUMENT ME!
 627    *
 628    * @param evt
 629    *          DOCUMENT ME!
 630    */
 631   @Override
 632   public void mouseExited(MouseEvent evt)
 633   {
 634     ap.getScalePanel().mouseExited(evt);
 635   }
 636
 637   /**
 638    * DOCUMENT ME!
 639    *
 640    * @param evt
 641    *          DOCUMENT ME!
 642    */
 643   @Override
 644   public void mouseDragged(MouseEvent evt)
 645   {
 646     if (graphStretch > -1)
 647     {
 648       av.getAlignment().getAlignmentAnnotation()[graphStretch].graphHeight += graphStretchY
 649               - evt.getY();
 650       if (av.getAlignment().getAlignmentAnnotation()[graphStretch].graphHeight < 0)
 651       {
 652         av.getAlignment().getAlignmentAnnotation()[graphStretch].graphHeight = 0;
 653       }
 654       graphStretchY = evt.getY();
 655       adjustPanelHeight();
 656       ap.paintAlignment(true);
 657     }
 658     else
 659     {
 660       ap.getScalePanel().mouseDragged(evt);
 661     }
 662   }
 663
 664   /**
 665    * Constructs the tooltip, and constructs and displays a status message, for
 666    * the current mouse position
 667    *
 668    * @param evt
 669    */
 670   @Override
 671   public void mouseMoved(MouseEvent evt)
 672   {
 673     AlignmentAnnotation[] aa = av.getAlignment().getAlignmentAnnotation();
 674
 675     if (aa == null)
 676     {
 677       this.setToolTipText(null);
 678       return;
 679     }
 680
 681     int row = -1;
 682     int height = 0;
 683
 684     for (int i = 0; i < aa.length; i++)
 685     {
 686       if (aa[i].visible)
 687       {
 688         height += aa[i].height;
 689       }
 690
 691       if (evt.getY() < height)
 692       {
 693         row = i;
 694         break;
 695       }
 696     }
 697
 698     if (row == -1)
 699     {
 700       this.setToolTipText(null);
 701       return;
 702     }
 703
 704     int column = (evt.getX() / av.getCharWidth()) + av.getStartRes();
 705
 706     if (av.hasHiddenColumns())
 707     {
 708       column = av.getColumnSelection().adjustForHiddenColumns(column);
 709     }
 710
 711     AlignmentAnnotation ann = aa[row];
 712     if (row > -1 && ann.annotations != null
 713             && column < ann.annotations.length)
 714     {
 715       buildToolTip(ann, column, aa);
 716       setStatusMessage(column, ann);
 717     }
 718     else
 719     {
 720       this.setToolTipText(null);
 721       ap.alignFrame.statusBar.setText(" ");
 722     }
 723   }
 724
 725   /**
 726    * Builds a tooltip for the annotation at the current mouse position.
 727    *
 728    * @param ann
 729    * @param column
 730    * @param anns
 731    */
 732   void buildToolTip(AlignmentAnnotation ann, int column,
 733           AlignmentAnnotation[] anns)
 734   {
 735     if (ann.graphGroup > -1)
 736     {
 737       StringBuilder tip = new StringBuilder(32);
 738       tip.append("<html>");
 739       for (int i = 0; i < anns.length; i++)
 740       {
 741         if (anns[i].graphGroup == ann.graphGroup
 742                 && anns[i].annotations[column] != null)
 743         {
 744           tip.append(anns[i].label);
 745           String description = anns[i].annotations[column].description;
 746           if (description != null && description.length() > 0)
 747           {
 748             tip.append(" ").append(description);
 749           }
 750           tip.append("<br>");
 751         }
 752       }
 753       if (tip.length() != 6)
 754       {
 755         tip.setLength(tip.length() - 4);
 756         this.setToolTipText(tip.toString() + "</html>");
 757       }
 758     }
 759     else if (ann.annotations[column] != null)
 760     {
 761       String description = ann.annotations[column].description;
 762       if (description != null && description.length() > 0)
 763       {
 764         this.setToolTipText(JvSwingUtils.wrapTooltip(true, description));
 765       }
 766     }
 767     else
 768     {
 769       // clear the tooltip.
 770       this.setToolTipText(null);
 771     }
 772   }
 773
 774   /**
 775    * Constructs and displays the status bar message
 776    *
 777    * @param column
 778    * @param ann
 779    */
 780   void setStatusMessage(int column, AlignmentAnnotation ann)
 781   {
 782     /*
 783      * show alignment column and annotation description if any
 784      */
 785     StringBuilder text = new StringBuilder(32);
 786     text.append(MessageManager.getString("label.column")).append(" ")
 787             .append(column + 1);
 788
 789     if (ann.annotations[column] != null)
 790     {
 791       String description = ann.annotations[column].description;
 792       if (description != null && description.trim().length() > 0)
 793       {
 794         text.append("  ").append(description);
 795       }
 796     }
 797
 798     /*
 799      * if the annotation is sequence-specific, show the sequence number
 800      * in the alignment, and (if not a gap) the residue and position
 801      */
 802     SequenceI seqref = ann.sequenceRef;
 803     if (seqref != null)
 804     {
 805       int seqIndex = av.getAlignment().findIndex(seqref);
 806       if (seqIndex != -1)
 807       {
 808         text.append(", ")
 809                 .append(MessageManager.getString("label.sequence"))
 810                 .append(" ")
 811                 .append(seqIndex + 1);
 812         char residue = seqref.getCharAt(column);
 813         if (!Comparison.isGap(residue))
 814         {
 815           text.append(" ");
 816           String name;
 817           if (av.getAlignment().isNucleotide())
 818           {
 819             name = ResidueProperties.nucleotideName.get(String
 820                     .valueOf(residue));
 821             text.append(" Nucleotide: ").append(
 822                     name != null ? name : residue);
 823           }
 824           else
 825           {
 826             name = 'X' == residue ? "X" : ('*' == residue ? "STOP"
 827                     : ResidueProperties.aa2Triplet.get(String
 828                             .valueOf(residue)));
 829             text.append(" Residue: ").append(name != null ? name : residue);
 830           }
 831           int residuePos = seqref.findPosition(column);
 832           text.append(" (").append(residuePos).append(")");
 833         }
 834       }
 835     }
 836
 837     ap.alignFrame.statusBar.setText(text.toString());
 838   }
 839
 840   /**
 841    * DOCUMENT ME!
 842    *
 843    * @param evt
 844    *          DOCUMENT ME!
 845    */
 846   @Override
 847   public void mouseClicked(MouseEvent evt)
 848   {
 849     // if (activeRow != -1)
 850     // {
 851     // AlignmentAnnotation[] aa = av.getAlignment().getAlignmentAnnotation();
 852     // AlignmentAnnotation anot = aa[activeRow];
 853     // }
 854   }
 855
 856   // TODO mouseClicked-content and drawCursor are quite experimental!
 857   public void drawCursor(Graphics graphics, SequenceI seq, int res, int x1,
 858           int y1)
 859   {
 860     int pady = av.getCharHeight() / 5;
 861     int charOffset = 0;
 862     graphics.setColor(Color.black);
 863     graphics.fillRect(x1, y1, av.getCharWidth(), av.getCharHeight());
 864
 865     if (av.validCharWidth)
 866     {
 867       graphics.setColor(Color.white);
 868
 869       char s = seq.getCharAt(res);
 870
 871       charOffset = (av.getCharWidth() - fm.charWidth(s)) / 2;
 872       graphics.drawString(String.valueOf(s), charOffset + x1,
 873               (y1 + av.getCharHeight()) - pady);
 874     }
 875
 876   }
 877
 878   private volatile boolean imageFresh = false;
 879
 880   /**
 881    * DOCUMENT ME!
 882    *
 883    * @param g
 884    *          DOCUMENT ME!
 885    */
 886   @Override
 887   public void paintComponent(Graphics g)
 888   {
 889     g.setColor(Color.white);
 890     g.fillRect(0, 0, getWidth(), getHeight());
 891
 892     if (image != null)
 893     {
 894       if (fastPaint || (getVisibleRect().width != g.getClipBounds().width)
 895               || (getVisibleRect().height != g.getClipBounds().height))
 896       {
 897         g.drawImage(image, 0, 0, this);
 898         fastPaint = false;
 899         return;
 900       }
 901     }
 902     imgWidth = (av.endRes - av.startRes + 1) * av.getCharWidth();
 903     if (imgWidth < 1)
 904     {
 905       return;
 906     }
 907     if (image == null || imgWidth != image.getWidth(this)
 908             || image.getHeight(this) != getHeight())
 909     {
 910       try
 911       {
 912         image = new BufferedImage(imgWidth, ap.getAnnotationPanel()
 913                 .getHeight(), BufferedImage.TYPE_INT_RGB);
 914       } catch (OutOfMemoryError oom)
 915       {
 916         try
 917         {
 918           System.gc();
 919         } catch (Exception x)
 920         {
 921         }
 922         ;
 923         new OOMWarning(
 924                 "Couldn't allocate memory to redraw screen. Please restart Jalview",
 925                 oom);
 926         return;
 927       }
 928       gg = (Graphics2D) image.getGraphics();
 929
 930       if (av.antiAlias)
 931       {
 932         gg.setRenderingHint(RenderingHints.KEY_ANTIALIASING,
 933                 RenderingHints.VALUE_ANTIALIAS_ON);
 934       }
 935
 936       gg.setFont(av.getFont());
 937       fm = gg.getFontMetrics();
 938       gg.setColor(Color.white);
 939       gg.fillRect(0, 0, imgWidth, image.getHeight());
 940       imageFresh = true;
 941     }
 942
 943     drawComponent(gg, av.startRes, av.endRes + 1);
 944     imageFresh = false;
 945     g.drawImage(image, 0, 0, this);
 946   }
 947
 948   /**
 949    * set true to enable redraw timing debug output on stderr
 950    */
 951   private final boolean debugRedraw = false;
 952
 953   /**
 954    * non-Thread safe repaint
 955    *
 956    * @param horizontal
 957    *          repaint with horizontal shift in alignment
 958    */
 959   public void fastPaint(int horizontal)
 960   {
 961     if ((horizontal == 0) || gg == null
 962             || av.getAlignment().getAlignmentAnnotation() == null
 963             || av.getAlignment().getAlignmentAnnotation().length < 1
 964             || av.isCalcInProgress())
 965     {
 966       repaint();
 967       return;
 968     }
 969     long stime = System.currentTimeMillis();
 970     gg.copyArea(0, 0, imgWidth, getHeight(),
 971             -horizontal * av.getCharWidth(), 0);
 972     long mtime = System.currentTimeMillis();
 973     int sr = av.startRes;
 974     int er = av.endRes + 1;
 975     int transX = 0;
 976
 977     if (horizontal > 0) // scrollbar pulled right, image to the left
 978     {
 979       transX = (er - sr - horizontal) * av.getCharWidth();
 980       sr = er - horizontal;
 981     }
 982     else if (horizontal < 0)
 983     {
 984       er = sr - horizontal;
 985     }
 986
 987     gg.translate(transX, 0);
 988
 989     drawComponent(gg, sr, er);
 990
 991     gg.translate(-transX, 0);
 992     long dtime = System.currentTimeMillis();
 993     fastPaint = true;
 994     repaint();
 995     long rtime = System.currentTimeMillis();
 996     if (debugRedraw)
 997     {
 998       System.err.println("Scroll:\t" + horizontal + "\tCopyArea:\t"
 999               + (mtime - stime) + "\tDraw component:\t" + (dtime - mtime)
1000               + "\tRepaint call:\t" + (rtime - dtime));
1001     }
1002
1003   }
1004
1005   private volatile boolean lastImageGood = false;
1006
1007   /**
1008    * DOCUMENT ME!
1009    *
1010    * @param g
1011    *          DOCUMENT ME!
1012    * @param startRes
1013    *          DOCUMENT ME!
1014    * @param endRes
1015    *          DOCUMENT ME!
1016    */
1017   public void drawComponent(Graphics g, int startRes, int endRes)
1018   {
1019     BufferedImage oldFaded = fadedImage;
1020     if (av.isCalcInProgress())
1021     {
1022       if (image == null)
1023       {
1024         lastImageGood = false;
1025         return;
1026       }
1027       // We'll keep a record of the old image,
1028       // and draw a faded image until the calculation
1029       // has completed
1030       if (lastImageGood
1031               && (fadedImage == null || fadedImage.getWidth() != imgWidth || fadedImage
1032                       .getHeight() != image.getHeight()))
1033       {
1034         // System.err.println("redraw faded image ("+(fadedImage==null ?
1035         // "null image" : "") + " lastGood="+lastImageGood+")");
1036         fadedImage = new BufferedImage(imgWidth, image.getHeight(),
1037                 BufferedImage.TYPE_INT_RGB);
1038
1039         Graphics2D fadedG = (Graphics2D) fadedImage.getGraphics();
1040
1041         fadedG.setColor(Color.white);
1042         fadedG.fillRect(0, 0, imgWidth, image.getHeight());
1043
1044         fadedG.setComposite(AlphaComposite.getInstance(
1045                 AlphaComposite.SRC_OVER, .3f));
1046         fadedG.drawImage(image, 0, 0, this);
1047
1048       }
1049       // make sure we don't overwrite the last good faded image until all
1050       // calculations have finished
1051       lastImageGood = false;
1052
1053     }
1054     else
1055     {
1056       if (fadedImage != null)
1057       {
1058         oldFaded = fadedImage;
1059       }
1060       fadedImage = null;
1061     }
1062
1063     g.setColor(Color.white);
1064     g.fillRect(0, 0, (endRes - startRes) * av.getCharWidth(), getHeight());
1065
1066     g.setFont(av.getFont());
1067     if (fm == null)
1068     {
1069       fm = g.getFontMetrics();
1070     }
1071
1072     if ((av.getAlignment().getAlignmentAnnotation() == null)
1073             || (av.getAlignment().getAlignmentAnnotation().length < 1))
1074     {
1075       g.setColor(Color.white);
1076       g.fillRect(0, 0, getWidth(), getHeight());
1077       g.setColor(Color.black);
1078       if (av.validCharWidth)
1079       {
1080         g.drawString(MessageManager
1081                 .getString("label.alignment_has_no_annotations"), 20, 15);
1082       }
1083
1084       return;
1085     }
1086     lastImageGood = renderer.drawComponent(this, av, g, activeRow,
1087             startRes, endRes);
1088     if (!lastImageGood && fadedImage == null)
1089     {
1090       fadedImage = oldFaded;
1091     }
1092   }
1093
1094   @Override
1095   public FontMetrics getFontMetrics()
1096   {
1097     return fm;
1098   }
1099
1100   @Override
1101   public Image getFadedImage()
1102   {
1103     return fadedImage;
1104   }
1105
1106   @Override
1107   public int getFadedImageWidth()
1108   {
1109     return imgWidth;
1110   }
1111
1112   private int[] bounds = new int[2];
1113
1114   @Override
1115   public int[] getVisibleVRange()
1116   {
1117     if (ap != null && ap.getAlabels() != null)
1118     {
1119       int sOffset = -ap.getAlabels().getScrollOffset();
1120       int visHeight = sOffset + ap.annotationSpaceFillerHolder.getHeight();
1121       bounds[0] = sOffset;
1122       bounds[1] = visHeight;
1123       return bounds;
1124     }
1125     else
1126     {
1127       return null;
1128     }
1129   }
1130 }