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