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 click
 609       ap.getScalePanel().mousePressed(evt);
 610     }
 611   }
 612
 613   /**
 614    * checks whether the annotation row under the mouse click evt's handles the
 615    * event
 616    *
 617    * @param evt
 618    * @return false if evt was not handled
 619    */
 620   boolean matrix_clicked(MouseEvent evt)
 621   {
 622     int[] rowIndex = getRowIndexAndOffset(evt.getY(),
 623             av.getAlignment().getAlignmentAnnotation());
 624     if (rowIndex == null)
 625     {
 626       jalview.bin.Console
 627               .error("IMPLEMENTATION ERROR: matrix click out of range.");
 628       return false;
 629     }
 630     int yOffset = rowIndex[1];
 631
 632     AlignmentAnnotation clicked = av.getAlignment()
 633             .getAlignmentAnnotation()[rowIndex[0]];
 634     if (clicked.graph != AlignmentAnnotation.CONTACT_MAP)
 635     {
 636       return false;
 637     }
 638
 639     // TODO - use existing threshold to select related sections of matrix
 640     GraphLine thr = clicked.getThreshold();
 641
 642     int currentX = getColumnForXPos(evt.getX());
 643     ContactListI forCurrentX = av.getContactList(clicked, currentX);
 644     if (forCurrentX != null)
 645     {
 646       ContactGeometry cXcgeom = new ContactGeometry(forCurrentX,
 647               clicked.graphHeight);
 648       ContactGeometry.contactInterval cXci = cXcgeom.mapFor(yOffset,
 649               yOffset);
 650       /**
 651        * start and end range corresponding to the row range under the mouse at
 652        * column currentX
 653        */
 654       int fr, to;
 655       fr = Math.min(cXci.cStart, cXci.cEnd);
 656       to = Math.max(cXci.cStart, cXci.cEnd);
 657
 658       if (evt.isControlDown())
 659       {
 660         ContactMatrixI matrix = av.getContactMatrix(clicked);
 661
 662         if (matrix != null)
 663         {
 664           // simplest approach is to select all group containing column
 665           if (matrix.hasGroups())
 666           {
 667             SequenceI rseq = clicked.sequenceRef;
 668             BitSet grp = matrix.getGroupsFor(currentX);
 669             for (int c = fr; c <= to; c++)
 670             {
 671               BitSet additionalGrp = matrix.getGroupsFor(c);
 672               grp.or(additionalGrp);
 673             }
 674             HiddenColumns hc = av.getAlignment().getHiddenColumns();
 675             for (int p = grp.nextSetBit(0); p >= 0; p = grp
 676                     .nextSetBit(p + 1))
 677             {
 678               int offp = (rseq != null)
 679                       ? rseq.findIndex(rseq.getStart() - 1 + p)
 680                       : p;
 681
 682               if (!av.hasHiddenColumns() || hc.isVisible(offp))
 683               {
 684                 av.getColumnSelection().addElement(offp);
 685               }
 686             }
 687           }
 688           // possible alternative for interactive selection - threshold
 689           // gives 'ceiling' for forming a cluster
 690           // when a row+column is selected, farthest common ancestor less
 691           // than thr is used to compute cluster
 692
 693         }
 694       }
 695       else
 696       {
 697         // select corresponding range in segment under mouse
 698         {
 699           for (int c = fr; c <= to; c++)
 700           {
 701             av.getColumnSelection().addElement(c);
 702           }
 703           av.getColumnSelection().addElement(currentX);
 704         }
 705         // PAE SPECIFIC
 706         // and also select everything lower than the max range adjacent
 707         // (kind of works)
 708         if (PAEContactMatrix.PAEMATRIX.equals(clicked.getCalcId()))
 709         {
 710           int c = fr - 1;
 711           ContactRange cr = forCurrentX.getRangeFor(fr, to);
 712           double cval;
 713           // TODO: could use GraphLine instead of arbitrary picking
 714           // TODO: could report mean/median/variance for partitions
 715           // (contiguous selected vs unselected regions and inter-contig
 716           // regions)
 717           // controls feathering - what other elements in row/column
 718           // should we select
 719           double thresh = cr.getMean() + (cr.getMax() - cr.getMean()) * .15;
 720           while (c > 0)
 721           {
 722             cval = forCurrentX.getContactAt(c);
 723             if (// cr.getMin() <= cval &&
 724             cval <= thresh)
 725             {
 726               av.getColumnSelection().addElement(c--);
 727             }
 728             else
 729             {
 730               break;
 731             }
 732           }
 733           c = to;
 734           while (c < forCurrentX.getContactHeight())
 735           {
 736             cval = forCurrentX.getContactAt(c);
 737             if (// cr.getMin() <= cval &&
 738             cval <= thresh)
 739             {
 740               av.getColumnSelection().addElement(c++);
 741             }
 742             else
 743             {
 744               break;
 745             }
 746           }
 747         }
 748       }
 749     }
 750     ap.paintAlignment(false, false);
 751     PaintRefresher.Refresh(ap, av.getSequenceSetId());
 752     av.sendSelection();
 753     return true;
 754   }
 755   /**
 756    * Construct and display a context menu at the right-click position
 757    *
 758    * @param y
 759    * @param x
 760    */
 761   void showPopupMenu(final int y, int x)
 762   {
 763     if (av.getColumnSelection() == null
 764             || av.getColumnSelection().isEmpty())
 765     {
 766       return;
 767     }
 768
 769     JPopupMenu pop = new JPopupMenu(
 770             MessageManager.getString("label.structure_type"));
 771     JMenuItem item;
 772     /*
 773      * Just display the needed structure options
 774      */
 775     if (av.getAlignment().isNucleotide())
 776     {
 777       item = new JMenuItem(STEM);
 778       item.addActionListener(this);
 779       pop.add(item);
 780     }
 781     else
 782     {
 783       item = new JMenuItem(HELIX);
 784       item.addActionListener(this);
 785       pop.add(item);
 786       item = new JMenuItem(SHEET);
 787       item.addActionListener(this);
 788       pop.add(item);
 789     }
 790     item = new JMenuItem(LABEL);
 791     item.addActionListener(this);
 792     pop.add(item);
 793     item = new JMenuItem(COLOUR);
 794     item.addActionListener(this);
 795     pop.add(item);
 796     item = new JMenuItem(REMOVE);
 797     item.addActionListener(this);
 798     pop.add(item);
 799     pop.show(this, x, y);
 800   }
 801
 802   /**
 803    * Action on mouse up is to clear mouse drag data and call mouseReleased on
 804    * ScalePanel, to deal with defining the selection group (if any) defined by
 805    * the mouse drag
 806    *
 807    * @param evt
 808    */
 809   @Override
 810   public void mouseReleased(MouseEvent evt)
 811   {
 812     if (dragMode == DragMode.MatrixSelect)
 813     {
 814       matrixSelectRange(evt);
 815     }
 816     graphStretch = -1;
 817     mouseDragLastX = -1;
 818     mouseDragLastY = -1;
 819     firstDragX = -1;
 820     firstDragY = -1;
 821     mouseDragging = false;
 822     if (dragMode == DragMode.Resize)
 823     {
 824       ap.adjustAnnotationHeight();
 825     }
 826     dragMode = DragMode.Undefined;
 827     if (!matrix_clicked(evt))
 828     {
 829       ap.getScalePanel().mouseReleased(evt);
 830     }
 831
 832     /*
 833      * isPopupTrigger is set in mouseReleased on Windows
 834      * (in mousePressed on Mac)
 835      */
 836     if (evt.isPopupTrigger() && activeRow != -1)
 837     {
 838       showPopupMenu(evt.getY(), evt.getX());
 839     }
 840
 841   }
 842
 843   /**
 844    * DOCUMENT ME!
 845    *
 846    * @param evt
 847    *          DOCUMENT ME!
 848    */
 849   @Override
 850   public void mouseEntered(MouseEvent evt)
 851   {
 852     this.mouseDragging = false;
 853     ap.getScalePanel().mouseEntered(evt);
 854   }
 855
 856   /**
 857    * On leaving the panel, calls ScalePanel.mouseExited to deal with scrolling
 858    * with column selection on a mouse drag
 859    *
 860    * @param evt
 861    */
 862   @Override
 863   public void mouseExited(MouseEvent evt)
 864   {
 865     ap.getScalePanel().mouseExited(evt);
 866   }
 867
 868   /**
 869    * Action on starting or continuing a mouse drag. There are two possible
 870    * actions:
 871    * <ul>
 872    * <li>drag up or down on a graphed annotation increases or decreases the
 873    * height of the graph</li>
 874    * <li>dragging left or right selects the columns dragged across</li>
 875    * </ul>
 876    * A drag on a graph annotation is treated as column selection if it starts
 877    * with more horizontal than vertical movement, and as resize if it starts
 878    * with more vertical than horizontal movement. Once started, the drag does
 879    * not change mode.
 880    *
 881    * @param evt
 882    */
 883   @Override
 884   public void mouseDragged(MouseEvent evt)
 885   {
 886     /*
 887      * if dragMode is Undefined:
 888      * - set to Select if dx > dy
 889      * - set to Resize if dy > dx
 890      * - do nothing if dx == dy
 891      */
 892     final int x = evt.getX();
 893     final int y = evt.getY();
 894     if (dragMode == DragMode.Undefined)
 895     {
 896       int dx = Math.abs(x - mouseDragLastX);
 897       int dy = Math.abs(y - mouseDragLastY);
 898       if (graphStretch == -1 || dx > dy)
 899       {
 900         /*
 901          * mostly horizontal drag, or not a graph annotation
 902          */
 903         dragMode = DragMode.Select;
 904       }
 905       else if (dy > dx)
 906       {
 907         /*
 908          * mostly vertical drag
 909          */
 910         dragMode = DragMode.Resize;
 911         notJustOne = evt.isShiftDown();
 912
 913         /*
 914          * but could also be a matrix drag
 915          */
 916         if ((evt.isAltDown() || evt.isAltGraphDown()) && (av.getAlignment()
 917                 .getAlignmentAnnotation()[graphStretch].graph == AlignmentAnnotation.CONTACT_MAP))
 918         {
 919           /*
 920            * dragging in a matrix
 921            */
 922           dragMode = DragMode.MatrixSelect;
 923           firstDragX = mouseDragLastX;
 924           firstDragY = mouseDragLastY;
 925         }
 926       }
 927     }
 928
 929     if (dragMode == DragMode.Undefined)
 930
 931     {
 932       /*
 933        * drag is diagonal - defer deciding whether to
 934        * treat as up/down or left/right
 935        */
 936       return;
 937     }
 938
 939     try
 940     {
 941       if (dragMode == DragMode.Resize)
 942       {
 943         /*
 944          * resize graph annotation if mouse was dragged up or down
 945          */
 946         int deltaY = mouseDragLastY - evt.getY();
 947         if (deltaY != 0)
 948         {
 949           AlignmentAnnotation graphAnnotation = av.getAlignment()
 950                   .getAlignmentAnnotation()[graphStretch];
 951           int newHeight = Math.max(0, graphAnnotation.graphHeight + deltaY);
 952           if (notJustOne)
 953           {
 954             for (AlignmentAnnotation similar : av.getAlignment()
 955                     .findAnnotations(null, graphAnnotation.getCalcId(),
 956                             graphAnnotation.label))
 957             {
 958               similar.graphHeight = newHeight;
 959             }
 960
 961           }
 962           else
 963           {
 964             graphAnnotation.graphHeight = newHeight;
 965           }
 966           adjustPanelHeight();
 967           ap.paintAlignment(false, false);
 968         }
 969       }
 970       else if (dragMode == DragMode.MatrixSelect)
 971       {
 972         /*
 973          * TODO draw a rubber band for range
 974          */
 975         mouseDragLastX = x;
 976         mouseDragLastY = y;
 977         ap.paintAlignment(false, false);
 978       }
 979       else
 980       {
 981         /*
 982          * for mouse drag left or right, delegate to
 983          * ScalePanel to adjust the column selection
 984          */
 985         ap.getScalePanel().mouseDragged(evt);
 986       }
 987     } finally
 988     {
 989       mouseDragLastX = x;
 990       mouseDragLastY = y;
 991     }
 992   }
 993
 994   public void matrixSelectRange(MouseEvent evt)
 995   {
 996     /*
 997      * get geometry of drag
 998      */
 999     int fromY = Math.min(firstDragY, evt.getY());
1000     int toY = Math.max(firstDragY, evt.getY());
1001     int fromX = Math.min(firstDragX, evt.getX());
1002     int toX = Math.max(firstDragX, evt.getX());
1003
1004     int deltaY = toY - fromY;
1005     int deltaX = toX - fromX;
1006
1007     int[] rowIndex = getRowIndexAndOffset(fromY,
1008             av.getAlignment().getAlignmentAnnotation());
1009     int[] toRowIndex = getRowIndexAndOffset(toY,
1010             av.getAlignment().getAlignmentAnnotation());
1011
1012     if (rowIndex == null || toRowIndex == null)
1013     {
1014       jalview.bin.Console.trace("Drag out of range. needs to be clipped");
1015
1016     }
1017     if (rowIndex[0] != toRowIndex[0])
1018     {
1019       jalview.bin.Console.trace("Drag went to another row. needs to be clipped");
1020     }
1021
1022     // rectangular selection on matrix style annotation
1023     AlignmentAnnotation cma = av.getAlignment()
1024             .getAlignmentAnnotation()[rowIndex[0]];
1025
1026     int lastX = getColumnForXPos(fromX);
1027     int currentX = getColumnForXPos(toX);
1028     int fromXc = Math.min(lastX, currentX);
1029     int toXc = Math.max(lastX, currentX);
1030     ContactListI forFromX = av.getContactList(cma, fromXc);
1031     ContactListI forToX = av.getContactList(cma, toXc);
1032
1033     if (forFromX != null && forToX != null)
1034     {
1035       ContactGeometry lastXcgeom = new ContactGeometry(forFromX,
1036               cma.graphHeight);
1037       ContactGeometry.contactInterval lastXci = lastXcgeom
1038               .mapFor(rowIndex[1], rowIndex[1] - deltaY);
1039
1040       ContactGeometry cXcgeom = new ContactGeometry(forToX,
1041               cma.graphHeight);
1042       ContactGeometry.contactInterval cXci = cXcgeom.mapFor(rowIndex[1],
1043               rowIndex[1] - deltaY);
1044
1045       // mark rectangular region formed by drag
1046       jalview.bin.Console.trace("Matrix Selection from last(" + fromXc + ",["
1047               + lastXci.cStart + "," + lastXci.cEnd + "]) to cur(" + toXc
1048               + ",[" + cXci.cStart + "," + cXci.cEnd + "])");
1049       int fr, to;
1050       fr = Math.min(lastXci.cStart, lastXci.cEnd);
1051       to = Math.max(lastXci.cStart, lastXci.cEnd);
1052       jalview.bin.Console.trace("Marking " + fr + " to " + to);
1053       for (int c = fr; c <= to; c++)
1054       {
1055         if (cma.sequenceRef != null)
1056         {
1057           int col = cma.sequenceRef.findIndex(c);
1058           av.getColumnSelection().addElement(col);
1059         }
1060         else
1061         {
1062           av.getColumnSelection().addElement(c);
1063         }
1064       }
1065       fr = Math.min(cXci.cStart, cXci.cEnd);
1066       to = Math.max(cXci.cStart, cXci.cEnd);
1067       jalview.bin.Console.trace("Marking " + fr + " to " + to);
1068       for (int c = fr; c <= to; c++)
1069       {
1070         if (cma.sequenceRef != null)
1071         {
1072           int col = cma.sequenceRef.findIndex(c);
1073           av.getColumnSelection().addElement(col);
1074         }
1075         else
1076         {
1077           av.getColumnSelection().addElement(c);
1078         }
1079       }
1080       fr = Math.min(lastX, currentX);
1081       to = Math.max(lastX, currentX);
1082
1083       jalview.bin.Console.trace("Marking " + fr + " to " + to);
1084       for (int c = fr; c <= to; c++)
1085       {
1086         av.getColumnSelection().addElement(c);
1087       }
1088     }
1089
1090   }
1091
1092   /**
1093    * Constructs the tooltip, and constructs and displays a status message, for
1094    * the current mouse position
1095    *
1096    * @param evt
1097    */
1098   @Override
1099   public void mouseMoved(MouseEvent evt)
1100   {
1101     int yPos = evt.getY();
1102     AlignmentAnnotation[] aa = av.getAlignment().getAlignmentAnnotation();
1103     int rowAndOffset[] = getRowIndexAndOffset(yPos, aa);
1104     int row = rowAndOffset[0];
1105
1106     if (row == -1)
1107     {
1108       this.setToolTipText(null);
1109       return;
1110     }
1111
1112     int column = getColumnForXPos(evt.getX());
1113
1114     AlignmentAnnotation ann = aa[row];
1115     if (row > -1 && ann.annotations != null
1116             && column < ann.annotations.length)
1117     {
1118       String toolTip = buildToolTip(ann, column, aa, rowAndOffset[1], av,
1119               ap);
1120       setToolTipText(toolTip == null ? null
1121               : JvSwingUtils.wrapTooltip(true, toolTip));
1122       String msg = getStatusMessage(av.getAlignment(), column, ann,
1123               rowAndOffset[1], av);
1124       ap.alignFrame.setStatus(msg);
1125     }
1126     else
1127     {
1128       this.setToolTipText(null);
1129       ap.alignFrame.setStatus(" ");
1130     }
1131   }
1132
1133   private int getColumnForXPos(int x)
1134   {
1135     int column = (x / av.getCharWidth()) + av.getRanges().getStartRes();
1136     column = Math.min(column, av.getRanges().getEndRes());
1137
1138     if (av.hasHiddenColumns())
1139     {
1140       column = av.getAlignment().getHiddenColumns()
1141               .visibleToAbsoluteColumn(column);
1142     }
1143     return column;
1144   }
1145
1146   /**
1147    * Answers the index in the annotations array of the visible annotation at the
1148    * given y position. This is done by adding the heights of visible annotations
1149    * until the y position has been exceeded. Answers -1 if no annotations are
1150    * visible, or the y position is below all annotations.
1151    *
1152    * @param yPos
1153    * @param aa
1154    * @return
1155    */
1156   static int getRowIndex(int yPos, AlignmentAnnotation[] aa)
1157   {
1158     if (aa == null)
1159     {
1160       return -1;
1161     }
1162     return getRowIndexAndOffset(yPos, aa)[0];
1163   }
1164
1165   static int[] getRowIndexAndOffset(int yPos, AlignmentAnnotation[] aa)
1166   {
1167     int[] res = new int[2];
1168     res[0] = -1;
1169     res[1] = 0;
1170     if (aa == null)
1171     {
1172       return res;
1173     }
1174     int row = -1;
1175     int height = 0, lheight = 0;
1176     for (int i = 0; i < aa.length; i++)
1177     {
1178       if (aa[i].visible)
1179       {
1180         lheight = height;
1181         height += aa[i].height;
1182       }
1183
1184       if (height > yPos)
1185       {
1186         row = i;
1187         res[0] = row;
1188         res[1] = height - yPos;
1189         break;
1190       }
1191     }
1192     return res;
1193   }
1194
1195   /**
1196    * Answers a tooltip for the annotation at the current mouse position, not
1197    * wrapped in &lt;html&gt; tags (apply if wanted). Answers null if there is no
1198    * tooltip to show.
1199    *
1200    * @param ann
1201    * @param column
1202    * @param anns
1203    * @param rowAndOffset
1204    */
1205   static String buildToolTip(AlignmentAnnotation ann, int column,
1206           AlignmentAnnotation[] anns, int rowAndOffset, AlignViewportI av,
1207           AlignmentPanel ap)
1208   {
1209     String tooltip = null;
1210     if (ann.graphGroup > -1)
1211     {
1212       StringBuilder tip = new StringBuilder(32);
1213       boolean first = true;
1214       for (int i = 0; i < anns.length; i++)
1215       {
1216         if (anns[i].graphGroup == ann.graphGroup
1217                 && anns[i].annotations[column] != null)
1218         {
1219           if (!first)
1220           {
1221             tip.append("<br>");
1222           }
1223           first = false;
1224           tip.append(anns[i].label);
1225           String description = anns[i].annotations[column].description;
1226           if (description != null && description.length() > 0)
1227           {
1228             tip.append(" ").append(description);
1229           }
1230         }
1231       }
1232       tooltip = first ? null : tip.toString();
1233     }
1234     else if (column < ann.annotations.length
1235             && ann.annotations[column] != null)
1236     {
1237       tooltip = ann.annotations[column].description;
1238     }
1239     // TODO abstract tooltip generator so different implementations can be built
1240     if (ann.graph == AlignmentAnnotation.CONTACT_MAP)
1241     {
1242       ContactListI clist = av.getContactList(ann, column);
1243       if (clist != null)
1244       {
1245         ContactGeometry cgeom = new ContactGeometry(clist, ann.graphHeight);
1246         ContactGeometry.contactInterval ci = cgeom.mapFor(rowAndOffset);
1247         ContactRange cr = clist.getRangeFor(ci.cStart, ci.cEnd);
1248         tooltip = "Contact from " + clist.getPosition() + ", [" + ci.cStart
1249                 + " - " + ci.cEnd + "]" + "<br/>Mean:" + cr.getMean();
1250         int col = ann.sequenceRef.findPosition(column);
1251         ap.getStructureSelectionManager()
1252                 .highlightPositionsOn(ann.sequenceRef, new int[][]
1253                 { new int[] { col, col },
1254                     new int[]
1255                     { ci.cStart, ci.cEnd } }, null);
1256       }
1257     }
1258     return tooltip;
1259   }
1260
1261   /**
1262    * Constructs and returns the status bar message
1263    *
1264    * @param al
1265    * @param column
1266    * @param ann
1267    * @param rowAndOffset
1268    */
1269   static String getStatusMessage(AlignmentI al, int column,
1270           AlignmentAnnotation ann, int rowAndOffset, AlignViewportI av)
1271   {
1272     /*
1273      * show alignment column and annotation description if any
1274      */
1275     StringBuilder text = new StringBuilder(32);
1276     text.append(MessageManager.getString("label.column")).append(" ")
1277             .append(column + 1);
1278
1279     if (column < ann.annotations.length && ann.annotations[column] != null)
1280     {
1281       String description = ann.annotations[column].description;
1282       if (description != null && description.trim().length() > 0)
1283       {
1284         text.append("  ").append(description);
1285       }
1286     }
1287
1288     /*
1289      * if the annotation is sequence-specific, show the sequence number
1290      * in the alignment, and (if not a gap) the residue and position
1291      */
1292     SequenceI seqref = ann.sequenceRef;
1293     if (seqref != null)
1294     {
1295       int seqIndex = al.findIndex(seqref);
1296       if (seqIndex != -1)
1297       {
1298         text.append(", ").append(MessageManager.getString("label.sequence"))
1299                 .append(" ").append(seqIndex + 1);
1300         char residue = seqref.getCharAt(column);
1301         if (!Comparison.isGap(residue))
1302         {
1303           text.append(" ");
1304           String name;
1305           if (al.isNucleotide())
1306           {
1307             name = ResidueProperties.nucleotideName
1308                     .get(String.valueOf(residue));
1309             text.append(" Nucleotide: ")
1310                     .append(name != null ? name : residue);
1311           }
1312           else
1313           {
1314             name = 'X' == residue ? "X"
1315                     : ('*' == residue ? "STOP"
1316                             : ResidueProperties.aa2Triplet
1317                                     .get(String.valueOf(residue)));
1318             text.append(" Residue: ").append(name != null ? name : residue);
1319           }
1320           int residuePos = seqref.findPosition(column);
1321           text.append(" (").append(residuePos).append(")");
1322         }
1323       }
1324     }
1325
1326     return text.toString();
1327   }
1328
1329   /**
1330    * DOCUMENT ME!
1331    *
1332    * @param evt
1333    *          DOCUMENT ME!
1334    */
1335   @Override
1336   public void mouseClicked(MouseEvent evt)
1337   {
1338     // if (activeRow != -1)
1339     // {
1340     // AlignmentAnnotation[] aa = av.getAlignment().getAlignmentAnnotation();
1341     // AlignmentAnnotation anot = aa[activeRow];
1342     // }
1343   }
1344
1345   // TODO mouseClicked-content and drawCursor are quite experimental!
1346   public void drawCursor(Graphics graphics, SequenceI seq, int res, int x1,
1347           int y1)
1348   {
1349     int pady = av.getCharHeight() / 5;
1350     int charOffset = 0;
1351     graphics.setColor(Color.black);
1352     graphics.fillRect(x1, y1, av.getCharWidth(), av.getCharHeight());
1353
1354     if (av.validCharWidth)
1355     {
1356       graphics.setColor(Color.white);
1357
1358       char s = seq.getCharAt(res);
1359
1360       charOffset = (av.getCharWidth() - fm.charWidth(s)) / 2;
1361       graphics.drawString(String.valueOf(s), charOffset + x1,
1362               (y1 + av.getCharHeight()) - pady);
1363     }
1364
1365   }
1366
1367   private volatile boolean imageFresh = false;
1368
1369   private Rectangle visibleRect = new Rectangle(),
1370           clipBounds = new Rectangle();
1371
1372   /**
1373    * DOCUMENT ME!
1374    *
1375    * @param g
1376    *          DOCUMENT ME!
1377    */
1378   @Override
1379   public void paintComponent(Graphics g)
1380   {
1381
1382     // BH: note that this method is generally recommended to
1383     // call super.paintComponent(g). Otherwise, the children of this
1384     // component will not be rendered. That is not needed here
1385     // because AnnotationPanel does not have any children. It is
1386     // just a JPanel contained in a JViewPort.
1387
1388     computeVisibleRect(visibleRect);
1389
1390     g.setColor(Color.white);
1391     g.fillRect(0, 0, visibleRect.width, visibleRect.height);
1392
1393     if (image != null)
1394     {
1395       // BH 2018 optimizing generation of new Rectangle().
1396       if (fastPaint
1397               || (visibleRect.width != (clipBounds = g
1398                       .getClipBounds(clipBounds)).width)
1399               || (visibleRect.height != clipBounds.height))
1400       {
1401
1402         g.drawImage(image, 0, 0, this);
1403         fastPaint = false;
1404         return;
1405       }
1406     }
1407     imgWidth = (av.getRanges().getEndRes() - av.getRanges().getStartRes()
1408             + 1) * av.getCharWidth();
1409     if (imgWidth < 1)
1410     {
1411       return;
1412     }
1413     Graphics2D gg;
1414     if (image == null || imgWidth != image.getWidth(this)
1415             || image.getHeight(this) != getHeight())
1416     {
1417       boolean tried = false;
1418       image = null;
1419       while (image == null && !tried)
1420       {
1421         try
1422         {
1423           image = new BufferedImage(imgWidth,
1424                   ap.getAnnotationPanel().getHeight(),
1425                   BufferedImage.TYPE_INT_RGB);
1426           tried = true;
1427         } catch (IllegalArgumentException exc)
1428         {
1429           System.err.println(
1430                   "Serious issue with viewport geometry imgWidth requested was "
1431                           + imgWidth);
1432           return;
1433         } catch (OutOfMemoryError oom)
1434         {
1435           try
1436           {
1437             System.gc();
1438           } catch (Exception x)
1439           {
1440           }
1441           ;
1442           new OOMWarning(
1443                   "Couldn't allocate memory to redraw screen. Please restart Jalview",
1444                   oom);
1445           return;
1446         }
1447
1448       }
1449       gg = (Graphics2D) image.getGraphics();
1450
1451       if (av.antiAlias)
1452       {
1453         gg.setRenderingHint(RenderingHints.KEY_ANTIALIASING,
1454                 RenderingHints.VALUE_ANTIALIAS_ON);
1455       }
1456
1457       gg.setFont(av.getFont());
1458       fm = gg.getFontMetrics();
1459       gg.setColor(Color.white);
1460       gg.fillRect(0, 0, imgWidth, image.getHeight());
1461       imageFresh = true;
1462     }
1463     else
1464     {
1465       gg = (Graphics2D) image.getGraphics();
1466
1467     }
1468
1469     drawComponent(gg, av.getRanges().getStartRes(),
1470             av.getRanges().getEndRes() + 1);
1471     gg.dispose();
1472     imageFresh = false;
1473     g.drawImage(image, 0, 0, this);
1474   }
1475
1476   /**
1477    * set true to enable redraw timing debug output on stderr
1478    */
1479   private final boolean debugRedraw = false;
1480
1481   /**
1482    * non-Thread safe repaint
1483    *
1484    * @param horizontal
1485    *          repaint with horizontal shift in alignment
1486    */
1487   public void fastPaint(int horizontal)
1488   {
1489     if ((horizontal == 0) || image == null
1490             || av.getAlignment().getAlignmentAnnotation() == null
1491             || av.getAlignment().getAlignmentAnnotation().length < 1
1492             || av.isCalcInProgress())
1493     {
1494       repaint();
1495       return;
1496     }
1497
1498     int sr = av.getRanges().getStartRes();
1499     int er = av.getRanges().getEndRes() + 1;
1500     int transX = 0;
1501
1502     Graphics2D gg = (Graphics2D) image.getGraphics();
1503
1504     if (imgWidth > Math.abs(horizontal * av.getCharWidth()))
1505     {
1506       // scroll is less than imgWidth away so can re-use buffered graphics
1507       gg.copyArea(0, 0, imgWidth, getHeight(),
1508               -horizontal * av.getCharWidth(), 0);
1509
1510       if (horizontal > 0) // scrollbar pulled right, image to the left
1511       {
1512         transX = (er - sr - horizontal) * av.getCharWidth();
1513         sr = er - horizontal;
1514       }
1515       else if (horizontal < 0)
1516       {
1517         er = sr - horizontal;
1518       }
1519     }
1520     gg.translate(transX, 0);
1521
1522     drawComponent(gg, sr, er);
1523
1524     gg.translate(-transX, 0);
1525
1526     gg.dispose();
1527
1528     fastPaint = true;
1529
1530     // Call repaint on alignment panel so that repaints from other alignment
1531     // panel components can be aggregated. Otherwise performance of the overview
1532     // window and others may be adversely affected.
1533     av.getAlignPanel().repaint();
1534   }
1535
1536   private volatile boolean lastImageGood = false;
1537
1538   /**
1539    * DOCUMENT ME!
1540    *
1541    * @param g
1542    *          DOCUMENT ME!
1543    * @param startRes
1544    *          DOCUMENT ME!
1545    * @param endRes
1546    *          DOCUMENT ME!
1547    */
1548   public void drawComponent(Graphics g, int startRes, int endRes)
1549   {
1550     BufferedImage oldFaded = fadedImage;
1551     if (av.isCalcInProgress())
1552     {
1553       if (image == null)
1554       {
1555         lastImageGood = false;
1556         return;
1557       }
1558       // We'll keep a record of the old image,
1559       // and draw a faded image until the calculation
1560       // has completed
1561       if (lastImageGood
1562               && (fadedImage == null || fadedImage.getWidth() != imgWidth
1563                       || fadedImage.getHeight() != image.getHeight()))
1564       {
1565         // System.err.println("redraw faded image ("+(fadedImage==null ?
1566         // "null image" : "") + " lastGood="+lastImageGood+")");
1567         fadedImage = new BufferedImage(imgWidth, image.getHeight(),
1568                 BufferedImage.TYPE_INT_RGB);
1569
1570         Graphics2D fadedG = (Graphics2D) fadedImage.getGraphics();
1571
1572         fadedG.setColor(Color.white);
1573         fadedG.fillRect(0, 0, imgWidth, image.getHeight());
1574
1575         fadedG.setComposite(
1576                 AlphaComposite.getInstance(AlphaComposite.SRC_OVER, .3f));
1577         fadedG.drawImage(image, 0, 0, this);
1578
1579       }
1580       // make sure we don't overwrite the last good faded image until all
1581       // calculations have finished
1582       lastImageGood = false;
1583
1584     }
1585     else
1586     {
1587       if (fadedImage != null)
1588       {
1589         oldFaded = fadedImage;
1590       }
1591       fadedImage = null;
1592     }
1593
1594     g.setColor(Color.white);
1595     g.fillRect(0, 0, (endRes - startRes) * av.getCharWidth(), getHeight());
1596
1597     g.setFont(av.getFont());
1598     if (fm == null)
1599     {
1600       fm = g.getFontMetrics();
1601     }
1602
1603     if ((av.getAlignment().getAlignmentAnnotation() == null)
1604             || (av.getAlignment().getAlignmentAnnotation().length < 1))
1605     {
1606       g.setColor(Color.white);
1607       g.fillRect(0, 0, getWidth(), getHeight());
1608       g.setColor(Color.black);
1609       if (av.validCharWidth)
1610       {
1611         g.drawString(MessageManager
1612                 .getString("label.alignment_has_no_annotations"), 20, 15);
1613       }
1614
1615       return;
1616     }
1617     lastImageGood = renderer.drawComponent(this, av, g, activeRow, startRes,
1618             endRes);
1619     if (!lastImageGood && fadedImage == null)
1620     {
1621       fadedImage = oldFaded;
1622     }
1623     if (dragMode == DragMode.MatrixSelect)
1624     {
1625       g.setColor(Color.yellow);
1626       g.drawRect(Math.min(firstDragX, mouseDragLastX),
1627               Math.min(firstDragY, mouseDragLastY),
1628               Math.max(firstDragX, mouseDragLastX)
1629                       - Math.min(firstDragX, mouseDragLastX),
1630               Math.max(firstDragY, mouseDragLastY)
1631                       - Math.min(firstDragY, mouseDragLastY));
1632
1633     }
1634   }
1635
1636   @Override
1637   public FontMetrics getFontMetrics()
1638   {
1639     return fm;
1640   }
1641
1642   @Override
1643   public Image getFadedImage()
1644   {
1645     return fadedImage;
1646   }
1647
1648   @Override
1649   public int getFadedImageWidth()
1650   {
1651     return imgWidth;
1652   }
1653
1654   private int[] bounds = new int[2];
1655
1656   @Override
1657   public int[] getVisibleVRange()
1658   {
1659     if (ap != null && ap.getAlabels() != null)
1660     {
1661       int sOffset = -ap.getAlabels().getScrollOffset();
1662       int visHeight = sOffset + ap.annotationSpaceFillerHolder.getHeight();
1663       bounds[0] = sOffset;
1664       bounds[1] = visHeight;
1665       return bounds;
1666     }
1667     else
1668     {
1669       return null;
1670     }
1671   }
1672
1673   /**
1674    * Try to ensure any references held are nulled
1675    */
1676   public void dispose()
1677   {
1678     av = null;
1679     ap = null;
1680     image = null;
1681     fadedImage = null;
1682     // gg = null;
1683     _mwl = null;
1684
1685     /*
1686      * I created the renderer so I will dispose of it
1687      */
1688     if (renderer != null)
1689     {
1690       renderer.dispose();
1691     }
1692   }
1693
1694   @Override
1695   public void propertyChange(PropertyChangeEvent evt)
1696   {
1697     // Respond to viewport range changes (e.g. alignment panel was scrolled)
1698     // Both scrolling and resizing change viewport ranges: scrolling changes
1699     // both start and end points, but resize only changes end values.
1700     // Here we only want to fastpaint on a scroll, with resize using a normal
1701     // paint, so scroll events are identified as changes to the horizontal or
1702     // vertical start value.
1703     if (evt.getPropertyName().equals(ViewportRanges.STARTRES))
1704     {
1705       fastPaint((int) evt.getNewValue() - (int) evt.getOldValue());
1706     }
1707     else if (evt.getPropertyName().equals(ViewportRanges.STARTRESANDSEQ))
1708     {
1709       fastPaint(((int[]) evt.getNewValue())[0]
1710               - ((int[]) evt.getOldValue())[0]);
1711     }
1712     else if (evt.getPropertyName().equals(ViewportRanges.MOVE_VIEWPORT))
1713     {
1714       repaint();
1715     }
1716   }
1717
1718   /**
1719    * computes the visible height of the annotation panel
1720    *
1721    * @param adjustPanelHeight
1722    *          - when false, just adjust existing height according to other
1723    *          windows
1724    * @param annotationHeight
1725    * @return height to use for the ScrollerPreferredVisibleSize
1726    */
1727   public int adjustForAlignFrame(boolean adjustPanelHeight,
1728           int annotationHeight)
1729   {
1730     /*
1731      * Estimate available height in the AlignFrame for alignment +
1732      * annotations. Deduct an estimate for title bar, menu bar, scale panel,
1733      * hscroll, status bar, insets.
1734      */
1735     int stuff = (ap.getViewName() != null ? 30 : 0)
1736             + (Platform.isAMacAndNotJS() ? 120 : 140);
1737     int availableHeight = ap.alignFrame.getHeight() - stuff;
1738     int rowHeight = av.getCharHeight();
1739
1740     if (adjustPanelHeight)
1741     {
1742       int alignmentHeight = rowHeight * av.getAlignment().getHeight();
1743
1744       /*
1745        * If not enough vertical space, maximize annotation height while keeping
1746        * at least two rows of alignment visible
1747        */
1748       if (annotationHeight + alignmentHeight > availableHeight)
1749       {
1750         annotationHeight = Math.min(annotationHeight,
1751                 availableHeight - 2 * rowHeight);
1752       }
1753     }
1754     else
1755     {
1756       // maintain same window layout whilst updating sliders
1757       annotationHeight = Math.min(ap.annotationScroller.getSize().height,
1758               availableHeight - 2 * rowHeight);
1759     }
1760     return annotationHeight;
1761   }
1762 }