afa6c7e82e5e071448ffc5837e7ec45b5f40ad04
[jalview.git] / src / jalview / appletgui / APopupMenu.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.awt.*;\r
23 import java.awt.event.*;\r
24 import java.util.Vector;\r
25 \r
26 import jalview.analysis.*;\r
27 import jalview.datamodel.*;\r
28 import jalview.schemes.*;\r
29 \r
30 public class APopupMenu\r
31     extends java.awt.PopupMenu implements ActionListener, ItemListener\r
32 {\r
33   Menu groupMenu = new Menu();\r
34   protected MenuItem clustalColour = new MenuItem();\r
35   protected MenuItem zappoColour = new MenuItem();\r
36   protected MenuItem taylorColour = new MenuItem();\r
37   protected MenuItem hydrophobicityColour = new MenuItem();\r
38   protected MenuItem helixColour = new MenuItem();\r
39   protected MenuItem strandColour = new MenuItem();\r
40   protected MenuItem turnColour = new MenuItem();\r
41   protected MenuItem buriedColour = new MenuItem();\r
42   protected CheckboxMenuItem abovePIDColour = new CheckboxMenuItem();\r
43   protected MenuItem userDefinedColour = new MenuItem();\r
44   protected MenuItem PIDColour = new MenuItem();\r
45   protected MenuItem BLOSUM62Colour = new MenuItem();\r
46   MenuItem noColourmenuItem = new MenuItem();\r
47   protected CheckboxMenuItem conservationMenuItem = new CheckboxMenuItem();\r
48 \r
49   final AlignmentPanel ap;\r
50   MenuItem unGroupMenuItem = new MenuItem();\r
51   MenuItem nucleotideMenuItem = new MenuItem();\r
52   Menu colourMenu = new Menu();\r
53   CheckboxMenuItem showBoxes = new CheckboxMenuItem();\r
54   CheckboxMenuItem showText = new CheckboxMenuItem();\r
55   CheckboxMenuItem showColourText = new CheckboxMenuItem();\r
56   Menu editMenu = new Menu("Edit");\r
57   MenuItem copy = new MenuItem("Copy (Jalview Only)");\r
58   MenuItem cut = new MenuItem("Cut (Jalview Only)");\r
59   MenuItem toUpper = new MenuItem("To Upper Case");\r
60   MenuItem toLower = new MenuItem("To Lower Case");\r
61   MenuItem toggleCase = new MenuItem("Toggle Case");\r
62   Menu outputmenu = new Menu();\r
63   Menu seqMenu = new Menu();\r
64   MenuItem pdb = new MenuItem();\r
65   MenuItem hideSeqs = new MenuItem();\r
66   MenuItem repGroup = new MenuItem();\r
67 \r
68   Sequence seq;\r
69   MenuItem revealAll = new MenuItem();\r
70 \r
71   public APopupMenu(AlignmentPanel apanel, final Sequence seq, Vector links)\r
72   {\r
73     ///////////////////////////////////////////////////////////\r
74     // If this is activated from the sequence panel, the user may want to\r
75     // edit or annotate a particular residue. Therefore display the residue menu\r
76     //\r
77     // If from the IDPanel, we must display the sequence menu\r
78     //////////////////////////////////////////////////////////\r
79 \r
80     this.ap = apanel;\r
81     this.seq = seq;\r
82 \r
83     try\r
84     {\r
85       jbInit();\r
86     }\r
87     catch (Exception e)\r
88     {\r
89       e.printStackTrace();\r
90     }\r
91 \r
92     for (int i = 0; i < jalview.io.AppletFormatAdapter.WRITEABLE_FORMATS.length; i++)\r
93     {\r
94       MenuItem item = new MenuItem( jalview.io.AppletFormatAdapter.WRITEABLE_FORMATS[i] );\r
95 \r
96       item.addActionListener(this);\r
97       outputmenu.add(item);\r
98     }\r
99 \r
100     SequenceGroup sg = ap.av.getSelectionGroup();\r
101 \r
102     if (sg != null && sg.getSize(false)>0)\r
103     {\r
104       showText.setState(sg.getDisplayText());\r
105       showColourText.setState(sg.getColourText());\r
106       showBoxes.setState(sg.getDisplayBoxes());\r
107       if (!ap.av.alignment.getGroups().contains(sg))\r
108       {\r
109         groupMenu.remove(unGroupMenuItem);\r
110       }\r
111 \r
112     }\r
113     else\r
114     {\r
115       remove(hideSeqs);\r
116       remove(groupMenu);\r
117     }\r
118 \r
119     if (links!=null)\r
120     {\r
121       Menu linkMenu = new Menu("Link");\r
122       MenuItem item;\r
123       String link;\r
124       for(int i=0; i<links.size(); i++)\r
125       {\r
126         link = links.elementAt(i).toString();\r
127         final String target = link.substring(0, link.indexOf("|"));\r
128         item = new MenuItem(target);\r
129 \r
130         final String url;\r
131 \r
132         if (link.indexOf("$SEQUENCE_ID$") > -1)\r
133         {\r
134           String id = seq.getName();\r
135           if (id.indexOf("|") > -1)\r
136             id = id.substring(id.lastIndexOf("|") + 1);\r
137 \r
138           url = link.substring(link.indexOf("|") + 1,\r
139                                link.indexOf("$SEQUENCE_ID$"))\r
140               + id +\r
141               link.substring(link.indexOf("$SEQUENCE_ID$") + 13);\r
142         }\r
143         else\r
144           url = link.substring(link.lastIndexOf("|")+1);\r
145 \r
146         System.out.println("add "+url +" "+target);\r
147            item.addActionListener(new java.awt.event.ActionListener()\r
148            {\r
149                public void actionPerformed(ActionEvent e)\r
150                {\r
151                   ap.alignFrame.showURL(url, target);\r
152                }\r
153            });\r
154           linkMenu.add(item);\r
155       }\r
156       if(seq!=null)\r
157         seqMenu.add(linkMenu);\r
158       else\r
159         add(linkMenu);\r
160     }\r
161     if(seq!=null)\r
162     {\r
163       seqMenu.setLabel(seq.getName());\r
164       repGroup.setLabel("Represent Group with " + seq.getName());\r
165     }\r
166     else\r
167       remove(seqMenu);\r
168 \r
169     if(!ap.av.hasHiddenRows)\r
170       remove(revealAll);\r
171   }\r
172 \r
173   public void itemStateChanged(ItemEvent evt)\r
174   {\r
175     if(evt.getSource()==abovePIDColour)\r
176       abovePIDColour_itemStateChanged();\r
177     else if(evt.getSource()==showColourText)\r
178       showColourText_itemStateChanged();\r
179     else if(evt.getSource()==showText)\r
180       showText_itemStateChanged();\r
181     else if(evt.getSource()==showBoxes)\r
182        showBoxes_itemStateChanged()   ;\r
183   }\r
184 \r
185   public void actionPerformed(ActionEvent evt)\r
186   {\r
187     Object source = evt.getSource();\r
188     if(source==clustalColour)\r
189       clustalColour_actionPerformed();\r
190     else if(source==zappoColour)\r
191       zappoColour_actionPerformed();\r
192     else if(source==taylorColour)\r
193       taylorColour_actionPerformed();\r
194     else if(source==hydrophobicityColour)\r
195       hydrophobicityColour_actionPerformed();\r
196     else if(source==helixColour)\r
197       helixColour_actionPerformed();\r
198     else if(source==strandColour)\r
199       strandColour_actionPerformed();\r
200     else if(source==clustalColour)\r
201       turnColour_actionPerformed();\r
202     else if(source==buriedColour)\r
203       buriedColour_actionPerformed();\r
204     else if(source==nucleotideMenuItem)\r
205       nucleotideMenuItem_actionPerformed();\r
206 \r
207     else if (source == userDefinedColour)\r
208       userDefinedColour_actionPerformed();\r
209     else if (source == PIDColour)\r
210       PIDColour_actionPerformed();\r
211     else if (source == BLOSUM62Colour)\r
212       BLOSUM62Colour_actionPerformed();\r
213     else if (source == noColourmenuItem)\r
214       noColourmenuItem_actionPerformed();\r
215     else if (source == conservationMenuItem)\r
216       conservationMenuItem_itemStateChanged();\r
217     else if (source == unGroupMenuItem)\r
218       unGroupMenuItem_actionPerformed();\r
219 \r
220     else if(source == pdb)\r
221       addPDB();\r
222     else if(source == hideSeqs)\r
223       hideSequences(false);\r
224     else if(source == repGroup)\r
225       hideSequences(true);\r
226     else if(source == revealAll)\r
227     {\r
228         ap.av.showAllHiddenSeqs();\r
229     }\r
230 \r
231     else if(source==copy)\r
232       ap.alignFrame.copy_actionPerformed();\r
233     else if(source==cut)\r
234       ap.alignFrame.cut_actionPerformed();\r
235     else if(source==toUpper || source==toLower || source==toggleCase)\r
236     {\r
237       SequenceGroup sg = ap.av.getSelectionGroup();\r
238       if (sg != null)\r
239       {\r
240         for (int g = 0; g < sg.getSize(true); g++)\r
241         {\r
242           if (source == toggleCase)\r
243            ((SequenceI) sg.getSequences(true).elementAt(g))\r
244           .toggleCase(sg.getStartRes(), sg.getEndRes() + 1);\r
245           else\r
246             ((SequenceI) sg.getSequences(true).elementAt(g))\r
247                 .changeCase(source == toUpper, sg.getStartRes(),\r
248                                            sg.getEndRes() + 1);\r
249         }\r
250         ap.seqPanel.seqCanvas.repaint();\r
251       }\r
252     }\r
253     else\r
254       outputText(evt);\r
255 \r
256   }\r
257 \r
258   void outputText(ActionEvent e)\r
259   {\r
260     CutAndPasteTransfer cap = new CutAndPasteTransfer(false, ap.alignFrame);\r
261     Vector vseqs = new Vector();\r
262 \r
263       String [] selection = ap.av.getViewAsString(true);\r
264       SequenceI [] seqs = ap.av.getSelectionAsNewSequence();\r
265       if (selection != null)\r
266       {\r
267         for (int i = 0; i < selection.length; i++)\r
268         {\r
269           Sequence seq = new Sequence(\r
270               seqs[i].getName(),\r
271               selection[i],\r
272               seqs[i].getStart(), seqs[i].getEnd());\r
273           seq.setDescription(seqs[i].getDescription());\r
274           vseqs.addElement( seq );\r
275       }\r
276     }\r
277 \r
278     Frame frame = new Frame();\r
279     frame.add(cap);\r
280     jalview.bin.JalviewLite.addFrame(frame,\r
281                                      "Selection output - " + e.getActionCommand(),\r
282                                      600, 500);\r
283 \r
284     cap.setText(new jalview.io.AppletFormatAdapter().formatSequences(\r
285         e.getActionCommand(),\r
286         vseqs,\r
287         ap.av.showJVSuffix));\r
288 \r
289   }\r
290 \r
291   void addPDB()\r
292   {\r
293     CutAndPasteTransfer cap = new CutAndPasteTransfer(true, ap.alignFrame);\r
294     cap.setText("Paste your PDB file here.");\r
295     cap.setPDBImport(seq);\r
296     Frame frame = new Frame();\r
297     frame.add(cap);\r
298     jalview.bin.JalviewLite.addFrame(frame, "Paste PDB file ", 400, 300);\r
299   }\r
300 \r
301   private void jbInit()\r
302       throws Exception\r
303   {\r
304     groupMenu.setLabel("Group");\r
305     groupMenu.setLabel("Selection");\r
306 \r
307     unGroupMenuItem.setLabel("Remove Group");\r
308     unGroupMenuItem.addActionListener(this);\r
309 \r
310     nucleotideMenuItem.setLabel("Nucleotide");\r
311     nucleotideMenuItem.addActionListener(this);\r
312     conservationMenuItem.addItemListener(this);\r
313     abovePIDColour.addItemListener(this);\r
314     colourMenu.setLabel("Group Colour");\r
315     showBoxes.setLabel("Boxes");\r
316     showBoxes.setState(true);\r
317     showBoxes.addItemListener(this);\r
318 \r
319     showText.setLabel("Text");\r
320     showText.addItemListener(this);\r
321     showColourText.setLabel("Colour Text");\r
322     showColourText.addItemListener(this);\r
323     outputmenu.setLabel("Output to Textbox...");\r
324     seqMenu.setLabel("Sequence");\r
325     pdb.setLabel("View PDB Structure");\r
326     hideSeqs.setLabel("Hide Sequences");\r
327     repGroup.setLabel("Represent Group with");\r
328     revealAll.setLabel("Reveal All");\r
329 \r
330     add(groupMenu);\r
331     this.add(seqMenu);\r
332     this.add(hideSeqs);\r
333     this.add(revealAll);\r
334     groupMenu.add(editMenu);\r
335     groupMenu.add(outputmenu);\r
336     groupMenu.addSeparator();\r
337     groupMenu.add(unGroupMenuItem);\r
338     groupMenu.add(colourMenu);\r
339     groupMenu.add(showBoxes);\r
340     groupMenu.add(showText);\r
341     groupMenu.add(showColourText);\r
342     colourMenu.add(noColourmenuItem);\r
343     colourMenu.add(clustalColour);\r
344     colourMenu.add(BLOSUM62Colour);\r
345     colourMenu.add(PIDColour);\r
346     colourMenu.add(zappoColour);\r
347     colourMenu.add(taylorColour);\r
348     colourMenu.add(hydrophobicityColour);\r
349     colourMenu.add(helixColour);\r
350     colourMenu.add(strandColour);\r
351     colourMenu.add(turnColour);\r
352     colourMenu.add(buriedColour);\r
353     colourMenu.add(nucleotideMenuItem);\r
354     colourMenu.add(userDefinedColour);\r
355     colourMenu.addSeparator();\r
356     colourMenu.add(abovePIDColour);\r
357     colourMenu.add(conservationMenuItem);\r
358 \r
359     noColourmenuItem.setLabel("None");\r
360     noColourmenuItem.addActionListener(this);\r
361 \r
362     clustalColour.setLabel("Clustalx colours");\r
363     clustalColour.addActionListener(this);\r
364     zappoColour.setLabel("Zappo");\r
365     zappoColour.addActionListener(this);\r
366     taylorColour.setLabel("Taylor");\r
367     taylorColour.addActionListener(this);\r
368     hydrophobicityColour.setLabel("Hydrophobicity");\r
369     hydrophobicityColour.addActionListener(this);\r
370     helixColour.setLabel("Helix propensity");\r
371     helixColour.addActionListener(this);\r
372     strandColour.setLabel("Strand propensity");\r
373     strandColour.addActionListener(this);\r
374     turnColour.setLabel("Turn propensity");\r
375     turnColour.addActionListener(this);\r
376     buriedColour.setLabel("Buried Index");\r
377     buriedColour.addActionListener(this);\r
378     abovePIDColour.setLabel("Above % Identity");\r
379 \r
380     userDefinedColour.setLabel("User Defined");\r
381     userDefinedColour.addActionListener(this);\r
382     PIDColour.setLabel("Percentage Identity");\r
383     PIDColour.addActionListener(this);\r
384     BLOSUM62Colour.setLabel("BLOSUM62");\r
385     BLOSUM62Colour.addActionListener(this);\r
386     conservationMenuItem.setLabel("Conservation");\r
387 \r
388     editMenu.add(copy);\r
389     copy.addActionListener(this);\r
390     editMenu.add(cut);\r
391     cut.addActionListener(this);\r
392     editMenu.add(toUpper);\r
393     toUpper.addActionListener(this);\r
394     editMenu.add(toLower);\r
395     toLower.addActionListener(this);\r
396     editMenu.add(toggleCase);\r
397     seqMenu.add(pdb);\r
398     seqMenu.add(repGroup);\r
399     toggleCase.addActionListener(this);\r
400     pdb.addActionListener(this);\r
401     hideSeqs.addActionListener(this);\r
402     repGroup.addActionListener(this);\r
403     revealAll.addActionListener(this);\r
404 \r
405   }\r
406 \r
407   void refresh()\r
408   {\r
409     ap.seqPanel.seqCanvas.repaint();\r
410     if(ap.overviewPanel!=null)\r
411       ap.overviewPanel.updateOverviewImage();\r
412   }\r
413 \r
414   protected void clustalColour_actionPerformed()\r
415   {\r
416     SequenceGroup sg = getGroup();\r
417     sg.cs = new ClustalxColourScheme(sg.getSequences(true), ap.av.alignment.getWidth());\r
418     refresh();\r
419   }\r
420 \r
421   protected void zappoColour_actionPerformed()\r
422   {\r
423     getGroup().cs = new ZappoColourScheme();\r
424     refresh();\r
425   }\r
426 \r
427   protected void taylorColour_actionPerformed()\r
428   {\r
429     getGroup().cs = new TaylorColourScheme();\r
430     refresh();\r
431   }\r
432 \r
433   protected void hydrophobicityColour_actionPerformed()\r
434   {\r
435     getGroup().cs = new HydrophobicColourScheme();\r
436     refresh();\r
437   }\r
438 \r
439   protected void helixColour_actionPerformed()\r
440   {\r
441     getGroup().cs = new HelixColourScheme();\r
442     refresh();\r
443   }\r
444 \r
445   protected void strandColour_actionPerformed()\r
446   {\r
447     getGroup().cs = new StrandColourScheme();\r
448     refresh();\r
449   }\r
450 \r
451   protected void turnColour_actionPerformed()\r
452   {\r
453     getGroup().cs = new TurnColourScheme();\r
454     refresh();\r
455   }\r
456 \r
457   protected void buriedColour_actionPerformed()\r
458   {\r
459     getGroup().cs = new BuriedColourScheme();\r
460     refresh();\r
461   }\r
462 \r
463   public void nucleotideMenuItem_actionPerformed()\r
464   {\r
465     getGroup().cs = new NucleotideColourScheme();\r
466     refresh();\r
467   }\r
468 \r
469   protected void abovePIDColour_itemStateChanged()\r
470   {\r
471     SequenceGroup sg = getGroup();\r
472     if(sg.cs==null)\r
473           return;\r
474 \r
475     if (abovePIDColour.getState())\r
476     {\r
477       sg.cs.setConsensus(AAFrequency.calculate(sg.getSequences(true), 0,\r
478                                                ap.av.alignment.getWidth()));\r
479       int threshold = SliderPanel.setPIDSliderSource(ap, sg.cs,\r
480           getGroup().getName());\r
481 \r
482       sg.cs.setThreshold(threshold, ap.av.getIgnoreGapsConsensus());\r
483 \r
484       SliderPanel.showPIDSlider();\r
485 \r
486     }\r
487     else // remove PIDColouring\r
488     {\r
489       sg.cs.setThreshold(0, ap.av.getIgnoreGapsConsensus());\r
490     }\r
491 \r
492     refresh();\r
493 \r
494   }\r
495 \r
496   protected void userDefinedColour_actionPerformed()\r
497   {\r
498     new UserDefinedColours(ap, getGroup());\r
499   }\r
500 \r
501   protected void PIDColour_actionPerformed()\r
502   {\r
503     SequenceGroup sg = getGroup();\r
504     sg.cs = new PIDColourScheme();\r
505     sg.cs.setConsensus(AAFrequency.calculate(sg.getSequences(true), 0,\r
506                                              ap.av.alignment.getWidth()));\r
507     refresh();\r
508   }\r
509 \r
510   protected void BLOSUM62Colour_actionPerformed()\r
511   {\r
512     SequenceGroup sg = getGroup();\r
513 \r
514     sg.cs = new Blosum62ColourScheme();\r
515 \r
516     sg.cs.setConsensus(AAFrequency.calculate(sg.getSequences(true), 0,\r
517                                              ap.av.alignment.getWidth()));\r
518 \r
519     refresh();\r
520   }\r
521 \r
522   protected void noColourmenuItem_actionPerformed()\r
523   {\r
524     getGroup().cs = null;\r
525     refresh();\r
526   }\r
527 \r
528   protected void conservationMenuItem_itemStateChanged()\r
529   {\r
530     SequenceGroup sg = getGroup();\r
531     if(sg.cs==null)\r
532           return;\r
533 \r
534     if (conservationMenuItem.getState())\r
535     {\r
536 \r
537       Conservation c = new Conservation("Group",\r
538                                         ResidueProperties.propHash, 3,\r
539                                         sg.getSequences(true), 0,\r
540                                         ap.av.alignment.getWidth());\r
541 \r
542       c.calculate();\r
543       c.verdict(false, ap.av.ConsPercGaps);\r
544 \r
545       sg.cs.setConservation(c);\r
546 \r
547       SliderPanel.setConservationSlider(ap, sg.cs, sg.getName());\r
548       SliderPanel.showConservationSlider();\r
549     }\r
550     else // remove ConservationColouring\r
551     {\r
552       sg.cs.setConservation(null);\r
553     }\r
554 \r
555     refresh();\r
556   }\r
557 \r
558 \r
559   SequenceGroup getGroup()\r
560   {\r
561     SequenceGroup sg = ap.av.getSelectionGroup();\r
562 \r
563     // this method won't add a new group if it already exists\r
564     if(sg!=null)\r
565       ap.av.alignment.addGroup(sg);\r
566 \r
567     return sg;\r
568   }\r
569 \r
570   void unGroupMenuItem_actionPerformed()\r
571   {\r
572     SequenceGroup sg = ap.av.getSelectionGroup();\r
573     ap.av.alignment.deleteGroup(sg);\r
574     ap.av.setSelectionGroup(null);\r
575     ap.repaint();\r
576   }\r
577 \r
578   public void showColourText_itemStateChanged()\r
579   {\r
580     getGroup().setColourText(showColourText.getState());\r
581     refresh();\r
582   }\r
583 \r
584   public void showText_itemStateChanged()\r
585   {\r
586     getGroup().setDisplayText(showText.getState());\r
587     refresh();\r
588   }\r
589 \r
590   public void showBoxes_itemStateChanged()\r
591   {\r
592     getGroup().setDisplayBoxes(showBoxes.getState());\r
593     refresh();\r
594   }\r
595 \r
596   void hideSequences(boolean representGroup)\r
597   {\r
598     SequenceGroup sg = ap.av.getSelectionGroup();\r
599     if(sg==null || sg.getSize(false)<1)\r
600     {\r
601       ap.av.hideSequence(seq);\r
602       return;\r
603     }\r
604 \r
605       int index = 0;\r
606       while(index < sg.getSize(false))\r
607       {\r
608         if(representGroup && sg.getSequenceAt(index)!=seq)\r
609         {\r
610           seq.addHiddenSequence(sg.getSequenceAt(index));\r
611           ap.av.hideSequence(sg.getSequenceAt(index));\r
612         }\r
613         else if(!representGroup)\r
614         {\r
615           ap.av.hideSequence(sg.getSequenceAt(index));\r
616         }\r
617         index ++;\r
618       }\r
619 \r
620       ap.av.setSelectionGroup(null);\r
621     }\r
622 \r
623 }\r