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.Collections;
  45 import java.util.List;
  46
  47 import javax.swing.JMenuItem;
  48 import javax.swing.JPanel;
  49 import javax.swing.JPopupMenu;
  50 import javax.swing.Scrollable;
  51 import javax.swing.ToolTipManager;
  52
  53 import jalview.datamodel.AlignmentAnnotation;
  54 import jalview.datamodel.AlignmentI;
  55 import jalview.datamodel.Annotation;
  56 import jalview.datamodel.ColumnSelection;
  57 import jalview.datamodel.HiddenColumns;
  58 import jalview.datamodel.SequenceI;
  59 import jalview.gui.JalviewColourChooser.ColourChooserListener;
  60 import jalview.renderer.AnnotationRenderer;
  61 import jalview.renderer.AwtRenderPanelI;
  62 import jalview.schemes.ResidueProperties;
  63 import jalview.util.Comparison;
  64 import jalview.util.MessageManager;
  65 import jalview.util.Platform;
  66 import jalview.viewmodel.ViewportListenerI;
  67 import jalview.viewmodel.ViewportRanges;
  68
  69 /**
  70  * AnnotationPanel displays visible portion of annotation rows below unwrapped
  71  * alignment
  72  *
  73  * @author $author$
  74  * @version $Revision$
  75  */
  76 public class AnnotationPanel extends JPanel implements AwtRenderPanelI,
  77         MouseListener, MouseWheelListener, MouseMotionListener,
  78         ActionListener, AdjustmentListener, Scrollable, ViewportListenerI
  79 {
  80   enum DragMode
  81   {
  82     Select, Resize, Undefined
  83   };
  84
  85   String HELIX = MessageManager.getString("label.helix");
  86
  87   String SHEET = MessageManager.getString("label.sheet");
  88
  89   /**
  90    * For RNA secondary structure "stems" aka helices
  91    */
  92   String STEM = MessageManager.getString("label.rna_helix");
  93
  94   String LABEL = MessageManager.getString("label.label");
  95
  96   String REMOVE = MessageManager.getString("label.remove_annotation");
  97
  98   String COLOUR = MessageManager.getString("action.colour");
  99
 100   public final Color HELIX_COLOUR = Color.red.darker();
 101
 102   public final Color SHEET_COLOUR = Color.green.darker().darker();
 103
 104   public final Color STEM_COLOUR = Color.blue.darker();
 105
 106   /** DOCUMENT ME!! */
 107   public AlignViewport av;
 108
 109   AlignmentPanel ap;
 110
 111   public int activeRow = -1;
 112
 113   public BufferedImage image;
 114
 115   public volatile BufferedImage fadedImage;
 116
 117   // private Graphics2D gg;
 118
 119   public FontMetrics fm;
 120
 121   public int imgWidth = 0;
 122
 123   boolean fastPaint = false;
 124
 125   // Used For mouse Dragging and resizing graphs
 126   int graphStretch = -1;
 127
 128   int mouseDragLastX = -1;
 129
 130   int mouseDragLastY = -1;
 131
 132   DragMode dragMode = DragMode.Undefined;
 133
 134   boolean mouseDragging = false;
 135
 136   // for editing cursor
 137   int cursorX = 0;
 138
 139   int cursorY = 0;
 140
 141   public final AnnotationRenderer renderer;
 142
 143   private MouseWheelListener[] _mwl;
 144
 145   /**
 146    * Creates a new AnnotationPanel object.
 147    *
 148    * @param ap
 149    *          DOCUMENT ME!
 150    */
 151   public AnnotationPanel(AlignmentPanel ap)
 152   {
 153     setName("AnnotationPanel");
 154     ToolTipManager.sharedInstance().registerComponent(this);
 155     ToolTipManager.sharedInstance().setInitialDelay(0);
 156     ToolTipManager.sharedInstance().setDismissDelay(10000);
 157     this.ap = ap;
 158     av = ap.av;
 159     this.setLayout(null);
 160     addMouseListener(this);
 161     addMouseMotionListener(this);
 162     ap.annotationScroller.getVerticalScrollBar()
 163             .addAdjustmentListener(this);
 164     // save any wheel listeners on the scroller, so we can propagate scroll
 165     // events to them.
 166     _mwl = ap.annotationScroller.getMouseWheelListeners();
 167     // and then set our own listener to consume all mousewheel events
 168     ap.annotationScroller.addMouseWheelListener(this);
 169     renderer = new AnnotationRenderer();
 170
 171     av.getRanges().addPropertyChangeListener(this);
 172   }
 173
 174   public AnnotationPanel(AlignViewport av)
 175   {
 176     this.av = av;
 177     renderer = new AnnotationRenderer();
 178   }
 179
 180   @Override
 181   public void mouseWheelMoved(MouseWheelEvent e)
 182   {
 183     if (e.isShiftDown())
 184     {
 185       e.consume();
 186       double wheelRotation = e.getPreciseWheelRotation();
 187       if (wheelRotation > 0)
 188       {
 189         av.getRanges().scrollRight(true);
 190       }
 191       else if (wheelRotation < 0)
 192       {
 193         av.getRanges().scrollRight(false);
 194       }
 195     }
 196     else
 197     {
 198       // TODO: find the correct way to let the event bubble up to
 199       // ap.annotationScroller
 200       for (MouseWheelListener mwl : _mwl)
 201       {
 202         if (mwl != null)
 203         {
 204           mwl.mouseWheelMoved(e);
 205         }
 206         if (e.isConsumed())
 207         {
 208           break;
 209         }
 210       }
 211     }
 212   }
 213
 214   @Override
 215   public Dimension getPreferredScrollableViewportSize()
 216   {
 217     Dimension ps = getPreferredSize();
 218     return new Dimension(ps.width, adjustForAlignFrame(false, ps.height));
 219   }
 220
 221   @Override
 222   public int getScrollableBlockIncrement(Rectangle visibleRect,
 223           int orientation, int direction)
 224   {
 225     return 30;
 226   }
 227
 228   @Override
 229   public boolean getScrollableTracksViewportHeight()
 230   {
 231     return false;
 232   }
 233
 234   @Override
 235   public boolean getScrollableTracksViewportWidth()
 236   {
 237     return true;
 238   }
 239
 240   @Override
 241   public int getScrollableUnitIncrement(Rectangle visibleRect,
 242           int orientation, int direction)
 243   {
 244     return 30;
 245   }
 246
 247   /*
 248    * (non-Javadoc)
 249    *
 250    * @see
 251    * java.awt.event.AdjustmentListener#adjustmentValueChanged(java.awt.event
 252    * .AdjustmentEvent)
 253    */
 254   @Override
 255   public void adjustmentValueChanged(AdjustmentEvent evt)
 256   {
 257     // update annotation label display
 258     ap.getAlabels().setScrollOffset(-evt.getValue());
 259   }
 260
 261   /**
 262    * Calculates the height of the annotation displayed in the annotation panel.
 263    * Callers should normally call the ap.adjustAnnotationHeight method to ensure
 264    * all annotation associated components are updated correctly.
 265    *
 266    */
 267   public int adjustPanelHeight()
 268   {
 269     int height = av.calcPanelHeight();
 270     this.setPreferredSize(new Dimension(1, height));
 271     if (ap != null)
 272     {
 273       // revalidate only when the alignment panel is fully constructed
 274       ap.validate();
 275     }
 276
 277     return height;
 278   }
 279
 280   /**
 281    * DOCUMENT ME!
 282    *
 283    * @param evt
 284    *          DOCUMENT ME!
 285    */
 286   @Override
 287   public void actionPerformed(ActionEvent evt)
 288   {
 289     AlignmentAnnotation[] aa = av.getAlignment().getAlignmentAnnotation();
 290     if (aa == null)
 291     {
 292       return;
 293     }
 294     Annotation[] anot = aa[activeRow].annotations;
 295
 296     if (anot.length < av.getColumnSelection().getMax())
 297     {
 298       Annotation[] temp = new Annotation[av.getColumnSelection().getMax()
 299               + 2];
 300       System.arraycopy(anot, 0, temp, 0, anot.length);
 301       anot = temp;
 302       aa[activeRow].annotations = anot;
 303     }
 304
 305     String action = evt.getActionCommand();
 306     if (action.equals(REMOVE))
 307     {
 308       for (int index : av.getColumnSelection().getSelected())
 309       {
 310         if (av.getAlignment().getHiddenColumns().isVisible(index))
 311         {
 312           anot[index] = null;
 313         }
 314       }
 315     }
 316     else if (action.equals(LABEL))
 317     {
 318       String exMesg = collectAnnotVals(anot, LABEL);
 319       String label = JvOptionPane.showInputDialog(
 320               MessageManager.getString("label.enter_label"), exMesg);
 321
 322       if (label == null)
 323       {
 324         return;
 325       }
 326
 327       if ((label.length() > 0) && !aa[activeRow].hasText)
 328       {
 329         aa[activeRow].hasText = true;
 330       }
 331
 332       for (int index : av.getColumnSelection().getSelected())
 333       {
 334         if (!av.getAlignment().getHiddenColumns().isVisible(index))
 335         {
 336           continue;
 337         }
 338
 339         if (anot[index] == null)
 340         {
 341           anot[index] = new Annotation(label, "", ' ', 0);
 342         }
 343         else
 344         {
 345           anot[index].displayCharacter = label;
 346         }
 347       }
 348     }
 349     else if (action.equals(COLOUR))
 350     {
 351       final Annotation[] fAnot = anot;
 352       String title = MessageManager
 353               .getString("label.select_foreground_colour");
 354       ColourChooserListener listener = new ColourChooserListener()
 355       {
 356         @Override
 357         public void colourSelected(Color c)
 358         {
 359           HiddenColumns hiddenColumns = av.getAlignment()
 360                   .getHiddenColumns();
 361           for (int index : av.getColumnSelection().getSelected())
 362           {
 363             if (hiddenColumns.isVisible(index))
 364             {
 365               if (fAnot[index] == null)
 366               {
 367                 fAnot[index] = new Annotation("", "", ' ', 0);
 368               }
 369               fAnot[index].colour = c;
 370             }
 371           }
 372         };
 373       };
 374       JalviewColourChooser.showColourChooser(this, title, Color.black,
 375               listener);
 376     }
 377     else
 378     // HELIX, SHEET or STEM
 379     {
 380       char type = 0;
 381       String symbol = "\u03B1"; // alpha
 382
 383       if (action.equals(HELIX))
 384       {
 385         type = 'H';
 386       }
 387       else if (action.equals(SHEET))
 388       {
 389         type = 'E';
 390         symbol = "\u03B2"; // beta
 391       }
 392
 393       // Added by LML to color stems
 394       else if (action.equals(STEM))
 395       {
 396         type = 'S';
 397         int column = av.getColumnSelection().getSelectedRanges().get(0)[0];
 398         symbol = aa[activeRow].getDefaultRnaHelixSymbol(column);
 399       }
 400
 401       if (!aa[activeRow].hasIcons)
 402       {
 403         aa[activeRow].hasIcons = true;
 404       }
 405
 406       String label = JvOptionPane.showInputDialog(MessageManager
 407               .getString("label.enter_label_for_the_structure"), symbol);
 408
 409       if (label == null)
 410       {
 411         return;
 412       }
 413
 414       if ((label.length() > 0) && !aa[activeRow].hasText)
 415       {
 416         aa[activeRow].hasText = true;
 417         if (action.equals(STEM))
 418         {
 419           aa[activeRow].showAllColLabels = true;
 420         }
 421       }
 422       for (int index : av.getColumnSelection().getSelected())
 423       {
 424         if (!av.getAlignment().getHiddenColumns().isVisible(index))
 425         {
 426           continue;
 427         }
 428
 429         if (anot[index] == null)
 430         {
 431           anot[index] = new Annotation(label, "", type, 0);
 432         }
 433
 434         anot[index].secondaryStructure = type != 'S' ? type
 435                 : label.length() == 0 ? ' ' : label.charAt(0);
 436         anot[index].displayCharacter = label;
 437
 438       }
 439     }
 440
 441     av.getAlignment().validateAnnotation(aa[activeRow]);
 442     ap.alignmentChanged();
 443     ap.alignFrame.setMenusForViewport();
 444     adjustPanelHeight();
 445     repaint();
 446
 447     return;
 448   }
 449
 450   /**
 451    * Returns any existing annotation concatenated as a string. For each
 452    * annotation, takes the description, if any, else the secondary structure
 453    * character (if type is HELIX, SHEET or STEM), else the display character (if
 454    * type is LABEL).
 455    *
 456    * @param anots
 457    * @param type
 458    * @return
 459    */
 460   private String collectAnnotVals(Annotation[] anots, String type)
 461   {
 462     // TODO is this method wanted? why? 'last' is not used
 463
 464     StringBuilder collatedInput = new StringBuilder(64);
 465     String last = "";
 466     ColumnSelection viscols = av.getColumnSelection();
 467     HiddenColumns hidden = av.getAlignment().getHiddenColumns();
 468
 469     /*
 470      * the selection list (read-only view) is in selection order, not
 471      * column order; make a copy so we can sort it
 472      */
 473     List<Integer> selected = new ArrayList<>(viscols.getSelected());
 474     Collections.sort(selected);
 475     for (int index : selected)
 476     {
 477       // always check for current display state - just in case
 478       if (!hidden.isVisible(index))
 479       {
 480         continue;
 481       }
 482       String tlabel = null;
 483       if (anots[index] != null)
 484       { // LML added stem code
 485         if (type.equals(HELIX) || type.equals(SHEET) || type.equals(STEM)
 486                 || type.equals(LABEL))
 487         {
 488           tlabel = anots[index].description;
 489           if (tlabel == null || tlabel.length() < 1)
 490           {
 491             if (type.equals(HELIX) || type.equals(SHEET)
 492                     || type.equals(STEM))
 493             {
 494               tlabel = "" + anots[index].secondaryStructure;
 495             }
 496             else
 497             {
 498               tlabel = "" + anots[index].displayCharacter;
 499             }
 500           }
 501         }
 502         if (tlabel != null && !tlabel.equals(last))
 503         {
 504           if (last.length() > 0)
 505           {
 506             collatedInput.append(" ");
 507           }
 508           collatedInput.append(tlabel);
 509         }
 510       }
 511     }
 512     return collatedInput.toString();
 513   }
 514
 515   /**
 516    * Action on right mouse pressed on Mac is to show a pop-up menu for the
 517    * annotation. Action on left mouse pressed is to find which annotation is
 518    * pressed and mark the start of a column selection or graph resize operation.
 519    *
 520    * @param evt
 521    */
 522   @Override
 523   public void mousePressed(MouseEvent evt)
 524   {
 525
 526     AlignmentAnnotation[] aa = av.getAlignment().getAlignmentAnnotation();
 527     if (aa == null)
 528     {
 529       return;
 530     }
 531     mouseDragLastX = evt.getX();
 532     mouseDragLastY = evt.getY();
 533
 534     /*
 535      * add visible annotation heights until we reach the y
 536      * position, to find which annotation it is in
 537      */
 538     int height = 0;
 539     activeRow = -1;
 540
 541     final int y = evt.getY();
 542     for (int i = 0; i < aa.length; i++)
 543     {
 544       if (aa[i].visible)
 545       {
 546         height += aa[i].height;
 547       }
 548
 549       if (y < height)
 550       {
 551         if (aa[i].editable)
 552         {
 553           activeRow = i;
 554         }
 555         else if (aa[i].graph > 0)
 556         {
 557           /*
 558            * we have clicked on a resizable graph annotation
 559            */
 560           graphStretch = i;
 561         }
 562         break;
 563       }
 564     }
 565
 566     /*
 567      * isPopupTrigger fires in mousePressed on Mac,
 568      * not until mouseRelease on Windows
 569      */
 570     if (evt.isPopupTrigger() && activeRow != -1)
 571     {
 572       showPopupMenu(y, evt.getX());
 573       return;
 574     }
 575
 576     ap.getScalePanel().mousePressed(evt);
 577   }
 578
 579   /**
 580    * Construct and display a context menu at the right-click position
 581    *
 582    * @param y
 583    * @param x
 584    */
 585   void showPopupMenu(final int y, int x)
 586   {
 587     if (av.getColumnSelection() == null
 588             || av.getColumnSelection().isEmpty())
 589     {
 590       return;
 591     }
 592
 593     JPopupMenu pop = new JPopupMenu(
 594             MessageManager.getString("label.structure_type"));
 595     JMenuItem item;
 596     /*
 597      * Just display the needed structure options
 598      */
 599     if (av.getAlignment().isNucleotide())
 600     {
 601       item = new JMenuItem(STEM);
 602       item.addActionListener(this);
 603       pop.add(item);
 604     }
 605     else
 606     {
 607       item = new JMenuItem(HELIX);
 608       item.addActionListener(this);
 609       pop.add(item);
 610       item = new JMenuItem(SHEET);
 611       item.addActionListener(this);
 612       pop.add(item);
 613     }
 614     item = new JMenuItem(LABEL);
 615     item.addActionListener(this);
 616     pop.add(item);
 617     item = new JMenuItem(COLOUR);
 618     item.addActionListener(this);
 619     pop.add(item);
 620     item = new JMenuItem(REMOVE);
 621     item.addActionListener(this);
 622     pop.add(item);
 623     pop.show(this, x, y);
 624   }
 625
 626   /**
 627    * Action on mouse up is to clear mouse drag data and call mouseReleased on
 628    * ScalePanel, to deal with defining the selection group (if any) defined by
 629    * the mouse drag
 630    *
 631    * @param evt
 632    */
 633   @Override
 634   public void mouseReleased(MouseEvent evt)
 635   {
 636     graphStretch = -1;
 637     mouseDragLastX = -1;
 638     mouseDragLastY = -1;
 639     mouseDragging = false;
 640     dragMode = DragMode.Undefined;
 641     ap.getScalePanel().mouseReleased(evt);
 642
 643     /*
 644      * isPopupTrigger is set in mouseReleased on Windows
 645      * (in mousePressed on Mac)
 646      */
 647     if (evt.isPopupTrigger() && activeRow != -1)
 648     {
 649       showPopupMenu(evt.getY(), evt.getX());
 650     }
 651
 652   }
 653
 654   /**
 655    * DOCUMENT ME!
 656    *
 657    * @param evt
 658    *          DOCUMENT ME!
 659    */
 660   @Override
 661   public void mouseEntered(MouseEvent evt)
 662   {
 663     this.mouseDragging = false;
 664     ap.getScalePanel().mouseEntered(evt);
 665   }
 666
 667   /**
 668    * On leaving the panel, calls ScalePanel.mouseExited to deal with scrolling
 669    * with column selection on a mouse drag
 670    *
 671    * @param evt
 672    */
 673   @Override
 674   public void mouseExited(MouseEvent evt)
 675   {
 676     ap.getScalePanel().mouseExited(evt);
 677   }
 678
 679   /**
 680    * DOCUMENT ME!
 681    *
 682    * @param evt
 683    *          DOCUMENT ME!
 684    */
 685   @Override
 686   public void mouseDragged(MouseEvent evt)
 687   {
 688     /*
 689      * todo: if dragMode is Undefined:
 690      * - set to Select if dx > dy
 691      * - set to Resize if dy > dx
 692      * - do nothing if dx == dy
 693      */
 694     final int x = evt.getX();
 695     final int y = evt.getY();
 696     if (dragMode == DragMode.Undefined)
 697     {
 698       int dx = Math.abs(x - mouseDragLastX);
 699       int dy = Math.abs(y - mouseDragLastY);
 700       if (graphStretch == -1 || dx > dy)
 701       {
 702         /*
 703          * mostly horizontal drag, or not a graph annotation
 704          */
 705         dragMode = DragMode.Select;
 706       }
 707       else if (dy > dx)
 708       {
 709         /*
 710          * mostly vertical drag
 711          */
 712         dragMode = DragMode.Resize;
 713       }
 714     }
 715
 716     if (dragMode == DragMode.Undefined)
 717       {
 718       /*
 719        * drag is diagonal - defer deciding whether to
 720        * treat as up/down or left/right
 721        */
 722         return;
 723       }
 724     try
 725     {
 726       if (dragMode == DragMode.Resize)
 727       {
 728         /*
 729          * resize graph annotation if mouse was dragged up or down
 730          */
 731         int deltaY = mouseDragLastY - evt.getY();
 732         if (deltaY != 0)
 733         {
 734           AlignmentAnnotation graphAnnotation = av.getAlignment()
 735                   .getAlignmentAnnotation()[graphStretch];
 736           int newHeight = Math.max(0, graphAnnotation.graphHeight + deltaY);
 737           graphAnnotation.graphHeight = newHeight;
 738           adjustPanelHeight();
 739           setNoFastPaint();
 740           ap.paintAlignment(false, false);
 741         }
 742       }
 743       else
 744       {
 745         /*
 746          * for mouse drag left or right, delegate to
 747          * ScalePanel to adjust the column selection
 748          */
 749         ap.getScalePanel().mouseDragged(evt);
 750       }
 751     } finally
 752     {
 753       mouseDragLastX = x;
 754       mouseDragLastY = y;
 755     }
 756   }
 757
 758   /**
 759    * Constructs the tooltip, and constructs and displays a status message, for
 760    * the current mouse position
 761    *
 762    * @param evt
 763    */
 764   @Override
 765   public void mouseMoved(MouseEvent evt)
 766   {
 767     int yPos = evt.getY();
 768     AlignmentAnnotation[] aa = av.getAlignment().getAlignmentAnnotation();
 769
 770     int row = getRowIndex(yPos, aa);
 771
 772     if (row == -1)
 773     {
 774       this.setToolTipText(null);
 775       return;
 776     }
 777
 778     int column = (evt.getX() / av.getCharWidth())
 779             + av.getRanges().getStartRes();
 780     column = Math.min(column, av.getRanges().getEndRes());
 781
 782     if (av.hasHiddenColumns())
 783     {
 784       column = av.getAlignment().getHiddenColumns()
 785               .visibleToAbsoluteColumn(column);
 786     }
 787
 788     AlignmentAnnotation ann = aa[row];
 789     if (row > -1 && ann.annotations != null
 790             && column < ann.annotations.length)
 791     {
 792       String toolTip = buildToolTip(ann, column, aa);
 793       setToolTipText(toolTip == null ? null
 794               : JvSwingUtils.wrapTooltip(true, toolTip));
 795       String msg = getStatusMessage(av.getAlignment(), column, ann);
 796       ap.alignFrame.setStatus(msg);
 797     }
 798     else
 799     {
 800       this.setToolTipText(null);
 801       ap.alignFrame.setStatus(" ");
 802     }
 803   }
 804
 805   /**
 806    * Answers the index in the annotations array of the visible annotation at the
 807    * given y position. This is done by adding the heights of visible annotations
 808    * until the y position has been exceeded. Answers -1 if no annotations are
 809    * visible, or the y position is below all annotations.
 810    *
 811    * @param yPos
 812    * @param aa
 813    * @return
 814    */
 815   static int getRowIndex(int yPos, AlignmentAnnotation[] aa)
 816   {
 817     if (aa == null)
 818     {
 819       return -1;
 820     }
 821     int row = -1;
 822     int height = 0;
 823
 824     for (int i = 0; i < aa.length; i++)
 825     {
 826       if (aa[i].visible)
 827       {
 828         height += aa[i].height;
 829       }
 830
 831       if (height > yPos)
 832       {
 833         row = i;
 834         break;
 835       }
 836     }
 837     return row;
 838   }
 839
 840   /**
 841    * Answers a tooltip for the annotation at the current mouse position, not
 842    * wrapped in &lt;html&gt; tags (apply if wanted). Answers null if there is no
 843    * tooltip to show.
 844    *
 845    * @param ann
 846    * @param column
 847    * @param anns
 848    */
 849   static String buildToolTip(AlignmentAnnotation ann, int column,
 850           AlignmentAnnotation[] anns)
 851   {
 852     String tooltip = null;
 853     if (ann.graphGroup > -1)
 854     {
 855       StringBuilder tip = new StringBuilder(32);
 856       boolean first = true;
 857       for (int i = 0; i < anns.length; i++)
 858       {
 859         if (anns[i].graphGroup == ann.graphGroup
 860                 && anns[i].annotations[column] != null)
 861         {
 862           if (!first)
 863           {
 864             tip.append("<br>");
 865           }
 866           first = false;
 867           tip.append(anns[i].label);
 868           String description = anns[i].annotations[column].description;
 869           if (description != null && description.length() > 0)
 870           {
 871             tip.append(" ").append(description);
 872           }
 873         }
 874       }
 875       tooltip = first ? null : tip.toString();
 876     }
 877     else if (column < ann.annotations.length
 878             && ann.annotations[column] != null)
 879     {
 880       tooltip = ann.annotations[column].description;
 881     }
 882
 883     return tooltip;
 884   }
 885
 886   /**
 887    * Constructs and returns the status bar message
 888    *
 889    * @param al
 890    * @param column
 891    * @param ann
 892    */
 893   static String getStatusMessage(AlignmentI al, int column,
 894           AlignmentAnnotation ann)
 895   {
 896     /*
 897      * show alignment column and annotation description if any
 898      */
 899     StringBuilder text = new StringBuilder(32);
 900     text.append(MessageManager.getString("label.column")).append(" ")
 901             .append(column + 1);
 902
 903     if (column < ann.annotations.length && ann.annotations[column] != null)
 904     {
 905       String description = ann.annotations[column].description;
 906       if (description != null && description.trim().length() > 0)
 907       {
 908         text.append("  ").append(description);
 909       }
 910     }
 911
 912     /*
 913      * if the annotation is sequence-specific, show the sequence number
 914      * in the alignment, and (if not a gap) the residue and position
 915      */
 916     SequenceI seqref = ann.sequenceRef;
 917     if (seqref != null)
 918     {
 919       int seqIndex = al.findIndex(seqref);
 920       if (seqIndex != -1)
 921       {
 922         text.append(", ").append(MessageManager.getString("label.sequence"))
 923                 .append(" ").append(seqIndex + 1);
 924         char residue = seqref.getCharAt(column);
 925         if (!Comparison.isGap(residue))
 926         {
 927           text.append(" ");
 928           String name;
 929           if (al.isNucleotide())
 930           {
 931             name = ResidueProperties.nucleotideName
 932                     .get(String.valueOf(residue));
 933             text.append(" Nucleotide: ")
 934                     .append(name != null ? name : residue);
 935           }
 936           else
 937           {
 938             name = 'X' == residue ? "X"
 939                     : ('*' == residue ? "STOP"
 940                             : ResidueProperties.aa2Triplet
 941                                     .get(String.valueOf(residue)));
 942             text.append(" Residue: ").append(name != null ? name : residue);
 943           }
 944           int residuePos = seqref.findPosition(column);
 945           text.append(" (").append(residuePos).append(")");
 946         }
 947       }
 948     }
 949
 950     return text.toString();
 951   }
 952
 953   /**
 954    * DOCUMENT ME!
 955    *
 956    * @param evt
 957    *          DOCUMENT ME!
 958    */
 959   @Override
 960   public void mouseClicked(MouseEvent evt)
 961   {
 962     // if (activeRow != -1)
 963     // {
 964     // AlignmentAnnotation[] aa = av.getAlignment().getAlignmentAnnotation();
 965     // AlignmentAnnotation anot = aa[activeRow];
 966     // }
 967   }
 968
 969   // TODO mouseClicked-content and drawCursor are quite experimental!
 970   public void drawCursor(Graphics graphics, SequenceI seq, int res, int x1,
 971           int y1)
 972   {
 973     int pady = av.getCharHeight() / 5;
 974     int charOffset = 0;
 975     graphics.setColor(Color.black);
 976     graphics.fillRect(x1, y1, av.getCharWidth(), av.getCharHeight());
 977
 978     if (av.validCharWidth)
 979     {
 980       graphics.setColor(Color.white);
 981
 982       char s = seq.getCharAt(res);
 983
 984       charOffset = (av.getCharWidth() - fm.charWidth(s)) / 2;
 985       graphics.drawString(String.valueOf(s), charOffset + x1,
 986               (y1 + av.getCharHeight()) - pady);
 987     }
 988
 989   }
 990
 991   private volatile boolean imageFresh = false;
 992
 993   private Rectangle visibleRect = new Rectangle(),
 994           clipBounds = new Rectangle();
 995
 996   /**
 997    * DOCUMENT ME!
 998    *
 999    * @param g
1000    *          DOCUMENT ME!
1001    */
1002   @Override
1003   public void paintComponent(Graphics g)
1004   {
1005
1006     // BH: note that this method is generally recommended to
1007     // call super.paintComponent(g). Otherwise, the children of this
1008     // component will not be rendered. That is not needed here
1009     // because AnnotationPanel does not have any children. It is
1010     // just a JPanel contained in a JViewPort.
1011
1012     computeVisibleRect(visibleRect);
1013
1014     g.setColor(Color.white);
1015     g.fillRect(0, 0, visibleRect.width, visibleRect.height);
1016
1017     ViewportRanges ranges = av.getRanges();
1018
1019     if (allowFastPaint && image != null)
1020     {
1021       // BH 2018 optimizing generation of new Rectangle().
1022       if (fastPaint
1023               || (visibleRect.width != (clipBounds = g
1024                       .getClipBounds(clipBounds)).width)
1025               || (visibleRect.height != clipBounds.height))
1026       {
1027         g.drawImage(image, 0, 0, this);
1028         fastPaint = false;
1029         return;
1030       }
1031     }
1032
1033     imgWidth = (ranges.getEndRes() - ranges.getStartRes() + 1)
1034             * av.getCharWidth();
1035
1036     if (imgWidth < 1)
1037     {
1038       fastPaint = false;
1039       return;
1040     }
1041     Graphics2D gg;
1042     if (image == null || imgWidth != image.getWidth(this)
1043             || image.getHeight(this) != getHeight())
1044     {
1045       try
1046       {
1047         image = new BufferedImage(imgWidth,
1048                 ap.getAnnotationPanel().getHeight(),
1049                 BufferedImage.TYPE_INT_RGB);
1050       } catch (OutOfMemoryError oom)
1051       {
1052         try
1053         {
1054           System.gc();
1055         } catch (Exception x)
1056         {
1057         }
1058         ;
1059         new OOMWarning(
1060                 "Couldn't allocate memory to redraw screen. Please restart Jalview",
1061                 oom);
1062         return;
1063       }
1064       gg = (Graphics2D) image.getGraphics();
1065
1066       if (av.antiAlias)
1067       {
1068         gg.setRenderingHint(RenderingHints.KEY_ANTIALIASING,
1069                 RenderingHints.VALUE_ANTIALIAS_ON);
1070       }
1071
1072       gg.setFont(av.getFont());
1073       fm = gg.getFontMetrics();
1074       gg.setColor(Color.white);
1075       gg.fillRect(0, 0, imgWidth, image.getHeight());
1076       imageFresh = true;
1077     }
1078     else
1079     {
1080       gg = (Graphics2D) image.getGraphics();
1081
1082     }
1083
1084     drawComponent(gg, ranges.getStartRes(), av.getRanges().getEndRes() + 1);
1085     gg.dispose();
1086     imageFresh = false;
1087     g.drawImage(image, 0, 0, this);
1088   }
1089
1090   /**
1091    * non-Thread safe repaint
1092    *
1093    * @param horizontal
1094    *          repaint with horizontal shift in alignment
1095    */
1096   public void fastPaint(int horizontal)
1097   {
1098     if ((horizontal == 0) || image == null
1099             || av.getAlignment().getAlignmentAnnotation() == null
1100             || av.getAlignment().getAlignmentAnnotation().length < 1
1101             || av.isCalcInProgress())
1102     {
1103       repaint();
1104       return;
1105     }
1106
1107     int sr = av.getRanges().getStartRes();
1108     int er = av.getRanges().getEndRes() + 1;
1109     int transX = 0;
1110
1111     if (er == sr + 1)
1112     {
1113       fastPaint = false;
1114       return;
1115     }
1116
1117     Graphics2D gg = (Graphics2D) image.getGraphics();
1118
1119     gg.copyArea(0, 0, imgWidth, getHeight(),
1120             -horizontal * av.getCharWidth(), 0);
1121
1122     if (horizontal > 0) // scrollbar pulled right, image to the left
1123     {
1124       transX = (er - sr - horizontal) * av.getCharWidth();
1125       sr = er - horizontal;
1126     }
1127     else if (horizontal < 0)
1128     {
1129       er = sr - horizontal;
1130     }
1131
1132     gg.translate(transX, 0);
1133
1134     drawComponent(gg, sr, er);
1135
1136     gg.translate(-transX, 0);
1137
1138     gg.dispose();
1139
1140     fastPaint = true;
1141
1142     // Call repaint on alignment panel so that repaints from other alignment
1143     // panel components can be aggregated. Otherwise performance of the overview
1144     // window and others may be adversely affected.
1145     av.getAlignPanel().repaint();
1146   }
1147
1148   private volatile boolean lastImageGood = false;
1149
1150   /**
1151    * DOCUMENT ME!
1152    *
1153    * @param g
1154    *          DOCUMENT ME!
1155    * @param startRes
1156    *          DOCUMENT ME!
1157    * @param endRes
1158    *          DOCUMENT ME!
1159    */
1160   public void drawComponent(Graphics g, int startRes, int endRes)
1161   {
1162     BufferedImage oldFaded = fadedImage;
1163     if (av.isCalcInProgress())
1164     {
1165       if (image == null)
1166       {
1167         lastImageGood = false;
1168         return;
1169       }
1170       // We'll keep a record of the old image,
1171       // and draw a faded image until the calculation
1172       // has completed
1173       if (lastImageGood
1174               && (fadedImage == null || fadedImage.getWidth() != imgWidth
1175                       || fadedImage.getHeight() != image.getHeight()))
1176       {
1177         // System.err.println("redraw faded image ("+(fadedImage==null ?
1178         // "null image" : "") + " lastGood="+lastImageGood+")");
1179         fadedImage = new BufferedImage(imgWidth, image.getHeight(),
1180                 BufferedImage.TYPE_INT_RGB);
1181
1182         Graphics2D fadedG = (Graphics2D) fadedImage.getGraphics();
1183
1184         fadedG.setColor(Color.white);
1185         fadedG.fillRect(0, 0, imgWidth, image.getHeight());
1186
1187         fadedG.setComposite(
1188                 AlphaComposite.getInstance(AlphaComposite.SRC_OVER, .3f));
1189         fadedG.drawImage(image, 0, 0, this);
1190
1191       }
1192       // make sure we don't overwrite the last good faded image until all
1193       // calculations have finished
1194       lastImageGood = false;
1195
1196     }
1197     else
1198     {
1199       if (fadedImage != null)
1200       {
1201         oldFaded = fadedImage;
1202       }
1203       fadedImage = null;
1204     }
1205
1206     g.setColor(Color.white);
1207     g.fillRect(0, 0, (endRes - startRes) * av.getCharWidth(), getHeight());
1208
1209     g.setFont(av.getFont());
1210     if (fm == null)
1211     {
1212       fm = g.getFontMetrics();
1213     }
1214
1215     if ((av.getAlignment().getAlignmentAnnotation() == null)
1216             || (av.getAlignment().getAlignmentAnnotation().length < 1))
1217     {
1218       g.setColor(Color.white);
1219       g.fillRect(0, 0, getWidth(), getHeight());
1220       g.setColor(Color.black);
1221       if (av.validCharWidth)
1222       {
1223         g.drawString(MessageManager
1224                 .getString("label.alignment_has_no_annotations"), 20, 15);
1225       }
1226
1227       return;
1228     }
1229     lastImageGood = renderer.drawComponent(this, av, g, activeRow, startRes,
1230             endRes);
1231     if (!lastImageGood && fadedImage == null)
1232     {
1233       fadedImage = oldFaded;
1234     }
1235   }
1236
1237   @Override
1238   public FontMetrics getFontMetrics()
1239   {
1240     return fm;
1241   }
1242
1243   @Override
1244   public Image getFadedImage()
1245   {
1246     return fadedImage;
1247   }
1248
1249   @Override
1250   public int getFadedImageWidth()
1251   {
1252     return imgWidth;
1253   }
1254
1255   private int[] bounds = new int[2];
1256
1257   private boolean allowFastPaint;
1258
1259   @Override
1260   public int[] getVisibleVRange()
1261   {
1262     if (ap != null && ap.getAlabels() != null)
1263     {
1264       int sOffset = -ap.getAlabels().getScrollOffset();
1265       int visHeight = sOffset + ap.annotationSpaceFillerHolder.getHeight();
1266       bounds[0] = sOffset;
1267       bounds[1] = visHeight;
1268       return bounds;
1269     }
1270     else
1271     {
1272       return null;
1273     }
1274   }
1275
1276   /**
1277    * Try to ensure any references held are nulled
1278    */
1279   public void dispose()
1280   {
1281     av = null;
1282     ap = null;
1283     image = null;
1284     fadedImage = null;
1285     // gg = null;
1286     _mwl = null;
1287
1288     /*
1289      * I created the renderer so I will dispose of it
1290      */
1291     if (renderer != null)
1292     {
1293       renderer.dispose();
1294     }
1295   }
1296
1297   @Override
1298   public void propertyChange(PropertyChangeEvent evt)
1299   {
1300     // Respond to viewport range changes (e.g. alignment panel was scrolled)
1301     // Both scrolling and resizing change viewport ranges: scrolling changes
1302     // both start and end points, but resize only changes end values.
1303     // Here we only want to fastpaint on a scroll, with resize using a normal
1304     // paint, so scroll events are identified as changes to the horizontal or
1305     // vertical start value.
1306     if (evt.getPropertyName().equals(ViewportRanges.STARTRES))
1307     {
1308       fastPaint((int) evt.getNewValue() - (int) evt.getOldValue());
1309     }
1310     else if (evt.getPropertyName().equals(ViewportRanges.STARTRESANDSEQ))
1311     {
1312       fastPaint(((int[]) evt.getNewValue())[0]
1313               - ((int[]) evt.getOldValue())[0]);
1314     }
1315     else if (evt.getPropertyName().equals(ViewportRanges.MOVE_VIEWPORT))
1316     {
1317       repaint();
1318     }
1319   }
1320
1321   /**
1322    * computes the visible height of the annotation panel
1323    *
1324    * @param adjustPanelHeight
1325    *          - when false, just adjust existing height according to other
1326    *          windows
1327    * @param annotationHeight
1328    * @return height to use for the ScrollerPreferredVisibleSize
1329    */
1330   public int adjustForAlignFrame(boolean adjustPanelHeight,
1331           int annotationHeight)
1332   {
1333     /*
1334      * Estimate available height in the AlignFrame for alignment +
1335      * annotations. Deduct an estimate for title bar, menu bar, scale panel,
1336      * hscroll, status bar, insets.
1337      */
1338     int stuff = (ap.getViewName() != null ? 30 : 0)
1339             + (Platform.isAMacAndNotJS() ? 120 : 140);
1340     int availableHeight = ap.alignFrame.getHeight() - stuff;
1341     int rowHeight = av.getCharHeight();
1342
1343     if (adjustPanelHeight)
1344     {
1345       int alignmentHeight = rowHeight * av.getAlignment().getHeight();
1346
1347       /*
1348        * If not enough vertical space, maximize annotation height while keeping
1349        * at least two rows of alignment visible
1350        */
1351       if (annotationHeight + alignmentHeight > availableHeight)
1352       {
1353         annotationHeight = Math.min(annotationHeight,
1354                 availableHeight - 2 * rowHeight);
1355       }
1356     }
1357     else
1358     {
1359       // maintain same window layout whilst updating sliders
1360       annotationHeight = Math.min(ap.annotationScroller.getSize().height,
1361               availableHeight - 2 * rowHeight);
1362     }
1363     return annotationHeight;
1364   }
1365
1366   /**
1367    * Clears the flag that allows a 'fast paint' on the next repaint, so
1368    * requiring a full repaint
1369    */
1370   public void setNoFastPaint()
1371   {
1372     allowFastPaint = false;
1373   }
1374
1375 }