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