Display nucleotides
[jalview.git] / src / jalview / appletgui / SeqPanel.java
1 /*\r
2  * Jalview - A Sequence Alignment Editor and Viewer\r
3  * Copyright (C) 2005 AM Waterhouse, J Procter, G Barton, M Clamp, S Searle\r
4  *\r
5  * This program is free software; you can redistribute it and/or\r
6  * modify it under the terms of the GNU General Public License\r
7  * as published by the Free Software Foundation; either version 2\r
8  * of the License, or (at your option) any later version.\r
9  *\r
10  * This program is distributed in the hope that it will be useful,\r
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of\r
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the\r
13  * GNU General Public License for more details.\r
14  *\r
15  * You should have received a copy of the GNU General Public License\r
16  * along with this program; if not, write to the Free Software\r
17  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA\r
18  */\r
19 \r
20 package jalview.appletgui;\r
21 \r
22 import java.util.*;\r
23 \r
24 import java.awt.*;\r
25 import java.awt.event.*;\r
26 \r
27 import jalview.datamodel.*;\r
28 import jalview.schemes.*;\r
29 \r
30 public class SeqPanel\r
31     extends Panel\r
32 {\r
33 \r
34   public SeqCanvas seqCanvas;\r
35   public AlignmentPanel ap;\r
36 \r
37   protected int lastres;\r
38   protected int startseq;\r
39   int startEdit = -1;\r
40   int endEdit = -1;\r
41 \r
42   protected AlignViewport av;\r
43 \r
44   // if character is inserted or deleted, we will need to recalculate the conservation\r
45   int seqEditOccurred = -1;\r
46 \r
47   ScrollThread scrollThread = null;\r
48   boolean mouseDragging = false;\r
49 \r
50   boolean editingSeqs = false;\r
51   boolean groupEditing = false;\r
52 \r
53   public SeqPanel(AlignViewport avp, AlignmentPanel p)\r
54   {\r
55     this.av = avp;\r
56 \r
57     seqCanvas = new SeqCanvas(avp);\r
58     setLayout(new BorderLayout());\r
59     add(seqCanvas);\r
60 \r
61     ap = p;\r
62 \r
63     seqCanvas.addMouseMotionListener(new MouseMotionAdapter()\r
64     {\r
65       public void mouseMoved(MouseEvent evt)\r
66       {\r
67         doMouseMoved(evt);\r
68       }\r
69 \r
70       public void mouseDragged(MouseEvent evt)\r
71       {\r
72         if (editingSeqs)\r
73         {\r
74           doMouseDragged(evt);\r
75         }\r
76         else\r
77         {\r
78           doMouseDraggedDefineMode(evt);\r
79         }\r
80       }\r
81     });\r
82 \r
83     seqCanvas.addMouseListener(new MouseAdapter()\r
84     {\r
85       public void mouseReleased(MouseEvent evt)\r
86       {\r
87         if (editingSeqs)\r
88         {\r
89           doMouseReleased(evt);\r
90         }\r
91         else\r
92         {\r
93           doMouseReleasedDefineMode(evt);\r
94         }\r
95 \r
96       }\r
97 \r
98       public void mousePressed(MouseEvent evt)\r
99       {\r
100         if (evt.isShiftDown() || evt.isAltDown() || evt.isControlDown())\r
101         {\r
102           if (evt.isAltDown() || evt.isControlDown())\r
103           {\r
104             groupEditing = true;\r
105           }\r
106 \r
107           editingSeqs = true;\r
108           doMousePressed(evt);\r
109         }\r
110         else\r
111         {\r
112           doMousePressedDefineMode(evt);\r
113         }\r
114       }\r
115 \r
116       public void mouseExited(MouseEvent evt)\r
117       {\r
118         if (editingSeqs)\r
119         {\r
120           return;\r
121         }\r
122         doMouseExitedDefineMode(evt);\r
123 \r
124       }\r
125 \r
126       public void mouseEntered(MouseEvent evt)\r
127       {\r
128         if (editingSeqs)\r
129         {\r
130           return;\r
131         }\r
132         doMouseEnteredDefineMode(evt);\r
133       }\r
134 \r
135     });\r
136     seqCanvas.repaint();\r
137   }\r
138 \r
139   public void doMouseReleased(MouseEvent evt)\r
140   {\r
141 \r
142     if (seqEditOccurred > -1)\r
143     {\r
144       editOccurred(seqEditOccurred);\r
145     }\r
146 \r
147     startseq = -1;\r
148     lastres = -1;\r
149     seqEditOccurred = -1;\r
150     editingSeqs = false;\r
151     groupEditing = false;\r
152     ap.repaint();\r
153   }\r
154 \r
155   int startWrapBlock=-1;\r
156   int wrappedBlock=-1;\r
157   int findRes(MouseEvent evt)\r
158  {\r
159    int res = 0;\r
160    int x = evt.getX();\r
161 \r
162   if (av.wrapAlignment)\r
163   {\r
164       int y = evt.getY();\r
165       y -= (2 * av.charHeight);\r
166       x -= seqCanvas.LABEL_WEST;\r
167 \r
168       int chunkHeight = (av.getAlignment().getHeight() + 2) * av.charHeight;\r
169       int cwidth = seqCanvas.getWrappedCanvasWidth(this.getSize().width);\r
170       wrappedBlock = y/chunkHeight;\r
171       wrappedBlock += av.getStartRes()/cwidth;\r
172 \r
173       res = wrappedBlock*cwidth   +   x / av.getCharWidth();\r
174   }\r
175   else\r
176   {\r
177       res = (x / av.getCharWidth()) + av.getStartRes();\r
178   }\r
179 \r
180   return res;\r
181 \r
182  }\r
183 \r
184  int findSeq(MouseEvent evt)\r
185  {\r
186    int seq = 0;\r
187    int y = evt.getY();\r
188 \r
189    if (av.wrapAlignment)\r
190    {\r
191      y -= (2 * av.charHeight);\r
192      int chunkHeight = (av.getAlignment().getHeight() + 2) * av.charHeight;\r
193      seq = ( (y % chunkHeight) / av.getCharHeight());\r
194    }\r
195    else\r
196    {\r
197      seq = (y / av.getCharHeight()) + av.getStartSeq();\r
198    }\r
199 \r
200    return seq;\r
201  }\r
202 \r
203 \r
204   public void doMousePressed(MouseEvent evt)\r
205   {\r
206     ap.alignFrame.addHistoryItem(new HistoryItem(\r
207         "Edit Sequence", av.alignment, HistoryItem.EDIT));\r
208 \r
209     int seq = findSeq(evt);\r
210     int res = findRes(evt);\r
211 \r
212     if (seq < av.getAlignment().getHeight() &&\r
213         res < av.getAlignment().getSequenceAt(seq).getLength())\r
214     {\r
215       //char resstr = align.getSequenceAt(seq).getSequence().charAt(res);\r
216       // Find the residue's position in the sequence (res is the position\r
217       // in the alignment\r
218 \r
219       startseq = seq;\r
220       lastres = res;\r
221     }\r
222     else\r
223     {\r
224       startseq = -1;\r
225       lastres = -1;\r
226     }\r
227 \r
228     return;\r
229   }\r
230 \r
231   public void doMouseMoved(MouseEvent evt)\r
232   {\r
233     int res = findRes(evt);\r
234     int seq = findSeq(evt);\r
235 \r
236     if (seq >= av.getAlignment().getHeight() || seq<0 || res<0)\r
237     {\r
238       return;\r
239     }\r
240 \r
241     SequenceI sequence = av.getAlignment().getSequenceAt(seq);\r
242     if (res > sequence.getLength())\r
243     {\r
244       return;\r
245     }\r
246 \r
247     StringBuffer text = new StringBuffer("Sequence " + (seq + 1) + " ID: " +\r
248             sequence.getName());\r
249 \r
250     Object obj = null;\r
251     if (av.alignment.isNucleotide())\r
252     {\r
253       obj = ResidueProperties.nucleotideName.get(sequence.getCharAt(res) +\r
254           "");\r
255       if(obj!=null)\r
256         text.append(" Nucleotide: ");\r
257     }\r
258     else\r
259     {\r
260       obj = ResidueProperties.aa2Triplet.get(sequence.getCharAt(res) + "");\r
261       if(obj!=null)\r
262         text.append("  Residue: ");\r
263     }\r
264 \r
265     if (obj != null)\r
266     {\r
267 \r
268       if (obj != "")\r
269       {\r
270         text.append(obj + " (" +\r
271                     av.getAlignment().getSequenceAt(seq).findPosition(res) + ")");\r
272       }\r
273     }\r
274 \r
275     ap.alignFrame.statusBar.setText(text.toString());\r
276 \r
277     // use aa to see if the mouse pointer is on a\r
278     if (av.showSequenceFeatures)\r
279     {\r
280       Vector features = sequence.getSequenceFeatures();\r
281       Enumeration e = features.elements();\r
282       StringBuffer sbuffer = new StringBuffer();\r
283 \r
284       while (e.hasMoreElements())\r
285       {\r
286         SequenceFeature sf = (SequenceFeature) e.nextElement();\r
287         if (sf.getStart() <= sequence.findPosition(res) &&\r
288             sf.getEnd() >= sequence.findPosition(res))\r
289         {\r
290           if (sbuffer.length() > 0)\r
291           {\r
292             sbuffer.append("; ");\r
293           }\r
294           sbuffer.append(sf.getType() + " " + sf.getDescription());\r
295           if (sf.getStatus().length() > 0)\r
296           {\r
297             sbuffer.append(" (" + sf.getStatus() + ")");\r
298           }\r
299         }\r
300 \r
301       }\r
302     }\r
303 \r
304   }\r
305 \r
306   public void doMouseDragged(MouseEvent evt)\r
307   {\r
308 \r
309     // If we're dragging we're editing\r
310     int res = findRes(evt);\r
311     if (res < 0)\r
312     {\r
313       res = 0;\r
314     }\r
315 \r
316     if (lastres == -1 || lastres == res)\r
317     {\r
318       return;\r
319     }\r
320 \r
321     boolean dragRight = true;\r
322     if (res < av.getAlignment().getWidth() && res < lastres)\r
323     {\r
324       dragRight = false;\r
325     }\r
326 \r
327     if (res != lastres)\r
328     {\r
329       // Group editing\r
330       if (groupEditing)\r
331       {\r
332         SequenceGroup sg = av.getSelectionGroup();\r
333         if (sg == null)\r
334         {\r
335           lastres = -1;\r
336           return;\r
337         }\r
338 \r
339         // drag to right\r
340         if (dragRight)\r
341         {\r
342           sg.setEndRes(sg.getEndRes() + (res - lastres));\r
343         }\r
344 \r
345         // drag to left\r
346         else\r
347         {\r
348           /// Are we able to delete?\r
349           // ie are all columns blank?\r
350           boolean deleteAllowed = false;\r
351           for (int s = 0; s < sg.getSize(); s++)\r
352           {\r
353             SequenceI seq = sg.getSequenceAt(s);\r
354             for (int j = res; j < lastres; j++)\r
355             {\r
356               if (seq.getSequence().length() <= j)\r
357               {\r
358                 continue;\r
359               }\r
360 \r
361               if (!jalview.util.Comparison.isGap(seq.getSequence().charAt(j)))\r
362               {\r
363                 // Not a gap, block edit not valid\r
364                 res = j + 1;\r
365                 deleteAllowed = false;\r
366                 continue;\r
367               }\r
368               deleteAllowed = true;\r
369             }\r
370           }\r
371 \r
372           if (!deleteAllowed)\r
373           {\r
374             lastres = -1;\r
375             return;\r
376           }\r
377 \r
378           sg.setEndRes(sg.getEndRes() - (lastres - res));\r
379         }\r
380 \r
381         for (int i = 0; i < sg.getSize(); i++)\r
382         {\r
383           SequenceI s = sg.getSequenceAt(i);\r
384           int k = av.alignment.findIndex(s);\r
385 \r
386           // drag to right\r
387           if (dragRight)\r
388           {\r
389             for (int j = lastres; j < res; j++)\r
390             {\r
391               insertChar(j, k);\r
392             }\r
393           }\r
394 \r
395           // drag to left\r
396           else\r
397           {\r
398             for (int j = res; j < lastres; j++)\r
399             {\r
400               if (s.getLength() > j)\r
401               {\r
402                 deleteChar(res, k);\r
403               }\r
404             }\r
405           }\r
406         }\r
407       }\r
408       else /////Editing a single sequence///////////\r
409       {\r
410         if (res < av.getAlignment().getWidth() && res > lastres)\r
411         {\r
412           // dragging to the right\r
413           for (int j = lastres; j < res; j++)\r
414           {\r
415             insertChar(j, startseq);\r
416           }\r
417         }\r
418         else if (res < av.getAlignment().getWidth() && res < lastres)\r
419         {\r
420           // dragging to the left\r
421           for (int j = lastres; j > res; j--)\r
422           {\r
423             if (jalview.util.Comparison.isGap(\r
424                 av.alignment.getSequenceAt(startseq).getSequence().charAt(res)))\r
425             {\r
426 \r
427               deleteChar(res, startseq);\r
428             }\r
429             else\r
430             {\r
431 \r
432               break;\r
433             }\r
434           }\r
435         }\r
436 \r
437       }\r
438     }\r
439 \r
440     endEdit = res;\r
441     lastres = res;\r
442     seqCanvas.repaint();\r
443   }\r
444 \r
445   public void drawChars(int seqstart, int seqend, int start)\r
446   {\r
447     seqCanvas.drawPanel(seqCanvas.gg, start, av.getEndRes(), seqstart, seqend,\r
448                         av.getStartRes(), av.getStartSeq(), 0);\r
449     seqCanvas.repaint();\r
450   }\r
451 \r
452   public void insertChar(int j, int seq)\r
453   {\r
454     av.alignment.getSequenceAt(seq).insertCharAt(j, av.getGapCharacter());\r
455     seqEditOccurred = seq;\r
456   }\r
457 \r
458   public void deleteChar(int j, int seq)\r
459   {\r
460 \r
461     av.alignment.getSequenceAt(seq).deleteCharAt(j);\r
462     seqEditOccurred = seq;\r
463     av.alignment.getWidth();\r
464     repaint();\r
465   }\r
466 \r
467   void editOccurred(int i)\r
468   {\r
469     if (endEdit == startEdit)\r
470     {\r
471         ap.alignFrame.historyList.pop();\r
472         ap.alignFrame.updateEditMenuBar();\r
473     }\r
474 \r
475     av.firePropertyChange("alignment", null,av.getAlignment().getSequences());\r
476   }\r
477 \r
478 //////////////////////////////////////////\r
479 /////Everything below this is for defining the boundary of the rubberband\r
480 //////////////////////////////////////////\r
481   int oldSeq = -1;\r
482   public void doMousePressedDefineMode(MouseEvent evt)\r
483   {\r
484     int res = findRes(evt);\r
485     int seq = findSeq(evt);\r
486     oldSeq = seq;\r
487     startWrapBlock=wrappedBlock;\r
488 \r
489     SequenceI sequence = (Sequence) av.getAlignment().getSequenceAt(seq);\r
490 \r
491     if (sequence == null || res > sequence.getLength())\r
492     {\r
493       return;\r
494     }\r
495 \r
496     stretchGroup = av.getSelectionGroup();\r
497 \r
498     if (stretchGroup == null)\r
499     {\r
500       stretchGroup = av.alignment.findGroup(sequence);\r
501       if (stretchGroup != null && res > stretchGroup.getStartRes() &&\r
502           res < stretchGroup.getEndRes())\r
503       {\r
504         av.setSelectionGroup(stretchGroup);\r
505       }\r
506       else\r
507       {\r
508         stretchGroup = null;\r
509       }\r
510     }\r
511 \r
512     else if (!stretchGroup.sequences.contains(sequence)\r
513              || stretchGroup.getStartRes() > res\r
514              || stretchGroup.getEndRes() < res)\r
515     {\r
516       stretchGroup = null;\r
517 \r
518       SequenceGroup[] allGroups = av.alignment.findAllGroups(sequence);\r
519 \r
520       if (allGroups != null)\r
521       {\r
522         for (int i = 0; i < allGroups.length; i++)\r
523         {\r
524           if (allGroups[i].getStartRes() <= res &&\r
525               allGroups[i].getEndRes() >= res)\r
526           {\r
527             stretchGroup = allGroups[i];\r
528             av.setSelectionGroup(stretchGroup);\r
529             break;\r
530           }\r
531         }\r
532       }\r
533     }\r
534 \r
535     if (stretchGroup == null)\r
536     {\r
537       // define a new group here\r
538       SequenceGroup sg = new SequenceGroup();\r
539       sg.setStartRes(res);\r
540       sg.setEndRes(res);\r
541       sg.addSequence(sequence, false);\r
542       av.setSelectionGroup(sg);\r
543       stretchGroup = sg;\r
544 \r
545       if (av.getConservationSelected())\r
546       {\r
547         SliderPanel.setConservationSlider(ap, av.getGlobalColourScheme(),\r
548                                           "Background");\r
549       }\r
550       if (av.getAbovePIDThreshold())\r
551       {\r
552         SliderPanel.setPIDSliderSource(ap, av.getGlobalColourScheme(),\r
553                                        "Background");\r
554       }\r
555 \r
556     }\r
557 \r
558     // DETECT RIGHT MOUSE BUTTON IN AWT\r
559     else if ( (evt.getModifiers() & InputEvent.BUTTON3_MASK) ==\r
560              InputEvent.BUTTON3_MASK)\r
561     {\r
562       APopupMenu popup = new APopupMenu(ap, null, null);\r
563       this.add(popup);\r
564       popup.show(this, evt.getX(), evt.getY());\r
565     }\r
566 \r
567     if (stretchGroup != null && stretchGroup.getEndRes() == res)\r
568     {\r
569       // Edit end res position of selected group\r
570       changeEndRes = true;\r
571     }\r
572 \r
573     else if (stretchGroup != null && stretchGroup.getStartRes() == res)\r
574     {\r
575       // Edit end res position of selected group\r
576       changeStartRes = true;\r
577     }\r
578 \r
579   }\r
580 \r
581   boolean changeEndSeq = false;\r
582   boolean changeStartSeq = false;\r
583   boolean changeEndRes = false;\r
584   boolean changeStartRes = false;\r
585   SequenceGroup stretchGroup = null;\r
586 \r
587   public void doMouseReleasedDefineMode(MouseEvent evt)\r
588   {\r
589     if(mouseDragging)\r
590      {\r
591        stretchGroup.recalcConservation();\r
592        mouseDragging = false;\r
593      }\r
594 \r
595     if (stretchGroup == null)\r
596     {\r
597       return;\r
598     }\r
599 \r
600     if(stretchGroup.cs!=null)\r
601     {\r
602       if (stretchGroup.cs.conservationApplied())\r
603       {\r
604         SliderPanel.setConservationSlider(ap, stretchGroup.cs,\r
605                                           stretchGroup.getName());\r
606       }\r
607       else\r
608       {\r
609         SliderPanel.setPIDSliderSource(ap, stretchGroup.cs,\r
610                                        stretchGroup.getName());\r
611       }\r
612     }\r
613     changeEndRes = false;\r
614     changeStartRes = false;\r
615     stretchGroup = null;\r
616     seqCanvas.repaint();\r
617     ap.repaint();\r
618   }\r
619 \r
620   boolean remove = false;\r
621   public void doMouseDraggedDefineMode(MouseEvent evt)\r
622   {\r
623     int res = findRes(evt);\r
624     int y = findSeq(evt);\r
625 \r
626     if(wrappedBlock!=startWrapBlock)\r
627         return;\r
628 \r
629     if(y>=av.alignment.getHeight())\r
630       y = av.alignment.getHeight()-1;\r
631 \r
632     if (stretchGroup == null)\r
633     {\r
634       return;\r
635     }\r
636 \r
637     if (res > av.alignment.getWidth())\r
638     {\r
639       res = av.alignment.getWidth() - 1;\r
640     }\r
641 \r
642     if (stretchGroup.getEndRes() == res)\r
643     {\r
644       // Edit end res position of selected group\r
645       changeEndRes = true;\r
646     }\r
647 \r
648     else if (stretchGroup.getStartRes() == res)\r
649     {\r
650       // Edit start res position of selected group\r
651       changeStartRes = true;\r
652     }\r
653 \r
654     if (res < av.getStartRes())\r
655     {\r
656       res = av.getStartRes();\r
657     }\r
658     else if (res > av.getEndRes() && !av.getWrapAlignment())\r
659     {\r
660       res = av.getEndRes();\r
661     }\r
662 \r
663     if (changeEndRes)\r
664     {\r
665       if (res > stretchGroup.getStartRes() - 1)\r
666       {\r
667         stretchGroup.setEndRes(res);\r
668       }\r
669     }\r
670     else if (changeStartRes)\r
671     {\r
672       if (res < stretchGroup.getEndRes() + 1)\r
673       {\r
674         stretchGroup.setStartRes(res);\r
675       }\r
676     }\r
677 \r
678     int dragDirection = 0;\r
679     if (y > oldSeq)\r
680     {\r
681       dragDirection = 1;\r
682     }\r
683     else if (y < oldSeq)\r
684     {\r
685       dragDirection = -1;\r
686     }\r
687 \r
688     while (y != oldSeq && oldSeq > 0 && y < av.alignment.getHeight())\r
689     {\r
690       // This routine ensures we don't skip any sequences, as the\r
691       // selection is quite slow.\r
692       Sequence seq = (Sequence) av.getAlignment().getSequenceAt(oldSeq);\r
693 \r
694       oldSeq += dragDirection;\r
695       Sequence nextSeq = (Sequence) av.getAlignment().getSequenceAt(oldSeq);\r
696 \r
697       if (stretchGroup.sequences.contains(nextSeq))\r
698       {\r
699         stretchGroup.deleteSequence(seq, false);\r
700       }\r
701       else\r
702       {\r
703         if (seq != null)\r
704         {\r
705           stretchGroup.addSequence(seq, false);\r
706         }\r
707         stretchGroup.addSequence(nextSeq, false);\r
708       }\r
709     }\r
710     oldSeq = y;\r
711     mouseDragging = true;\r
712     if (scrollThread != null)\r
713     {\r
714       scrollThread.setEvent(evt);\r
715     }\r
716 \r
717     seqCanvas.repaint();\r
718   }\r
719 \r
720   public void doMouseEnteredDefineMode(MouseEvent e)\r
721   {\r
722     if (scrollThread != null)\r
723     {\r
724       scrollThread.running = false;\r
725     }\r
726   }\r
727 \r
728   public void doMouseExitedDefineMode(MouseEvent e)\r
729   {\r
730     if (mouseDragging)\r
731     {\r
732       scrollThread = new ScrollThread();\r
733     }\r
734   }\r
735 \r
736   // this class allows scrolling off the bottom of the visible alignment\r
737   class ScrollThread\r
738       extends Thread\r
739   {\r
740     MouseEvent evt;\r
741     boolean running = false;\r
742     public ScrollThread()\r
743     {\r
744       start();\r
745     }\r
746 \r
747     public void setEvent(MouseEvent e)\r
748     {\r
749       evt = e;\r
750     }\r
751 \r
752     public void stopScrolling()\r
753     {\r
754       running = false;\r
755     }\r
756 \r
757     public void run()\r
758     {\r
759       running = true;\r
760       while (running)\r
761       {\r
762         if (evt != null)\r
763         {\r
764 \r
765           if (mouseDragging && evt.getY() < 0 && av.getStartSeq() > 0)\r
766           {\r
767             running = ap.scrollUp(true);\r
768           }\r
769 \r
770           if (mouseDragging && evt.getY() >= getSize().height &&\r
771               av.alignment.getHeight() > av.getEndSeq())\r
772           {\r
773             running = ap.scrollUp(false);\r
774           }\r
775 \r
776           if (mouseDragging && evt.getX() < 0)\r
777           {\r
778             running = ap.scrollRight(true);\r
779           }\r
780 \r
781           else if (mouseDragging && evt.getX() >= getSize().width)\r
782           {\r
783             running = ap.scrollRight(false);\r
784           }\r
785         }\r
786 \r
787         try\r
788         {\r
789           Thread.sleep(75);\r
790         }\r
791         catch (Exception ex)\r
792         {}\r
793       }\r
794     }\r
795   }\r
796 \r
797 }\r