d0aa93f865e128a647dac0e3b9d9f8f5b3214069
[jalview.git] / src / jalview / gui / SeqPanel.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.api.AlignViewportI;
24 import jalview.bin.Cache;
25 import jalview.commands.EditCommand;
26 import jalview.commands.EditCommand.Action;
27 import jalview.commands.EditCommand.Edit;
28 import jalview.datamodel.AlignmentI;
29 import jalview.datamodel.ColumnSelection;
30 import jalview.datamodel.HiddenColumns;
31 import jalview.datamodel.SearchResultMatchI;
32 import jalview.datamodel.SearchResults;
33 import jalview.datamodel.SearchResultsI;
34 import jalview.datamodel.Sequence;
35 import jalview.datamodel.SequenceFeature;
36 import jalview.datamodel.SequenceGroup;
37 import jalview.datamodel.SequenceI;
38 import jalview.io.SequenceAnnotationReport;
39 import jalview.renderer.ResidueShaderI;
40 import jalview.schemes.ResidueProperties;
41 import jalview.structure.SelectionListener;
42 import jalview.structure.SelectionSource;
43 import jalview.structure.SequenceListener;
44 import jalview.structure.StructureSelectionManager;
45 import jalview.structure.VamsasSource;
46 import jalview.util.Comparison;
47 import jalview.util.MappingUtils;
48 import jalview.util.MessageManager;
49 import jalview.util.Platform;
50 import jalview.viewmodel.AlignmentViewport;
51
52 import java.awt.BorderLayout;
53 import java.awt.Color;
54 import java.awt.Font;
55 import java.awt.FontMetrics;
56 import java.awt.Point;
57 import java.awt.event.MouseEvent;
58 import java.awt.event.MouseListener;
59 import java.awt.event.MouseMotionListener;
60 import java.awt.event.MouseWheelEvent;
61 import java.awt.event.MouseWheelListener;
62 import java.util.Collections;
63 import java.util.List;
64
65 import javax.swing.JPanel;
66 import javax.swing.SwingUtilities;
67 import javax.swing.ToolTipManager;
68
69 /**
70  * DOCUMENT ME!
71  * 
72  * @author $author$
73  * @version $Revision: 1.130 $
74  */
75 public class SeqPanel extends JPanel
76         implements MouseListener, MouseMotionListener, MouseWheelListener,
77         SequenceListener, SelectionListener
78 {
79   private static final int MAX_TOOLTIP_LENGTH = 300;
80
81   public SeqCanvas seqCanvas;
82
83   public AlignmentPanel ap;
84
85   /*
86    * last column position for mouseMoved event
87    */
88   private int lastMouseColumn;
89
90   /*
91    * last sequence offset for mouseMoved event
92    */
93   private int lastMouseSeq;
94
95   protected int editLastRes;
96
97   protected int editStartSeq;
98
99   protected AlignViewport av;
100
101   ScrollThread scrollThread = null;
102
103   boolean mouseDragging = false;
104
105   boolean editingSeqs = false;
106
107   boolean groupEditing = false;
108
109   // ////////////////////////////////////////
110   // ///Everything below this is for defining the boundary of the rubberband
111   // ////////////////////////////////////////
112   int oldSeq = -1;
113
114   boolean changeEndSeq = false;
115
116   boolean changeStartSeq = false;
117
118   boolean changeEndRes = false;
119
120   boolean changeStartRes = false;
121
122   SequenceGroup stretchGroup = null;
123
124   boolean remove = false;
125
126   Point lastMousePress;
127
128   boolean mouseWheelPressed = false;
129
130   StringBuffer keyboardNo1;
131
132   StringBuffer keyboardNo2;
133
134   java.net.URL linkImageURL;
135
136   private final SequenceAnnotationReport seqARep;
137
138   StringBuilder tooltipText = new StringBuilder();
139
140   String tmpString;
141
142   EditCommand editCommand;
143
144   StructureSelectionManager ssm;
145
146   SearchResultsI lastSearchResults;
147
148   /**
149    * Creates a new SeqPanel object
150    * 
151    * @param viewport
152    * @param alignPanel
153    */
154   public SeqPanel(AlignViewport viewport, AlignmentPanel alignPanel)
155   {
156     linkImageURL = getClass().getResource("/images/link.gif");
157     seqARep = new SequenceAnnotationReport(linkImageURL.toString());
158     ToolTipManager.sharedInstance().registerComponent(this);
159     ToolTipManager.sharedInstance().setInitialDelay(0);
160     ToolTipManager.sharedInstance().setDismissDelay(10000);
161     this.av = viewport;
162     setBackground(Color.white);
163
164     seqCanvas = new SeqCanvas(alignPanel);
165     setLayout(new BorderLayout());
166     add(seqCanvas, BorderLayout.CENTER);
167
168     this.ap = alignPanel;
169
170     if (!viewport.isDataset())
171     {
172       addMouseMotionListener(this);
173       addMouseListener(this);
174       addMouseWheelListener(this);
175       ssm = viewport.getStructureSelectionManager();
176       ssm.addStructureViewerListener(this);
177       ssm.addSelectionListener(this);
178     }
179
180     lastMouseColumn = -1;
181     lastMouseSeq = -1;
182   }
183
184   int startWrapBlock = -1;
185
186   int wrappedBlock = -1;
187
188   /**
189    * Returns the aligned sequence position (base 0) at the mouse position, or
190    * the closest visible one
191    * 
192    * @param evt
193    * @return
194    */
195   int findColumn(MouseEvent evt)
196   {
197     int res = 0;
198     int x = evt.getX();
199
200     int startRes = av.getRanges().getStartRes();
201     if (av.getWrapAlignment())
202     {
203
204       int hgap = av.getCharHeight();
205       if (av.getScaleAboveWrapped())
206       {
207         hgap += av.getCharHeight();
208       }
209
210       int cHeight = av.getAlignment().getHeight() * av.getCharHeight()
211               + hgap + seqCanvas.getAnnotationHeight();
212
213       int y = evt.getY();
214       y = Math.max(0, y - hgap);
215       x = Math.max(0, x - seqCanvas.getLabelWidthWest());
216
217       int cwidth = seqCanvas.getWrappedCanvasWidth(this.getWidth());
218       if (cwidth < 1)
219       {
220         return 0;
221       }
222
223       wrappedBlock = y / cHeight;
224       wrappedBlock += startRes / cwidth;
225       // allow for wrapped view scrolled right (possible from Overview)
226       int startOffset = startRes % cwidth;
227       res = wrappedBlock * cwidth + startOffset
228               + +Math.min(cwidth - 1, x / av.getCharWidth());
229     }
230     else
231     {
232       if (x > seqCanvas.getX() + seqCanvas.getWidth())
233       {
234         // make sure we calculate relative to visible alignment, rather than
235         // right-hand gutter
236         x = seqCanvas.getX() + seqCanvas.getWidth();
237       }
238       res = (x / av.getCharWidth()) + startRes;
239       if (res > av.getRanges().getEndRes())
240       {
241         // moused off right
242         res = av.getRanges().getEndRes();
243       }
244     }
245
246     if (av.hasHiddenColumns())
247     {
248       res = av.getAlignment().getHiddenColumns()
249               .visibleToAbsoluteColumn(res);
250     }
251
252     return res;
253
254   }
255
256   int findSeq(MouseEvent evt)
257   {
258     int seq = 0;
259     int y = evt.getY();
260
261     if (av.getWrapAlignment())
262     {
263       int hgap = av.getCharHeight();
264       if (av.getScaleAboveWrapped())
265       {
266         hgap += av.getCharHeight();
267       }
268
269       int cHeight = av.getAlignment().getHeight() * av.getCharHeight()
270               + hgap + seqCanvas.getAnnotationHeight();
271
272       y -= hgap;
273
274       seq = Math.min((y % cHeight) / av.getCharHeight(),
275               av.getAlignment().getHeight() - 1);
276     }
277     else
278     {
279       seq = Math.min(
280               (y / av.getCharHeight()) + av.getRanges().getStartSeq(),
281               av.getAlignment().getHeight() - 1);
282     }
283
284     return seq;
285   }
286
287   /**
288    * When all of a sequence of edits are complete, put the resulting edit list
289    * on the history stack (undo list), and reset flags for editing in progress.
290    */
291   void endEditing()
292   {
293     try
294     {
295       if (editCommand != null && editCommand.getSize() > 0)
296       {
297         ap.alignFrame.addHistoryItem(editCommand);
298         av.firePropertyChange("alignment", null,
299                 av.getAlignment().getSequences());
300       }
301     } finally
302     {
303       /*
304        * Tidy up come what may...
305        */
306       editStartSeq = -1;
307       editLastRes = -1;
308       editingSeqs = false;
309       groupEditing = false;
310       keyboardNo1 = null;
311       keyboardNo2 = null;
312       editCommand = null;
313     }
314   }
315
316   void setCursorRow()
317   {
318     seqCanvas.cursorY = getKeyboardNo1() - 1;
319     scrollToVisible(true);
320   }
321
322   void setCursorColumn()
323   {
324     seqCanvas.cursorX = getKeyboardNo1() - 1;
325     scrollToVisible(true);
326   }
327
328   void setCursorRowAndColumn()
329   {
330     if (keyboardNo2 == null)
331     {
332       keyboardNo2 = new StringBuffer();
333     }
334     else
335     {
336       seqCanvas.cursorX = getKeyboardNo1() - 1;
337       seqCanvas.cursorY = getKeyboardNo2() - 1;
338       scrollToVisible(true);
339     }
340   }
341
342   void setCursorPosition()
343   {
344     SequenceI sequence = av.getAlignment().getSequenceAt(seqCanvas.cursorY);
345
346     seqCanvas.cursorX = sequence.findIndex(getKeyboardNo1()) - 1;
347     scrollToVisible(true);
348   }
349
350   void moveCursor(int dx, int dy)
351   {
352     seqCanvas.cursorX += dx;
353     seqCanvas.cursorY += dy;
354
355     HiddenColumns hidden = av.getAlignment().getHiddenColumns();
356
357     if (av.hasHiddenColumns() && !hidden.isVisible(seqCanvas.cursorX))
358     {
359       int original = seqCanvas.cursorX - dx;
360       int maxWidth = av.getAlignment().getWidth();
361
362       if (!hidden.isVisible(seqCanvas.cursorX))
363       {
364         int visx = hidden.absoluteToVisibleColumn(seqCanvas.cursorX - dx);
365         int[] region = hidden.getRegionWithEdgeAtRes(visx);
366
367         if (region != null) // just in case
368         {
369           if (dx == 1)
370           {
371             // moving right
372             seqCanvas.cursorX = region[1] + 1;
373           }
374           else if (dx == -1)
375           {
376             // moving left
377             seqCanvas.cursorX = region[0] - 1;
378           }
379         }
380         seqCanvas.cursorX = (seqCanvas.cursorX < 0) ? 0 : seqCanvas.cursorX;
381       }
382
383       if (seqCanvas.cursorX >= maxWidth
384               || !hidden.isVisible(seqCanvas.cursorX))
385       {
386         seqCanvas.cursorX = original;
387       }
388     }
389
390     scrollToVisible(false);
391   }
392
393   /**
394    * Scroll to make the cursor visible in the viewport.
395    * 
396    * @param jump
397    *          just jump to the location rather than scrolling
398    */
399   void scrollToVisible(boolean jump)
400   {
401     if (seqCanvas.cursorX < 0)
402     {
403       seqCanvas.cursorX = 0;
404     }
405     else if (seqCanvas.cursorX > av.getAlignment().getWidth() - 1)
406     {
407       seqCanvas.cursorX = av.getAlignment().getWidth() - 1;
408     }
409
410     if (seqCanvas.cursorY < 0)
411     {
412       seqCanvas.cursorY = 0;
413     }
414     else if (seqCanvas.cursorY > av.getAlignment().getHeight() - 1)
415     {
416       seqCanvas.cursorY = av.getAlignment().getHeight() - 1;
417     }
418
419     endEditing();
420
421     boolean repaintNeeded = true;
422     if (jump)
423     {
424       // only need to repaint if the viewport did not move, as otherwise it will
425       // get a repaint
426       repaintNeeded = !av.getRanges().setViewportLocation(seqCanvas.cursorX,
427               seqCanvas.cursorY);
428     }
429     else
430     {
431       if (av.getWrapAlignment())
432       {
433         // scrollToWrappedVisible expects x-value to have hidden cols subtracted
434         int x = av.getAlignment().getHiddenColumns()
435                 .absoluteToVisibleColumn(seqCanvas.cursorX);
436         av.getRanges().scrollToWrappedVisible(x);
437       }
438       else
439       {
440         av.getRanges().scrollToVisible(seqCanvas.cursorX,
441                 seqCanvas.cursorY);
442       }
443     }
444
445     if (av.getAlignment().getHiddenColumns().isVisible(seqCanvas.cursorX))
446     {
447       setStatusMessage(av.getAlignment().getSequenceAt(seqCanvas.cursorY),
448             seqCanvas.cursorX, seqCanvas.cursorY);
449     }
450
451     if (repaintNeeded)
452     {
453       seqCanvas.repaint();
454     }
455   }
456
457
458   void setSelectionAreaAtCursor(boolean topLeft)
459   {
460     SequenceI sequence = av.getAlignment().getSequenceAt(seqCanvas.cursorY);
461
462     if (av.getSelectionGroup() != null)
463     {
464       SequenceGroup sg = av.getSelectionGroup();
465       // Find the top and bottom of this group
466       int min = av.getAlignment().getHeight(), max = 0;
467       for (int i = 0; i < sg.getSize(); i++)
468       {
469         int index = av.getAlignment().findIndex(sg.getSequenceAt(i));
470         if (index > max)
471         {
472           max = index;
473         }
474         if (index < min)
475         {
476           min = index;
477         }
478       }
479
480       max++;
481
482       if (topLeft)
483       {
484         sg.setStartRes(seqCanvas.cursorX);
485         if (sg.getEndRes() < seqCanvas.cursorX)
486         {
487           sg.setEndRes(seqCanvas.cursorX);
488         }
489
490         min = seqCanvas.cursorY;
491       }
492       else
493       {
494         sg.setEndRes(seqCanvas.cursorX);
495         if (sg.getStartRes() > seqCanvas.cursorX)
496         {
497           sg.setStartRes(seqCanvas.cursorX);
498         }
499
500         max = seqCanvas.cursorY + 1;
501       }
502
503       if (min > max)
504       {
505         // Only the user can do this
506         av.setSelectionGroup(null);
507       }
508       else
509       {
510         // Now add any sequences between min and max
511         sg.getSequences(null).clear();
512         for (int i = min; i < max; i++)
513         {
514           sg.addSequence(av.getAlignment().getSequenceAt(i), false);
515         }
516       }
517     }
518
519     if (av.getSelectionGroup() == null)
520     {
521       SequenceGroup sg = new SequenceGroup();
522       sg.setStartRes(seqCanvas.cursorX);
523       sg.setEndRes(seqCanvas.cursorX);
524       sg.addSequence(sequence, false);
525       av.setSelectionGroup(sg);
526     }
527
528     ap.paintAlignment(false, false);
529     av.sendSelection();
530   }
531
532   void insertGapAtCursor(boolean group)
533   {
534     groupEditing = group;
535     editStartSeq = seqCanvas.cursorY;
536     editLastRes = seqCanvas.cursorX;
537     editSequence(true, false, seqCanvas.cursorX + getKeyboardNo1());
538     endEditing();
539   }
540
541   void deleteGapAtCursor(boolean group)
542   {
543     groupEditing = group;
544     editStartSeq = seqCanvas.cursorY;
545     editLastRes = seqCanvas.cursorX + getKeyboardNo1();
546     editSequence(false, false, seqCanvas.cursorX);
547     endEditing();
548   }
549
550   void insertNucAtCursor(boolean group, String nuc)
551   {
552     // TODO not called - delete?
553     groupEditing = group;
554     editStartSeq = seqCanvas.cursorY;
555     editLastRes = seqCanvas.cursorX;
556     editSequence(false, true, seqCanvas.cursorX + getKeyboardNo1());
557     endEditing();
558   }
559
560   void numberPressed(char value)
561   {
562     if (keyboardNo1 == null)
563     {
564       keyboardNo1 = new StringBuffer();
565     }
566
567     if (keyboardNo2 != null)
568     {
569       keyboardNo2.append(value);
570     }
571     else
572     {
573       keyboardNo1.append(value);
574     }
575   }
576
577   int getKeyboardNo1()
578   {
579     try
580     {
581       if (keyboardNo1 != null)
582       {
583         int value = Integer.parseInt(keyboardNo1.toString());
584         keyboardNo1 = null;
585         return value;
586       }
587     } catch (Exception x)
588     {
589     }
590     keyboardNo1 = null;
591     return 1;
592   }
593
594   int getKeyboardNo2()
595   {
596     try
597     {
598       if (keyboardNo2 != null)
599       {
600         int value = Integer.parseInt(keyboardNo2.toString());
601         keyboardNo2 = null;
602         return value;
603       }
604     } catch (Exception x)
605     {
606     }
607     keyboardNo2 = null;
608     return 1;
609   }
610
611   /**
612    * DOCUMENT ME!
613    * 
614    * @param evt
615    *          DOCUMENT ME!
616    */
617   @Override
618   public void mouseReleased(MouseEvent evt)
619   {
620     boolean didDrag = mouseDragging; // did we come here after a drag
621     mouseDragging = false;
622     mouseWheelPressed = false;
623
624     if (evt.isPopupTrigger()) // Windows: mouseReleased
625     {
626       showPopupMenu(evt);
627       evt.consume();
628       return;
629     }
630
631     if (!editingSeqs)
632     {
633       doMouseReleasedDefineMode(evt, didDrag);
634       return;
635     }
636
637     endEditing();
638   }
639
640   /**
641    * DOCUMENT ME!
642    * 
643    * @param evt
644    *          DOCUMENT ME!
645    */
646   @Override
647   public void mousePressed(MouseEvent evt)
648   {
649     lastMousePress = evt.getPoint();
650
651     if (SwingUtilities.isMiddleMouseButton(evt))
652     {
653       mouseWheelPressed = true;
654       return;
655     }
656
657     boolean isControlDown = Platform.isControlDown(evt);
658     if (evt.isShiftDown() || isControlDown)
659     {
660       editingSeqs = true;
661       if (isControlDown)
662       {
663         groupEditing = true;
664       }
665     }
666     else
667     {
668       doMousePressedDefineMode(evt);
669       return;
670     }
671
672     int seq = findSeq(evt);
673     int res = findColumn(evt);
674
675     if (seq < 0 || res < 0)
676     {
677       return;
678     }
679
680     if ((seq < av.getAlignment().getHeight())
681             && (res < av.getAlignment().getSequenceAt(seq).getLength()))
682     {
683       editStartSeq = seq;
684       editLastRes = res;
685     }
686     else
687     {
688       editStartSeq = -1;
689       editLastRes = -1;
690     }
691
692     return;
693   }
694
695   String lastMessage;
696
697   @Override
698   public void mouseOverSequence(SequenceI sequence, int index, int pos)
699   {
700     String tmp = sequence.hashCode() + " " + index + " " + pos;
701
702     if (lastMessage == null || !lastMessage.equals(tmp))
703     {
704       // System.err.println("mouseOver Sequence: "+tmp);
705       ssm.mouseOverSequence(sequence, index, pos, av);
706     }
707     lastMessage = tmp;
708   }
709
710   /**
711    * Highlight the mapped region described by the search results object (unless
712    * unchanged). This supports highlight of protein while mousing over linked
713    * cDNA and vice versa. The status bar is also updated to show the location of
714    * the start of the highlighted region.
715    */
716   @Override
717   public void highlightSequence(SearchResultsI results)
718   {
719     if (results == null || results.equals(lastSearchResults))
720     {
721       return;
722     }
723     lastSearchResults = results;
724
725     boolean wasScrolled = false;
726
727     if (av.isFollowHighlight())
728     {
729       // don't allow highlight of protein/cDNA to also scroll a complementary
730       // panel,as this sets up a feedback loop (scrolling panel 1 causes moused
731       // over residue to change abruptly, causing highlighted residue in panel 2
732       // to change, causing a scroll in panel 1 etc)
733       ap.setToScrollComplementPanel(false);
734       wasScrolled = ap.scrollToPosition(results, false);
735       if (wasScrolled)
736       {
737         seqCanvas.revalidate();
738       }
739       ap.setToScrollComplementPanel(true);
740     }
741
742     boolean noFastPaint = wasScrolled && av.getWrapAlignment();
743     if (seqCanvas.highlightSearchResults(results, noFastPaint))
744     {
745       setStatusMessage(results);
746     }
747   }
748
749   @Override
750   public VamsasSource getVamsasSource()
751   {
752     return this.ap == null ? null : this.ap.av;
753   }
754
755   @Override
756   public void updateColours(SequenceI seq, int index)
757   {
758     System.out.println("update the seqPanel colours");
759     // repaint();
760   }
761
762   /**
763    * Action on mouse movement is to update the status bar to show the current
764    * sequence position, and (if features are shown) to show any features at the
765    * position in a tooltip. Does nothing if the mouse move does not change
766    * residue position.
767    * 
768    * @param evt
769    */
770   @Override
771   public void mouseMoved(MouseEvent evt)
772   {
773     if (editingSeqs)
774     {
775       // This is because MacOSX creates a mouseMoved
776       // If control is down, other platforms will not.
777       mouseDragged(evt);
778     }
779
780     final int column = findColumn(evt);
781     final int seq = findSeq(evt);
782
783     if (column < 0 || seq < 0 || seq >= av.getAlignment().getHeight())
784     {
785       lastMouseSeq = -1;
786       return;
787     }
788     if (column == lastMouseColumn && seq == lastMouseSeq)
789     {
790       /*
791        * just a pixel move without change of residue
792        */
793       return;
794     }
795     lastMouseColumn = column;
796     lastMouseSeq = seq;
797
798     SequenceI sequence = av.getAlignment().getSequenceAt(seq);
799
800     if (column >= sequence.getLength())
801     {
802       return;
803     }
804
805     /*
806      * set status bar message, returning residue position in sequence
807      */
808     boolean isGapped = Comparison.isGap(sequence.getCharAt(column));
809     final int pos = setStatusMessage(sequence, column, seq);
810     if (ssm != null && !isGapped)
811     {
812       mouseOverSequence(sequence, column, pos);
813     }
814
815     tooltipText.setLength(6); // Cuts the buffer back to <html>
816
817     SequenceGroup[] groups = av.getAlignment().findAllGroups(sequence);
818     if (groups != null)
819     {
820       for (int g = 0; g < groups.length; g++)
821       {
822         if (groups[g].getStartRes() <= column
823                 && groups[g].getEndRes() >= column)
824         {
825           if (!groups[g].getName().startsWith("JTreeGroup")
826                   && !groups[g].getName().startsWith("JGroup"))
827           {
828             tooltipText.append(groups[g].getName());
829           }
830
831           if (groups[g].getDescription() != null)
832           {
833             tooltipText.append(": " + groups[g].getDescription());
834           }
835         }
836       }
837     }
838
839     /*
840      * add any features at the position to the tooltip; if over a gap, only
841      * add features that straddle the gap (pos may be the residue before or
842      * after the gap)
843      */
844     if (av.isShowSequenceFeatures())
845     {
846       List<SequenceFeature> features = ap.getFeatureRenderer()
847               .findFeaturesAtColumn(sequence, column + 1);
848       seqARep.appendFeatures(tooltipText, pos, features,
849               this.ap.getSeqPanel().seqCanvas.fr);
850     }
851     if (tooltipText.length() == 6) // <html>
852     {
853       setToolTipText(null);
854       lastTooltip = null;
855     }
856     else
857     {
858       if (tooltipText.length() > MAX_TOOLTIP_LENGTH) // constant
859       {
860         tooltipText.setLength(MAX_TOOLTIP_LENGTH);
861         tooltipText.append("...");
862       }
863       String textString = tooltipText.toString();
864       if (lastTooltip == null || !lastTooltip.equals(textString))
865       {
866         String formattedTooltipText = JvSwingUtils.wrapTooltip(true,
867                 textString);
868         setToolTipText(formattedTooltipText);
869         lastTooltip = textString;
870       }
871     }
872   }
873
874   private Point lastp = null;
875
876   /*
877    * (non-Javadoc)
878    * 
879    * @see javax.swing.JComponent#getToolTipLocation(java.awt.event.MouseEvent)
880    */
881   @Override
882   public Point getToolTipLocation(MouseEvent event)
883   {
884     int x = event.getX(), w = getWidth();
885     int wdth = (w - x < 200) ? -(w / 2) : 5; // switch sides when tooltip is too
886     // close to edge
887     Point p = lastp;
888     if (!event.isShiftDown() || p == null)
889     {
890       p = (tooltipText != null && tooltipText.length() > 6)
891               ? new Point(event.getX() + wdth, event.getY() - 20)
892               : null;
893     }
894     /*
895      * TODO: try to modify position region is not obcured by tooltip
896      */
897     return lastp = p;
898   }
899
900   String lastTooltip;
901
902   /**
903    * set when the current UI interaction has resulted in a change that requires
904    * shading in overviews and structures to be recalculated. this could be
905    * changed to a something more expressive that indicates what actually has
906    * changed, so selective redraws can be applied (ie. only structures, only
907    * overview, etc)
908    */
909   private boolean updateOverviewAndStructs = false; // TODO: refactor to avcontroller
910
911   /**
912    * set if av.getSelectionGroup() refers to a group that is defined on the
913    * alignment view, rather than a transient selection
914    */
915   // private boolean editingDefinedGroup = false; // TODO: refactor to
916   // avcontroller or viewModel
917
918   /**
919    * Sets the status message in alignment panel, showing the sequence number
920    * (index) and id, and residue and residue position if not at a gap, for the
921    * given sequence and column position. Returns the residue position returned
922    * by Sequence.findPosition. Note this may be for the nearest adjacent residue
923    * if at a gapped position.
924    * 
925    * @param sequence
926    *          aligned sequence object
927    * @param column
928    *          alignment column
929    * @param seqIndex
930    *          index of sequence in alignment
931    * @return sequence position of residue at column, or adjacent residue if at a
932    *         gap
933    */
934   int setStatusMessage(SequenceI sequence, final int column, int seqIndex)
935   {
936     char sequenceChar = sequence.getCharAt(column);
937     int pos = sequence.findPosition(column);
938     setStatusMessage(sequence, seqIndex, sequenceChar, pos);
939
940     return pos;
941   }
942
943   /**
944    * Builds the status message for the current cursor location and writes it to
945    * the status bar, for example
946    * 
947    * <pre>
948    * Sequence 3 ID: FER1_SOLLC
949    * Sequence 5 ID: FER1_PEA Residue: THR (4)
950    * Sequence 5 ID: FER1_PEA Residue: B (3)
951    * Sequence 6 ID: O.niloticus.3 Nucleotide: Uracil (2)
952    * </pre>
953    * 
954    * @param sequence
955    * @param seqIndex
956    *          sequence position in the alignment (1..)
957    * @param sequenceChar
958    *          the character under the cursor
959    * @param residuePos
960    *          the sequence residue position (if not over a gap)
961    */
962   protected void setStatusMessage(SequenceI sequence, int seqIndex,
963           char sequenceChar, int residuePos)
964   {
965     StringBuilder text = new StringBuilder(32);
966
967     /*
968      * Sequence number (if known), and sequence name.
969      */
970     String seqno = seqIndex == -1 ? "" : " " + (seqIndex + 1);
971     text.append("Sequence").append(seqno).append(" ID: ")
972             .append(sequence.getName());
973
974     String residue = null;
975
976     /*
977      * Try to translate the display character to residue name (null for gap).
978      */
979     boolean isGapped = Comparison.isGap(sequenceChar);
980
981     if (!isGapped)
982     {
983       boolean nucleotide = av.getAlignment().isNucleotide();
984       String displayChar = String.valueOf(sequenceChar);
985       if (nucleotide)
986       {
987         residue = ResidueProperties.nucleotideName.get(displayChar);
988       }
989       else
990       {
991         residue = "X".equalsIgnoreCase(displayChar) ? "X"
992                 : ("*".equals(displayChar) ? "STOP"
993                         : ResidueProperties.aa2Triplet.get(displayChar));
994       }
995       text.append(" ").append(nucleotide ? "Nucleotide" : "Residue")
996               .append(": ").append(residue == null ? displayChar : residue);
997
998       text.append(" (").append(Integer.toString(residuePos)).append(")");
999     }
1000     ap.alignFrame.statusBar.setText(text.toString());
1001   }
1002
1003   /**
1004    * Set the status bar message to highlight the first matched position in
1005    * search results.
1006    * 
1007    * @param results
1008    */
1009   private void setStatusMessage(SearchResultsI results)
1010   {
1011     AlignmentI al = this.av.getAlignment();
1012     int sequenceIndex = al.findIndex(results);
1013     if (sequenceIndex == -1)
1014     {
1015       return;
1016     }
1017     SequenceI ds = al.getSequenceAt(sequenceIndex).getDatasetSequence();
1018     for (SearchResultMatchI m : results.getResults())
1019     {
1020       SequenceI seq = m.getSequence();
1021       if (seq.getDatasetSequence() != null)
1022       {
1023         seq = seq.getDatasetSequence();
1024       }
1025
1026       if (seq == ds)
1027       {
1028         int start = m.getStart();
1029         setStatusMessage(seq, sequenceIndex, seq.getCharAt(start - 1),
1030                 start);
1031         return;
1032       }
1033     }
1034   }
1035
1036   /**
1037    * {@inheritDoc}
1038    */
1039   @Override
1040   public void mouseDragged(MouseEvent evt)
1041   {
1042     if (mouseWheelPressed)
1043     {
1044       boolean inSplitFrame = ap.av.getCodingComplement() != null;
1045       boolean copyChanges = inSplitFrame && av.isProteinFontAsCdna();
1046
1047       int oldWidth = av.getCharWidth();
1048
1049       // Which is bigger, left-right or up-down?
1050       if (Math.abs(evt.getY() - lastMousePress.getY()) > Math
1051               .abs(evt.getX() - lastMousePress.getX()))
1052       {
1053         /*
1054          * on drag up or down, decrement or increment font size
1055          */
1056         int fontSize = av.font.getSize();
1057         boolean fontChanged = false;
1058
1059         if (evt.getY() < lastMousePress.getY())
1060         {
1061           fontChanged = true;
1062           fontSize--;
1063         }
1064         else if (evt.getY() > lastMousePress.getY())
1065         {
1066           fontChanged = true;
1067           fontSize++;
1068         }
1069
1070         if (fontSize < 1)
1071         {
1072           fontSize = 1;
1073         }
1074
1075         if (fontChanged)
1076         {
1077           Font newFont = new Font(av.font.getName(), av.font.getStyle(),
1078                   fontSize);
1079           av.setFont(newFont, true);
1080           av.setCharWidth(oldWidth);
1081           ap.fontChanged();
1082           if (copyChanges)
1083           {
1084             ap.av.getCodingComplement().setFont(newFont, true);
1085             SplitFrame splitFrame = (SplitFrame) ap.alignFrame
1086                     .getSplitViewContainer();
1087             splitFrame.adjustLayout();
1088             splitFrame.repaint();
1089           }
1090         }
1091       }
1092       else
1093       {
1094         /*
1095          * on drag left or right, decrement or increment character width
1096          */
1097         int newWidth = 0;
1098         if (evt.getX() < lastMousePress.getX() && av.getCharWidth() > 1)
1099         {
1100           newWidth = av.getCharWidth() - 1;
1101           av.setCharWidth(newWidth);
1102         }
1103         else if (evt.getX() > lastMousePress.getX())
1104         {
1105           newWidth = av.getCharWidth() + 1;
1106           av.setCharWidth(newWidth);
1107         }
1108         if (newWidth > 0)
1109         {
1110           ap.paintAlignment(false, false);
1111           if (copyChanges)
1112           {
1113             /*
1114              * need to ensure newWidth is set on cdna, regardless of which
1115              * panel the mouse drag happened in; protein will compute its 
1116              * character width as 1:1 or 3:1
1117              */
1118             av.getCodingComplement().setCharWidth(newWidth);
1119             SplitFrame splitFrame = (SplitFrame) ap.alignFrame
1120                     .getSplitViewContainer();
1121             splitFrame.adjustLayout();
1122             splitFrame.repaint();
1123           }
1124         }
1125       }
1126
1127       FontMetrics fm = getFontMetrics(av.getFont());
1128       av.validCharWidth = fm.charWidth('M') <= av.getCharWidth();
1129
1130       lastMousePress = evt.getPoint();
1131
1132       return;
1133     }
1134
1135     if (!editingSeqs)
1136     {
1137       doMouseDraggedDefineMode(evt);
1138       return;
1139     }
1140
1141     int res = findColumn(evt);
1142
1143     if (res < 0)
1144     {
1145       res = 0;
1146     }
1147
1148     if ((editLastRes == -1) || (editLastRes == res))
1149     {
1150       return;
1151     }
1152
1153     if ((res < av.getAlignment().getWidth()) && (res < editLastRes))
1154     {
1155       // dragLeft, delete gap
1156       editSequence(false, false, res);
1157     }
1158     else
1159     {
1160       editSequence(true, false, res);
1161     }
1162
1163     mouseDragging = true;
1164     if ((scrollThread != null) && (scrollThread.isRunning()))
1165     {
1166       scrollThread.setEvent(evt);
1167     }
1168   }
1169
1170   /**
1171    * Edits the sequence to insert or delete one or more gaps, in response to a
1172    * mouse drag or cursor mode command. The number of inserts/deletes may be
1173    * specified with the cursor command, or else depends on the mouse event
1174    * (normally one column, but potentially more for a fast mouse drag).
1175    * <p>
1176    * Delete gaps is limited to the number of gaps left of the cursor position
1177    * (mouse drag), or at or right of the cursor position (cursor mode).
1178    * <p>
1179    * In group editing mode (Ctrl or Cmd down), the edit acts on all sequences in
1180    * the current selection group.
1181    * <p>
1182    * In locked editing mode (with a selection group present), inserts/deletions
1183    * within the selection group are limited to its boundaries (and edits outside
1184    * the group stop at its border).
1185    * 
1186    * @param insertGap
1187    *          true to insert gaps, false to delete gaps
1188    * @param editSeq
1189    *          (unused parameter)
1190    * @param startres
1191    *          the column at which to perform the action; the number of columns
1192    *          affected depends on <code>this.lastres</code> (cursor position)
1193    */
1194   synchronized void editSequence(boolean insertGap, boolean editSeq,
1195           final int startres)
1196   {
1197     int fixedLeft = -1;
1198     int fixedRight = -1;
1199     boolean fixedColumns = false;
1200     SequenceGroup sg = av.getSelectionGroup();
1201
1202     final SequenceI seq = av.getAlignment().getSequenceAt(editStartSeq);
1203
1204     // No group, but the sequence may represent a group
1205     if (!groupEditing && av.hasHiddenRows())
1206     {
1207       if (av.isHiddenRepSequence(seq))
1208       {
1209         sg = av.getRepresentedSequences(seq);
1210         groupEditing = true;
1211       }
1212     }
1213
1214     /*
1215      * make a name for the edit action, for
1216      * status bar message and Undo/Redo menu
1217      */
1218     String label = null;
1219     if (groupEditing)
1220     {
1221       label = MessageManager.getString("action.edit_group");
1222     }
1223     else
1224     {
1225       label = seq.getName();
1226       if (label.length() > 10)
1227       {
1228         label = label.substring(0, 10);
1229       }
1230       label = MessageManager.formatMessage("label.edit_params",
1231               new String[]
1232               { label });
1233     }
1234
1235     /*
1236      * initialise the edit command if there is not
1237      * already one being extended
1238      */
1239     if (editCommand == null)
1240     {
1241       editCommand = new EditCommand(label);
1242     }
1243
1244     // Are we editing within a selection group?
1245     boolean inSelectionGroup = sg != null
1246             && sg.getSequences(av.getHiddenRepSequences()).contains(seq);
1247     if (groupEditing || inSelectionGroup)
1248     {
1249       fixedColumns = true;
1250
1251       // sg might be null as the user may only see 1 sequence,
1252       // but the sequence represents a group
1253       if (sg == null)
1254       {
1255         if (!av.isHiddenRepSequence(seq))
1256         {
1257           endEditing();
1258           return;
1259         }
1260         sg = av.getRepresentedSequences(seq);
1261       }
1262
1263       fixedLeft = sg.getStartRes();
1264       fixedRight = sg.getEndRes();
1265
1266       if ((startres < fixedLeft && editLastRes >= fixedLeft)
1267               || (startres >= fixedLeft && editLastRes < fixedLeft)
1268               || (startres > fixedRight && editLastRes <= fixedRight)
1269               || (startres <= fixedRight && editLastRes > fixedRight))
1270       {
1271         endEditing();
1272         return;
1273       }
1274
1275       if (fixedLeft > startres)
1276       {
1277         fixedRight = fixedLeft - 1;
1278         fixedLeft = 0;
1279       }
1280       else if (fixedRight < startres)
1281       {
1282         fixedLeft = fixedRight;
1283         fixedRight = -1;
1284       }
1285     }
1286
1287     if (av.hasHiddenColumns())
1288     {
1289       fixedColumns = true;
1290       int y1 = av.getAlignment().getHiddenColumns()
1291               .getNextHiddenBoundary(true, startres);
1292       int y2 = av.getAlignment().getHiddenColumns()
1293               .getNextHiddenBoundary(false, startres);
1294
1295       if ((insertGap && startres > y1 && editLastRes < y1)
1296               || (!insertGap && startres < y2 && editLastRes > y2))
1297       {
1298         endEditing();
1299         return;
1300       }
1301
1302       // System.out.print(y1+" "+y2+" "+fixedLeft+" "+fixedRight+"~~");
1303       // Selection spans a hidden region
1304       if (fixedLeft < y1 && (fixedRight > y2 || fixedRight == -1))
1305       {
1306         if (startres >= y2)
1307         {
1308           fixedLeft = y2;
1309         }
1310         else
1311         {
1312           fixedRight = y2 - 1;
1313         }
1314       }
1315     }
1316
1317     boolean endEditing = doEditSequence(insertGap, editSeq, startres,
1318             fixedRight, fixedColumns, sg);
1319
1320     /*
1321      * report what actually happened (might be less than
1322      * what was requested), by inspecting the edit command added
1323      */
1324     String msg = getEditStatusMessage(editCommand);
1325     ap.alignFrame.statusBar.setText(msg == null ? " " : msg);
1326     if (endEditing)
1327     {
1328       endEditing();
1329     }
1330
1331     editLastRes = startres;
1332     seqCanvas.repaint();
1333   }
1334
1335   /**
1336    * A helper method that performs the requested editing to insert or delete
1337    * gaps (if possible). Answers true if the edit was successful, false if could
1338    * only be performed in part or not at all. Failure may occur in 'locked edit'
1339    * mode, when an insertion requires a matching gapped position (or column) to
1340    * delete, and deletion requires a gapped position (or column) to remove.
1341    * 
1342    * @param insertGap
1343    * @param editSeq
1344    * @param startres
1345    * @param fixedRight
1346    * @param fixedColumns
1347    * @param sg
1348    * @return
1349    */
1350   protected boolean doEditSequence(boolean insertGap, boolean editSeq,
1351           final int startres, int fixedRight, boolean fixedColumns,
1352           SequenceGroup sg)
1353   {
1354     final SequenceI seq = av.getAlignment().getSequenceAt(editStartSeq);
1355     SequenceI[] seqs = new SequenceI[] { seq };
1356
1357     if (groupEditing)
1358     {
1359       List<SequenceI> vseqs = sg.getSequences(av.getHiddenRepSequences());
1360       int g, groupSize = vseqs.size();
1361       SequenceI[] groupSeqs = new SequenceI[groupSize];
1362       for (g = 0; g < groupSeqs.length; g++)
1363       {
1364         groupSeqs[g] = vseqs.get(g);
1365       }
1366
1367       // drag to right
1368       if (insertGap)
1369       {
1370         // If the user has selected the whole sequence, and is dragging to
1371         // the right, we can still extend the alignment and selectionGroup
1372         if (sg.getStartRes() == 0 && sg.getEndRes() == fixedRight
1373                 && sg.getEndRes() == av.getAlignment().getWidth() - 1)
1374         {
1375           sg.setEndRes(
1376                   av.getAlignment().getWidth() + startres - editLastRes);
1377           fixedRight = sg.getEndRes();
1378         }
1379
1380         // Is it valid with fixed columns??
1381         // Find the next gap before the end
1382         // of the visible region boundary
1383         boolean blank = false;
1384         for (; fixedRight > editLastRes; fixedRight--)
1385         {
1386           blank = true;
1387
1388           for (g = 0; g < groupSize; g++)
1389           {
1390             for (int j = 0; j < startres - editLastRes; j++)
1391             {
1392               if (!Comparison
1393                       .isGap(groupSeqs[g].getCharAt(fixedRight - j)))
1394               {
1395                 blank = false;
1396                 break;
1397               }
1398             }
1399           }
1400           if (blank)
1401           {
1402             break;
1403           }
1404         }
1405
1406         if (!blank)
1407         {
1408           if (sg.getSize() == av.getAlignment().getHeight())
1409           {
1410             if ((av.hasHiddenColumns()
1411                     && startres < av.getAlignment().getHiddenColumns()
1412                             .getNextHiddenBoundary(false, startres)))
1413             {
1414               return true;
1415             }
1416
1417             int alWidth = av.getAlignment().getWidth();
1418             if (av.hasHiddenRows())
1419             {
1420               int hwidth = av.getAlignment().getHiddenSequences()
1421                       .getWidth();
1422               if (hwidth > alWidth)
1423               {
1424                 alWidth = hwidth;
1425               }
1426             }
1427             // We can still insert gaps if the selectionGroup
1428             // contains all the sequences
1429             sg.setEndRes(sg.getEndRes() + startres - editLastRes);
1430             fixedRight = alWidth + startres - editLastRes;
1431           }
1432           else
1433           {
1434             return true;
1435           }
1436         }
1437       }
1438
1439       // drag to left
1440       else if (!insertGap)
1441       {
1442         // / Are we able to delete?
1443         // ie are all columns blank?
1444
1445         for (g = 0; g < groupSize; g++)
1446         {
1447           for (int j = startres; j < editLastRes; j++)
1448           {
1449             if (groupSeqs[g].getLength() <= j)
1450             {
1451               continue;
1452             }
1453
1454             if (!Comparison.isGap(groupSeqs[g].getCharAt(j)))
1455             {
1456               // Not a gap, block edit not valid
1457               return true;
1458             }
1459           }
1460         }
1461       }
1462
1463       if (insertGap)
1464       {
1465         // dragging to the right
1466         if (fixedColumns && fixedRight != -1)
1467         {
1468           for (int j = editLastRes; j < startres; j++)
1469           {
1470             insertGap(j, groupSeqs, fixedRight);
1471           }
1472         }
1473         else
1474         {
1475           appendEdit(Action.INSERT_GAP, groupSeqs, startres,
1476                   startres - editLastRes, false);
1477         }
1478       }
1479       else
1480       {
1481         // dragging to the left
1482         if (fixedColumns && fixedRight != -1)
1483         {
1484           for (int j = editLastRes; j > startres; j--)
1485           {
1486             deleteChar(startres, groupSeqs, fixedRight);
1487           }
1488         }
1489         else
1490         {
1491           appendEdit(Action.DELETE_GAP, groupSeqs, startres,
1492                   editLastRes - startres, false);
1493         }
1494       }
1495     }
1496     else
1497     {
1498       /*
1499        * editing a single sequence
1500        */
1501       if (insertGap)
1502       {
1503         // dragging to the right
1504         if (fixedColumns && fixedRight != -1)
1505         {
1506           for (int j = editLastRes; j < startres; j++)
1507           {
1508             if (!insertGap(j, seqs, fixedRight))
1509             {
1510               /*
1511                * e.g. cursor mode command asked for 
1512                * more inserts than are possible
1513                */
1514               return true;
1515             }
1516           }
1517         }
1518         else
1519         {
1520           appendEdit(Action.INSERT_GAP, seqs, editLastRes,
1521                   startres - editLastRes, false);
1522         }
1523       }
1524       else
1525       {
1526         if (!editSeq)
1527         {
1528           // dragging to the left
1529           if (fixedColumns && fixedRight != -1)
1530           {
1531             for (int j = editLastRes; j > startres; j--)
1532             {
1533               if (!Comparison.isGap(seq.getCharAt(startres)))
1534               {
1535                 return true;
1536               }
1537               deleteChar(startres, seqs, fixedRight);
1538             }
1539           }
1540           else
1541           {
1542             // could be a keyboard edit trying to delete none gaps
1543             int max = 0;
1544             for (int m = startres; m < editLastRes; m++)
1545             {
1546               if (!Comparison.isGap(seq.getCharAt(m)))
1547               {
1548                 break;
1549               }
1550               max++;
1551             }
1552             if (max > 0)
1553             {
1554               appendEdit(Action.DELETE_GAP, seqs, startres, max, false);
1555             }
1556           }
1557         }
1558         else
1559         {// insertGap==false AND editSeq==TRUE;
1560           if (fixedColumns && fixedRight != -1)
1561           {
1562             for (int j = editLastRes; j < startres; j++)
1563             {
1564               insertGap(j, seqs, fixedRight);
1565             }
1566           }
1567           else
1568           {
1569             appendEdit(Action.INSERT_NUC, seqs, editLastRes,
1570                     startres - editLastRes, false);
1571           }
1572         }
1573       }
1574     }
1575
1576     return false;
1577   }
1578
1579   /**
1580    * Constructs an informative status bar message while dragging to insert or
1581    * delete gaps. Answers null if inserts and deletes cancel out.
1582    * 
1583    * @param editCommand
1584    *          a command containing the list of individual edits
1585    * @return
1586    */
1587   protected static String getEditStatusMessage(EditCommand editCommand)
1588   {
1589     if (editCommand == null)
1590     {
1591       return null;
1592     }
1593
1594     /*
1595      * add any inserts, and subtract any deletes,  
1596      * not counting those auto-inserted when doing a 'locked edit'
1597      * (so only counting edits 'under the cursor')
1598      */
1599     int count = 0;
1600     for (Edit cmd : editCommand.getEdits())
1601     {
1602       if (!cmd.isSystemGenerated())
1603       {
1604         count += cmd.getAction() == Action.INSERT_GAP ? cmd.getNumber()
1605                 : -cmd.getNumber();
1606       }
1607     }
1608
1609     if (count == 0)
1610     {
1611       /*
1612        * inserts and deletes cancel out
1613        */
1614       return null;
1615     }
1616
1617     String msgKey = count > 1 ? "label.insert_gaps"
1618             : (count == 1 ? "label.insert_gap"
1619                     : (count == -1 ? "label.delete_gap"
1620                             : "label.delete_gaps"));
1621     count = Math.abs(count);
1622
1623     return MessageManager.formatMessage(msgKey, String.valueOf(count));
1624   }
1625
1626   /**
1627    * Inserts one gap at column j, deleting the right-most gapped column up to
1628    * (and including) fixedColumn. Returns true if the edit is successful, false
1629    * if no blank column is available to allow the insertion to be balanced by a
1630    * deletion.
1631    * 
1632    * @param j
1633    * @param seq
1634    * @param fixedColumn
1635    * @return
1636    */
1637   boolean insertGap(int j, SequenceI[] seq, int fixedColumn)
1638   {
1639     int blankColumn = fixedColumn;
1640     for (int s = 0; s < seq.length; s++)
1641     {
1642       // Find the next gap before the end of the visible region boundary
1643       // If lastCol > j, theres a boundary after the gap insertion
1644
1645       for (blankColumn = fixedColumn; blankColumn > j; blankColumn--)
1646       {
1647         if (Comparison.isGap(seq[s].getCharAt(blankColumn)))
1648         {
1649           // Theres a space, so break and insert the gap
1650           break;
1651         }
1652       }
1653
1654       if (blankColumn <= j)
1655       {
1656         blankColumn = fixedColumn;
1657         endEditing();
1658         return false;
1659       }
1660     }
1661
1662     appendEdit(Action.DELETE_GAP, seq, blankColumn, 1, true);
1663
1664     appendEdit(Action.INSERT_GAP, seq, j, 1, false);
1665
1666     return true;
1667   }
1668
1669   /**
1670    * Helper method to add and perform one edit action
1671    * 
1672    * @param action
1673    * @param seq
1674    * @param pos
1675    * @param count
1676    * @param systemGenerated
1677    *          true if the edit is a 'balancing' delete (or insert) to match a
1678    *          user's insert (or delete) in a locked editing region
1679    */
1680   protected void appendEdit(Action action, SequenceI[] seq, int pos,
1681           int count, boolean systemGenerated)
1682   {
1683
1684     final Edit edit = new EditCommand().new Edit(action, seq, pos, count,
1685             av.getAlignment().getGapCharacter());
1686     edit.setSystemGenerated(systemGenerated);
1687
1688     editCommand.appendEdit(edit, av.getAlignment(), true, null);
1689   }
1690
1691   /**
1692    * Deletes the character at column j, and inserts a gap at fixedColumn, in
1693    * each of the given sequences. The caller should ensure that all sequences
1694    * are gapped in column j.
1695    * 
1696    * @param j
1697    * @param seqs
1698    * @param fixedColumn
1699    */
1700   void deleteChar(int j, SequenceI[] seqs, int fixedColumn)
1701   {
1702     appendEdit(Action.DELETE_GAP, seqs, j, 1, false);
1703
1704     appendEdit(Action.INSERT_GAP, seqs, fixedColumn, 1, true);
1705   }
1706
1707   /**
1708    * DOCUMENT ME!
1709    * 
1710    * @param e
1711    *          DOCUMENT ME!
1712    */
1713   @Override
1714   public void mouseEntered(MouseEvent e)
1715   {
1716     if (oldSeq < 0)
1717     {
1718       oldSeq = 0;
1719     }
1720
1721     if ((scrollThread != null) && (scrollThread.isRunning()))
1722     {
1723       scrollThread.stopScrolling();
1724       scrollThread = null;
1725     }
1726   }
1727
1728   /**
1729    * DOCUMENT ME!
1730    * 
1731    * @param e
1732    *          DOCUMENT ME!
1733    */
1734   @Override
1735   public void mouseExited(MouseEvent e)
1736   {
1737     if (av.getWrapAlignment())
1738     {
1739       return;
1740     }
1741
1742     if (mouseDragging && scrollThread == null)
1743     {
1744       scrollThread = new ScrollThread();
1745     }
1746   }
1747
1748   /**
1749    * Handler for double-click on a position with one or more sequence features.
1750    * Opens the Amend Features dialog to allow feature details to be amended, or
1751    * the feature deleted.
1752    */
1753   @Override
1754   public void mouseClicked(MouseEvent evt)
1755   {
1756     SequenceGroup sg = null;
1757     SequenceI sequence = av.getAlignment().getSequenceAt(findSeq(evt));
1758     if (evt.getClickCount() > 1)
1759     {
1760       sg = av.getSelectionGroup();
1761       if (sg != null && sg.getSize() == 1
1762               && sg.getEndRes() - sg.getStartRes() < 2)
1763       {
1764         av.setSelectionGroup(null);
1765       }
1766
1767       int column = findColumn(evt);
1768
1769       /*
1770        * find features at the position (if not gapped), or straddling
1771        * the position (if at a gap)
1772        */
1773       List<SequenceFeature> features = seqCanvas.getFeatureRenderer()
1774               .findFeaturesAtColumn(sequence, column + 1);
1775
1776       if (!features.isEmpty())
1777       {
1778         /*
1779          * highlight the first feature at the position on the alignment
1780          */
1781         SearchResultsI highlight = new SearchResults();
1782         highlight.addResult(sequence, features.get(0).getBegin(), features
1783                 .get(0).getEnd());
1784         seqCanvas.highlightSearchResults(highlight, false);
1785
1786         /*
1787          * open the Amend Features dialog; clear highlighting afterwards,
1788          * whether changes were made or not
1789          */
1790         List<SequenceI> seqs = Collections.singletonList(sequence);
1791         seqCanvas.getFeatureRenderer().amendFeatures(seqs, features, false,
1792                 ap);
1793         av.setSearchResults(null); // clear highlighting
1794         seqCanvas.repaint(); // draw new/amended features
1795       }
1796     }
1797   }
1798
1799   @Override
1800   public void mouseWheelMoved(MouseWheelEvent e)
1801   {
1802     e.consume();
1803     double wheelRotation = e.getPreciseWheelRotation();
1804     if (wheelRotation > 0)
1805     {
1806       if (e.isShiftDown())
1807       {
1808         av.getRanges().scrollRight(true);
1809
1810       }
1811       else
1812       {
1813         av.getRanges().scrollUp(false);
1814       }
1815     }
1816     else if (wheelRotation < 0)
1817     {
1818       if (e.isShiftDown())
1819       {
1820         av.getRanges().scrollRight(false);
1821       }
1822       else
1823       {
1824         av.getRanges().scrollUp(true);
1825       }
1826     }
1827
1828     /*
1829      * update status bar and tooltip for new position
1830      * (need to synthesize a mouse movement to refresh tooltip)
1831      */
1832     mouseMoved(e);
1833     ToolTipManager.sharedInstance().mouseMoved(e);
1834   }
1835
1836   /**
1837    * DOCUMENT ME!
1838    * 
1839    * @param evt
1840    *          DOCUMENT ME!
1841    */
1842   public void doMousePressedDefineMode(MouseEvent evt)
1843   {
1844     final int res = findColumn(evt);
1845     final int seq = findSeq(evt);
1846     oldSeq = seq;
1847     updateOverviewAndStructs = false;
1848
1849     startWrapBlock = wrappedBlock;
1850
1851     if (av.getWrapAlignment() && seq > av.getAlignment().getHeight())
1852     {
1853       JvOptionPane.showInternalMessageDialog(Desktop.desktop,
1854               MessageManager.getString(
1855                       "label.cannot_edit_annotations_in_wrapped_view"),
1856               MessageManager.getString("label.wrapped_view_no_edit"),
1857               JvOptionPane.WARNING_MESSAGE);
1858       return;
1859     }
1860
1861     if (seq < 0 || res < 0)
1862     {
1863       return;
1864     }
1865
1866     SequenceI sequence = av.getAlignment().getSequenceAt(seq);
1867
1868     if ((sequence == null) || (res > sequence.getLength()))
1869     {
1870       return;
1871     }
1872
1873     stretchGroup = av.getSelectionGroup();
1874
1875     if (stretchGroup == null || !stretchGroup.contains(sequence, res))
1876     {
1877       stretchGroup = av.getAlignment().findGroup(sequence, res);
1878       if (stretchGroup != null)
1879       {
1880         // only update the current selection if the popup menu has a group to
1881         // focus on
1882         av.setSelectionGroup(stretchGroup);
1883       }
1884     }
1885
1886     if (evt.isPopupTrigger()) // Mac: mousePressed
1887     {
1888       showPopupMenu(evt);
1889       return;
1890     }
1891
1892     /*
1893      * defer right-mouse click handling to mouseReleased on Windows
1894      * (where isPopupTrigger() will answer true)
1895      * NB isRightMouseButton is also true for Cmd-click on Mac
1896      */
1897     if (SwingUtilities.isRightMouseButton(evt) && !Platform.isAMac())
1898     {
1899       return;
1900     }
1901
1902     if (av.cursorMode)
1903     {
1904       seqCanvas.cursorX = findColumn(evt);
1905       seqCanvas.cursorY = findSeq(evt);
1906       seqCanvas.repaint();
1907       return;
1908     }
1909
1910     if (stretchGroup == null)
1911     {
1912       createStretchGroup(res, sequence);
1913     }
1914
1915     if (stretchGroup != null)
1916     {
1917       stretchGroup.addPropertyChangeListener(seqCanvas);
1918     }
1919
1920     seqCanvas.repaint();
1921   }
1922
1923   private void createStretchGroup(int res, SequenceI sequence)
1924   {
1925     // Only if left mouse button do we want to change group sizes
1926     // define a new group here
1927     SequenceGroup sg = new SequenceGroup();
1928     sg.setStartRes(res);
1929     sg.setEndRes(res);
1930     sg.addSequence(sequence, false);
1931     av.setSelectionGroup(sg);
1932     stretchGroup = sg;
1933
1934     if (av.getConservationSelected())
1935     {
1936       SliderPanel.setConservationSlider(ap, av.getResidueShading(),
1937               ap.getViewName());
1938     }
1939
1940     if (av.getAbovePIDThreshold())
1941     {
1942       SliderPanel.setPIDSliderSource(ap, av.getResidueShading(),
1943               ap.getViewName());
1944     }
1945     // TODO: stretchGroup will always be not null. Is this a merge error ?
1946     // or is there a threading issue here?
1947     if ((stretchGroup != null) && (stretchGroup.getEndRes() == res))
1948     {
1949       // Edit end res position of selected group
1950       changeEndRes = true;
1951     }
1952     else if ((stretchGroup != null) && (stretchGroup.getStartRes() == res))
1953     {
1954       // Edit end res position of selected group
1955       changeStartRes = true;
1956     }
1957     stretchGroup.getWidth();
1958
1959   }
1960
1961   /**
1962    * Build and show a pop-up menu at the right-click mouse position
1963    * 
1964    * @param evt
1965    * @param res
1966    * @param sequences
1967    */
1968   void showPopupMenu(MouseEvent evt)
1969   {
1970     final int column = findColumn(evt);
1971     final int seq = findSeq(evt);
1972     SequenceI sequence = av.getAlignment().getSequenceAt(seq);
1973     List<SequenceFeature> features = ap.getFeatureRenderer()
1974             .findFeaturesAtColumn(sequence, column + 1);
1975
1976     PopupMenu pop = new PopupMenu(ap, null, features);
1977     pop.show(this, evt.getX(), evt.getY());
1978   }
1979
1980   /**
1981    * Update the display after mouse up on a selection or group
1982    * 
1983    * @param evt
1984    *          mouse released event details
1985    * @param afterDrag
1986    *          true if this event is happening after a mouse drag (rather than a
1987    *          mouse down)
1988    */
1989   public void doMouseReleasedDefineMode(MouseEvent evt, boolean afterDrag)
1990   {
1991     if (stretchGroup == null)
1992     {
1993       return;
1994     }
1995
1996     stretchGroup.removePropertyChangeListener(seqCanvas);
1997
1998     // always do this - annotation has own state
1999     // but defer colourscheme update until hidden sequences are passed in
2000     boolean vischange = stretchGroup.recalcConservation(true);
2001     updateOverviewAndStructs |= vischange && av.isSelectionDefinedGroup()
2002             && afterDrag;
2003     if (stretchGroup.cs != null)
2004     {
2005       stretchGroup.cs.alignmentChanged(stretchGroup,
2006               av.getHiddenRepSequences());
2007
2008       ResidueShaderI groupColourScheme = stretchGroup
2009               .getGroupColourScheme();
2010       String name = stretchGroup.getName();
2011       if (stretchGroup.cs.conservationApplied())
2012       {
2013         SliderPanel.setConservationSlider(ap, groupColourScheme, name);
2014       }
2015       if (stretchGroup.cs.getThreshold() > 0)
2016       {
2017         SliderPanel.setPIDSliderSource(ap, groupColourScheme, name);
2018       }
2019     }
2020     PaintRefresher.Refresh(this, av.getSequenceSetId());
2021     // TODO: structure colours only need updating if stretchGroup used to or now
2022     // does contain sequences with structure views
2023     ap.paintAlignment(updateOverviewAndStructs, updateOverviewAndStructs);
2024     updateOverviewAndStructs = false;
2025     changeEndRes = false;
2026     changeStartRes = false;
2027     stretchGroup = null;
2028     av.sendSelection();
2029   }
2030
2031   /**
2032    * DOCUMENT ME!
2033    * 
2034    * @param evt
2035    *          DOCUMENT ME!
2036    */
2037   public void doMouseDraggedDefineMode(MouseEvent evt)
2038   {
2039     int res = findColumn(evt);
2040     int y = findSeq(evt);
2041
2042     if (wrappedBlock != startWrapBlock)
2043     {
2044       return;
2045     }
2046
2047     if (stretchGroup == null)
2048     {
2049       return;
2050     }
2051
2052     if (res >= av.getAlignment().getWidth())
2053     {
2054       res = av.getAlignment().getWidth() - 1;
2055     }
2056
2057     if (stretchGroup.getEndRes() == res)
2058     {
2059       // Edit end res position of selected group
2060       changeEndRes = true;
2061     }
2062     else if (stretchGroup.getStartRes() == res)
2063     {
2064       // Edit start res position of selected group
2065       changeStartRes = true;
2066     }
2067
2068     if (res < av.getRanges().getStartRes())
2069     {
2070       res = av.getRanges().getStartRes();
2071     }
2072
2073     if (changeEndRes)
2074     {
2075       if (res > (stretchGroup.getStartRes() - 1))
2076       {
2077         stretchGroup.setEndRes(res);
2078         updateOverviewAndStructs |= av.isSelectionDefinedGroup();
2079       }
2080     }
2081     else if (changeStartRes)
2082     {
2083       if (res < (stretchGroup.getEndRes() + 1))
2084       {
2085         stretchGroup.setStartRes(res);
2086         updateOverviewAndStructs |= av.isSelectionDefinedGroup();
2087       }
2088     }
2089
2090     int dragDirection = 0;
2091
2092     if (y > oldSeq)
2093     {
2094       dragDirection = 1;
2095     }
2096     else if (y < oldSeq)
2097     {
2098       dragDirection = -1;
2099     }
2100
2101     while ((y != oldSeq) && (oldSeq > -1)
2102             && (y < av.getAlignment().getHeight()))
2103     {
2104       // This routine ensures we don't skip any sequences, as the
2105       // selection is quite slow.
2106       Sequence seq = (Sequence) av.getAlignment().getSequenceAt(oldSeq);
2107
2108       oldSeq += dragDirection;
2109
2110       if (oldSeq < 0)
2111       {
2112         break;
2113       }
2114
2115       Sequence nextSeq = (Sequence) av.getAlignment().getSequenceAt(oldSeq);
2116
2117       if (stretchGroup.getSequences(null).contains(nextSeq))
2118       {
2119         stretchGroup.deleteSequence(seq, false);
2120         updateOverviewAndStructs |= av.isSelectionDefinedGroup();
2121       }
2122       else
2123       {
2124         if (seq != null)
2125         {
2126           stretchGroup.addSequence(seq, false);
2127         }
2128
2129         stretchGroup.addSequence(nextSeq, false);
2130         updateOverviewAndStructs |= av.isSelectionDefinedGroup();
2131       }
2132     }
2133
2134     if (oldSeq < 0)
2135     {
2136       oldSeq = -1;
2137     }
2138
2139     mouseDragging = true;
2140
2141     if ((scrollThread != null) && (scrollThread.isRunning()))
2142     {
2143       scrollThread.setEvent(evt);
2144     }
2145
2146     /*
2147      * construct a status message showing the range of the selection
2148      */
2149     StringBuilder status = new StringBuilder(64);
2150     List<SequenceI> seqs = stretchGroup.getSequences();
2151     String name = seqs.get(0).getName();
2152     if (name.length() > 20)
2153     {
2154       name = name.substring(0, 20);
2155     }
2156     status.append(name).append(" - ");
2157     name = seqs.get(seqs.size() - 1).getName();
2158     if (name.length() > 20)
2159     {
2160       name = name.substring(0, 20);
2161     }
2162     status.append(name).append(" ");
2163     int startRes = stretchGroup.getStartRes();
2164     status.append(" cols ").append(String.valueOf(startRes + 1))
2165             .append("-");
2166     int endRes = stretchGroup.getEndRes();
2167     status.append(String.valueOf(endRes + 1));
2168     status.append(" (").append(String.valueOf(seqs.size())).append(" x ")
2169             .append(String.valueOf(endRes - startRes + 1)).append(")");
2170     ap.alignFrame.setStatus(status.toString());
2171   }
2172
2173   void scrollCanvas(MouseEvent evt)
2174   {
2175     if (evt == null)
2176     {
2177       if ((scrollThread != null) && (scrollThread.isRunning()))
2178       {
2179         scrollThread.stopScrolling();
2180         scrollThread = null;
2181       }
2182       mouseDragging = false;
2183     }
2184     else
2185     {
2186       if (scrollThread == null)
2187       {
2188         scrollThread = new ScrollThread();
2189       }
2190
2191       mouseDragging = true;
2192       scrollThread.setEvent(evt);
2193     }
2194
2195   }
2196
2197   // this class allows scrolling off the bottom of the visible alignment
2198   class ScrollThread extends Thread
2199   {
2200     MouseEvent evt;
2201
2202     private volatile boolean threadRunning = true;
2203
2204     public ScrollThread()
2205     {
2206       start();
2207     }
2208
2209     public void setEvent(MouseEvent e)
2210     {
2211       evt = e;
2212     }
2213
2214     public void stopScrolling()
2215     {
2216       threadRunning = false;
2217     }
2218
2219     public boolean isRunning()
2220     {
2221       return threadRunning;
2222     }
2223
2224     @Override
2225     public void run()
2226     {
2227       while (threadRunning)
2228       {
2229         if (evt != null)
2230         {
2231           if (mouseDragging && (evt.getY() < 0)
2232                   && (av.getRanges().getStartSeq() > 0))
2233           {
2234             av.getRanges().scrollUp(true);
2235           }
2236
2237           if (mouseDragging && (evt.getY() >= getHeight()) && (av
2238                   .getAlignment().getHeight() > av.getRanges().getEndSeq()))
2239           {
2240             av.getRanges().scrollUp(false);
2241           }
2242
2243           if (mouseDragging && (evt.getX() < 0))
2244           {
2245             av.getRanges().scrollRight(false);
2246           }
2247           else if (mouseDragging && (evt.getX() >= getWidth()))
2248           {
2249             av.getRanges().scrollRight(true);
2250           }
2251         }
2252
2253         try
2254         {
2255           Thread.sleep(20);
2256         } catch (Exception ex)
2257         {
2258         }
2259       }
2260     }
2261   }
2262
2263   /**
2264    * modify current selection according to a received message.
2265    */
2266   @Override
2267   public void selection(SequenceGroup seqsel, ColumnSelection colsel,
2268           HiddenColumns hidden, SelectionSource source)
2269   {
2270     // TODO: fix this hack - source of messages is align viewport, but SeqPanel
2271     // handles selection messages...
2272     // TODO: extend config options to allow user to control if selections may be
2273     // shared between viewports.
2274     boolean iSentTheSelection = (av == source
2275             || (source instanceof AlignViewport
2276                     && ((AlignmentViewport) source).getSequenceSetId()
2277                             .equals(av.getSequenceSetId())));
2278
2279     if (iSentTheSelection)
2280     {
2281       // respond to our own event by updating dependent dialogs
2282       if (ap.getCalculationDialog() != null)
2283       {
2284         ap.getCalculationDialog().validateCalcTypes();
2285       }
2286
2287       return;
2288     }
2289
2290     // process further ?
2291     if (!av.followSelection)
2292     {
2293       return;
2294     }
2295
2296     /*
2297      * Ignore the selection if there is one of our own pending.
2298      */
2299     if (av.isSelectionGroupChanged(false) || av.isColSelChanged(false))
2300     {
2301       return;
2302     }
2303
2304     /*
2305      * Check for selection in a view of which this one is a dna/protein
2306      * complement.
2307      */
2308     if (selectionFromTranslation(seqsel, colsel, hidden, source))
2309     {
2310       return;
2311     }
2312
2313     // do we want to thread this ? (contention with seqsel and colsel locks, I
2314     // suspect)
2315     /*
2316      * only copy colsel if there is a real intersection between
2317      * sequence selection and this panel's alignment
2318      */
2319     boolean repaint = false;
2320     boolean copycolsel = false;
2321
2322     SequenceGroup sgroup = null;
2323     if (seqsel != null && seqsel.getSize() > 0)
2324     {
2325       if (av.getAlignment() == null)
2326       {
2327         Cache.log.warn("alignviewport av SeqSetId=" + av.getSequenceSetId()
2328                 + " ViewId=" + av.getViewId()
2329                 + " 's alignment is NULL! returning immediately.");
2330         return;
2331       }
2332       sgroup = seqsel.intersect(av.getAlignment(),
2333               (av.hasHiddenRows()) ? av.getHiddenRepSequences() : null);
2334       if ((sgroup != null && sgroup.getSize() > 0))
2335       {
2336         copycolsel = true;
2337       }
2338     }
2339     if (sgroup != null && sgroup.getSize() > 0)
2340     {
2341       av.setSelectionGroup(sgroup);
2342     }
2343     else
2344     {
2345       av.setSelectionGroup(null);
2346     }
2347     av.isSelectionGroupChanged(true);
2348     repaint = true;
2349
2350     if (copycolsel)
2351     {
2352       // the current selection is unset or from a previous message
2353       // so import the new colsel.
2354       if (colsel == null || colsel.isEmpty())
2355       {
2356         if (av.getColumnSelection() != null)
2357         {
2358           av.getColumnSelection().clear();
2359           repaint = true;
2360         }
2361       }
2362       else
2363       {
2364         // TODO: shift colSel according to the intersecting sequences
2365         if (av.getColumnSelection() == null)
2366         {
2367           av.setColumnSelection(new ColumnSelection(colsel));
2368         }
2369         else
2370         {
2371           av.getColumnSelection().setElementsFrom(colsel,
2372                   av.getAlignment().getHiddenColumns());
2373         }
2374       }
2375       av.isColSelChanged(true);
2376       repaint = true;
2377     }
2378
2379     if (copycolsel && av.hasHiddenColumns()
2380             && (av.getAlignment().getHiddenColumns() == null))
2381     {
2382       System.err.println("Bad things");
2383     }
2384     if (repaint) // always true!
2385     {
2386       // probably finessing with multiple redraws here
2387       PaintRefresher.Refresh(this, av.getSequenceSetId());
2388       // ap.paintAlignment(false);
2389     }
2390
2391     // lastly, update dependent dialogs
2392     if (ap.getCalculationDialog() != null)
2393     {
2394       ap.getCalculationDialog().validateCalcTypes();
2395     }
2396
2397   }
2398
2399   /**
2400    * If this panel is a cdna/protein translation view of the selection source,
2401    * tries to map the source selection to a local one, and returns true. Else
2402    * returns false.
2403    * 
2404    * @param seqsel
2405    * @param colsel
2406    * @param source
2407    */
2408   protected boolean selectionFromTranslation(SequenceGroup seqsel,
2409           ColumnSelection colsel, HiddenColumns hidden,
2410           SelectionSource source)
2411   {
2412     if (!(source instanceof AlignViewportI))
2413     {
2414       return false;
2415     }
2416     final AlignViewportI sourceAv = (AlignViewportI) source;
2417     if (sourceAv.getCodingComplement() != av
2418             && av.getCodingComplement() != sourceAv)
2419     {
2420       return false;
2421     }
2422
2423     /*
2424      * Map sequence selection
2425      */
2426     SequenceGroup sg = MappingUtils.mapSequenceGroup(seqsel, sourceAv, av);
2427     av.setSelectionGroup(sg);
2428     av.isSelectionGroupChanged(true);
2429
2430     /*
2431      * Map column selection
2432      */
2433     // ColumnSelection cs = MappingUtils.mapColumnSelection(colsel, sourceAv,
2434     // av);
2435     ColumnSelection cs = new ColumnSelection();
2436     HiddenColumns hs = new HiddenColumns();
2437     MappingUtils.mapColumnSelection(colsel, hidden, sourceAv, av, cs, hs);
2438     av.setColumnSelection(cs);
2439     av.getAlignment().setHiddenColumns(hs);
2440
2441     // lastly, update any dependent dialogs
2442     if (ap.getCalculationDialog() != null)
2443     {
2444       ap.getCalculationDialog().validateCalcTypes();
2445     }
2446
2447     PaintRefresher.Refresh(this, av.getSequenceSetId());
2448
2449     return true;
2450   }
2451
2452   /**
2453    * 
2454    * @return null or last search results handled by this panel
2455    */
2456   public SearchResultsI getLastSearchResults()
2457   {
2458     return lastSearchResults;
2459   }
2460 }