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