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