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