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 java.awt.AlphaComposite;
  24 import java.awt.Color;
  25 import java.awt.Dimension;
  26 import java.awt.FontMetrics;
  27 import java.awt.Graphics;
  28 import java.awt.Graphics2D;
  29 import java.awt.Image;
  30 import java.awt.Rectangle;
  31 import java.awt.RenderingHints;
  32 import java.awt.event.ActionEvent;
  33 import java.awt.event.ActionListener;
  34 import java.awt.event.AdjustmentEvent;
  35 import java.awt.event.AdjustmentListener;
  36 import java.awt.event.MouseEvent;
  37 import java.awt.event.MouseListener;
  38 import java.awt.event.MouseMotionListener;
  39 import java.awt.event.MouseWheelEvent;
  40 import java.awt.event.MouseWheelListener;
  41 import java.awt.image.BufferedImage;
  42 import java.beans.PropertyChangeEvent;
  43 import java.util.ArrayList;
  44 import java.util.BitSet;
  45 import java.util.Collections;
  46 import java.util.List;
  47
  48 import javax.swing.JMenuItem;
  49 import javax.swing.JPanel;
  50 import javax.swing.JPopupMenu;
  51 import javax.swing.Scrollable;
  52 import javax.swing.ToolTipManager;
  53
  54 import jalview.api.AlignViewportI;
  55 import jalview.datamodel.AlignmentAnnotation;
  56 import jalview.datamodel.AlignmentI;
  57 import jalview.datamodel.Annotation;
  58 import jalview.datamodel.ColumnSelection;
  59 import jalview.datamodel.ContactListI;
  60 import jalview.datamodel.ContactMatrixI;
  61 import jalview.datamodel.ContactRange;
  62 import jalview.datamodel.GraphLine;
  63 import jalview.datamodel.HiddenColumns;
  64 import jalview.datamodel.SequenceI;
  65 import jalview.gui.JalviewColourChooser.ColourChooserListener;
  66 import jalview.renderer.AnnotationRenderer;
  67 import jalview.renderer.AwtRenderPanelI;
  68 import jalview.renderer.ContactGeometry;
  69 import jalview.schemes.ResidueProperties;
  70 import jalview.util.Comparison;
  71 import jalview.util.MessageManager;
  72 import jalview.util.Platform;
  73 import jalview.viewmodel.ViewportListenerI;
  74 import jalview.viewmodel.ViewportRanges;
  75 import jalview.ws.datamodel.alphafold.PAEContactMatrix;
  76
  77 /**
  78  * AnnotationPanel displays visible portion of annotation rows below unwrapped
  79  * alignment
  80  *
  81  * @author $author$
  82  * @version $Revision$
  83  */
  84 public class AnnotationPanel extends JPanel implements AwtRenderPanelI,
  85         MouseListener, MouseWheelListener, MouseMotionListener,
  86         ActionListener, AdjustmentListener, Scrollable, ViewportListenerI
  87 {
  88   enum DragMode
  89   {
  90     Select, Resize, Undefined, MatrixSelect
  91   };
  92
  93   String HELIX = MessageManager.getString("label.helix");
  94
  95   String SHEET = MessageManager.getString("label.sheet");
  96
  97   /**
  98    * For RNA secondary structure "stems" aka helices
  99    */
 100   String STEM = MessageManager.getString("label.rna_helix");
 101
 102   String LABEL = MessageManager.getString("label.label");
 103
 104   String REMOVE = MessageManager.getString("label.remove_annotation");
 105
 106   String COLOUR = MessageManager.getString("action.colour");
 107
 108   public final Color HELIX_COLOUR = Color.red.darker();
 109
 110   public final Color SHEET_COLOUR = Color.green.darker().darker();
 111
 112   public final Color STEM_COLOUR = Color.blue.darker();
 113
 114   /** DOCUMENT ME!! */
 115   public AlignViewport av;
 116
 117   AlignmentPanel ap;
 118
 119   public int activeRow = -1;
 120
 121   public BufferedImage image;
 122
 123   public volatile BufferedImage fadedImage;
 124
 125   // private Graphics2D gg;
 126
 127   public FontMetrics fm;
 128
 129   public int imgWidth = 0;
 130
 131   boolean fastPaint = false;
 132
 133   // Used For mouse Dragging and resizing graphs
 134   int graphStretch = -1;
 135
 136   int mouseDragLastX = -1;
 137
 138   int mouseDragLastY = -1;
 139
 140   int firstDragX = -1;
 141
 142   int firstDragY = -1;
 143
 144   DragMode dragMode = DragMode.Undefined;
 145
 146   boolean mouseDragging = false;
 147
 148   // for editing cursor
 149   int cursorX = 0;
 150
 151   int cursorY = 0;
 152
 153   public final AnnotationRenderer renderer;
 154
 155   private MouseWheelListener[] _mwl;
 156
 157   private boolean notJustOne;
 158
 159   /**
 160    * Creates a new AnnotationPanel object.
 161    *
 162    * @param ap
 163    *          DOCUMENT ME!
 164    */
 165   public AnnotationPanel(AlignmentPanel ap)
 166   {
 167     ToolTipManager.sharedInstance().registerComponent(this);
 168     ToolTipManager.sharedInstance().setInitialDelay(0);
 169     ToolTipManager.sharedInstance().setDismissDelay(10000);
 170     this.ap = ap;
 171     av = ap.av;
 172     this.setLayout(null);
 173     addMouseListener(this);
 174     addMouseMotionListener(this);
 175     ap.annotationScroller.getVerticalScrollBar()
 176             .addAdjustmentListener(this);
 177     // save any wheel listeners on the scroller, so we can propagate scroll
 178     // events to them.
 179     _mwl = ap.annotationScroller.getMouseWheelListeners();
 180     // and then set our own listener to consume all mousewheel events
 181     ap.annotationScroller.addMouseWheelListener(this);
 182     renderer = new AnnotationRenderer();
 183
 184     av.getRanges().addPropertyChangeListener(this);
 185   }
 186
 187   public AnnotationPanel(AlignViewport av)
 188   {
 189     this.av = av;
 190     renderer = new AnnotationRenderer();
 191   }
 192
 193   @Override
 194   public void mouseWheelMoved(MouseWheelEvent e)
 195   {
 196     if (e.isShiftDown())
 197     {
 198       e.consume();
 199       double wheelRotation = e.getPreciseWheelRotation();
 200       if (wheelRotation > 0)
 201       {
 202         av.getRanges().scrollRight(true);
 203       }
 204       else if (wheelRotation < 0)
 205       {
 206         av.getRanges().scrollRight(false);
 207       }
 208     }
 209     else
 210     {
 211       // TODO: find the correct way to let the event bubble up to
 212       // ap.annotationScroller
 213       for (MouseWheelListener mwl : _mwl)
 214       {
 215         if (mwl != null)
 216         {
 217           mwl.mouseWheelMoved(e);
 218         }
 219         if (e.isConsumed())
 220         {
 221           break;
 222         }
 223       }
 224     }
 225   }
 226
 227   @Override
 228   public Dimension getPreferredScrollableViewportSize()
 229   {
 230     Dimension ps = getPreferredSize();
 231     return new Dimension(ps.width, adjustForAlignFrame(false, ps.height));
 232   }
 233
 234   @Override
 235   public int getScrollableBlockIncrement(Rectangle visibleRect,
 236           int orientation, int direction)
 237   {
 238     return 30;
 239   }
 240
 241   @Override
 242   public boolean getScrollableTracksViewportHeight()
 243   {
 244     return false;
 245   }
 246
 247   @Override
 248   public boolean getScrollableTracksViewportWidth()
 249   {
 250     return true;
 251   }
 252
 253   @Override
 254   public int getScrollableUnitIncrement(Rectangle visibleRect,
 255           int orientation, int direction)
 256   {
 257     return 30;
 258   }
 259
 260   /*
 261    * (non-Javadoc)
 262    *
 263    * @see
 264    * java.awt.event.AdjustmentListener#adjustmentValueChanged(java.awt.event
 265    * .AdjustmentEvent)
 266    */
 267   @Override
 268   public void adjustmentValueChanged(AdjustmentEvent evt)
 269   {
 270     // update annotation label display
 271     ap.getAlabels().setScrollOffset(-evt.getValue());
 272   }
 273
 274   /**
 275    * Calculates the height of the annotation displayed in the annotation panel.
 276    * Callers should normally call the ap.adjustAnnotationHeight method to ensure
 277    * all annotation associated components are updated correctly.
 278    *
 279    */
 280   public int adjustPanelHeight()
 281   {
 282     int height = av.calcPanelHeight();
 283     this.setPreferredSize(new Dimension(1, height));
 284     if (ap != null)
 285     {
 286       // revalidate only when the alignment panel is fully constructed
 287       ap.validate();
 288     }
 289
 290     return height;
 291   }
 292
 293   /**
 294    * DOCUMENT ME!
 295    *
 296    * @param evt
 297    *          DOCUMENT ME!
 298    */
 299   @Override
 300   public void actionPerformed(ActionEvent evt)
 301   {
 302     AlignmentAnnotation[] aa = av.getAlignment().getAlignmentAnnotation();
 303     if (aa == null)
 304     {
 305       return;
 306     }
 307     Annotation[] anot = aa[activeRow].annotations;
 308
 309     if (anot.length < av.getColumnSelection().getMax())
 310     {
 311       Annotation[] temp = new Annotation[av.getColumnSelection().getMax()
 312               + 2];
 313       System.arraycopy(anot, 0, temp, 0, anot.length);
 314       anot = temp;
 315       aa[activeRow].annotations = anot;
 316     }
 317
 318     String action = evt.getActionCommand();
 319     if (action.equals(REMOVE))
 320     {
 321       for (int index : av.getColumnSelection().getSelected())
 322       {
 323         if (av.getAlignment().getHiddenColumns().isVisible(index))
 324         {
 325           anot[index] = null;
 326         }
 327       }
 328     }
 329     else if (action.equals(LABEL))
 330     {
 331       String exMesg = collectAnnotVals(anot, LABEL);
 332       String label = JvOptionPane.showInputDialog(
 333               MessageManager.getString("label.enter_label"), exMesg);
 334
 335       if (label == null)
 336       {
 337         return;
 338       }
 339
 340       if ((label.length() > 0) && !aa[activeRow].hasText)
 341       {
 342         aa[activeRow].hasText = true;
 343       }
 344
 345       for (int index : av.getColumnSelection().getSelected())
 346       {
 347         if (!av.getAlignment().getHiddenColumns().isVisible(index))
 348         {
 349           continue;
 350         }
 351
 352         if (anot[index] == null)
 353         {
 354           anot[index] = new Annotation(label, "", ' ', 0);
 355         }
 356         else
 357         {
 358           anot[index].displayCharacter = label;
 359         }
 360       }
 361     }
 362     else if (action.equals(COLOUR))
 363     {
 364       final Annotation[] fAnot = anot;
 365       String title = MessageManager
 366               .getString("label.select_foreground_colour");
 367       ColourChooserListener listener = new ColourChooserListener()
 368       {
 369         @Override
 370         public void colourSelected(Color c)
 371         {
 372           HiddenColumns hiddenColumns = av.getAlignment()
 373                   .getHiddenColumns();
 374           for (int index : av.getColumnSelection().getSelected())
 375           {
 376             if (hiddenColumns.isVisible(index))
 377             {
 378               if (fAnot[index] == null)
 379               {
 380                 fAnot[index] = new Annotation("", "", ' ', 0);
 381               }
 382               fAnot[index].colour = c;
 383             }
 384           }
 385         };
 386       };
 387       JalviewColourChooser.showColourChooser(this, title, Color.black,
 388               listener);
 389     }
 390     else
 391     // HELIX, SHEET or STEM
 392     {
 393       char type = 0;
 394       String symbol = "\u03B1"; // alpha
 395
 396       if (action.equals(HELIX))
 397       {
 398         type = 'H';
 399       }
 400       else if (action.equals(SHEET))
 401       {
 402         type = 'E';
 403         symbol = "\u03B2"; // beta
 404       }
 405
 406       // Added by LML to color stems
 407       else if (action.equals(STEM))
 408       {
 409         type = 'S';
 410         int column = av.getColumnSelection().getSelectedRanges().get(0)[0];
 411         symbol = aa[activeRow].getDefaultRnaHelixSymbol(column);
 412       }
 413
 414       if (!aa[activeRow].hasIcons)
 415       {
 416         aa[activeRow].hasIcons = true;
 417       }
 418
 419       String label = JvOptionPane.showInputDialog(MessageManager
 420               .getString("label.enter_label_for_the_structure"), symbol);
 421
 422       if (label == null)
 423       {
 424         return;
 425       }
 426
 427       if ((label.length() > 0) && !aa[activeRow].hasText)
 428       {
 429         aa[activeRow].hasText = true;
 430         if (action.equals(STEM))
 431         {
 432           aa[activeRow].showAllColLabels = true;
 433         }
 434       }
 435       for (int index : av.getColumnSelection().getSelected())
 436       {
 437         if (!av.getAlignment().getHiddenColumns().isVisible(index))
 438         {
 439           continue;
 440         }
 441
 442         if (anot[index] == null)
 443         {
 444           anot[index] = new Annotation(label, "", type, 0);
 445         }
 446
 447         anot[index].secondaryStructure = type != 'S' ? type
 448                 : label.length() == 0 ? ' ' : label.charAt(0);
 449         anot[index].displayCharacter = label;
 450
 451       }
 452     }
 453
 454     av.getAlignment().validateAnnotation(aa[activeRow]);
 455     ap.alignmentChanged();
 456     ap.alignFrame.setMenusForViewport();
 457     adjustPanelHeight();
 458     repaint();
 459
 460     return;
 461   }
 462
 463   /**
 464    * Returns any existing annotation concatenated as a string. For each
 465    * annotation, takes the description, if any, else the secondary structure
 466    * character (if type is HELIX, SHEET or STEM), else the display character (if
 467    * type is LABEL).
 468    *
 469    * @param anots
 470    * @param type
 471    * @return
 472    */
 473   private String collectAnnotVals(Annotation[] anots, String type)
 474   {
 475     // TODO is this method wanted? why? 'last' is not used
 476
 477     StringBuilder collatedInput = new StringBuilder(64);
 478     String last = "";
 479     ColumnSelection viscols = av.getColumnSelection();
 480     HiddenColumns hidden = av.getAlignment().getHiddenColumns();
 481
 482     /*
 483      * the selection list (read-only view) is in selection order, not
 484      * column order; make a copy so we can sort it
 485      */
 486     List<Integer> selected = new ArrayList<>(viscols.getSelected());
 487     Collections.sort(selected);
 488     for (int index : selected)
 489     {
 490       // always check for current display state - just in case
 491       if (!hidden.isVisible(index))
 492       {
 493         continue;
 494       }
 495       String tlabel = null;
 496       if (anots[index] != null)
 497       { // LML added stem code
 498         if (type.equals(HELIX) || type.equals(SHEET) || type.equals(STEM)
 499                 || type.equals(LABEL))
 500         {
 501           tlabel = anots[index].description;
 502           if (tlabel == null || tlabel.length() < 1)
 503           {
 504             if (type.equals(HELIX) || type.equals(SHEET)
 505                     || type.equals(STEM))
 506             {
 507               tlabel = "" + anots[index].secondaryStructure;
 508             }
 509             else
 510             {
 511               tlabel = "" + anots[index].displayCharacter;
 512             }
 513           }
 514         }
 515         if (tlabel != null && !tlabel.equals(last))
 516         {
 517           if (last.length() > 0)
 518           {
 519             collatedInput.append(" ");
 520           }
 521           collatedInput.append(tlabel);
 522         }
 523       }
 524     }
 525     return collatedInput.toString();
 526   }
 527
 528   /**
 529    * Action on right mouse pressed on Mac is to show a pop-up menu for the
 530    * annotation. Action on left mouse pressed is to find which annotation is
 531    * pressed and mark the start of a column selection or graph resize operation.
 532    *
 533    * @param evt
 534    */
 535   @Override
 536   public void mousePressed(MouseEvent evt)
 537   {
 538
 539     AlignmentAnnotation[] aa = av.getAlignment().getAlignmentAnnotation();
 540     if (aa == null)
 541     {
 542       return;
 543     }
 544     mouseDragLastX = evt.getX();
 545     mouseDragLastY = evt.getY();
 546
 547     /*
 548      * add visible annotation heights until we reach the y
 549      * position, to find which annotation it is in
 550      */
 551     int height = 0;
 552     activeRow = -1;
 553     int yOffset = 0;
 554     // todo could reuse getRowIndexAndOffset ?
 555     final int y = evt.getY();
 556
 557     for (int i = 0; i < aa.length; i++)
 558     {
 559       if (aa[i].visible)
 560       {
 561         height += aa[i].height;
 562       }
 563
 564       if (y < height)
 565       {
 566         if (aa[i].editable)
 567         {
 568           activeRow = i;
 569         }
 570         else if (aa[i].graph != 0)
 571         {
 572           /*
 573            * we have clicked on a resizable graph annotation
 574            */
 575           graphStretch = i;
 576           yOffset = height - y;
 577         }
 578         break;
 579       }
 580     }
 581
 582     /*
 583      * isPopupTrigger fires in mousePressed on Mac,
 584      * not until mouseRelease on Windows
 585      */
 586     if (evt.isPopupTrigger() && activeRow != -1)
 587     {
 588       showPopupMenu(y, evt.getX());
 589       return;
 590     }
 591
 592     if (graphStretch != -1)
 593     {
 594
 595       if (aa[graphStretch].graph == AlignmentAnnotation.CONTACT_MAP)
 596       {
 597         // data in row has position on y as well as x axis
 598         if (evt.isAltDown() || evt.isAltGraphDown())
 599         {
 600           dragMode = DragMode.MatrixSelect;
 601           firstDragX = mouseDragLastX;
 602           firstDragY = mouseDragLastY;
 603         }
 604       }
 605     }
 606     else
 607     {
 608       // no row (or row that can be adjusted) was pressed. Simulate a ruler
 609       // click
 610       ap.getScalePanel().mousePressed(evt);
 611     }
 612   }
 613
 614   /**
 615    * checks whether the annotation row under the mouse click evt's handles the
 616    * event
 617    *
 618    * @param evt
 619    * @return false if evt was not handled
 620    */
 621   boolean matrix_clicked(MouseEvent evt)
 622   {
 623     int[] rowIndex = getRowIndexAndOffset(evt.getY(),
 624             av.getAlignment().getAlignmentAnnotation());
 625     if (rowIndex == null)
 626     {
 627       jalview.bin.Console
 628               .error("IMPLEMENTATION ERROR: matrix click out of range.");
 629       return false;
 630     }
 631     int yOffset = rowIndex[1];
 632
 633     AlignmentAnnotation clicked = av.getAlignment()
 634             .getAlignmentAnnotation()[rowIndex[0]];
 635     if (clicked.graph != AlignmentAnnotation.CONTACT_MAP)
 636     {
 637       return false;
 638     }
 639
 640     // TODO - use existing threshold to select related sections of matrix
 641     GraphLine thr = clicked.getThreshold();
 642
 643     int currentX = getColumnForXPos(evt.getX());
 644     ContactListI forCurrentX = av.getContactList(clicked, currentX);
 645     if (forCurrentX != null)
 646     {
 647       ContactGeometry cXcgeom = new ContactGeometry(forCurrentX,
 648               clicked.graphHeight);
 649       ContactGeometry.contactInterval cXci = cXcgeom.mapFor(yOffset,
 650               yOffset);
 651       /**
 652        * start and end range corresponding to the row range under the mouse at
 653        * column currentX
 654        */
 655       int fr, to;
 656       fr = Math.min(cXci.cStart, cXci.cEnd);
 657       to = Math.max(cXci.cStart, cXci.cEnd);
 658
 659       if (evt.isControlDown())
 660       {
 661         ContactMatrixI matrix = av.getContactMatrix(clicked);
 662
 663         if (matrix != null)
 664         {
 665           // simplest approach is to select all group containing column
 666           if (matrix.hasGroups())
 667           {
 668             SequenceI rseq = clicked.sequenceRef;
 669             BitSet grp = matrix.getGroupsFor(currentX);
 670             for (int c = fr; c <= to; c++)
 671             {
 672               BitSet additionalGrp = matrix.getGroupsFor(c);
 673               grp.or(additionalGrp);
 674             }
 675             HiddenColumns hc = av.getAlignment().getHiddenColumns();
 676             for (int p = grp.nextSetBit(0); p >= 0; p = grp
 677                     .nextSetBit(p + 1))
 678             {
 679               int offp = (rseq != null)
 680                       ? rseq.findIndex(rseq.getStart() - 1 + p)
 681                       : p;
 682
 683               if (!av.hasHiddenColumns() || hc.isVisible(offp))
 684               {
 685                 av.getColumnSelection().addElement(offp);
 686               }
 687             }
 688           }
 689           // possible alternative for interactive selection - threshold
 690           // gives 'ceiling' for forming a cluster
 691           // when a row+column is selected, farthest common ancestor less
 692           // than thr is used to compute cluster
 693
 694         }
 695       }
 696       else
 697       {
 698         // select corresponding range in segment under mouse
 699         {
 700           for (int c = fr; c <= to; c++)
 701           {
 702             av.getColumnSelection().addElement(c);
 703           }
 704           av.getColumnSelection().addElement(currentX);
 705         }
 706         // PAE SPECIFIC
 707         // and also select everything lower than the max range adjacent
 708         // (kind of works)
 709         if (PAEContactMatrix.PAEMATRIX.equals(clicked.getCalcId()))
 710         {
 711           int c = fr - 1;
 712           ContactRange cr = forCurrentX.getRangeFor(fr, to);
 713           double cval;
 714           // TODO: could use GraphLine instead of arbitrary picking
 715           // TODO: could report mean/median/variance for partitions
 716           // (contiguous selected vs unselected regions and inter-contig
 717           // regions)
 718           // controls feathering - what other elements in row/column
 719           // should we select
 720           double thresh = cr.getMean() + (cr.getMax() - cr.getMean()) * .15;
 721           while (c > 0)
 722           {
 723             cval = forCurrentX.getContactAt(c);
 724             if (// cr.getMin() <= cval &&
 725             cval <= thresh)
 726             {
 727               av.getColumnSelection().addElement(c--);
 728             }
 729             else
 730             {
 731               break;
 732             }
 733           }
 734           c = to;
 735           while (c < forCurrentX.getContactHeight())
 736           {
 737             cval = forCurrentX.getContactAt(c);
 738             if (// cr.getMin() <= cval &&
 739             cval <= thresh)
 740             {
 741               av.getColumnSelection().addElement(c++);
 742             }
 743             else
 744             {
 745               break;
 746             }
 747           }
 748         }
 749       }
 750     }
 751     ap.paintAlignment(false, false);
 752     PaintRefresher.Refresh(ap, av.getSequenceSetId());
 753     av.sendSelection();
 754     return true;
 755   }
 756
 757   /**
 758    * Construct and display a context menu at the right-click position
 759    *
 760    * @param y
 761    * @param x
 762    */
 763   void showPopupMenu(final int y, int x)
 764   {
 765     if (av.getColumnSelection() == null
 766             || av.getColumnSelection().isEmpty())
 767     {
 768       return;
 769     }
 770
 771     JPopupMenu pop = new JPopupMenu(
 772             MessageManager.getString("label.structure_type"));
 773     JMenuItem item;
 774     /*
 775      * Just display the needed structure options
 776      */
 777     if (av.getAlignment().isNucleotide())
 778     {
 779       item = new JMenuItem(STEM);
 780       item.addActionListener(this);
 781       pop.add(item);
 782     }
 783     else
 784     {
 785       item = new JMenuItem(HELIX);
 786       item.addActionListener(this);
 787       pop.add(item);
 788       item = new JMenuItem(SHEET);
 789       item.addActionListener(this);
 790       pop.add(item);
 791     }
 792     item = new JMenuItem(LABEL);
 793     item.addActionListener(this);
 794     pop.add(item);
 795     item = new JMenuItem(COLOUR);
 796     item.addActionListener(this);
 797     pop.add(item);
 798     item = new JMenuItem(REMOVE);
 799     item.addActionListener(this);
 800     pop.add(item);
 801     pop.show(this, x, y);
 802   }
 803
 804   /**
 805    * Action on mouse up is to clear mouse drag data and call mouseReleased on
 806    * ScalePanel, to deal with defining the selection group (if any) defined by
 807    * the mouse drag
 808    *
 809    * @param evt
 810    */
 811   @Override
 812   public void mouseReleased(MouseEvent evt)
 813   {
 814     if (dragMode == DragMode.MatrixSelect)
 815     {
 816       matrixSelectRange(evt);
 817     }
 818     graphStretch = -1;
 819     mouseDragLastX = -1;
 820     mouseDragLastY = -1;
 821     firstDragX = -1;
 822     firstDragY = -1;
 823     mouseDragging = false;
 824     if (dragMode == DragMode.Resize)
 825     {
 826       ap.adjustAnnotationHeight();
 827     }
 828     dragMode = DragMode.Undefined;
 829     if (!matrix_clicked(evt))
 830     {
 831       ap.getScalePanel().mouseReleased(evt);
 832     }
 833
 834     /*
 835      * isPopupTrigger is set in mouseReleased on Windows
 836      * (in mousePressed on Mac)
 837      */
 838     if (evt.isPopupTrigger() && activeRow != -1)
 839     {
 840       showPopupMenu(evt.getY(), evt.getX());
 841     }
 842
 843   }
 844
 845   /**
 846    * DOCUMENT ME!
 847    *
 848    * @param evt
 849    *          DOCUMENT ME!
 850    */
 851   @Override
 852   public void mouseEntered(MouseEvent evt)
 853   {
 854     this.mouseDragging = false;
 855     ap.getScalePanel().mouseEntered(evt);
 856   }
 857
 858   /**
 859    * On leaving the panel, calls ScalePanel.mouseExited to deal with scrolling
 860    * with column selection on a mouse drag
 861    *
 862    * @param evt
 863    */
 864   @Override
 865   public void mouseExited(MouseEvent evt)
 866   {
 867     ap.getScalePanel().mouseExited(evt);
 868   }
 869
 870   /**
 871    * Action on starting or continuing a mouse drag. There are two possible
 872    * actions:
 873    * <ul>
 874    * <li>drag up or down on a graphed annotation increases or decreases the
 875    * height of the graph</li>
 876    * <li>dragging left or right selects the columns dragged across</li>
 877    * </ul>
 878    * A drag on a graph annotation is treated as column selection if it starts
 879    * with more horizontal than vertical movement, and as resize if it starts
 880    * with more vertical than horizontal movement. Once started, the drag does
 881    * not change mode.
 882    *
 883    * @param evt
 884    */
 885   @Override
 886   public void mouseDragged(MouseEvent evt)
 887   {
 888     /*
 889      * if dragMode is Undefined:
 890      * - set to Select if dx > dy
 891      * - set to Resize if dy > dx
 892      * - do nothing if dx == dy
 893      */
 894     final int x = evt.getX();
 895     final int y = evt.getY();
 896     if (dragMode == DragMode.Undefined)
 897     {
 898       int dx = Math.abs(x - mouseDragLastX);
 899       int dy = Math.abs(y - mouseDragLastY);
 900       if (graphStretch == -1 || dx > dy)
 901       {
 902         /*
 903          * mostly horizontal drag, or not a graph annotation
 904          */
 905         dragMode = DragMode.Select;
 906       }
 907       else if (dy > dx)
 908       {
 909         /*
 910          * mostly vertical drag
 911          */
 912         dragMode = DragMode.Resize;
 913         notJustOne = evt.isShiftDown();
 914
 915         /*
 916          * but could also be a matrix drag
 917          */
 918         if ((evt.isAltDown() || evt.isAltGraphDown()) && (av.getAlignment()
 919                 .getAlignmentAnnotation()[graphStretch].graph == AlignmentAnnotation.CONTACT_MAP))
 920         {
 921           /*
 922            * dragging in a matrix
 923            */
 924           dragMode = DragMode.MatrixSelect;
 925           firstDragX = mouseDragLastX;
 926           firstDragY = mouseDragLastY;
 927         }
 928       }
 929     }
 930
 931     if (dragMode == DragMode.Undefined)
 932
 933     {
 934       /*
 935        * drag is diagonal - defer deciding whether to
 936        * treat as up/down or left/right
 937        */
 938       return;
 939     }
 940
 941     try
 942     {
 943       if (dragMode == DragMode.Resize)
 944       {
 945         /*
 946          * resize graph annotation if mouse was dragged up or down
 947          */
 948         int deltaY = mouseDragLastY - evt.getY();
 949         if (deltaY != 0)
 950         {
 951           AlignmentAnnotation graphAnnotation = av.getAlignment()
 952                   .getAlignmentAnnotation()[graphStretch];
 953           int newHeight = Math.max(0, graphAnnotation.graphHeight + deltaY);
 954           if (notJustOne)
 955           {
 956             for (AlignmentAnnotation similar : av.getAlignment()
 957                     .findAnnotations(null, graphAnnotation.getCalcId(),
 958                             graphAnnotation.label))
 959             {
 960               similar.graphHeight = newHeight;
 961             }
 962
 963           }
 964           else
 965           {
 966             graphAnnotation.graphHeight = newHeight;
 967           }
 968           adjustPanelHeight();
 969           ap.paintAlignment(false, false);
 970         }
 971       }
 972       else if (dragMode == DragMode.MatrixSelect)
 973       {
 974         /*
 975          * TODO draw a rubber band for range
 976          */
 977         mouseDragLastX = x;
 978         mouseDragLastY = y;
 979         ap.paintAlignment(false, false);
 980       }
 981       else
 982       {
 983         /*
 984          * for mouse drag left or right, delegate to
 985          * ScalePanel to adjust the column selection
 986          */
 987         ap.getScalePanel().mouseDragged(evt);
 988       }
 989     } finally
 990     {
 991       mouseDragLastX = x;
 992       mouseDragLastY = y;
 993     }
 994   }
 995
 996   public void matrixSelectRange(MouseEvent evt)
 997   {
 998     /*
 999      * get geometry of drag
1000      */
1001     int fromY = Math.min(firstDragY, evt.getY());
1002     int toY = Math.max(firstDragY, evt.getY());
1003     int fromX = Math.min(firstDragX, evt.getX());
1004     int toX = Math.max(firstDragX, evt.getX());
1005
1006     int deltaY = toY - fromY;
1007     int deltaX = toX - fromX;
1008
1009     int[] rowIndex = getRowIndexAndOffset(fromY,
1010             av.getAlignment().getAlignmentAnnotation());
1011     int[] toRowIndex = getRowIndexAndOffset(toY,
1012             av.getAlignment().getAlignmentAnnotation());
1013
1014     if (rowIndex == null || toRowIndex == null)
1015     {
1016       jalview.bin.Console.trace("Drag out of range. needs to be clipped");
1017
1018     }
1019     if (rowIndex[0] != toRowIndex[0])
1020     {
1021       jalview.bin.Console
1022               .trace("Drag went to another row. needs to be clipped");
1023     }
1024
1025     // rectangular selection on matrix style annotation
1026     AlignmentAnnotation cma = av.getAlignment()
1027             .getAlignmentAnnotation()[rowIndex[0]];
1028
1029     int lastX = getColumnForXPos(fromX);
1030     int currentX = getColumnForXPos(toX);
1031     int fromXc = Math.min(lastX, currentX);
1032     int toXc = Math.max(lastX, currentX);
1033     ContactListI forFromX = av.getContactList(cma, fromXc);
1034     ContactListI forToX = av.getContactList(cma, toXc);
1035
1036     if (forFromX != null && forToX != null)
1037     {
1038       ContactGeometry lastXcgeom = new ContactGeometry(forFromX,
1039               cma.graphHeight);
1040       ContactGeometry.contactInterval lastXci = lastXcgeom
1041               .mapFor(rowIndex[1], rowIndex[1] - deltaY);
1042
1043       ContactGeometry cXcgeom = new ContactGeometry(forToX,
1044               cma.graphHeight);
1045       ContactGeometry.contactInterval cXci = cXcgeom.mapFor(rowIndex[1],
1046               rowIndex[1] - deltaY);
1047
1048       // mark rectangular region formed by drag
1049       jalview.bin.Console.trace("Matrix Selection from last(" + fromXc
1050               + ",[" + lastXci.cStart + "," + lastXci.cEnd + "]) to cur("
1051               + toXc + ",[" + cXci.cStart + "," + cXci.cEnd + "])");
1052       int fr, to;
1053       fr = Math.min(lastXci.cStart, lastXci.cEnd);
1054       to = Math.max(lastXci.cStart, lastXci.cEnd);
1055       jalview.bin.Console.trace("Marking " + fr + " to " + to);
1056       for (int c = fr; c <= to; c++)
1057       {
1058         if (cma.sequenceRef != null)
1059         {
1060           int col = cma.sequenceRef.findIndex(c);
1061           av.getColumnSelection().addElement(col);
1062         }
1063         else
1064         {
1065           av.getColumnSelection().addElement(c);
1066         }
1067       }
1068       fr = Math.min(cXci.cStart, cXci.cEnd);
1069       to = Math.max(cXci.cStart, cXci.cEnd);
1070       jalview.bin.Console.trace("Marking " + fr + " to " + to);
1071       for (int c = fr; c <= to; c++)
1072       {
1073         if (cma.sequenceRef != null)
1074         {
1075           int col = cma.sequenceRef.findIndex(c);
1076           av.getColumnSelection().addElement(col);
1077         }
1078         else
1079         {
1080           av.getColumnSelection().addElement(c);
1081         }
1082       }
1083       fr = Math.min(lastX, currentX);
1084       to = Math.max(lastX, currentX);
1085
1086       jalview.bin.Console.trace("Marking " + fr + " to " + to);
1087       for (int c = fr; c <= to; c++)
1088       {
1089         av.getColumnSelection().addElement(c);
1090       }
1091     }
1092
1093   }
1094
1095   /**
1096    * Constructs the tooltip, and constructs and displays a status message, for
1097    * the current mouse position
1098    *
1099    * @param evt
1100    */
1101   @Override
1102   public void mouseMoved(MouseEvent evt)
1103   {
1104     int yPos = evt.getY();
1105     AlignmentAnnotation[] aa = av.getAlignment().getAlignmentAnnotation();
1106     int rowAndOffset[] = getRowIndexAndOffset(yPos, aa);
1107     int row = rowAndOffset[0];
1108
1109     if (row == -1)
1110     {
1111       this.setToolTipText(null);
1112       return;
1113     }
1114
1115     int column = getColumnForXPos(evt.getX());
1116
1117     AlignmentAnnotation ann = aa[row];
1118     if (row > -1 && ann.annotations != null
1119             && column < ann.annotations.length)
1120     {
1121       String toolTip = buildToolTip(ann, column, aa, rowAndOffset[1], av,
1122               ap);
1123       setToolTipText(toolTip == null ? null
1124               : JvSwingUtils.wrapTooltip(true, toolTip));
1125       String msg = getStatusMessage(av.getAlignment(), column, ann,
1126               rowAndOffset[1], av);
1127       ap.alignFrame.setStatus(msg);
1128     }
1129     else
1130     {
1131       this.setToolTipText(null);
1132       ap.alignFrame.setStatus(" ");
1133     }
1134   }
1135
1136   private int getColumnForXPos(int x)
1137   {
1138     int column = (x / av.getCharWidth()) + av.getRanges().getStartRes();
1139     column = Math.min(column, av.getRanges().getEndRes());
1140
1141     if (av.hasHiddenColumns())
1142     {
1143       column = av.getAlignment().getHiddenColumns()
1144               .visibleToAbsoluteColumn(column);
1145     }
1146     return column;
1147   }
1148
1149   /**
1150    * Answers the index in the annotations array of the visible annotation at the
1151    * given y position. This is done by adding the heights of visible annotations
1152    * until the y position has been exceeded. Answers -1 if no annotations are
1153    * visible, or the y position is below all annotations.
1154    *
1155    * @param yPos
1156    * @param aa
1157    * @return
1158    */
1159   static int getRowIndex(int yPos, AlignmentAnnotation[] aa)
1160   {
1161     if (aa == null)
1162     {
1163       return -1;
1164     }
1165     return getRowIndexAndOffset(yPos, aa)[0];
1166   }
1167
1168   static int[] getRowIndexAndOffset(int yPos, AlignmentAnnotation[] aa)
1169   {
1170     int[] res = new int[2];
1171     res[0] = -1;
1172     res[1] = 0;
1173     if (aa == null)
1174     {
1175       return res;
1176     }
1177     int row = -1;
1178     int height = 0, lheight = 0;
1179     for (int i = 0; i < aa.length; i++)
1180     {
1181       if (aa[i].visible)
1182       {
1183         lheight = height;
1184         height += aa[i].height;
1185       }
1186
1187       if (height > yPos)
1188       {
1189         row = i;
1190         res[0] = row;
1191         res[1] = height - yPos;
1192         break;
1193       }
1194     }
1195     return res;
1196   }
1197
1198   /**
1199    * Answers a tooltip for the annotation at the current mouse position, not
1200    * wrapped in &lt;html&gt; tags (apply if wanted). Answers null if there is no
1201    * tooltip to show.
1202    *
1203    * @param ann
1204    * @param column
1205    * @param anns
1206    * @param rowAndOffset
1207    */
1208   static String buildToolTip(AlignmentAnnotation ann, int column,
1209           AlignmentAnnotation[] anns, int rowAndOffset, AlignViewportI av,
1210           AlignmentPanel ap)
1211   {
1212     String tooltip = null;
1213     if (ann.graphGroup > -1)
1214     {
1215       StringBuilder tip = new StringBuilder(32);
1216       boolean first = true;
1217       for (int i = 0; i < anns.length; i++)
1218       {
1219         if (anns[i].graphGroup == ann.graphGroup
1220                 && anns[i].annotations[column] != null)
1221         {
1222           if (!first)
1223           {
1224             tip.append("<br>");
1225           }
1226           first = false;
1227           tip.append(anns[i].label);
1228           String description = anns[i].annotations[column].description;
1229           if (description != null && description.length() > 0)
1230           {
1231             tip.append(" ").append(description);
1232           }
1233         }
1234       }
1235       tooltip = first ? null : tip.toString();
1236     }
1237     else if (column < ann.annotations.length
1238             && ann.annotations[column] != null)
1239     {
1240       tooltip = ann.annotations[column].description;
1241     }
1242     // TODO abstract tooltip generator so different implementations can be built
1243     if (ann.graph == AlignmentAnnotation.CONTACT_MAP)
1244     {
1245       ContactListI clist = av.getContactList(ann, column);
1246       if (clist != null)
1247       {
1248         ContactGeometry cgeom = new ContactGeometry(clist, ann.graphHeight);
1249         ContactGeometry.contactInterval ci = cgeom.mapFor(rowAndOffset);
1250         ContactRange cr = clist.getRangeFor(ci.cStart, ci.cEnd);
1251         tooltip = "Contact from " + clist.getPosition() + ", [" + ci.cStart
1252                 + " - " + ci.cEnd + "]" + "<br/>Mean:" + cr.getMean();
1253         int col = ann.sequenceRef.findPosition(column);
1254         ap.getStructureSelectionManager()
1255                 .highlightPositionsOn(ann.sequenceRef, new int[][]
1256                 { new int[] { col, col },
1257                     new int[]
1258                     { ci.cStart, ci.cEnd } }, null);
1259       }
1260     }
1261     return tooltip;
1262   }
1263
1264   /**
1265    * Constructs and returns the status bar message
1266    *
1267    * @param al
1268    * @param column
1269    * @param ann
1270    * @param rowAndOffset
1271    */
1272   static String getStatusMessage(AlignmentI al, int column,
1273           AlignmentAnnotation ann, int rowAndOffset, AlignViewportI av)
1274   {
1275     /*
1276      * show alignment column and annotation description if any
1277      */
1278     StringBuilder text = new StringBuilder(32);
1279     text.append(MessageManager.getString("label.column")).append(" ")
1280             .append(column + 1);
1281
1282     if (column < ann.annotations.length && ann.annotations[column] != null)
1283     {
1284       String description = ann.annotations[column].description;
1285       if (description != null && description.trim().length() > 0)
1286       {
1287         text.append("  ").append(description);
1288       }
1289     }
1290
1291     /*
1292      * if the annotation is sequence-specific, show the sequence number
1293      * in the alignment, and (if not a gap) the residue and position
1294      */
1295     SequenceI seqref = ann.sequenceRef;
1296     if (seqref != null)
1297     {
1298       int seqIndex = al.findIndex(seqref);
1299       if (seqIndex != -1)
1300       {
1301         text.append(", ").append(MessageManager.getString("label.sequence"))
1302                 .append(" ").append(seqIndex + 1);
1303         char residue = seqref.getCharAt(column);
1304         if (!Comparison.isGap(residue))
1305         {
1306           text.append(" ");
1307           String name;
1308           if (al.isNucleotide())
1309           {
1310             name = ResidueProperties.nucleotideName
1311                     .get(String.valueOf(residue));
1312             text.append(" Nucleotide: ")
1313                     .append(name != null ? name : residue);
1314           }
1315           else
1316           {
1317             name = 'X' == residue ? "X"
1318                     : ('*' == residue ? "STOP"
1319                             : ResidueProperties.aa2Triplet
1320                                     .get(String.valueOf(residue)));
1321             text.append(" Residue: ").append(name != null ? name : residue);
1322           }
1323           int residuePos = seqref.findPosition(column);
1324           text.append(" (").append(residuePos).append(")");
1325         }
1326       }
1327     }
1328
1329     return text.toString();
1330   }
1331
1332   /**
1333    * DOCUMENT ME!
1334    *
1335    * @param evt
1336    *          DOCUMENT ME!
1337    */
1338   @Override
1339   public void mouseClicked(MouseEvent evt)
1340   {
1341     // if (activeRow != -1)
1342     // {
1343     // AlignmentAnnotation[] aa = av.getAlignment().getAlignmentAnnotation();
1344     // AlignmentAnnotation anot = aa[activeRow];
1345     // }
1346   }
1347
1348   // TODO mouseClicked-content and drawCursor are quite experimental!
1349   public void drawCursor(Graphics graphics, SequenceI seq, int res, int x1,
1350           int y1)
1351   {
1352     int pady = av.getCharHeight() / 5;
1353     int charOffset = 0;
1354     graphics.setColor(Color.black);
1355     graphics.fillRect(x1, y1, av.getCharWidth(), av.getCharHeight());
1356
1357     if (av.validCharWidth)
1358     {
1359       graphics.setColor(Color.white);
1360
1361       char s = seq.getCharAt(res);
1362
1363       charOffset = (av.getCharWidth() - fm.charWidth(s)) / 2;
1364       graphics.drawString(String.valueOf(s), charOffset + x1,
1365               (y1 + av.getCharHeight()) - pady);
1366     }
1367
1368   }
1369
1370   private volatile boolean imageFresh = false;
1371
1372   private Rectangle visibleRect = new Rectangle(),
1373           clipBounds = new Rectangle();
1374
1375   /**
1376    * DOCUMENT ME!
1377    *
1378    * @param g
1379    *          DOCUMENT ME!
1380    */
1381   @Override
1382   public void paintComponent(Graphics g)
1383   {
1384
1385     // BH: note that this method is generally recommended to
1386     // call super.paintComponent(g). Otherwise, the children of this
1387     // component will not be rendered. That is not needed here
1388     // because AnnotationPanel does not have any children. It is
1389     // just a JPanel contained in a JViewPort.
1390
1391     computeVisibleRect(visibleRect);
1392
1393     g.setColor(Color.white);
1394     g.fillRect(0, 0, visibleRect.width, visibleRect.height);
1395
1396     if (image != null)
1397     {
1398       // BH 2018 optimizing generation of new Rectangle().
1399       if (fastPaint
1400               || (visibleRect.width != (clipBounds = g
1401                       .getClipBounds(clipBounds)).width)
1402               || (visibleRect.height != clipBounds.height))
1403       {
1404
1405         g.drawImage(image, 0, 0, this);
1406         fastPaint = false;
1407         return;
1408       }
1409     }
1410     updateFadedImageWidth();
1411     if (imgWidth < 1)
1412     {
1413       return;
1414     }
1415     Graphics2D gg;
1416     if (image == null || imgWidth != image.getWidth(this)
1417             || image.getHeight(this) != getHeight())
1418     {
1419       boolean tried = false;
1420       image = null;
1421       while (image == null && !tried)
1422       {
1423         try
1424         {
1425           image = new BufferedImage(imgWidth,
1426                   ap.getAnnotationPanel().getHeight(),
1427                   BufferedImage.TYPE_INT_RGB);
1428           tried = true;
1429         } catch (IllegalArgumentException exc)
1430         {
1431           System.err.println(
1432                   "Serious issue with viewport geometry imgWidth requested was "
1433                           + imgWidth);
1434           return;
1435         } catch (OutOfMemoryError oom)
1436         {
1437           try
1438           {
1439             System.gc();
1440           } catch (Exception x)
1441           {
1442           }
1443           ;
1444           new OOMWarning(
1445                   "Couldn't allocate memory to redraw screen. Please restart Jalview",
1446                   oom);
1447           return;
1448         }
1449
1450       }
1451       gg = (Graphics2D) image.getGraphics();
1452
1453       if (av.antiAlias)
1454       {
1455         gg.setRenderingHint(RenderingHints.KEY_ANTIALIASING,
1456                 RenderingHints.VALUE_ANTIALIAS_ON);
1457       }
1458
1459       gg.setFont(av.getFont());
1460       fm = gg.getFontMetrics();
1461       gg.setColor(Color.white);
1462       gg.fillRect(0, 0, imgWidth, image.getHeight());
1463       imageFresh = true;
1464     }
1465     else
1466     {
1467       gg = (Graphics2D) image.getGraphics();
1468
1469     }
1470
1471     drawComponent(gg, av.getRanges().getStartRes(),
1472             av.getRanges().getEndRes() + 1);
1473     gg.dispose();
1474     imageFresh = false;
1475     g.drawImage(image, 0, 0, this);
1476   }
1477
1478   public void updateFadedImageWidth()
1479   {
1480     imgWidth = (av.getRanges().getEndRes() - av.getRanges().getStartRes()
1481             + 1) * av.getCharWidth();
1482
1483   }
1484
1485   /**
1486    * set true to enable redraw timing debug output on stderr
1487    */
1488   private final boolean debugRedraw = false;
1489
1490   /**
1491    * non-Thread safe repaint
1492    *
1493    * @param horizontal
1494    *          repaint with horizontal shift in alignment
1495    */
1496   public void fastPaint(int horizontal)
1497   {
1498     if ((horizontal == 0) || image == null
1499             || av.getAlignment().getAlignmentAnnotation() == null
1500             || av.getAlignment().getAlignmentAnnotation().length < 1
1501             || av.isCalcInProgress())
1502     {
1503       repaint();
1504       return;
1505     }
1506
1507     int sr = av.getRanges().getStartRes();
1508     int er = av.getRanges().getEndRes() + 1;
1509     int transX = 0;
1510
1511     Graphics2D gg = (Graphics2D) image.getGraphics();
1512
1513     if (imgWidth > Math.abs(horizontal * av.getCharWidth()))
1514     {
1515       // scroll is less than imgWidth away so can re-use buffered graphics
1516       gg.copyArea(0, 0, imgWidth, getHeight(),
1517               -horizontal * av.getCharWidth(), 0);
1518
1519       if (horizontal > 0) // scrollbar pulled right, image to the left
1520       {
1521         transX = (er - sr - horizontal) * av.getCharWidth();
1522         sr = er - horizontal;
1523       }
1524       else if (horizontal < 0)
1525       {
1526         er = sr - horizontal;
1527       }
1528     }
1529     gg.translate(transX, 0);
1530
1531     drawComponent(gg, sr, er);
1532
1533     gg.translate(-transX, 0);
1534
1535     gg.dispose();
1536
1537     fastPaint = true;
1538
1539     // Call repaint on alignment panel so that repaints from other alignment
1540     // panel components can be aggregated. Otherwise performance of the overview
1541     // window and others may be adversely affected.
1542     av.getAlignPanel().repaint();
1543   }
1544
1545   private volatile boolean lastImageGood = false;
1546
1547   /**
1548    * DOCUMENT ME!
1549    *
1550    * @param g
1551    *          DOCUMENT ME!
1552    * @param startRes
1553    *          DOCUMENT ME!
1554    * @param endRes
1555    *          DOCUMENT ME!
1556    */
1557   public void drawComponent(Graphics g, int startRes, int endRes)
1558   {
1559     BufferedImage oldFaded = fadedImage;
1560     if (av.isCalcInProgress())
1561     {
1562       if (image == null)
1563       {
1564         lastImageGood = false;
1565         return;
1566       }
1567       // We'll keep a record of the old image,
1568       // and draw a faded image until the calculation
1569       // has completed
1570       if (lastImageGood
1571               && (fadedImage == null || fadedImage.getWidth() != imgWidth
1572                       || fadedImage.getHeight() != image.getHeight()))
1573       {
1574         // System.err.println("redraw faded image ("+(fadedImage==null ?
1575         // "null image" : "") + " lastGood="+lastImageGood+")");
1576         fadedImage = new BufferedImage(imgWidth, image.getHeight(),
1577                 BufferedImage.TYPE_INT_RGB);
1578
1579         Graphics2D fadedG = (Graphics2D) fadedImage.getGraphics();
1580
1581         fadedG.setColor(Color.white);
1582         fadedG.fillRect(0, 0, imgWidth, image.getHeight());
1583
1584         fadedG.setComposite(
1585                 AlphaComposite.getInstance(AlphaComposite.SRC_OVER, .3f));
1586         fadedG.drawImage(image, 0, 0, this);
1587
1588       }
1589       // make sure we don't overwrite the last good faded image until all
1590       // calculations have finished
1591       lastImageGood = false;
1592
1593     }
1594     else
1595     {
1596       if (fadedImage != null)
1597       {
1598         oldFaded = fadedImage;
1599       }
1600       fadedImage = null;
1601     }
1602
1603     g.setColor(Color.white);
1604     g.fillRect(0, 0, (endRes - startRes) * av.getCharWidth(), getHeight());
1605
1606     g.setFont(av.getFont());
1607     if (fm == null)
1608     {
1609       fm = g.getFontMetrics();
1610     }
1611
1612     if ((av.getAlignment().getAlignmentAnnotation() == null)
1613             || (av.getAlignment().getAlignmentAnnotation().length < 1))
1614     {
1615       g.setColor(Color.white);
1616       g.fillRect(0, 0, getWidth(), getHeight());
1617       g.setColor(Color.black);
1618       if (av.validCharWidth)
1619       {
1620         g.drawString(MessageManager
1621                 .getString("label.alignment_has_no_annotations"), 20, 15);
1622       }
1623
1624       return;
1625     }
1626     lastImageGood = renderer.drawComponent(this, av, g, activeRow, startRes,
1627             endRes);
1628     if (!lastImageGood && fadedImage == null)
1629     {
1630       fadedImage = oldFaded;
1631     }
1632     if (dragMode == DragMode.MatrixSelect)
1633     {
1634       g.setColor(Color.yellow);
1635       g.drawRect(Math.min(firstDragX, mouseDragLastX),
1636               Math.min(firstDragY, mouseDragLastY),
1637               Math.max(firstDragX, mouseDragLastX)
1638                       - Math.min(firstDragX, mouseDragLastX),
1639               Math.max(firstDragY, mouseDragLastY)
1640                       - Math.min(firstDragY, mouseDragLastY));
1641
1642     }
1643   }
1644
1645   @Override
1646   public FontMetrics getFontMetrics()
1647   {
1648     return fm;
1649   }
1650
1651   @Override
1652   public Image getFadedImage()
1653   {
1654     return fadedImage;
1655   }
1656
1657   @Override
1658   public int getFadedImageWidth()
1659   {
1660     updateFadedImageWidth();
1661     return imgWidth;
1662   }
1663
1664   private int[] bounds = new int[2];
1665
1666   @Override
1667   public int[] getVisibleVRange()
1668   {
1669     if (ap != null && ap.getAlabels() != null)
1670     {
1671       int sOffset = -ap.getAlabels().getScrollOffset();
1672       int visHeight = sOffset + ap.annotationSpaceFillerHolder.getHeight();
1673       bounds[0] = sOffset;
1674       bounds[1] = visHeight;
1675       return bounds;
1676     }
1677     else
1678     {
1679       return null;
1680     }
1681   }
1682
1683   /**
1684    * Try to ensure any references held are nulled
1685    */
1686   public void dispose()
1687   {
1688     av = null;
1689     ap = null;
1690     image = null;
1691     fadedImage = null;
1692     // gg = null;
1693     _mwl = null;
1694
1695     /*
1696      * I created the renderer so I will dispose of it
1697      */
1698     if (renderer != null)
1699     {
1700       renderer.dispose();
1701     }
1702   }
1703
1704   @Override
1705   public void propertyChange(PropertyChangeEvent evt)
1706   {
1707     // Respond to viewport range changes (e.g. alignment panel was scrolled)
1708     // Both scrolling and resizing change viewport ranges: scrolling changes
1709     // both start and end points, but resize only changes end values.
1710     // Here we only want to fastpaint on a scroll, with resize using a normal
1711     // paint, so scroll events are identified as changes to the horizontal or
1712     // vertical start value.
1713     if (evt.getPropertyName().equals(ViewportRanges.STARTRES))
1714     {
1715       fastPaint((int) evt.getNewValue() - (int) evt.getOldValue());
1716     }
1717     else if (evt.getPropertyName().equals(ViewportRanges.STARTRESANDSEQ))
1718     {
1719       fastPaint(((int[]) evt.getNewValue())[0]
1720               - ((int[]) evt.getOldValue())[0]);
1721     }
1722     else if (evt.getPropertyName().equals(ViewportRanges.MOVE_VIEWPORT))
1723     {
1724       repaint();
1725     }
1726   }
1727
1728   /**
1729    * computes the visible height of the annotation panel
1730    *
1731    * @param adjustPanelHeight
1732    *          - when false, just adjust existing height according to other
1733    *          windows
1734    * @param annotationHeight
1735    * @return height to use for the ScrollerPreferredVisibleSize
1736    */
1737   public int adjustForAlignFrame(boolean adjustPanelHeight,
1738           int annotationHeight)
1739   {
1740     /*
1741      * Estimate available height in the AlignFrame for alignment +
1742      * annotations. Deduct an estimate for title bar, menu bar, scale panel,
1743      * hscroll, status bar, insets.
1744      */
1745     int stuff = (ap.getViewName() != null ? 30 : 0)
1746             + (Platform.isAMacAndNotJS() ? 120 : 140);
1747     int availableHeight = ap.alignFrame.getHeight() - stuff;
1748     int rowHeight = av.getCharHeight();
1749
1750     if (adjustPanelHeight)
1751     {
1752       int alignmentHeight = rowHeight * av.getAlignment().getHeight();
1753
1754       /*
1755        * If not enough vertical space, maximize annotation height while keeping
1756        * at least two rows of alignment visible
1757        */
1758       if (annotationHeight + alignmentHeight > availableHeight)
1759       {
1760         annotationHeight = Math.min(annotationHeight,
1761                 availableHeight - 2 * rowHeight);
1762       }
1763     }
1764     else
1765     {
1766       // maintain same window layout whilst updating sliders
1767       annotationHeight = Math.min(ap.annotationScroller.getSize().height,
1768               availableHeight - 2 * rowHeight);
1769     }
1770     return annotationHeight;
1771   }
1772 }