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