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