WRITEABLE_FORMATS and READABLE_FORMATS string []
[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         ap.repaint();\r
230     }\r
231 \r
232     else if(source==copy)\r
233       ap.alignFrame.copy_actionPerformed();\r
234     else if(source==cut)\r
235       ap.alignFrame.cut_actionPerformed();\r
236     else if(source==toUpper || source==toLower || source==toggleCase)\r
237     {\r
238       SequenceGroup sg = ap.av.getSelectionGroup();\r
239       if (sg != null)\r
240       {\r
241         for (int g = 0; g < sg.getSize(true); g++)\r
242         {\r
243           if (source == toggleCase)\r
244            ((SequenceI) sg.getSequences(true).elementAt(g))\r
245           .toggleCase(sg.getStartRes(), sg.getEndRes() + 1);\r
246           else\r
247             ((SequenceI) sg.getSequences(true).elementAt(g))\r
248                 .changeCase(source == toUpper, sg.getStartRes(),\r
249                                            sg.getEndRes() + 1);\r
250         }\r
251         ap.seqPanel.seqCanvas.repaint();\r
252       }\r
253     }\r
254     else\r
255       outputText(evt);\r
256 \r
257   }\r
258 \r
259   void outputText(ActionEvent e)\r
260   {\r
261     CutAndPasteTransfer cap = new CutAndPasteTransfer(false, ap.alignFrame);\r
262     Vector vseqs = new Vector();\r
263 \r
264       String [] selection = ap.av.getViewAsString(true);\r
265       SequenceI [] seqs = ap.av.getSelectionAsNewSequence();\r
266       if (selection != null)\r
267       {\r
268         for (int i = 0; i < selection.length; i++)\r
269         {\r
270           Sequence seq = new Sequence(\r
271               seqs[i].getName(),\r
272               selection[i],\r
273               seqs[i].getStart(), seqs[i].getEnd());\r
274           seq.setDescription(seqs[i].getDescription());\r
275           vseqs.addElement( seq );\r
276       }\r
277     }\r
278 \r
279     Frame frame = new Frame();\r
280     frame.add(cap);\r
281     jalview.bin.JalviewLite.addFrame(frame,\r
282                                      "Selection output - " + e.getActionCommand(),\r
283                                      600, 500);\r
284 \r
285     cap.setText(new jalview.io.AppletFormatAdapter().formatSequences(\r
286         e.getActionCommand(),\r
287         vseqs,\r
288         ap.av.showJVSuffix));\r
289 \r
290   }\r
291 \r
292   void addPDB()\r
293   {\r
294     CutAndPasteTransfer cap = new CutAndPasteTransfer(true, ap.alignFrame);\r
295     cap.setText("Paste your PDB file here.");\r
296     cap.setPDBImport(seq);\r
297     Frame frame = new Frame();\r
298     frame.add(cap);\r
299     jalview.bin.JalviewLite.addFrame(frame, "Paste PDB file ", 400, 300);\r
300   }\r
301 \r
302   private void jbInit()\r
303       throws Exception\r
304   {\r
305     groupMenu.setLabel("Group");\r
306     groupMenu.setLabel("Selection");\r
307 \r
308     unGroupMenuItem.setLabel("Remove Group");\r
309     unGroupMenuItem.addActionListener(this);\r
310 \r
311     nucleotideMenuItem.setLabel("Nucleotide");\r
312     nucleotideMenuItem.addActionListener(this);\r
313     conservationMenuItem.addItemListener(this);\r
314     abovePIDColour.addItemListener(this);\r
315     colourMenu.setLabel("Group Colour");\r
316     showBoxes.setLabel("Boxes");\r
317     showBoxes.setState(true);\r
318     showBoxes.addItemListener(this);\r
319 \r
320     showText.setLabel("Text");\r
321     showText.addItemListener(this);\r
322     showColourText.setLabel("Colour Text");\r
323     showColourText.addItemListener(this);\r
324     outputmenu.setLabel("Output to Textbox...");\r
325     seqMenu.setLabel("Sequence");\r
326     pdb.setLabel("View PDB Structure");\r
327     hideSeqs.setLabel("Hide Sequences");\r
328     repGroup.setLabel("Represent Group with");\r
329     revealAll.setLabel("Reveal All");\r
330 \r
331     add(groupMenu);\r
332     this.add(seqMenu);\r
333     this.add(hideSeqs);\r
334     this.add(revealAll);\r
335     groupMenu.add(editMenu);\r
336     groupMenu.add(outputmenu);\r
337     groupMenu.addSeparator();\r
338     groupMenu.add(unGroupMenuItem);\r
339     groupMenu.add(colourMenu);\r
340     groupMenu.add(showBoxes);\r
341     groupMenu.add(showText);\r
342     groupMenu.add(showColourText);\r
343     colourMenu.add(noColourmenuItem);\r
344     colourMenu.add(clustalColour);\r
345     colourMenu.add(BLOSUM62Colour);\r
346     colourMenu.add(PIDColour);\r
347     colourMenu.add(zappoColour);\r
348     colourMenu.add(taylorColour);\r
349     colourMenu.add(hydrophobicityColour);\r
350     colourMenu.add(helixColour);\r
351     colourMenu.add(strandColour);\r
352     colourMenu.add(turnColour);\r
353     colourMenu.add(buriedColour);\r
354     colourMenu.add(nucleotideMenuItem);\r
355     colourMenu.add(userDefinedColour);\r
356     colourMenu.addSeparator();\r
357     colourMenu.add(abovePIDColour);\r
358     colourMenu.add(conservationMenuItem);\r
359 \r
360     noColourmenuItem.setLabel("None");\r
361     noColourmenuItem.addActionListener(this);\r
362 \r
363     clustalColour.setLabel("Clustalx colours");\r
364     clustalColour.addActionListener(this);\r
365     zappoColour.setLabel("Zappo");\r
366     zappoColour.addActionListener(this);\r
367     taylorColour.setLabel("Taylor");\r
368     taylorColour.addActionListener(this);\r
369     hydrophobicityColour.setLabel("Hydrophobicity");\r
370     hydrophobicityColour.addActionListener(this);\r
371     helixColour.setLabel("Helix propensity");\r
372     helixColour.addActionListener(this);\r
373     strandColour.setLabel("Strand propensity");\r
374     strandColour.addActionListener(this);\r
375     turnColour.setLabel("Turn propensity");\r
376     turnColour.addActionListener(this);\r
377     buriedColour.setLabel("Buried Index");\r
378     buriedColour.addActionListener(this);\r
379     abovePIDColour.setLabel("Above % Identity");\r
380 \r
381     userDefinedColour.setLabel("User Defined");\r
382     userDefinedColour.addActionListener(this);\r
383     PIDColour.setLabel("Percentage Identity");\r
384     PIDColour.addActionListener(this);\r
385     BLOSUM62Colour.setLabel("BLOSUM62");\r
386     BLOSUM62Colour.addActionListener(this);\r
387     conservationMenuItem.setLabel("Conservation");\r
388 \r
389     editMenu.add(copy);\r
390     copy.addActionListener(this);\r
391     editMenu.add(cut);\r
392     cut.addActionListener(this);\r
393     editMenu.add(toUpper);\r
394     toUpper.addActionListener(this);\r
395     editMenu.add(toLower);\r
396     toLower.addActionListener(this);\r
397     editMenu.add(toggleCase);\r
398     seqMenu.add(pdb);\r
399     seqMenu.add(repGroup);\r
400     toggleCase.addActionListener(this);\r
401     pdb.addActionListener(this);\r
402     hideSeqs.addActionListener(this);\r
403     repGroup.addActionListener(this);\r
404     revealAll.addActionListener(this);\r
405 \r
406   }\r
407 \r
408   void refresh()\r
409   {\r
410     ap.seqPanel.seqCanvas.repaint();\r
411     if(ap.overviewPanel!=null)\r
412       ap.overviewPanel.updateOverviewImage();\r
413   }\r
414 \r
415   protected void clustalColour_actionPerformed()\r
416   {\r
417     SequenceGroup sg = getGroup();\r
418     sg.cs = new ClustalxColourScheme(sg.getSequences(true), ap.av.alignment.getWidth());\r
419     refresh();\r
420   }\r
421 \r
422   protected void zappoColour_actionPerformed()\r
423   {\r
424     getGroup().cs = new ZappoColourScheme();\r
425     refresh();\r
426   }\r
427 \r
428   protected void taylorColour_actionPerformed()\r
429   {\r
430     getGroup().cs = new TaylorColourScheme();\r
431     refresh();\r
432   }\r
433 \r
434   protected void hydrophobicityColour_actionPerformed()\r
435   {\r
436     getGroup().cs = new HydrophobicColourScheme();\r
437     refresh();\r
438   }\r
439 \r
440   protected void helixColour_actionPerformed()\r
441   {\r
442     getGroup().cs = new HelixColourScheme();\r
443     refresh();\r
444   }\r
445 \r
446   protected void strandColour_actionPerformed()\r
447   {\r
448     getGroup().cs = new StrandColourScheme();\r
449     refresh();\r
450   }\r
451 \r
452   protected void turnColour_actionPerformed()\r
453   {\r
454     getGroup().cs = new TurnColourScheme();\r
455     refresh();\r
456   }\r
457 \r
458   protected void buriedColour_actionPerformed()\r
459   {\r
460     getGroup().cs = new BuriedColourScheme();\r
461     refresh();\r
462   }\r
463 \r
464   public void nucleotideMenuItem_actionPerformed()\r
465   {\r
466     getGroup().cs = new NucleotideColourScheme();\r
467     refresh();\r
468   }\r
469 \r
470   protected void abovePIDColour_itemStateChanged()\r
471   {\r
472     SequenceGroup sg = getGroup();\r
473     if(sg.cs==null)\r
474           return;\r
475 \r
476     if (abovePIDColour.getState())\r
477     {\r
478       sg.cs.setConsensus(AAFrequency.calculate(sg.getSequences(true), 0,\r
479                                                ap.av.alignment.getWidth()));\r
480       int threshold = SliderPanel.setPIDSliderSource(ap, sg.cs,\r
481           getGroup().getName());\r
482 \r
483       sg.cs.setThreshold(threshold, ap.av.getIgnoreGapsConsensus());\r
484 \r
485       SliderPanel.showPIDSlider();\r
486 \r
487     }\r
488     else // remove PIDColouring\r
489     {\r
490       sg.cs.setThreshold(0, ap.av.getIgnoreGapsConsensus());\r
491     }\r
492 \r
493     refresh();\r
494 \r
495   }\r
496 \r
497   protected void userDefinedColour_actionPerformed()\r
498   {\r
499     new UserDefinedColours(ap, getGroup());\r
500   }\r
501 \r
502   protected void PIDColour_actionPerformed()\r
503   {\r
504     SequenceGroup sg = getGroup();\r
505     sg.cs = new PIDColourScheme();\r
506     sg.cs.setConsensus(AAFrequency.calculate(sg.getSequences(true), 0,\r
507                                              ap.av.alignment.getWidth()));\r
508     refresh();\r
509   }\r
510 \r
511   protected void BLOSUM62Colour_actionPerformed()\r
512   {\r
513     SequenceGroup sg = getGroup();\r
514 \r
515     sg.cs = new Blosum62ColourScheme();\r
516 \r
517     sg.cs.setConsensus(AAFrequency.calculate(sg.getSequences(true), 0,\r
518                                              ap.av.alignment.getWidth()));\r
519 \r
520     refresh();\r
521   }\r
522 \r
523   protected void noColourmenuItem_actionPerformed()\r
524   {\r
525     getGroup().cs = null;\r
526     refresh();\r
527   }\r
528 \r
529   protected void conservationMenuItem_itemStateChanged()\r
530   {\r
531     SequenceGroup sg = getGroup();\r
532     if(sg.cs==null)\r
533           return;\r
534 \r
535     if (conservationMenuItem.getState())\r
536     {\r
537 \r
538       Conservation c = new Conservation("Group",\r
539                                         ResidueProperties.propHash, 3,\r
540                                         sg.getSequences(true), 0,\r
541                                         ap.av.alignment.getWidth());\r
542 \r
543       c.calculate();\r
544       c.verdict(false, ap.av.ConsPercGaps);\r
545 \r
546       sg.cs.setConservation(c);\r
547 \r
548       SliderPanel.setConservationSlider(ap, sg.cs, sg.getName());\r
549       SliderPanel.showConservationSlider();\r
550     }\r
551     else // remove ConservationColouring\r
552     {\r
553       sg.cs.setConservation(null);\r
554     }\r
555 \r
556     refresh();\r
557   }\r
558 \r
559 \r
560   SequenceGroup getGroup()\r
561   {\r
562     SequenceGroup sg = ap.av.getSelectionGroup();\r
563 \r
564     // this method won't add a new group if it already exists\r
565     if(sg!=null)\r
566       ap.av.alignment.addGroup(sg);\r
567 \r
568     return sg;\r
569   }\r
570 \r
571   void unGroupMenuItem_actionPerformed()\r
572   {\r
573     SequenceGroup sg = ap.av.getSelectionGroup();\r
574     ap.av.alignment.deleteGroup(sg);\r
575     ap.av.setSelectionGroup(null);\r
576     ap.repaint();\r
577   }\r
578 \r
579   public void showColourText_itemStateChanged()\r
580   {\r
581     getGroup().setColourText(showColourText.getState());\r
582     refresh();\r
583   }\r
584 \r
585   public void showText_itemStateChanged()\r
586   {\r
587     getGroup().setDisplayText(showText.getState());\r
588     refresh();\r
589   }\r
590 \r
591   public void showBoxes_itemStateChanged()\r
592   {\r
593     getGroup().setDisplayBoxes(showBoxes.getState());\r
594     refresh();\r
595   }\r
596 \r
597   void hideSequences(boolean representGroup)\r
598   {\r
599     SequenceGroup sg = ap.av.getSelectionGroup();\r
600     if(sg==null || sg.getSize(false)<1)\r
601     {\r
602       ap.av.hideSequence(seq);\r
603       return;\r
604     }\r
605 \r
606       int index = 0;\r
607       while(index < sg.getSize(false))\r
608       {\r
609         if(representGroup && sg.getSequenceAt(index)!=seq)\r
610         {\r
611           seq.addHiddenSequence(sg.getSequenceAt(index));\r
612           ap.av.hideSequence(sg.getSequenceAt(index));\r
613         }\r
614         else if(!representGroup)\r
615         {\r
616           ap.av.hideSequence(sg.getSequenceAt(index));\r
617         }\r
618         index ++;\r
619       }\r
620 \r
621       ap.av.setSelectionGroup(null);\r
622       ap.repaint();\r
623       refresh();\r
624     }\r
625 \r
626 }\r