JAL-2547 tooltip/AmendFeatures on gap straddled by feature, not for
[jalview.git] / src / jalview / appletgui / 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.appletgui;
22
23 import jalview.api.AlignViewportI;
24 import jalview.commands.EditCommand;
25 import jalview.commands.EditCommand.Action;
26 import jalview.datamodel.AlignmentI;
27 import jalview.datamodel.ColumnSelection;
28 import jalview.datamodel.HiddenColumns;
29 import jalview.datamodel.SearchResultMatchI;
30 import jalview.datamodel.SearchResults;
31 import jalview.datamodel.SearchResultsI;
32 import jalview.datamodel.Sequence;
33 import jalview.datamodel.SequenceFeature;
34 import jalview.datamodel.SequenceGroup;
35 import jalview.datamodel.SequenceI;
36 import jalview.schemes.ResidueProperties;
37 import jalview.structure.SelectionListener;
38 import jalview.structure.SelectionSource;
39 import jalview.structure.SequenceListener;
40 import jalview.structure.StructureSelectionManager;
41 import jalview.structure.VamsasSource;
42 import jalview.util.Comparison;
43 import jalview.util.MappingUtils;
44 import jalview.util.MessageManager;
45 import jalview.viewmodel.AlignmentViewport;
46 import jalview.viewmodel.ViewportRanges;
47
48 import java.awt.BorderLayout;
49 import java.awt.Font;
50 import java.awt.FontMetrics;
51 import java.awt.Panel;
52 import java.awt.Point;
53 import java.awt.event.InputEvent;
54 import java.awt.event.MouseEvent;
55 import java.awt.event.MouseListener;
56 import java.awt.event.MouseMotionListener;
57 import java.util.ArrayList;
58 import java.util.Collections;
59 import java.util.List;
60 import java.util.ListIterator;
61 import java.util.Vector;
62
63 public class SeqPanel extends Panel implements MouseMotionListener,
64         MouseListener, SequenceListener, SelectionListener
65 {
66
67   public SeqCanvas seqCanvas;
68
69   public AlignmentPanel ap;
70
71   protected int lastres;
72
73   protected int startseq;
74
75   protected AlignViewport av;
76
77   // if character is inserted or deleted, we will need to recalculate the
78   // conservation
79   boolean seqEditOccurred = false;
80
81   ScrollThread scrollThread = null;
82
83   boolean mouseDragging = false;
84
85   boolean editingSeqs = false;
86
87   boolean groupEditing = false;
88
89   int oldSeq = -1;
90
91   boolean changeEndSeq = false;
92
93   boolean changeStartSeq = false;
94
95   boolean changeEndRes = false;
96
97   boolean changeStartRes = false;
98
99   SequenceGroup stretchGroup = null;
100
101   StringBuffer keyboardNo1;
102
103   StringBuffer keyboardNo2;
104
105   boolean mouseWheelPressed = false;
106
107   Point lastMousePress;
108
109   EditCommand editCommand;
110
111   StructureSelectionManager ssm;
112
113   public SeqPanel(AlignViewport avp, AlignmentPanel p)
114   {
115     this.av = avp;
116
117     seqCanvas = new SeqCanvas(avp);
118     setLayout(new BorderLayout());
119     add(seqCanvas);
120
121     ap = p;
122
123     seqCanvas.addMouseMotionListener(this);
124     seqCanvas.addMouseListener(this);
125     ssm = StructureSelectionManager.getStructureSelectionManager(av.applet);
126     ssm.addStructureViewerListener(this);
127     ssm.addSelectionListener(this);
128
129     seqCanvas.repaint();
130   }
131
132   void endEditing()
133   {
134     if (editCommand != null && editCommand.getSize() > 0)
135     {
136       ap.alignFrame.addHistoryItem(editCommand);
137       av.firePropertyChange("alignment", null, av.getAlignment()
138               .getSequences());
139     }
140
141     startseq = -1;
142     lastres = -1;
143     editingSeqs = false;
144     groupEditing = false;
145     keyboardNo1 = null;
146     keyboardNo2 = null;
147     editCommand = null;
148   }
149
150   void setCursorRow()
151   {
152     seqCanvas.cursorY = getKeyboardNo1() - 1;
153     scrollToVisible();
154   }
155
156   void setCursorColumn()
157   {
158     seqCanvas.cursorX = getKeyboardNo1() - 1;
159     scrollToVisible();
160   }
161
162   void setCursorRowAndColumn()
163   {
164     if (keyboardNo2 == null)
165     {
166       keyboardNo2 = new StringBuffer();
167     }
168     else
169     {
170       seqCanvas.cursorX = getKeyboardNo1() - 1;
171       seqCanvas.cursorY = getKeyboardNo2() - 1;
172       scrollToVisible();
173     }
174   }
175
176   void setCursorPosition()
177   {
178     SequenceI sequence = av.getAlignment().getSequenceAt(seqCanvas.cursorY);
179
180     seqCanvas.cursorX = sequence.findIndex(getKeyboardNo1()) - 1;
181     scrollToVisible();
182   }
183
184   void moveCursor(int dx, int dy)
185   {
186     seqCanvas.cursorX += dx;
187     seqCanvas.cursorY += dy;
188     if (av.hasHiddenColumns()
189             && !av.getAlignment().getHiddenColumns()
190                     .isVisible(seqCanvas.cursorX))
191     {
192       int original = seqCanvas.cursorX - dx;
193       int maxWidth = av.getAlignment().getWidth();
194
195       while (!av.getAlignment().getHiddenColumns()
196               .isVisible(seqCanvas.cursorX)
197               && seqCanvas.cursorX < maxWidth && seqCanvas.cursorX > 0)
198       {
199         seqCanvas.cursorX += dx;
200       }
201
202       if (seqCanvas.cursorX >= maxWidth
203               || !av.getAlignment().getHiddenColumns()
204                       .isVisible(seqCanvas.cursorX))
205       {
206         seqCanvas.cursorX = original;
207       }
208     }
209     scrollToVisible();
210   }
211
212   void scrollToVisible()
213   {
214     if (seqCanvas.cursorX < 0)
215     {
216       seqCanvas.cursorX = 0;
217     }
218     else if (seqCanvas.cursorX > av.getAlignment().getWidth() - 1)
219     {
220       seqCanvas.cursorX = av.getAlignment().getWidth() - 1;
221     }
222
223     if (seqCanvas.cursorY < 0)
224     {
225       seqCanvas.cursorY = 0;
226     }
227     else if (seqCanvas.cursorY > av.getAlignment().getHeight() - 1)
228     {
229       seqCanvas.cursorY = av.getAlignment().getHeight() - 1;
230     }
231
232     endEditing();
233     if (av.getWrapAlignment())
234     {
235       av.getRanges().scrollToWrappedVisible(seqCanvas.cursorX);
236     }
237     else
238     {
239       ViewportRanges ranges = av.getRanges();
240       HiddenColumns hidden = av.getAlignment().getHiddenColumns();
241       while (seqCanvas.cursorY < ranges.getStartSeq())
242       {
243         ranges.scrollUp(true);
244       }
245       while (seqCanvas.cursorY > ranges.getEndSeq())
246       {
247         ranges.scrollUp(false);
248       }
249       while (seqCanvas.cursorX < hidden.adjustForHiddenColumns(ranges
250               .getStartRes()))
251       {
252
253         if (!ranges.scrollRight(false))
254         {
255           break;
256         }
257       }
258       while (seqCanvas.cursorX > hidden.adjustForHiddenColumns(ranges
259               .getEndRes()))
260       {
261         if (!ranges.scrollRight(true))
262         {
263           break;
264         }
265       }
266     }
267     setStatusMessage(av.getAlignment().getSequenceAt(seqCanvas.cursorY),
268             seqCanvas.cursorX, seqCanvas.cursorY);
269
270     seqCanvas.repaint();
271   }
272
273   void setSelectionAreaAtCursor(boolean topLeft)
274   {
275     SequenceI sequence = av.getAlignment().getSequenceAt(seqCanvas.cursorY);
276
277     if (av.getSelectionGroup() != null)
278     {
279       SequenceGroup sg = av.getSelectionGroup();
280       // Find the top and bottom of this group
281       int min = av.getAlignment().getHeight(), max = 0;
282       for (int i = 0; i < sg.getSize(); i++)
283       {
284         int index = av.getAlignment().findIndex(sg.getSequenceAt(i));
285         if (index > max)
286         {
287           max = index;
288         }
289         if (index < min)
290         {
291           min = index;
292         }
293       }
294
295       max++;
296
297       if (topLeft)
298       {
299         sg.setStartRes(seqCanvas.cursorX);
300         if (sg.getEndRes() < seqCanvas.cursorX)
301         {
302           sg.setEndRes(seqCanvas.cursorX);
303         }
304
305         min = seqCanvas.cursorY;
306       }
307       else
308       {
309         sg.setEndRes(seqCanvas.cursorX);
310         if (sg.getStartRes() > seqCanvas.cursorX)
311         {
312           sg.setStartRes(seqCanvas.cursorX);
313         }
314
315         max = seqCanvas.cursorY + 1;
316       }
317
318       if (min > max)
319       {
320         // Only the user can do this
321         av.setSelectionGroup(null);
322       }
323       else
324       {
325         // Now add any sequences between min and max
326         sg.clear();
327         for (int i = min; i < max; i++)
328         {
329           sg.addSequence(av.getAlignment().getSequenceAt(i), false);
330         }
331       }
332     }
333
334     if (av.getSelectionGroup() == null)
335     {
336       SequenceGroup sg = new SequenceGroup();
337       sg.setStartRes(seqCanvas.cursorX);
338       sg.setEndRes(seqCanvas.cursorX);
339       sg.addSequence(sequence, false);
340       av.setSelectionGroup(sg);
341     }
342     ap.paintAlignment(false);
343     av.sendSelection();
344   }
345
346   void insertGapAtCursor(boolean group)
347   {
348     groupEditing = group;
349     startseq = seqCanvas.cursorY;
350     lastres = seqCanvas.cursorX;
351     editSequence(true, seqCanvas.cursorX + getKeyboardNo1());
352     endEditing();
353   }
354
355   void deleteGapAtCursor(boolean group)
356   {
357     groupEditing = group;
358     startseq = seqCanvas.cursorY;
359     lastres = seqCanvas.cursorX + getKeyboardNo1();
360     editSequence(false, seqCanvas.cursorX);
361     endEditing();
362   }
363
364   void numberPressed(char value)
365   {
366     if (keyboardNo1 == null)
367     {
368       keyboardNo1 = new StringBuffer();
369     }
370
371     if (keyboardNo2 != null)
372     {
373       keyboardNo2.append(value);
374     }
375     else
376     {
377       keyboardNo1.append(value);
378     }
379   }
380
381   int getKeyboardNo1()
382   {
383     try
384     {
385       if (keyboardNo1 != null)
386       {
387         int value = Integer.parseInt(keyboardNo1.toString());
388         keyboardNo1 = null;
389         return value;
390       }
391     } catch (Exception x)
392     {
393     }
394     keyboardNo1 = null;
395     return 1;
396   }
397
398   int getKeyboardNo2()
399   {
400     try
401     {
402       if (keyboardNo2 != null)
403       {
404         int value = Integer.parseInt(keyboardNo2.toString());
405         keyboardNo2 = null;
406         return value;
407       }
408     } catch (Exception x)
409     {
410     }
411     keyboardNo2 = null;
412     return 1;
413   }
414
415   /**
416    * Set status message in alignment panel
417    * 
418    * @param sequence
419    *          aligned sequence object
420    * @param column
421    *          alignment column
422    * @param seq
423    *          index of sequence in alignment
424    * @return position of column in sequence or -1 if at gap
425    */
426   void setStatusMessage(SequenceI sequence, int column, int seq)
427   {
428     // TODO remove duplication of identical gui method
429     StringBuilder text = new StringBuilder(32);
430     String seqno = seq == -1 ? "" : " " + (seq + 1);
431     text.append("Sequence" + seqno + " ID: " + sequence.getName());
432
433     String residue = null;
434     /*
435      * Try to translate the display character to residue name (null for gap).
436      */
437     final String displayChar = String.valueOf(sequence.getCharAt(column));
438     if (av.getAlignment().isNucleotide())
439     {
440       residue = ResidueProperties.nucleotideName.get(displayChar);
441       if (residue != null)
442       {
443         text.append(" Nucleotide: ").append(residue);
444       }
445     }
446     else
447     {
448       residue = "X".equalsIgnoreCase(displayChar) ? "X" : ("*"
449               .equals(displayChar) ? "STOP" : ResidueProperties.aa2Triplet
450               .get(displayChar));
451       if (residue != null)
452       {
453         text.append(" Residue: ").append(residue);
454       }
455     }
456
457     int pos = -1;
458     if (residue != null)
459     {
460       pos = sequence.findPosition(column);
461       text.append(" (").append(Integer.toString(pos)).append(")");
462     }
463
464     ap.alignFrame.statusBar.setText(text.toString());
465   }
466
467   /**
468    * Set the status bar message to highlight the first matched position in
469    * search results.
470    * 
471    * @param results
472    * @return true if results were matched, false if not
473    */
474   private boolean setStatusMessage(SearchResultsI results)
475   {
476     AlignmentI al = this.av.getAlignment();
477     int sequenceIndex = al.findIndex(results);
478     if (sequenceIndex == -1)
479     {
480       return false;
481     }
482     SequenceI ds = al.getSequenceAt(sequenceIndex).getDatasetSequence();
483     for (SearchResultMatchI m : results.getResults())
484     {
485       SequenceI seq = m.getSequence();
486       if (seq.getDatasetSequence() != null)
487       {
488         seq = seq.getDatasetSequence();
489       }
490
491       if (seq == ds)
492       {
493         /*
494          * Convert position in sequence (base 1) to sequence character array
495          * index (base 0)
496          */
497         int start = m.getStart() - m.getSequence().getStart();
498         setStatusMessage(seq, start, sequenceIndex);
499         return true;
500       }
501     }
502     return false;
503   }
504
505   @Override
506   public void mousePressed(MouseEvent evt)
507   {
508     lastMousePress = evt.getPoint();
509
510     // For now, ignore the mouseWheel font resizing on Macs
511     // As the Button2_mask always seems to be true
512     if ((evt.getModifiers() & InputEvent.BUTTON2_MASK) == InputEvent.BUTTON2_MASK
513             && !av.MAC)
514     {
515       mouseWheelPressed = true;
516       return;
517     }
518
519     if (evt.isShiftDown() || evt.isControlDown() || evt.isAltDown())
520     {
521       if (evt.isControlDown() || evt.isAltDown())
522       {
523         groupEditing = true;
524       }
525       editingSeqs = true;
526     }
527     else
528     {
529       doMousePressedDefineMode(evt);
530       return;
531     }
532
533     int seq = findSeq(evt);
534     int res = findRes(evt);
535
536     if (seq < 0 || res < 0)
537     {
538       return;
539     }
540
541     if ((seq < av.getAlignment().getHeight())
542             && (res < av.getAlignment().getSequenceAt(seq).getLength()))
543     {
544       startseq = seq;
545       lastres = res;
546     }
547     else
548     {
549       startseq = -1;
550       lastres = -1;
551     }
552
553     return;
554   }
555
556   @Override
557   public void mouseClicked(MouseEvent evt)
558   {
559     SequenceI sequence = av.getAlignment().getSequenceAt(findSeq(evt));
560     if (evt.getClickCount() > 1)
561     {
562       if (av.getSelectionGroup() != null
563               && av.getSelectionGroup().getSize() == 1
564               && av.getSelectionGroup().getEndRes()
565                       - av.getSelectionGroup().getStartRes() < 2)
566       {
567         av.setSelectionGroup(null);
568       }
569
570       int column = findRes(evt);
571       boolean isGapped = Comparison.isGap(sequence.getCharAt(column));
572       List<SequenceFeature> features = findFeaturesAtRes(sequence,
573               sequence.findPosition(column));
574       if (isGapped)
575       {
576         removeAdjacentFeatures(features, column + 1, sequence);
577       }
578
579       if (!features.isEmpty())
580       {
581         SearchResultsI highlight = new SearchResults();
582         highlight.addResult(sequence, features.get(0).getBegin(), features
583                 .get(0).getEnd());
584         seqCanvas.highlightSearchResults(highlight);
585         seqCanvas.getFeatureRenderer().amendFeatures(
586                 Collections.singletonList(sequence), features, false, ap);
587
588         seqCanvas.highlightSearchResults(null);
589       }
590     }
591   }
592
593   @Override
594   public void mouseReleased(MouseEvent evt)
595   {
596     boolean didDrag = mouseDragging; // did we come here after a drag
597     mouseDragging = false;
598     mouseWheelPressed = false;
599
600     if (!editingSeqs)
601     {
602       doMouseReleasedDefineMode(evt, didDrag);
603       return;
604     }
605
606     endEditing();
607
608   }
609
610   int startWrapBlock = -1;
611
612   int wrappedBlock = -1;
613
614   int findRes(MouseEvent evt)
615   {
616     int res = 0;
617     int x = evt.getX();
618
619     if (av.getWrapAlignment())
620     {
621
622       int hgap = av.getCharHeight();
623       if (av.getScaleAboveWrapped())
624       {
625         hgap += av.getCharHeight();
626       }
627
628       int cHeight = av.getAlignment().getHeight() * av.getCharHeight()
629               + hgap + seqCanvas.getAnnotationHeight();
630
631       int y = evt.getY();
632       y -= hgap;
633       x -= seqCanvas.LABEL_WEST;
634
635       int cwidth = seqCanvas.getWrappedCanvasWidth(getSize().width);
636       if (cwidth < 1)
637       {
638         return 0;
639       }
640
641       wrappedBlock = y / cHeight;
642       wrappedBlock += av.getRanges().getStartRes() / cwidth;
643
644       res = wrappedBlock * cwidth + x / av.getCharWidth();
645
646     }
647     else
648     {
649       res = (x / av.getCharWidth()) + av.getRanges().getStartRes();
650     }
651
652     if (av.hasHiddenColumns())
653     {
654       res = av.getAlignment().getHiddenColumns()
655               .adjustForHiddenColumns(res);
656     }
657
658     return res;
659
660   }
661
662   int findSeq(MouseEvent evt)
663   {
664     final int sqnum = findAlRow(evt);
665     return (sqnum < 0) ? 0 : sqnum;
666   }
667
668   /**
669    * 
670    * @param evt
671    * @return row in alignment that was selected (or -1 for column selection)
672    */
673   private int findAlRow(MouseEvent evt)
674   {
675     int seq = 0;
676     int y = evt.getY();
677
678     if (av.getWrapAlignment())
679     {
680       int hgap = av.getCharHeight();
681       if (av.getScaleAboveWrapped())
682       {
683         hgap += av.getCharHeight();
684       }
685
686       int cHeight = av.getAlignment().getHeight() * av.getCharHeight()
687               + hgap + seqCanvas.getAnnotationHeight();
688
689       y -= hgap;
690
691       seq = Math.min((y % cHeight) / av.getCharHeight(), av.getAlignment()
692               .getHeight() - 1);
693       if (seq < 0)
694       {
695         seq = -1;
696       }
697     }
698     else
699     {
700       seq = Math.min((y / av.getCharHeight())
701               + av.getRanges().getStartSeq(),
702               av
703               .getAlignment().getHeight() - 1);
704       if (seq < 0)
705       {
706         seq = -1;
707       }
708     }
709
710     return seq;
711   }
712
713   public void doMousePressed(MouseEvent evt)
714   {
715
716     int seq = findSeq(evt);
717     int res = findRes(evt);
718
719     if (seq < av.getAlignment().getHeight()
720             && res < av.getAlignment().getSequenceAt(seq).getLength())
721     {
722       // char resstr = align.getSequenceAt(seq).getSequence().charAt(res);
723       // Find the residue's position in the sequence (res is the position
724       // in the alignment
725
726       startseq = seq;
727       lastres = res;
728     }
729     else
730     {
731       startseq = -1;
732       lastres = -1;
733     }
734
735     return;
736   }
737
738   String lastMessage;
739
740   @Override
741   public void mouseOverSequence(SequenceI sequence, int index, int pos)
742   {
743     String tmp = sequence.hashCode() + index + "";
744     if (lastMessage == null || !lastMessage.equals(tmp))
745     {
746       ssm.mouseOverSequence(sequence, index, pos, av);
747     }
748
749     lastMessage = tmp;
750   }
751
752   @Override
753   public void highlightSequence(SearchResultsI results)
754   {
755     if (av.isFollowHighlight())
756     {
757       // don't allow highlight of protein/cDNA to also scroll a complementary
758       // panel,as this sets up a feedback loop (scrolling panel 1 causes moused
759       // over residue to change abruptly, causing highlighted residue in panel 2
760       // to change, causing a scroll in panel 1 etc)
761       ap.setToScrollComplementPanel(false);
762       if (ap.scrollToPosition(results, true))
763       {
764         ap.alignFrame.repaint();
765       }
766       ap.setToScrollComplementPanel(true);
767     }
768     setStatusMessage(results);
769     seqCanvas.highlightSearchResults(results);
770
771   }
772
773   @Override
774   public VamsasSource getVamsasSource()
775   {
776     return this.ap == null ? null : this.ap.av;
777   }
778
779   @Override
780   public void updateColours(SequenceI seq, int index)
781   {
782     System.out.println("update the seqPanel colours");
783     // repaint();
784   }
785
786   @Override
787   public void mouseMoved(MouseEvent evt)
788   {
789     final int column = findRes(evt);
790     int seq = findSeq(evt);
791
792     if (seq >= av.getAlignment().getHeight() || seq < 0 || column < 0)
793     {
794       if (tooltip != null)
795       {
796         tooltip.setTip("");
797       }
798       return;
799     }
800
801     SequenceI sequence = av.getAlignment().getSequenceAt(seq);
802     if (column > sequence.getLength())
803     {
804       if (tooltip != null)
805       {
806         tooltip.setTip("");
807       }
808       return;
809     }
810
811     final char ch = sequence.getCharAt(column);
812     boolean isGapped = Comparison.isGap(ch);
813     // find residue at column (or nearest if at a gap)
814     int respos = sequence.findPosition(column);
815
816     if (ssm != null && !isGapped)
817     {
818       mouseOverSequence(sequence, column, respos);
819     }
820
821     StringBuilder text = new StringBuilder();
822     text.append("Sequence ").append(Integer.toString(seq + 1))
823             .append(" ID: ").append(sequence.getName());
824
825     if (!isGapped)
826     {
827       if (av.getAlignment().isNucleotide())
828       {
829         String base = ResidueProperties.nucleotideName.get(ch);
830         text.append(" Nucleotide: ").append(base == null ? ch : base);
831       }
832       else
833       {
834         String residue = (ch == 'x' || ch == 'X') ? "X"
835                 : ResidueProperties.aa2Triplet
836                 .get(String.valueOf(ch));
837         text.append(" Residue: ").append(residue == null ? ch : residue);
838       }
839       text.append(" (").append(Integer.toString(respos)).append(")");
840     }
841
842     ap.alignFrame.statusBar.setText(text.toString());
843
844     StringBuilder tooltipText = new StringBuilder();
845     SequenceGroup[] groups = av.getAlignment().findAllGroups(sequence);
846     if (groups != null)
847     {
848       for (int g = 0; g < groups.length; g++)
849       {
850         if (groups[g].getStartRes() <= column && groups[g].getEndRes() >= column)
851         {
852           if (!groups[g].getName().startsWith("JTreeGroup")
853                   && !groups[g].getName().startsWith("JGroup"))
854           {
855             tooltipText.append(groups[g].getName()).append(" ");
856           }
857           if (groups[g].getDescription() != null)
858           {
859             tooltipText.append(groups[g].getDescription());
860           }
861           tooltipText.append("\n");
862         }
863       }
864     }
865
866     /*
867      * add feature details to tooltip, including any that straddle
868      * a gapped position
869      */
870     if (av.isShowSequenceFeatures())
871     {
872       List<SequenceFeature> allFeatures = findFeaturesAtRes(sequence,
873               sequence.findPosition(column));
874       if (isGapped)
875       {
876         removeAdjacentFeatures(allFeatures, column + 1, sequence);
877       }
878       for (SequenceFeature sf : allFeatures)
879       {
880         tooltipText.append(sf.getType() + " " + sf.begin + ":" + sf.end);
881
882         if (sf.getDescription() != null)
883         {
884           tooltipText.append(" " + sf.getDescription());
885         }
886
887         if (sf.getValue("status") != null)
888         {
889           String status = sf.getValue("status").toString();
890           if (status.length() > 0)
891           {
892             tooltipText.append(" (" + sf.getValue("status") + ")");
893           }
894         }
895         tooltipText.append("\n");
896       }
897     }
898
899     if (tooltip == null)
900     {
901       tooltip = new Tooltip(tooltipText.toString(), seqCanvas);
902     }
903     else
904     {
905       tooltip.setTip(tooltipText.toString());
906     }
907   }
908
909   /**
910    * Removes from the list of features any that start after, or end before, the
911    * given column position. This allows us to retain only those features
912    * adjacent to a gapped position that straddle the position.
913    * 
914    * @param features
915    * @param column
916    *          alignment column (1..)
917    * @param sequence
918    */
919   protected void removeAdjacentFeatures(List<SequenceFeature> features,
920           int column, SequenceI sequence)
921   {
922     // TODO should this be an AlignViewController method (shared by gui)?
923     ListIterator<SequenceFeature> it = features.listIterator();
924     while (it.hasNext())
925     {
926       SequenceFeature sf = it.next();
927       if (sequence.findIndex(sf.getBegin()) > column
928               || sequence.findIndex(sf.getEnd()) < column)
929       {
930         it.remove();
931       }
932     }
933   }
934
935   List<SequenceFeature> findFeaturesAtRes(SequenceI sequence, int res)
936   {
937     List<SequenceFeature> result = new ArrayList<SequenceFeature>();
938     SequenceFeature[] features = sequence.getSequenceFeatures();
939     if (features != null)
940     {
941       for (int i = 0; i < features.length; i++)
942       {
943         if (av.getFeaturesDisplayed() == null
944                 || !av.getFeaturesDisplayed().isVisible(
945                         features[i].getType()))
946         {
947           continue;
948         }
949
950         if (features[i].featureGroup != null
951                 && !seqCanvas.fr.checkGroupVisibility(
952                         features[i].featureGroup, false))
953         {
954           continue;
955         }
956
957         if ((features[i].getBegin() <= res)
958                 && (features[i].getEnd() >= res))
959         {
960           result.add(features[i]);
961         }
962       }
963     }
964
965     return result;
966   }
967
968   Tooltip tooltip;
969
970   /**
971    * set when the current UI interaction has resulted in a change that requires
972    * overview shading to be recalculated. this could be changed to something
973    * more expressive that indicates what actually has changed, so selective
974    * redraws can be applied
975    */
976   private boolean needOverviewUpdate; // TODO: refactor to avcontroller
977
978   @Override
979   public void mouseDragged(MouseEvent evt)
980   {
981     if (mouseWheelPressed)
982     {
983       int oldWidth = av.getCharWidth();
984
985       // Which is bigger, left-right or up-down?
986       if (Math.abs(evt.getY() - lastMousePress.y) > Math.abs(evt.getX()
987               - lastMousePress.x))
988       {
989         int fontSize = av.font.getSize();
990
991         if (evt.getY() < lastMousePress.y && av.getCharHeight() > 1)
992         {
993           fontSize--;
994         }
995         else if (evt.getY() > lastMousePress.y)
996         {
997           fontSize++;
998         }
999
1000         if (fontSize < 1)
1001         {
1002           fontSize = 1;
1003         }
1004
1005         av.setFont(
1006                 new Font(av.font.getName(), av.font.getStyle(), fontSize),
1007                 true);
1008         av.setCharWidth(oldWidth);
1009       }
1010       else
1011       {
1012         if (evt.getX() < lastMousePress.x && av.getCharWidth() > 1)
1013         {
1014           av.setCharWidth(av.getCharWidth() - 1);
1015         }
1016         else if (evt.getX() > lastMousePress.x)
1017         {
1018           av.setCharWidth(av.getCharWidth() + 1);
1019         }
1020
1021         if (av.getCharWidth() < 1)
1022         {
1023           av.setCharWidth(1);
1024         }
1025       }
1026
1027       ap.fontChanged();
1028
1029       FontMetrics fm = getFontMetrics(av.getFont());
1030       av.validCharWidth = fm.charWidth('M') <= av.getCharWidth();
1031
1032       lastMousePress = evt.getPoint();
1033
1034       ap.paintAlignment(false);
1035       ap.annotationPanel.image = null;
1036       return;
1037     }
1038
1039     if (!editingSeqs)
1040     {
1041       doMouseDraggedDefineMode(evt);
1042       return;
1043     }
1044
1045     int res = findRes(evt);
1046
1047     if (res < 0)
1048     {
1049       res = 0;
1050     }
1051
1052     if ((lastres == -1) || (lastres == res))
1053     {
1054       return;
1055     }
1056
1057     if ((res < av.getAlignment().getWidth()) && (res < lastres))
1058     {
1059       // dragLeft, delete gap
1060       editSequence(false, res);
1061     }
1062     else
1063     {
1064       editSequence(true, res);
1065     }
1066
1067     mouseDragging = true;
1068     if (scrollThread != null)
1069     {
1070       scrollThread.setEvent(evt);
1071     }
1072
1073   }
1074
1075   synchronized void editSequence(boolean insertGap, int startres)
1076   {
1077     int fixedLeft = -1;
1078     int fixedRight = -1;
1079     boolean fixedColumns = false;
1080     SequenceGroup sg = av.getSelectionGroup();
1081
1082     SequenceI seq = av.getAlignment().getSequenceAt(startseq);
1083
1084     if (!groupEditing && av.hasHiddenRows())
1085     {
1086       if (av.isHiddenRepSequence(seq))
1087       {
1088         sg = av.getRepresentedSequences(seq);
1089         groupEditing = true;
1090       }
1091     }
1092
1093     StringBuffer message = new StringBuffer();
1094     if (groupEditing)
1095     {
1096       message.append(MessageManager.getString("action.edit_group")).append(
1097               ":");
1098       if (editCommand == null)
1099       {
1100         editCommand = new EditCommand(
1101                 MessageManager.getString("action.edit_group"));
1102       }
1103     }
1104     else
1105     {
1106       message.append(MessageManager.getString("label.edit_sequence"))
1107               .append(" " + seq.getName());
1108       String label = seq.getName();
1109       if (label.length() > 10)
1110       {
1111         label = label.substring(0, 10);
1112       }
1113       if (editCommand == null)
1114       {
1115         editCommand = new EditCommand(MessageManager.formatMessage(
1116                 "label.edit_params", new String[] { label }));
1117       }
1118     }
1119
1120     if (insertGap)
1121     {
1122       message.append(" insert ");
1123     }
1124     else
1125     {
1126       message.append(" delete ");
1127     }
1128
1129     message.append(Math.abs(startres - lastres) + " gaps.");
1130     ap.alignFrame.statusBar.setText(message.toString());
1131
1132     // Are we editing within a selection group?
1133     if (groupEditing
1134             || (sg != null && sg.getSequences(av.getHiddenRepSequences())
1135                     .contains(seq)))
1136     {
1137       fixedColumns = true;
1138
1139       // sg might be null as the user may only see 1 sequence,
1140       // but the sequence represents a group
1141       if (sg == null)
1142       {
1143         if (!av.isHiddenRepSequence(seq))
1144         {
1145           endEditing();
1146           return;
1147         }
1148
1149         sg = av.getRepresentedSequences(seq);
1150       }
1151
1152       fixedLeft = sg.getStartRes();
1153       fixedRight = sg.getEndRes();
1154
1155       if ((startres < fixedLeft && lastres >= fixedLeft)
1156               || (startres >= fixedLeft && lastres < fixedLeft)
1157               || (startres > fixedRight && lastres <= fixedRight)
1158               || (startres <= fixedRight && lastres > fixedRight))
1159       {
1160         endEditing();
1161         return;
1162       }
1163
1164       if (fixedLeft > startres)
1165       {
1166         fixedRight = fixedLeft - 1;
1167         fixedLeft = 0;
1168       }
1169       else if (fixedRight < startres)
1170       {
1171         fixedLeft = fixedRight;
1172         fixedRight = -1;
1173       }
1174     }
1175
1176     if (av.hasHiddenColumns())
1177     {
1178       fixedColumns = true;
1179       int y1 = av.getAlignment().getHiddenColumns()
1180               .getHiddenBoundaryLeft(startres);
1181       int y2 = av.getAlignment().getHiddenColumns()
1182               .getHiddenBoundaryRight(startres);
1183
1184       if ((insertGap && startres > y1 && lastres < y1)
1185               || (!insertGap && startres < y2 && lastres > y2))
1186       {
1187         endEditing();
1188         return;
1189       }
1190
1191       // System.out.print(y1+" "+y2+" "+fixedLeft+" "+fixedRight+"~~");
1192       // Selection spans a hidden region
1193       if (fixedLeft < y1 && (fixedRight > y2 || fixedRight == -1))
1194       {
1195         if (startres >= y2)
1196         {
1197           fixedLeft = y2;
1198         }
1199         else
1200         {
1201           fixedRight = y2 - 1;
1202         }
1203       }
1204     }
1205
1206     if (groupEditing)
1207     {
1208       SequenceI[] groupSeqs = sg.getSequences(av.getHiddenRepSequences())
1209               .toArray(new SequenceI[0]);
1210
1211       // drag to right
1212       if (insertGap)
1213       {
1214         // If the user has selected the whole sequence, and is dragging to
1215         // the right, we can still extend the alignment and selectionGroup
1216         if (sg.getStartRes() == 0 && sg.getEndRes() == fixedRight
1217                 && sg.getEndRes() == av.getAlignment().getWidth() - 1)
1218         {
1219           sg.setEndRes(av.getAlignment().getWidth() + startres - lastres);
1220           fixedRight = sg.getEndRes();
1221         }
1222
1223         // Is it valid with fixed columns??
1224         // Find the next gap before the end
1225         // of the visible region boundary
1226         boolean blank = false;
1227         for (fixedRight = fixedRight; fixedRight > lastres; fixedRight--)
1228         {
1229           blank = true;
1230
1231           for (SequenceI gs : groupSeqs)
1232           {
1233             for (int j = 0; j < startres - lastres; j++)
1234             {
1235               if (!jalview.util.Comparison.isGap(gs.getCharAt(fixedRight
1236                       - j)))
1237               {
1238                 blank = false;
1239                 break;
1240               }
1241             }
1242           }
1243           if (blank)
1244           {
1245             break;
1246           }
1247         }
1248
1249         if (!blank)
1250         {
1251           if (sg.getSize() == av.getAlignment().getHeight())
1252           {
1253             if ((av.hasHiddenColumns() && startres < av.getAlignment()
1254                     .getHiddenColumns().getHiddenBoundaryRight(startres)))
1255             {
1256               endEditing();
1257               return;
1258             }
1259
1260             int alWidth = av.getAlignment().getWidth();
1261             if (av.hasHiddenRows())
1262             {
1263               int hwidth = av.getAlignment().getHiddenSequences()
1264                       .getWidth();
1265               if (hwidth > alWidth)
1266               {
1267                 alWidth = hwidth;
1268               }
1269             }
1270             // We can still insert gaps if the selectionGroup
1271             // contains all the sequences
1272             sg.setEndRes(sg.getEndRes() + startres - lastres);
1273             fixedRight = alWidth + startres - lastres;
1274           }
1275           else
1276           {
1277             endEditing();
1278             return;
1279           }
1280         }
1281       }
1282
1283       // drag to left
1284       else if (!insertGap)
1285       {
1286         // / Are we able to delete?
1287         // ie are all columns blank?
1288
1289         for (SequenceI gs : groupSeqs)
1290         {
1291           for (int j = startres; j < lastres; j++)
1292           {
1293             if (gs.getLength() <= j)
1294             {
1295               continue;
1296             }
1297
1298             if (!jalview.util.Comparison.isGap(gs.getCharAt(j)))
1299             {
1300               // Not a gap, block edit not valid
1301               endEditing();
1302               return;
1303             }
1304           }
1305         }
1306       }
1307
1308       if (insertGap)
1309       {
1310         // dragging to the right
1311         if (fixedColumns && fixedRight != -1)
1312         {
1313           for (int j = lastres; j < startres; j++)
1314           {
1315             insertChar(j, groupSeqs, fixedRight);
1316           }
1317         }
1318         else
1319         {
1320           editCommand.appendEdit(Action.INSERT_GAP, groupSeqs, startres,
1321                   startres - lastres, av.getAlignment(), true);
1322         }
1323       }
1324       else
1325       {
1326         // dragging to the left
1327         if (fixedColumns && fixedRight != -1)
1328         {
1329           for (int j = lastres; j > startres; j--)
1330           {
1331             deleteChar(startres, groupSeqs, fixedRight);
1332           }
1333         }
1334         else
1335         {
1336           editCommand.appendEdit(Action.DELETE_GAP, groupSeqs, startres,
1337                   lastres - startres, av.getAlignment(), true);
1338         }
1339
1340       }
1341     }
1342     else
1343     // ///Editing a single sequence///////////
1344     {
1345       if (insertGap)
1346       {
1347         // dragging to the right
1348         if (fixedColumns && fixedRight != -1)
1349         {
1350           for (int j = lastres; j < startres; j++)
1351           {
1352             insertChar(j, new SequenceI[] { seq }, fixedRight);
1353           }
1354         }
1355         else
1356         {
1357           editCommand.appendEdit(Action.INSERT_GAP,
1358                   new SequenceI[] { seq }, lastres, startres - lastres,
1359                   av.getAlignment(), true);
1360         }
1361       }
1362       else
1363       {
1364         // dragging to the left
1365         if (fixedColumns && fixedRight != -1)
1366         {
1367           for (int j = lastres; j > startres; j--)
1368           {
1369             if (!jalview.util.Comparison.isGap(seq.getCharAt(startres)))
1370             {
1371               endEditing();
1372               break;
1373             }
1374             deleteChar(startres, new SequenceI[] { seq }, fixedRight);
1375           }
1376         }
1377         else
1378         {
1379           // could be a keyboard edit trying to delete none gaps
1380           int max = 0;
1381           for (int m = startres; m < lastres; m++)
1382           {
1383             if (!jalview.util.Comparison.isGap(seq.getCharAt(m)))
1384             {
1385               break;
1386             }
1387             max++;
1388           }
1389
1390           if (max > 0)
1391           {
1392             editCommand.appendEdit(Action.DELETE_GAP,
1393                     new SequenceI[] { seq }, startres, max,
1394                     av.getAlignment(), true);
1395           }
1396         }
1397       }
1398     }
1399
1400     lastres = startres;
1401     seqCanvas.repaint();
1402   }
1403
1404   void insertChar(int j, SequenceI[] seq, int fixedColumn)
1405   {
1406     int blankColumn = fixedColumn;
1407     for (int s = 0; s < seq.length; s++)
1408     {
1409       // Find the next gap before the end of the visible region boundary
1410       // If lastCol > j, theres a boundary after the gap insertion
1411
1412       for (blankColumn = fixedColumn; blankColumn > j; blankColumn--)
1413       {
1414         if (jalview.util.Comparison.isGap(seq[s].getCharAt(blankColumn)))
1415         {
1416           // Theres a space, so break and insert the gap
1417           break;
1418         }
1419       }
1420
1421       if (blankColumn <= j)
1422       {
1423         blankColumn = fixedColumn;
1424         endEditing();
1425         return;
1426       }
1427     }
1428
1429     editCommand.appendEdit(Action.DELETE_GAP, seq, blankColumn, 1,
1430             av.getAlignment(), true);
1431
1432     editCommand.appendEdit(Action.INSERT_GAP, seq, j, 1, av.getAlignment(),
1433             true);
1434
1435   }
1436
1437   void deleteChar(int j, SequenceI[] seq, int fixedColumn)
1438   {
1439
1440     editCommand.appendEdit(Action.DELETE_GAP, seq, j, 1, av.getAlignment(),
1441             true);
1442
1443     editCommand.appendEdit(Action.INSERT_GAP, seq, fixedColumn, 1,
1444             av.getAlignment(), true);
1445   }
1446
1447   // ////////////////////////////////////////
1448   // ///Everything below this is for defining the boundary of the rubberband
1449   // ////////////////////////////////////////
1450   public void doMousePressedDefineMode(MouseEvent evt)
1451   {
1452     if (scrollThread != null)
1453     {
1454       scrollThread.running = false;
1455       scrollThread = null;
1456     }
1457
1458     int res = findRes(evt);
1459     int seq = findSeq(evt);
1460     oldSeq = seq;
1461     startWrapBlock = wrappedBlock;
1462
1463     if (seq == -1)
1464     {
1465       return;
1466     }
1467
1468     SequenceI sequence = av.getAlignment().getSequenceAt(seq);
1469
1470     if (sequence == null || res > sequence.getLength())
1471     {
1472       return;
1473     }
1474
1475     stretchGroup = av.getSelectionGroup();
1476
1477     if (stretchGroup == null || !stretchGroup.contains(sequence, res))
1478     {
1479       stretchGroup = av.getAlignment().findGroup(sequence, res);
1480       if (stretchGroup != null)
1481       {
1482         // only update the current selection if the popup menu has a group to
1483         // focus on
1484         av.setSelectionGroup(stretchGroup);
1485       }
1486     }
1487
1488     // DETECT RIGHT MOUSE BUTTON IN AWT
1489     if ((evt.getModifiers() & InputEvent.BUTTON3_MASK) == InputEvent.BUTTON3_MASK)
1490     {
1491       List<SequenceFeature> allFeatures = findFeaturesAtRes(sequence,
1492               sequence.findPosition(res));
1493
1494       Vector<String> links = null;
1495       for (SequenceFeature sf : allFeatures)
1496       {
1497         if (sf.links != null)
1498         {
1499           if (links == null)
1500           {
1501             links = new Vector<String>();
1502           }
1503           for (int j = 0; j < sf.links.size(); j++)
1504           {
1505             links.addElement(sf.links.elementAt(j));
1506           }
1507         }
1508       }
1509       APopupMenu popup = new APopupMenu(ap, null, links);
1510       this.add(popup);
1511       popup.show(this, evt.getX(), evt.getY());
1512       return;
1513     }
1514
1515     if (av.cursorMode)
1516     {
1517       seqCanvas.cursorX = findRes(evt);
1518       seqCanvas.cursorY = findSeq(evt);
1519       seqCanvas.repaint();
1520       return;
1521     }
1522
1523     // Only if left mouse button do we want to change group sizes
1524
1525     if (stretchGroup == null)
1526     {
1527       // define a new group here
1528       SequenceGroup sg = new SequenceGroup();
1529       sg.setStartRes(res);
1530       sg.setEndRes(res);
1531       sg.addSequence(sequence, false);
1532       av.setSelectionGroup(sg);
1533       stretchGroup = sg;
1534
1535       if (av.getConservationSelected())
1536       {
1537         SliderPanel.setConservationSlider(ap, av.getResidueShading(),
1538                 ap.getViewName());
1539       }
1540       if (av.getAbovePIDThreshold())
1541       {
1542         SliderPanel.setPIDSliderSource(ap, av.getResidueShading(),
1543                 ap.getViewName());
1544       }
1545
1546     }
1547   }
1548
1549   public void doMouseReleasedDefineMode(MouseEvent evt, boolean afterDrag)
1550   {
1551     if (stretchGroup == null)
1552     {
1553       return;
1554     }
1555     // always do this - annotation has own state
1556     // but defer colourscheme update until hidden sequences are passed in
1557     boolean vischange = stretchGroup.recalcConservation(true);
1558     // here we rely on stretchGroup == av.getSelection()
1559     needOverviewUpdate |= vischange && av.isSelectionDefinedGroup()
1560             && afterDrag;
1561     if (stretchGroup.cs != null)
1562     {
1563       stretchGroup.cs.alignmentChanged(stretchGroup,
1564               av.getHiddenRepSequences());
1565
1566       if (stretchGroup.cs.conservationApplied())
1567       {
1568         SliderPanel.setConservationSlider(ap, stretchGroup.cs,
1569                 stretchGroup.getName());
1570       }
1571       if (stretchGroup.cs.getThreshold() > 0)
1572       {
1573         SliderPanel.setPIDSliderSource(ap, stretchGroup.cs,
1574                 stretchGroup.getName());
1575       }
1576     }
1577     PaintRefresher.Refresh(ap, av.getSequenceSetId());
1578     ap.paintAlignment(needOverviewUpdate);
1579     needOverviewUpdate = false;
1580     changeEndRes = false;
1581     changeStartRes = false;
1582     stretchGroup = null;
1583     av.sendSelection();
1584   }
1585
1586   public void doMouseDraggedDefineMode(MouseEvent evt)
1587   {
1588     int res = findRes(evt);
1589     int y = findSeq(evt);
1590
1591     if (wrappedBlock != startWrapBlock)
1592     {
1593       return;
1594     }
1595
1596     if (stretchGroup == null)
1597     {
1598       return;
1599     }
1600
1601     mouseDragging = true;
1602
1603     if (y > av.getAlignment().getHeight())
1604     {
1605       y = av.getAlignment().getHeight() - 1;
1606     }
1607
1608     if (res >= av.getAlignment().getWidth())
1609     {
1610       res = av.getAlignment().getWidth() - 1;
1611     }
1612
1613     if (stretchGroup.getEndRes() == res)
1614     {
1615       // Edit end res position of selected group
1616       changeEndRes = true;
1617     }
1618     else if (stretchGroup.getStartRes() == res)
1619     {
1620       // Edit start res position of selected group
1621       changeStartRes = true;
1622     }
1623
1624     if (res < 0)
1625     {
1626       res = 0;
1627     }
1628
1629     if (changeEndRes)
1630     {
1631       if (res > (stretchGroup.getStartRes() - 1))
1632       {
1633         stretchGroup.setEndRes(res);
1634         needOverviewUpdate |= av.isSelectionDefinedGroup();
1635       }
1636     }
1637     else if (changeStartRes)
1638     {
1639       if (res < (stretchGroup.getEndRes() + 1))
1640       {
1641         stretchGroup.setStartRes(res);
1642         needOverviewUpdate |= av.isSelectionDefinedGroup();
1643       }
1644     }
1645
1646     int dragDirection = 0;
1647
1648     if (y > oldSeq)
1649     {
1650       dragDirection = 1;
1651     }
1652     else if (y < oldSeq)
1653     {
1654       dragDirection = -1;
1655     }
1656
1657     while ((y != oldSeq) && (oldSeq > -1)
1658             && (y < av.getAlignment().getHeight()))
1659     {
1660       // This routine ensures we don't skip any sequences, as the
1661       // selection is quite slow.
1662       Sequence seq = (Sequence) av.getAlignment().getSequenceAt(oldSeq);
1663
1664       oldSeq += dragDirection;
1665
1666       if (oldSeq < 0)
1667       {
1668         break;
1669       }
1670
1671       Sequence nextSeq = (Sequence) av.getAlignment().getSequenceAt(oldSeq);
1672
1673       if (stretchGroup.getSequences(null).contains(nextSeq))
1674       {
1675         stretchGroup.deleteSequence(seq, false);
1676         needOverviewUpdate |= av.isSelectionDefinedGroup();
1677       }
1678       else
1679       {
1680         if (seq != null)
1681         {
1682           stretchGroup.addSequence(seq, false);
1683         }
1684
1685         stretchGroup.addSequence(nextSeq, false);
1686         needOverviewUpdate |= av.isSelectionDefinedGroup();
1687       }
1688     }
1689
1690     if (oldSeq < 0)
1691     {
1692       oldSeq = -1;
1693     }
1694
1695     if (res > av.getRanges().getEndRes()
1696             || res < av.getRanges().getStartRes()
1697             || y < av.getRanges().getStartSeq()
1698             || y > av.getRanges().getEndSeq())
1699     {
1700       mouseExited(evt);
1701     }
1702
1703     if (scrollThread != null)
1704     {
1705       scrollThread.setEvent(evt);
1706     }
1707
1708     seqCanvas.repaint();
1709   }
1710
1711   @Override
1712   public void mouseEntered(MouseEvent e)
1713   {
1714     if (oldSeq < 0)
1715     {
1716       oldSeq = 0;
1717     }
1718
1719     if (scrollThread != null)
1720     {
1721       scrollThread.running = false;
1722       scrollThread = null;
1723     }
1724   }
1725
1726   @Override
1727   public void mouseExited(MouseEvent e)
1728   {
1729     if (av.getWrapAlignment())
1730     {
1731       return;
1732     }
1733
1734     if (mouseDragging && scrollThread == null)
1735     {
1736       scrollThread = new ScrollThread();
1737     }
1738   }
1739
1740   void scrollCanvas(MouseEvent evt)
1741   {
1742     if (evt == null)
1743     {
1744       if (scrollThread != null)
1745       {
1746         scrollThread.running = false;
1747         scrollThread = null;
1748       }
1749       mouseDragging = false;
1750     }
1751     else
1752     {
1753       if (scrollThread == null)
1754       {
1755         scrollThread = new ScrollThread();
1756       }
1757
1758       mouseDragging = true;
1759       scrollThread.setEvent(evt);
1760     }
1761
1762   }
1763
1764   // this class allows scrolling off the bottom of the visible alignment
1765   class ScrollThread extends Thread
1766   {
1767     MouseEvent evt;
1768
1769     boolean running = false;
1770
1771     public ScrollThread()
1772     {
1773       start();
1774     }
1775
1776     public void setEvent(MouseEvent e)
1777     {
1778       evt = e;
1779     }
1780
1781     public void stopScrolling()
1782     {
1783       running = false;
1784     }
1785
1786     @Override
1787     public void run()
1788     {
1789       running = true;
1790       while (running)
1791       {
1792
1793         if (evt != null)
1794         {
1795
1796           if (mouseDragging && evt.getY() < 0
1797                   && av.getRanges().getStartSeq() > 0)
1798           {
1799             running = av.getRanges().scrollUp(true);
1800           }
1801
1802           if (mouseDragging && evt.getY() >= getSize().height
1803                   && av.getAlignment().getHeight() > av.getRanges()
1804                           .getEndSeq())
1805           {
1806             running = av.getRanges().scrollUp(false);
1807           }
1808
1809           if (mouseDragging && evt.getX() < 0)
1810           {
1811             running = av.getRanges().scrollRight(false);
1812           }
1813
1814           else if (mouseDragging && evt.getX() >= getSize().width)
1815           {
1816             running = av.getRanges().scrollRight(true);
1817           }
1818         }
1819
1820         try
1821         {
1822           Thread.sleep(75);
1823         } catch (Exception ex)
1824         {
1825         }
1826       }
1827     }
1828   }
1829
1830   /**
1831    * modify current selection according to a received message.
1832    */
1833   @Override
1834   public void selection(SequenceGroup seqsel, ColumnSelection colsel,
1835           HiddenColumns hidden, SelectionSource source)
1836   {
1837     // TODO: fix this hack - source of messages is align viewport, but SeqPanel
1838     // handles selection messages...
1839     // TODO: extend config options to allow user to control if selections may be
1840     // shared between viewports.
1841     if (av != null
1842             && (av == source || !av.followSelection || (source instanceof AlignViewport && ((AlignmentViewport) source)
1843                     .getSequenceSetId().equals(av.getSequenceSetId()))))
1844     {
1845       return;
1846     }
1847
1848     /*
1849      * Check for selection in a view of which this one is a dna/protein
1850      * complement.
1851      */
1852     if (selectionFromTranslation(seqsel, colsel, hidden, source))
1853     {
1854       return;
1855     }
1856
1857     // do we want to thread this ? (contention with seqsel and colsel locks, I
1858     // suspect)
1859     /*
1860      * only copy colsel if there is a real intersection between
1861      * sequence selection and this panel's alignment
1862      */
1863     boolean repaint = false;
1864     boolean copycolsel = false;
1865     if (av.getSelectionGroup() == null || !av.isSelectionGroupChanged(true))
1866     {
1867       SequenceGroup sgroup = null;
1868       if (seqsel != null && seqsel.getSize() > 0)
1869       {
1870         if (av.getAlignment() == null)
1871         {
1872           System.out
1873                   .println("Selection message: alignviewport av SeqSetId="
1874                           + av.getSequenceSetId() + " ViewId="
1875                           + av.getViewId()
1876                           + " 's alignment is NULL! returning immediatly.");
1877           return;
1878         }
1879         sgroup = seqsel.intersect(av.getAlignment(),
1880                 (av.hasHiddenRows()) ? av.getHiddenRepSequences() : null);
1881         if ((sgroup != null && sgroup.getSize() > 0))
1882         {
1883           copycolsel = true;
1884         }
1885       }
1886       if (sgroup != null && sgroup.getSize() > 0)
1887       {
1888         av.setSelectionGroup(sgroup);
1889       }
1890       else
1891       {
1892         av.setSelectionGroup(null);
1893       }
1894       repaint = av.isSelectionGroupChanged(true);
1895     }
1896     if (copycolsel
1897             && (av.getColumnSelection() == null || !av
1898                     .isColSelChanged(true)))
1899     {
1900       // the current selection is unset or from a previous message
1901       // so import the new colsel.
1902       if (colsel == null || colsel.isEmpty())
1903       {
1904         if (av.getColumnSelection() != null)
1905         {
1906           av.getColumnSelection().clear();
1907         }
1908       }
1909       else
1910       {
1911         // TODO: shift colSel according to the intersecting sequences
1912         if (av.getColumnSelection() == null)
1913         {
1914           av.setColumnSelection(new ColumnSelection(colsel));
1915         }
1916         else
1917         {
1918           av.getColumnSelection().setElementsFrom(colsel,
1919                   av.getAlignment().getHiddenColumns());
1920         }
1921       }
1922       repaint |= av.isColSelChanged(true);
1923     }
1924     if (copycolsel
1925             && av.hasHiddenColumns()
1926             && (av.getColumnSelection() == null || av.getAlignment()
1927                     .getHiddenColumns().getHiddenRegions() == null))
1928     {
1929       System.err.println("Bad things");
1930     }
1931     if (repaint)
1932     {
1933       ap.scalePanelHolder.repaint();
1934       ap.repaint();
1935     }
1936   }
1937
1938   /**
1939    * scroll to the given row/column - or nearest visible location
1940    * 
1941    * @param row
1942    * @param column
1943    */
1944   public void scrollTo(int row, int column)
1945   {
1946
1947     row = row < 0 ? ap.av.getRanges().getStartSeq() : row;
1948     column = column < 0 ? ap.av.getRanges().getStartRes() : column;
1949     ap.scrollTo(column, column, row, true, true);
1950   }
1951
1952   /**
1953    * scroll to the given row - or nearest visible location
1954    * 
1955    * @param row
1956    */
1957   public void scrollToRow(int row)
1958   {
1959
1960     row = row < 0 ? ap.av.getRanges().getStartSeq() : row;
1961     ap.scrollTo(ap.av.getRanges().getStartRes(), ap.av.getRanges()
1962             .getStartRes(), row, true, true);
1963   }
1964
1965   /**
1966    * scroll to the given column - or nearest visible location
1967    * 
1968    * @param column
1969    */
1970   public void scrollToColumn(int column)
1971   {
1972
1973     column = column < 0 ? ap.av.getRanges().getStartRes() : column;
1974     ap.scrollTo(column, column, ap.av.getRanges().getStartSeq(), true, true);
1975   }
1976
1977   /**
1978    * If this panel is a cdna/protein translation view of the selection source,
1979    * tries to map the source selection to a local one, and returns true. Else
1980    * returns false.
1981    * 
1982    * @param seqsel
1983    * @param colsel
1984    * @param source
1985    */
1986   protected boolean selectionFromTranslation(SequenceGroup seqsel,
1987           ColumnSelection colsel, HiddenColumns hidden,
1988           SelectionSource source)
1989   {
1990     if (!(source instanceof AlignViewportI))
1991     {
1992       return false;
1993     }
1994     final AlignViewportI sourceAv = (AlignViewportI) source;
1995     if (sourceAv.getCodingComplement() != av
1996             && av.getCodingComplement() != sourceAv)
1997     {
1998       return false;
1999     }
2000
2001     /*
2002      * Map sequence selection
2003      */
2004     SequenceGroup sg = MappingUtils.mapSequenceGroup(seqsel, sourceAv, av);
2005     av.setSelectionGroup(sg);
2006     av.isSelectionGroupChanged(true);
2007
2008     /*
2009      * Map column selection
2010      */
2011     // ColumnSelection cs = MappingUtils.mapColumnSelection(colsel, sourceAv,
2012     // av);
2013     ColumnSelection cs = new ColumnSelection();
2014     HiddenColumns hs = new HiddenColumns();
2015     MappingUtils.mapColumnSelection(colsel, hidden, sourceAv, av, cs, hs);
2016     av.setColumnSelection(cs);
2017     av.getAlignment().setHiddenColumns(hs);
2018
2019     ap.scalePanelHolder.repaint();
2020     ap.repaint();
2021
2022     return true;
2023   }
2024
2025 }