1d2feb24114fbc0d64f7003a2ce9ae57c4311289
[jalview.git] / src / jalview / appletgui / APopupMenu.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.analysis.AAFrequency;
24 import jalview.analysis.AlignmentAnnotationUtils;
25 import jalview.analysis.AlignmentUtils;
26 import jalview.analysis.Conservation;
27 import jalview.commands.ChangeCaseCommand;
28 import jalview.commands.EditCommand;
29 import jalview.commands.EditCommand.Action;
30 import jalview.datamodel.AlignmentAnnotation;
31 import jalview.datamodel.AlignmentI;
32 import jalview.datamodel.DBRefEntry;
33 import jalview.datamodel.PDBEntry;
34 import jalview.datamodel.SequenceFeature;
35 import jalview.datamodel.SequenceGroup;
36 import jalview.datamodel.SequenceI;
37 import jalview.io.AppletFormatAdapter;
38 import jalview.io.SequenceAnnotationReport;
39 import jalview.schemes.Blosum62ColourScheme;
40 import jalview.schemes.BuriedColourScheme;
41 import jalview.schemes.ClustalxColourScheme;
42 import jalview.schemes.HelixColourScheme;
43 import jalview.schemes.HydrophobicColourScheme;
44 import jalview.schemes.NucleotideColourScheme;
45 import jalview.schemes.PIDColourScheme;
46 import jalview.schemes.ResidueProperties;
47 import jalview.schemes.StrandColourScheme;
48 import jalview.schemes.TaylorColourScheme;
49 import jalview.schemes.TurnColourScheme;
50 import jalview.schemes.ZappoColourScheme;
51 import jalview.util.MessageManager;
52 import jalview.util.UrlLink;
53
54 import java.awt.CheckboxMenuItem;
55 import java.awt.Frame;
56 import java.awt.Menu;
57 import java.awt.MenuItem;
58 import java.awt.event.ActionEvent;
59 import java.awt.event.ActionListener;
60 import java.awt.event.ItemEvent;
61 import java.awt.event.ItemListener;
62 import java.util.Arrays;
63 import java.util.Collections;
64 import java.util.LinkedHashMap;
65 import java.util.List;
66 import java.util.Map;
67 import java.util.TreeMap;
68 import java.util.Vector;
69
70 public class APopupMenu extends java.awt.PopupMenu implements
71         ActionListener, ItemListener
72 {
73   private static final String ALL_ANNOTATIONS = "All";
74
75   Menu groupMenu = new Menu();
76
77   MenuItem editGroupName = new MenuItem();
78
79   protected MenuItem clustalColour = new MenuItem();
80
81   protected MenuItem zappoColour = new MenuItem();
82
83   protected MenuItem taylorColour = new MenuItem();
84
85   protected MenuItem hydrophobicityColour = new MenuItem();
86
87   protected MenuItem helixColour = new MenuItem();
88
89   protected MenuItem strandColour = new MenuItem();
90
91   protected MenuItem turnColour = new MenuItem();
92
93   protected MenuItem buriedColour = new MenuItem();
94
95   protected CheckboxMenuItem abovePIDColour = new CheckboxMenuItem();
96
97   protected MenuItem userDefinedColour = new MenuItem();
98
99   protected MenuItem PIDColour = new MenuItem();
100
101   protected MenuItem BLOSUM62Colour = new MenuItem();
102
103   MenuItem noColourmenuItem = new MenuItem();
104
105   protected CheckboxMenuItem conservationMenuItem = new CheckboxMenuItem();
106
107   final AlignmentPanel ap;
108
109   MenuItem unGroupMenuItem = new MenuItem();
110
111   MenuItem createGroupMenuItem = new MenuItem();
112
113   MenuItem nucleotideMenuItem = new MenuItem();
114
115   Menu colourMenu = new Menu();
116
117   CheckboxMenuItem showBoxes = new CheckboxMenuItem();
118
119   CheckboxMenuItem showText = new CheckboxMenuItem();
120
121   CheckboxMenuItem showColourText = new CheckboxMenuItem();
122
123   CheckboxMenuItem displayNonconserved = new CheckboxMenuItem();
124
125   Menu seqShowAnnotationsMenu = new Menu(
126           MessageManager.getString("label.show_annotations"));
127
128   Menu seqHideAnnotationsMenu = new Menu(
129           MessageManager.getString("label.hide_annotations"));
130
131   MenuItem seqAddReferenceAnnotations = new MenuItem(
132           MessageManager.getString("label.add_reference_annotations"));
133
134   Menu groupShowAnnotationsMenu = new Menu(
135           MessageManager.getString("label.show_annotations"));
136
137   Menu groupHideAnnotationsMenu = new Menu(
138           MessageManager.getString("label.hide_annotations"));
139
140   MenuItem groupAddReferenceAnnotations = new MenuItem(
141           MessageManager.getString("label.add_reference_annotations"));
142
143   Menu editMenu = new Menu(MessageManager.getString("action.edit"));
144
145   MenuItem copy = new MenuItem(MessageManager.getString("action.copy"));
146
147   MenuItem cut = new MenuItem(MessageManager.getString("action.cut"));
148
149   MenuItem toUpper = new MenuItem(
150           MessageManager.getString("label.to_upper_case"));
151
152   MenuItem toLower = new MenuItem(
153           MessageManager.getString("label.to_lower_case"));
154
155   MenuItem toggleCase = new MenuItem(
156           MessageManager.getString("label.toggle_case"));
157
158   Menu outputmenu = new Menu();
159
160   Menu seqMenu = new Menu();
161
162   MenuItem pdb = new MenuItem();
163
164   MenuItem hideSeqs = new MenuItem();
165
166   MenuItem repGroup = new MenuItem();
167
168   MenuItem sequenceName = new MenuItem(
169           MessageManager.getString("label.edit_name_description"));
170
171   MenuItem sequenceFeature = new MenuItem(
172           MessageManager.getString("label.create_sequence_feature"));
173
174   MenuItem editSequence = new MenuItem(
175           MessageManager.getString("label.edit_sequence"));
176
177   MenuItem sequenceDetails = new MenuItem(
178           MessageManager.getString("label.sequence_details"));
179
180   MenuItem selSeqDetails = new MenuItem(
181           MessageManager.getString("label.sequence_details"));
182
183   MenuItem makeReferenceSeq = new MenuItem();
184
185   SequenceI seq;
186
187   MenuItem revealAll = new MenuItem();
188
189   MenuItem revealSeq = new MenuItem();
190
191   /**
192    * index of sequence to be revealed
193    */
194   int revealSeq_index = -1;
195
196   Menu menu1 = new Menu();
197
198   public APopupMenu(AlignmentPanel apanel, final SequenceI seq,
199           Vector<String> links)
200   {
201     // /////////////////////////////////////////////////////////
202     // If this is activated from the sequence panel, the user may want to
203     // edit or annotate a particular residue. Therefore display the residue menu
204     //
205     // If from the IDPanel, we must display the sequence menu
206     // ////////////////////////////////////////////////////////
207
208     this.ap = apanel;
209     this.seq = seq;
210
211     try
212     {
213       jbInit();
214     } catch (Exception e)
215     {
216       e.printStackTrace();
217     }
218
219     for (int i = 0; i < jalview.io.AppletFormatAdapter.WRITEABLE_FORMATS.length; i++)
220     {
221       MenuItem item = new MenuItem(
222               jalview.io.AppletFormatAdapter.WRITEABLE_FORMATS[i]);
223
224       item.addActionListener(this);
225       outputmenu.add(item);
226     }
227
228     buildAnnotationSubmenus();
229
230     SequenceGroup sg = ap.av.getSelectionGroup();
231     if (sg != null && sg.getSize() > 0)
232     {
233       editGroupName.setLabel(MessageManager.formatMessage(
234               "label.name_param", new Object[] { sg.getName() }));
235       showText.setState(sg.getDisplayText());
236       showColourText.setState(sg.getColourText());
237       showBoxes.setState(sg.getDisplayBoxes());
238       displayNonconserved.setState(sg.getShowNonconserved());
239       if (!ap.av.getAlignment().getGroups().contains(sg))
240       {
241         menu1.setLabel(MessageManager.getString("action.edit_new_group"));
242         groupMenu.remove(unGroupMenuItem);
243       }
244       else
245       {
246         menu1.setLabel(MessageManager.getString("action.edit_group"));
247         groupMenu.remove(createGroupMenuItem);
248       }
249
250     }
251     else
252     {
253       remove(hideSeqs);
254       remove(groupMenu);
255     }
256
257     if (links != null && links.size() > 0)
258     {
259       Menu linkMenu = new Menu(MessageManager.getString("action.link"));
260       for (int i = 0; i < links.size(); i++)
261       {
262         String link = links.elementAt(i);
263         UrlLink urlLink = new UrlLink(link);
264         if (!urlLink.isValid())
265         {
266           System.err.println(urlLink.getInvalidMessage());
267           continue;
268         }
269         final String target = urlLink.getTarget(); // link.substring(0,
270         // link.indexOf("|"));
271         final String label = urlLink.getLabel();
272         if (seq != null && urlLink.isDynamic())
273         {
274
275           // collect matching db-refs
276           DBRefEntry[] dbr = jalview.util.DBRefUtils.selectRefs(
277                   seq.getDBRef(), new String[] { target });
278           // collect id string too
279           String id = seq.getName();
280           String descr = seq.getDescription();
281           if (descr != null && descr.length() < 1)
282           {
283             descr = null;
284           }
285           if (dbr != null)
286           {
287             for (int r = 0; r < dbr.length; r++)
288             {
289               if (id != null && dbr[r].getAccessionId().equals(id))
290               {
291                 // suppress duplicate link creation for the bare sequence ID
292                 // string with this link
293                 id = null;
294               }
295               // create Bare ID link for this RUL
296               String[] urls = urlLink.makeUrls(dbr[r].getAccessionId(),
297                       true);
298               if (urls != null)
299               {
300                 for (int u = 0; u < urls.length; u += 2)
301                 {
302                   addshowLink(linkMenu, label + "|" + urls[u], urls[u + 1]);
303                 }
304               }
305             }
306           }
307           if (id != null)
308           {
309             // create Bare ID link for this RUL
310             String[] urls = urlLink.makeUrls(id, true);
311             if (urls != null)
312             {
313               for (int u = 0; u < urls.length; u += 2)
314               {
315                 addshowLink(linkMenu, label, urls[u + 1]);
316               }
317             }
318             // addshowLink(linkMenu, target, url_pref + id + url_suff);
319           }
320           // Now construct URLs from description but only try to do it for regex
321           // URL links
322           if (descr != null && urlLink.getRegexReplace() != null)
323           {
324             // create link for this URL from description only if regex matches
325             String[] urls = urlLink.makeUrls(descr, true);
326             if (urls != null)
327             {
328               for (int u = 0; u < urls.length; u += 2)
329               {
330                 addshowLink(linkMenu, label, urls[u + 1]);
331               }
332             }
333           }
334         }
335         else
336         {
337           addshowLink(linkMenu, target, urlLink.getUrl_prefix()); // link.substring(link.lastIndexOf("|")+1));
338         }
339         /*
340          * final String url;
341          * 
342          * if (link.indexOf("$SEQUENCE_ID$") > -1) { // Substitute SEQUENCE_ID
343          * string and any matching database reference accessions String url_pref
344          * = link.substring(link.indexOf("|") + 1,
345          * link.indexOf("$SEQUENCE_ID$"));
346          * 
347          * String url_suff = link.substring(link.indexOf("$SEQUENCE_ID$") + 13);
348          * // collect matching db-refs DBRefEntry[] dbr =
349          * jalview.util.DBRefUtils.selectRefs(seq.getDBRef(), new
350          * String[]{target}); // collect id string too String id =
351          * seq.getName(); if (id.indexOf("|") > -1) { id =
352          * id.substring(id.lastIndexOf("|") + 1); } if (dbr!=null) { for (int
353          * r=0;r<dbr.length; r++) { if (dbr[r].getAccessionId().equals(id)) { //
354          * suppress duplicate link creation for the bare sequence ID string with
355          * this link id = null; } addshowLink(linkMenu,
356          * dbr[r].getSource()+"|"+dbr[r].getAccessionId(), target,
357          * url_pref+dbr[r].getAccessionId()+url_suff); } } if (id!=null) { //
358          * create Bare ID link for this RUL addshowLink(linkMenu, target,
359          * url_pref + id + url_suff); } } else { addshowLink(linkMenu, target,
360          * link.substring(link.lastIndexOf("|")+1)); }
361          */
362       }
363       if (linkMenu.getItemCount() > 0)
364       {
365         if (seq != null)
366         {
367           seqMenu.add(linkMenu);
368         }
369         else
370         {
371           add(linkMenu);
372         }
373       }
374     }
375     // TODO: add group link menu entry here
376     if (seq != null)
377     {
378       seqMenu.setLabel(seq.getName());
379       if (seq == ap.av.getAlignment().getSeqrep())
380       {
381         makeReferenceSeq.setLabel(MessageManager
382                 .getString("action.unmark_as_reference"));// Unmark
383                                                           // representative");
384       }
385       else
386       {
387         makeReferenceSeq.setLabel(MessageManager
388                 .getString("action.set_as_reference")); // );
389       }
390       repGroup.setLabel(MessageManager.formatMessage(
391               "label.represent_group_with", new Object[] { seq.getName() }));
392     }
393     else
394     {
395       remove(seqMenu);
396     }
397
398     if (!ap.av.hasHiddenRows())
399     {
400       remove(revealAll);
401       remove(revealSeq);
402     }
403     else
404     {
405       final int index = ap.av.getAlignment().findIndex(seq);
406
407       if (ap.av.adjustForHiddenSeqs(index)
408               - ap.av.adjustForHiddenSeqs(index - 1) > 1)
409       {
410         revealSeq_index = index;
411       }
412       else
413       {
414         remove(revealSeq);
415       }
416     }
417   }
418
419   /**
420    * Build menus for annotation types that may be shown or hidden, and for
421    * 'reference annotations' that may be added to the alignment.
422    */
423   private void buildAnnotationSubmenus()
424   {
425     /*
426      * First for the currently selected sequence (if there is one):
427      */
428     final List<SequenceI> selectedSequence = (seq == null ? Collections
429             .<SequenceI> emptyList() : Arrays.asList(seq));
430     buildAnnotationTypesMenus(seqShowAnnotationsMenu,
431             seqHideAnnotationsMenu, selectedSequence);
432     configureReferenceAnnotationsMenu(seqAddReferenceAnnotations,
433             selectedSequence);
434
435     /*
436      * and repeat for the current selection group (if there is one):
437      */
438     final List<SequenceI> selectedGroup = (ap.av.getSelectionGroup() == null ? Collections
439             .<SequenceI> emptyList() : ap.av.getSelectionGroup()
440             .getSequences());
441     buildAnnotationTypesMenus(groupShowAnnotationsMenu,
442             groupHideAnnotationsMenu, selectedGroup);
443     configureReferenceAnnotationsMenu(groupAddReferenceAnnotations,
444             selectedGroup);
445   }
446
447   /**
448    * Determine whether or not to enable 'add reference annotations' menu item.
449    * It is enable if there are any annotations, on any of the selected
450    * sequences, which are not yet on the alignment (visible or not).
451    * 
452    * @param menu
453    * @param forSequences
454    */
455   private void configureReferenceAnnotationsMenu(MenuItem menuItem,
456           List<SequenceI> forSequences)
457   {
458     menuItem.setEnabled(false);
459
460     /*
461      * Temporary store to hold distinct calcId / type pairs for the tooltip.
462      * Using TreeMap means calcIds are shown in alphabetical order.
463      */
464     Map<String, String> tipEntries = new TreeMap<String, String>();
465     final Map<SequenceI, List<AlignmentAnnotation>> candidates = new LinkedHashMap<SequenceI, List<AlignmentAnnotation>>();
466     AlignmentI al = this.ap.av.getAlignment();
467     AlignmentUtils.findAddableReferenceAnnotations(forSequences,
468             tipEntries, candidates, al);
469     if (!candidates.isEmpty())
470     {
471       StringBuilder tooltip = new StringBuilder(64);
472       tooltip.append(MessageManager.getString("label.add_annotations_for"));
473
474       /*
475        * Found annotations that could be added. Enable the menu item, and
476        * configure its action.
477        */
478       menuItem.setEnabled(true);
479
480       menuItem.addActionListener(new ActionListener()
481       {
482         @Override
483         public void actionPerformed(ActionEvent e)
484         {
485           addReferenceAnnotations_actionPerformed(candidates);
486         }
487       });
488     }
489   }
490
491   /**
492    * Add annotations to the sequences and to the alignment.
493    * 
494    * @param candidates
495    *          a map whose keys are sequences on the alignment, and values a list
496    *          of annotations to add to each sequence
497    */
498   protected void addReferenceAnnotations_actionPerformed(
499           Map<SequenceI, List<AlignmentAnnotation>> candidates)
500   {
501     final SequenceGroup selectionGroup = this.ap.av.getSelectionGroup();
502     final AlignmentI alignment = this.ap.getAlignment();
503     AlignmentUtils.addReferenceAnnotations(candidates, alignment,
504             selectionGroup);
505     refresh();
506   }
507
508   /**
509    * add a show URL menu item to the given linkMenu
510    * 
511    * @param linkMenu
512    * @param target
513    *          - menu label string
514    * @param url
515    *          - url to open
516    */
517   private void addshowLink(Menu linkMenu, final String target,
518           final String url)
519   {
520     addshowLink(linkMenu, target, target, url);
521   }
522
523   /**
524    * add a show URL menu item to the given linkMenu
525    * 
526    * @param linkMenu
527    * @param target
528    *          - URL target window
529    * @param label
530    *          - menu label string
531    * @param url
532    *          - url to open
533    */
534   private void addshowLink(Menu linkMenu, final String target,
535           final String label, final String url)
536   {
537     MenuItem item = new MenuItem(label);
538     item.addActionListener(new java.awt.event.ActionListener()
539     {
540       public void actionPerformed(ActionEvent e)
541       {
542         ap.alignFrame.showURL(url, target);
543       }
544     });
545     linkMenu.add(item);
546   }
547
548   public void itemStateChanged(ItemEvent evt)
549   {
550     if (evt.getSource() == abovePIDColour)
551     {
552       abovePIDColour_itemStateChanged();
553     }
554     else if (evt.getSource() == showColourText)
555     {
556       showColourText_itemStateChanged();
557     }
558     else if (evt.getSource() == showText)
559     {
560       showText_itemStateChanged();
561     }
562     else if (evt.getSource() == showBoxes)
563     {
564       showBoxes_itemStateChanged();
565     }
566     else if (evt.getSource() == displayNonconserved)
567     {
568       this.showNonconserved_itemStateChanged();
569     }
570   }
571
572   public void actionPerformed(ActionEvent evt)
573   {
574     Object source = evt.getSource();
575     if (source == clustalColour)
576     {
577       clustalColour_actionPerformed();
578     }
579     else if (source == zappoColour)
580     {
581       zappoColour_actionPerformed();
582     }
583     else if (source == taylorColour)
584     {
585       taylorColour_actionPerformed();
586     }
587     else if (source == hydrophobicityColour)
588     {
589       hydrophobicityColour_actionPerformed();
590     }
591     else if (source == helixColour)
592     {
593       helixColour_actionPerformed();
594     }
595     else if (source == strandColour)
596     {
597       strandColour_actionPerformed();
598     }
599     else if (source == turnColour)
600     {
601       turnColour_actionPerformed();
602     }
603     else if (source == buriedColour)
604     {
605       buriedColour_actionPerformed();
606     }
607     else if (source == nucleotideMenuItem)
608     {
609       nucleotideMenuItem_actionPerformed();
610     }
611
612     else if (source == userDefinedColour)
613     {
614       userDefinedColour_actionPerformed();
615     }
616     else if (source == PIDColour)
617     {
618       PIDColour_actionPerformed();
619     }
620     else if (source == BLOSUM62Colour)
621     {
622       BLOSUM62Colour_actionPerformed();
623     }
624     else if (source == noColourmenuItem)
625     {
626       noColourmenuItem_actionPerformed();
627     }
628     else if (source == conservationMenuItem)
629     {
630       conservationMenuItem_itemStateChanged();
631     }
632     else if (source == unGroupMenuItem)
633     {
634       unGroupMenuItem_actionPerformed();
635     }
636
637     else if (source == createGroupMenuItem)
638     {
639       createGroupMenuItem_actionPerformed();
640     }
641
642     else if (source == sequenceName)
643     {
644       editName();
645     }
646     else if (source == makeReferenceSeq)
647     {
648       makeReferenceSeq_actionPerformed();
649     }
650     else if (source == sequenceDetails)
651     {
652       showSequenceDetails();
653     }
654     else if (source == selSeqDetails)
655     {
656       showSequenceSelectionDetails();
657     }
658     else if (source == pdb)
659     {
660       addPDB();
661     }
662     else if (source == hideSeqs)
663     {
664       hideSequences(false);
665     }
666     else if (source == repGroup)
667     {
668       hideSequences(true);
669     }
670     else if (source == revealSeq)
671     {
672       ap.av.showSequence(revealSeq_index);
673     }
674     else if (source == revealAll)
675     {
676       ap.av.showAllHiddenSeqs();
677     }
678
679     else if (source == editGroupName)
680     {
681       EditNameDialog dialog = new EditNameDialog(getGroup().getName(),
682               getGroup().getDescription(), "       Group Name",
683               "Group Description", ap.alignFrame,
684               "Edit Group Name / Description", 500, 100, true);
685
686       if (dialog.accept)
687       {
688         getGroup().setName(dialog.getName().replace(' ', '_'));
689         getGroup().setDescription(dialog.getDescription());
690       }
691
692     }
693     else if (source == copy)
694     {
695       ap.alignFrame.copy_actionPerformed();
696     }
697     else if (source == cut)
698     {
699       ap.alignFrame.cut_actionPerformed();
700     }
701     else if (source == editSequence)
702     {
703       SequenceGroup sg = ap.av.getSelectionGroup();
704
705       if (sg != null)
706       {
707         if (seq == null)
708         {
709           seq = sg.getSequenceAt(0);
710         }
711
712         EditNameDialog dialog = new EditNameDialog(seq.getSequenceAsString(
713                 sg.getStartRes(), sg.getEndRes() + 1), null,
714                 "Edit Sequence ", null,
715
716                 ap.alignFrame, "Edit Sequence", 500, 100, true);
717
718         if (dialog.accept)
719         {
720           EditCommand editCommand = new EditCommand(
721                   MessageManager.getString("label.edit_sequences"),
722                   Action.REPLACE, dialog.getName().replace(' ',
723                           ap.av.getGapCharacter()),
724                   sg.getSequencesAsArray(ap.av.getHiddenRepSequences()),
725                   sg.getStartRes(), sg.getEndRes() + 1,
726                   ap.av.getAlignment());
727
728           ap.alignFrame.addHistoryItem(editCommand);
729
730           ap.av.firePropertyChange("alignment", null, ap.av.getAlignment()
731                   .getSequences());
732         }
733       }
734     }
735     else if (source == toUpper || source == toLower || source == toggleCase)
736     {
737       SequenceGroup sg = ap.av.getSelectionGroup();
738       if (sg != null)
739       {
740         List<int[]> startEnd = ap.av.getVisibleRegionBoundaries(
741                 sg.getStartRes(), sg.getEndRes() + 1);
742
743         String description;
744         int caseChange;
745
746         if (source == toggleCase)
747         {
748           description = "Toggle Case";
749           caseChange = ChangeCaseCommand.TOGGLE_CASE;
750         }
751         else if (source == toUpper)
752         {
753           description = "To Upper Case";
754           caseChange = ChangeCaseCommand.TO_UPPER;
755         }
756         else
757         {
758           description = "To Lower Case";
759           caseChange = ChangeCaseCommand.TO_LOWER;
760         }
761
762         ChangeCaseCommand caseCommand = new ChangeCaseCommand(description,
763                 sg.getSequencesAsArray(ap.av.getHiddenRepSequences()),
764                 startEnd, caseChange);
765
766         ap.alignFrame.addHistoryItem(caseCommand);
767
768         ap.av.firePropertyChange("alignment", null, ap.av.getAlignment()
769                 .getSequences());
770
771       }
772     }
773     else if (source == sequenceFeature)
774     {
775       SequenceGroup sg = ap.av.getSelectionGroup();
776       if (sg == null)
777       {
778         return;
779       }
780
781       int rsize = 0, gSize = sg.getSize();
782       SequenceI[] rseqs, seqs = new SequenceI[gSize];
783       SequenceFeature[] tfeatures, features = new SequenceFeature[gSize];
784
785       for (int i = 0; i < gSize; i++)
786       {
787         int start = sg.getSequenceAt(i).findPosition(sg.getStartRes());
788         int end = sg.findEndRes(sg.getSequenceAt(i));
789         if (start <= end)
790         {
791           seqs[rsize] = sg.getSequenceAt(i);
792           features[rsize] = new SequenceFeature(null, null, null, start,
793                   end, "Jalview");
794           rsize++;
795         }
796       }
797       rseqs = new SequenceI[rsize];
798       tfeatures = new SequenceFeature[rsize];
799       System.arraycopy(seqs, 0, rseqs, 0, rsize);
800       System.arraycopy(features, 0, tfeatures, 0, rsize);
801       features = tfeatures;
802       seqs = rseqs;
803
804       if (ap.seqPanel.seqCanvas.getFeatureRenderer().amendFeatures(seqs,
805               features, true, ap))
806       {
807         ap.alignFrame.sequenceFeatures.setState(true);
808         ap.av.setShowSequenceFeatures(true);
809         ;
810         ap.highlightSearchResults(null);
811       }
812     }
813     else
814     {
815       outputText(evt);
816     }
817
818   }
819
820   void outputText(ActionEvent e)
821   {
822     CutAndPasteTransfer cap = new CutAndPasteTransfer(true, ap.alignFrame);
823
824     Frame frame = new Frame();
825     frame.add(cap);
826     jalview.bin.JalviewLite.addFrame(frame, MessageManager.formatMessage(
827             "label.selection_output_command",
828             new Object[] { e.getActionCommand() }), 600, 500);
829     // JBPNote: getSelectionAsNewSequence behaviour has changed - this method
830     // now returns a full copy of sequence data
831     // TODO consider using getSequenceSelection instead here
832
833     cap.setText(new jalview.io.AppletFormatAdapter().formatSequences(
834             e.getActionCommand(), ap.av.getShowJVSuffix(), ap, true));
835
836   }
837
838   protected void showSequenceSelectionDetails()
839   {
840     createSequenceDetailsReport(ap.av.getSequenceSelection());
841   }
842
843   protected void showSequenceDetails()
844   {
845     createSequenceDetailsReport(new SequenceI[] { seq });
846   }
847
848   public void createSequenceDetailsReport(SequenceI[] sequences)
849   {
850
851     CutAndPasteTransfer cap = new CutAndPasteTransfer(false, ap.alignFrame);
852
853     StringBuffer contents = new StringBuffer();
854     for (SequenceI seq : sequences)
855     {
856       contents.append(MessageManager.formatMessage(
857               "label.annotation_for_displayid",
858               new Object[] { seq.getDisplayId(true) }));
859       new SequenceAnnotationReport(null).createSequenceAnnotationReport(
860               contents,
861               seq,
862               true,
863               true,
864               false,
865               (ap.seqPanel.seqCanvas.fr != null) ? ap.seqPanel.seqCanvas.fr
866                       .getMinMax() : null);
867       contents.append("</p>");
868     }
869     Frame frame = new Frame();
870     frame.add(cap);
871     jalview.bin.JalviewLite.addFrame(frame, "Sequence Details for "
872             + (sequences.length == 1 ? sequences[0].getDisplayId(true)
873                     : "Selection"), 600, 500);
874     cap.setText(MessageManager.formatMessage("label.html_content",
875             new Object[] { contents.toString() }));
876   }
877
878   void editName()
879   {
880     EditNameDialog dialog = new EditNameDialog(seq.getName(),
881             seq.getDescription(), "       Sequence Name",
882             "Sequence Description", ap.alignFrame,
883             "Edit Sequence Name / Description", 500, 100, true);
884
885     if (dialog.accept)
886     {
887       seq.setName(dialog.getName());
888       seq.setDescription(dialog.getDescription());
889       ap.paintAlignment(false);
890     }
891   }
892
893   void addPDB()
894   {
895     if (seq.getAllPDBEntries() != null)
896     {
897       PDBEntry entry = seq.getAllPDBEntries().firstElement();
898
899       if (ap.av.applet.jmolAvailable)
900       {
901         new jalview.appletgui.AppletJmol(entry, new SequenceI[] { seq },
902                 null, ap, AppletFormatAdapter.URL);
903       }
904       else
905       {
906         new MCview.AppletPDBViewer(entry, new SequenceI[] { seq }, null,
907                 ap, AppletFormatAdapter.URL);
908       }
909
910     }
911     else
912     {
913       CutAndPasteTransfer cap = new CutAndPasteTransfer(true, ap.alignFrame);
914       cap.setText(MessageManager.getString("label.paste_pdb_file"));
915       cap.setPDBImport(seq);
916       Frame frame = new Frame();
917       frame.add(cap);
918       jalview.bin.JalviewLite.addFrame(frame, MessageManager.formatMessage(
919               "label.paste_pdb_file_for_sequence",
920               new Object[] { seq.getName() }), 400, 300);
921     }
922   }
923
924   private void jbInit() throws Exception
925   {
926     groupMenu.setLabel(MessageManager.getString("label.selection"));
927     sequenceFeature.addActionListener(this);
928
929     editGroupName.addActionListener(this);
930     unGroupMenuItem.setLabel(MessageManager
931             .getString("action.remove_group"));
932     unGroupMenuItem.addActionListener(this);
933
934     createGroupMenuItem.setLabel(MessageManager
935             .getString("action.create_group"));
936     createGroupMenuItem.addActionListener(this);
937
938     nucleotideMenuItem.setLabel(MessageManager
939             .getString("label.nucleotide"));
940     nucleotideMenuItem.addActionListener(this);
941     conservationMenuItem.addItemListener(this);
942     abovePIDColour.addItemListener(this);
943     colourMenu.setLabel(MessageManager.getString("label.group_colour"));
944     showBoxes.setLabel(MessageManager.getString("action.boxes"));
945     showBoxes.setState(true);
946     showBoxes.addItemListener(this);
947     sequenceName.addActionListener(this);
948     sequenceDetails.addActionListener(this);
949     selSeqDetails.addActionListener(this);
950     displayNonconserved.setLabel(MessageManager
951             .getString("label.show_non_conversed"));
952     displayNonconserved.setState(false);
953     displayNonconserved.addItemListener(this);
954     showText.setLabel(MessageManager.getString("action.text"));
955     showText.addItemListener(this);
956     showColourText.setLabel(MessageManager.getString("label.colour_text"));
957     showColourText.addItemListener(this);
958     outputmenu.setLabel(MessageManager.getString("label.out_to_textbox"));
959     seqMenu.setLabel(MessageManager.getString("label.sequence"));
960     pdb.setLabel(MessageManager.getString("label.view_pdb_structure"));
961     hideSeqs.setLabel(MessageManager.getString("action.hide_sequences"));
962     repGroup.setLabel(MessageManager.formatMessage(
963             "label.represent_group_with", new Object[] { "" }));
964     revealAll.setLabel(MessageManager.getString("action.reveal_all"));
965     revealSeq.setLabel(MessageManager.getString("action.reveal_sequences"));
966     menu1.setLabel(MessageManager.getString("label.group") + ":");
967     add(groupMenu);
968     this.add(seqMenu);
969     this.add(hideSeqs);
970     this.add(revealSeq);
971     this.add(revealAll);
972     // groupMenu.add(selSeqDetails);
973     groupMenu.add(groupShowAnnotationsMenu);
974     groupMenu.add(groupHideAnnotationsMenu);
975     groupMenu.add(groupAddReferenceAnnotations);
976     groupMenu.add(editMenu);
977     groupMenu.add(outputmenu);
978     groupMenu.add(sequenceFeature);
979     groupMenu.add(createGroupMenuItem);
980     groupMenu.add(unGroupMenuItem);
981     groupMenu.add(menu1);
982
983     colourMenu.add(noColourmenuItem);
984     colourMenu.add(clustalColour);
985     colourMenu.add(BLOSUM62Colour);
986     colourMenu.add(PIDColour);
987     colourMenu.add(zappoColour);
988     colourMenu.add(taylorColour);
989     colourMenu.add(hydrophobicityColour);
990     colourMenu.add(helixColour);
991     colourMenu.add(strandColour);
992     colourMenu.add(turnColour);
993     colourMenu.add(buriedColour);
994     colourMenu.add(nucleotideMenuItem);
995     colourMenu.add(userDefinedColour);
996     colourMenu.addSeparator();
997     colourMenu.add(abovePIDColour);
998     colourMenu.add(conservationMenuItem);
999
1000     noColourmenuItem.setLabel(MessageManager.getString("label.none"));
1001     noColourmenuItem.addActionListener(this);
1002
1003     clustalColour.setLabel(MessageManager
1004             .getString("label.clustalx_colours"));
1005     clustalColour.addActionListener(this);
1006     zappoColour.setLabel(MessageManager.getString("label.zappo"));
1007     zappoColour.addActionListener(this);
1008     taylorColour.setLabel(MessageManager.getString("label.taylor"));
1009     taylorColour.addActionListener(this);
1010     hydrophobicityColour.setLabel(MessageManager
1011             .getString("label.hydrophobicity"));
1012     hydrophobicityColour.addActionListener(this);
1013     helixColour
1014             .setLabel(MessageManager.getString("label.helix_propensity"));
1015     helixColour.addActionListener(this);
1016     strandColour.setLabel(MessageManager
1017             .getString("label.strand_propensity"));
1018     strandColour.addActionListener(this);
1019     turnColour.setLabel(MessageManager.getString("label.turn_propensity"));
1020     turnColour.addActionListener(this);
1021     buriedColour.setLabel(MessageManager.getString("label.buried_index"));
1022     buriedColour.addActionListener(this);
1023     abovePIDColour.setLabel(MessageManager
1024             .getString("label.above_identity_percentage"));
1025
1026     userDefinedColour.setLabel(MessageManager
1027             .getString("action.user_defined"));
1028     userDefinedColour.addActionListener(this);
1029     PIDColour.setLabel(MessageManager
1030             .getString("label.percentage_identity"));
1031     PIDColour.addActionListener(this);
1032     BLOSUM62Colour.setLabel("BLOSUM62");
1033     BLOSUM62Colour.addActionListener(this);
1034     conservationMenuItem.setLabel(MessageManager
1035             .getString("label.conservation"));
1036
1037     editMenu.add(copy);
1038     copy.addActionListener(this);
1039     editMenu.add(cut);
1040     cut.addActionListener(this);
1041
1042     editMenu.add(editSequence);
1043     editSequence.addActionListener(this);
1044
1045     editMenu.add(toUpper);
1046     toUpper.addActionListener(this);
1047     editMenu.add(toLower);
1048     toLower.addActionListener(this);
1049     editMenu.add(toggleCase);
1050     seqMenu.add(seqShowAnnotationsMenu);
1051     seqMenu.add(seqHideAnnotationsMenu);
1052     seqMenu.add(seqAddReferenceAnnotations);
1053     seqMenu.add(sequenceName);
1054     seqMenu.add(makeReferenceSeq);
1055     // seqMenu.add(sequenceDetails);
1056
1057     if (!ap.av.applet.useXtrnalSviewer)
1058     {
1059       seqMenu.add(pdb);
1060     }
1061     seqMenu.add(repGroup);
1062     menu1.add(editGroupName);
1063     menu1.add(colourMenu);
1064     menu1.add(showBoxes);
1065     menu1.add(showText);
1066     menu1.add(showColourText);
1067     menu1.add(displayNonconserved);
1068     toggleCase.addActionListener(this);
1069     pdb.addActionListener(this);
1070     hideSeqs.addActionListener(this);
1071     repGroup.addActionListener(this);
1072     revealAll.addActionListener(this);
1073     revealSeq.addActionListener(this);
1074     makeReferenceSeq.addActionListener(this);
1075   }
1076
1077   void refresh()
1078   {
1079     ap.paintAlignment(true);
1080   }
1081
1082   protected void clustalColour_actionPerformed()
1083   {
1084     SequenceGroup sg = getGroup();
1085     sg.cs = new ClustalxColourScheme(sg, ap.av.getHiddenRepSequences());
1086     refresh();
1087   }
1088
1089   protected void zappoColour_actionPerformed()
1090   {
1091     getGroup().cs = new ZappoColourScheme();
1092     refresh();
1093   }
1094
1095   protected void taylorColour_actionPerformed()
1096   {
1097     getGroup().cs = new TaylorColourScheme();
1098     refresh();
1099   }
1100
1101   protected void hydrophobicityColour_actionPerformed()
1102   {
1103     getGroup().cs = new HydrophobicColourScheme();
1104     refresh();
1105   }
1106
1107   protected void helixColour_actionPerformed()
1108   {
1109     getGroup().cs = new HelixColourScheme();
1110     refresh();
1111   }
1112
1113   protected void strandColour_actionPerformed()
1114   {
1115     getGroup().cs = new StrandColourScheme();
1116     refresh();
1117   }
1118
1119   protected void turnColour_actionPerformed()
1120   {
1121     getGroup().cs = new TurnColourScheme();
1122     refresh();
1123   }
1124
1125   protected void buriedColour_actionPerformed()
1126   {
1127     getGroup().cs = new BuriedColourScheme();
1128     refresh();
1129   }
1130
1131   public void nucleotideMenuItem_actionPerformed()
1132   {
1133     getGroup().cs = new NucleotideColourScheme();
1134     refresh();
1135   }
1136
1137   protected void abovePIDColour_itemStateChanged()
1138   {
1139     SequenceGroup sg = getGroup();
1140     if (sg.cs == null)
1141     {
1142       return;
1143     }
1144
1145     if (abovePIDColour.getState())
1146     {
1147       sg.cs.setConsensus(AAFrequency.calculate(sg.getSequences(ap.av
1148               .getHiddenRepSequences()), 0, ap.av.getAlignment().getWidth()));
1149       int threshold = SliderPanel.setPIDSliderSource(ap, sg.cs, getGroup()
1150               .getName());
1151
1152       sg.cs.setThreshold(threshold, ap.av.isIgnoreGapsConsensus());
1153
1154       SliderPanel.showPIDSlider();
1155
1156     }
1157     else
1158     // remove PIDColouring
1159     {
1160       sg.cs.setThreshold(0, ap.av.isIgnoreGapsConsensus());
1161     }
1162
1163     refresh();
1164
1165   }
1166
1167   protected void userDefinedColour_actionPerformed()
1168   {
1169     new UserDefinedColours(ap, getGroup());
1170   }
1171
1172   protected void PIDColour_actionPerformed()
1173   {
1174     SequenceGroup sg = getGroup();
1175     sg.cs = new PIDColourScheme();
1176     sg.cs.setConsensus(AAFrequency.calculate(sg.getSequences(ap.av
1177             .getHiddenRepSequences()), 0, ap.av.getAlignment().getWidth()));
1178     refresh();
1179   }
1180
1181   protected void BLOSUM62Colour_actionPerformed()
1182   {
1183     SequenceGroup sg = getGroup();
1184
1185     sg.cs = new Blosum62ColourScheme();
1186
1187     sg.cs.setConsensus(AAFrequency.calculate(sg.getSequences(ap.av
1188             .getHiddenRepSequences()), 0, ap.av.getAlignment().getWidth()));
1189
1190     refresh();
1191   }
1192
1193   protected void noColourmenuItem_actionPerformed()
1194   {
1195     getGroup().cs = null;
1196     refresh();
1197   }
1198
1199   protected void conservationMenuItem_itemStateChanged()
1200   {
1201     SequenceGroup sg = getGroup();
1202     if (sg.cs == null)
1203     {
1204       return;
1205     }
1206
1207     if (conservationMenuItem.getState())
1208     {
1209
1210       sg.cs.setConservation(Conservation.calculateConservation("Group",
1211               ResidueProperties.propHash, 3, sg.getSequences(ap.av
1212                       .getHiddenRepSequences()), 0, ap.av.getAlignment()
1213                       .getWidth(), false, ap.av.getConsPercGaps(), false));
1214       SliderPanel.setConservationSlider(ap, sg.cs, sg.getName());
1215       SliderPanel.showConservationSlider();
1216     }
1217     else
1218     // remove ConservationColouring
1219     {
1220       sg.cs.setConservation(null);
1221     }
1222
1223     refresh();
1224   }
1225
1226   SequenceGroup getGroup()
1227   {
1228     SequenceGroup sg = ap.av.getSelectionGroup();
1229
1230     // this method won't add a new group if it already exists
1231     if (sg != null)
1232     {
1233       ap.av.getAlignment().addGroup(sg);
1234     }
1235
1236     return sg;
1237   }
1238
1239   void unGroupMenuItem_actionPerformed()
1240   {
1241     SequenceGroup sg = ap.av.getSelectionGroup();
1242     ap.av.getAlignment().deleteGroup(sg);
1243     ap.av.setSelectionGroup(null);
1244     ap.paintAlignment(true);
1245   }
1246
1247   void createGroupMenuItem_actionPerformed()
1248   {
1249     getGroup(); // implicitly create group
1250     refresh();
1251   }
1252
1253   public void showColourText_itemStateChanged()
1254   {
1255     getGroup().setColourText(showColourText.getState());
1256     refresh();
1257   }
1258
1259   public void showText_itemStateChanged()
1260   {
1261     getGroup().setDisplayText(showText.getState());
1262     refresh();
1263   }
1264
1265   public void makeReferenceSeq_actionPerformed()
1266   {
1267     if (!ap.av.getAlignment().hasSeqrep())
1268     {
1269       // initialise the display flags so the user sees something happen
1270       ap.av.setDisplayReferenceSeq(true);
1271       ap.av.setColourByReferenceSeq(true);
1272       ap.av.getAlignment().setSeqrep(seq);
1273     }
1274     else
1275     {
1276       if (ap.av.getAlignment().getSeqrep() == seq)
1277       {
1278         ap.av.getAlignment().setSeqrep(null);
1279       }
1280       else
1281       {
1282         ap.av.getAlignment().setSeqrep(seq);
1283       }
1284     }
1285     refresh();
1286   }
1287
1288   public void showNonconserved_itemStateChanged()
1289   {
1290     getGroup().setShowNonconserved(this.displayNonconserved.getState());
1291     refresh();
1292   }
1293
1294   public void showBoxes_itemStateChanged()
1295   {
1296     getGroup().setDisplayBoxes(showBoxes.getState());
1297     refresh();
1298   }
1299
1300   void hideSequences(boolean representGroup)
1301   {
1302     SequenceGroup sg = ap.av.getSelectionGroup();
1303     if (sg == null || sg.getSize() < 1)
1304     {
1305       ap.av.hideSequence(new SequenceI[] { seq });
1306       return;
1307     }
1308
1309     ap.av.setSelectionGroup(null);
1310
1311     if (representGroup)
1312     {
1313       ap.av.hideRepSequences(seq, sg);
1314
1315       return;
1316     }
1317
1318     int gsize = sg.getSize();
1319     SequenceI[] hseqs;
1320
1321     hseqs = new SequenceI[gsize];
1322
1323     int index = 0;
1324     for (int i = 0; i < gsize; i++)
1325     {
1326       hseqs[index++] = sg.getSequenceAt(i);
1327     }
1328
1329     ap.av.hideSequence(hseqs);
1330     ap.av.sendSelection();
1331   }
1332
1333   /**
1334    * Add annotation types to 'Show annotations' and/or 'Hide annotations' menus.
1335    * "All" is added first, followed by a separator. Then add any annotation
1336    * types associated with the current selection. Separate menus are built for
1337    * the selected sequence group (if any), and the selected sequence.
1338    * <p>
1339    * Some annotation rows are always rendered together - these can be identified
1340    * by a common graphGroup property > -1. Only one of each group will be marked
1341    * as visible (to avoid duplication of the display). For such groups we add a
1342    * composite type name, e.g.
1343    * <p>
1344    * IUPredWS (Long), IUPredWS (Short)
1345    * 
1346    * @param seq
1347    */
1348   protected void buildAnnotationTypesMenus(Menu showMenu, Menu hideMenu,
1349           List<SequenceI> forSequences)
1350   {
1351     showMenu.removeAll();
1352     hideMenu.removeAll();
1353
1354     final List<String> all = Arrays.asList(ALL_ANNOTATIONS);
1355     addAnnotationTypeToShowHide(showMenu, forSequences, "", all, true, true);
1356     addAnnotationTypeToShowHide(hideMenu, forSequences, "", all, true,
1357             false);
1358     showMenu.addSeparator();
1359     hideMenu.addSeparator();
1360
1361     final AlignmentAnnotation[] annotations = ap.getAlignment()
1362             .getAlignmentAnnotation();
1363
1364     /*
1365      * Find shown/hidden annotations types, distinguished by source (calcId),
1366      * and grouped by graphGroup. Using LinkedHashMap means we will retrieve in
1367      * the insertion order, which is the order of the annotations on the
1368      * alignment.
1369      */
1370     Map<String, List<List<String>>> shownTypes = new LinkedHashMap<String, List<List<String>>>();
1371     Map<String, List<List<String>>> hiddenTypes = new LinkedHashMap<String, List<List<String>>>();
1372     AlignmentAnnotationUtils.getShownHiddenTypes(shownTypes, hiddenTypes,
1373             AlignmentAnnotationUtils.asList(annotations), forSequences);
1374
1375     for (String calcId : hiddenTypes.keySet())
1376     {
1377       for (List<String> type : hiddenTypes.get(calcId))
1378       {
1379         addAnnotationTypeToShowHide(showMenu, forSequences, calcId, type,
1380                 false, true);
1381       }
1382     }
1383     // grey out 'show annotations' if none are hidden
1384     showMenu.setEnabled(!hiddenTypes.isEmpty());
1385
1386     for (String calcId : shownTypes.keySet())
1387     {
1388       for (List<String> type : shownTypes.get(calcId))
1389       {
1390         addAnnotationTypeToShowHide(hideMenu, forSequences, calcId, type,
1391                 false, false);
1392       }
1393     }
1394     // grey out 'hide annotations' if none are shown
1395     hideMenu.setEnabled(!shownTypes.isEmpty());
1396   }
1397
1398   /**
1399    * Add one annotation type to the 'Show Annotations' or 'Hide Annotations'
1400    * menus.
1401    * 
1402    * @param showOrHideMenu
1403    *          the menu to add to
1404    * @param forSequences
1405    *          the sequences whose annotations may be shown or hidden
1406    * @param calcId
1407    * @param types
1408    *          the label to add
1409    * @param allTypes
1410    *          if true this is a special label meaning 'All'
1411    * @param actionIsShow
1412    *          if true, the select menu item action is to show the annotation
1413    *          type, else hide
1414    */
1415   protected void addAnnotationTypeToShowHide(Menu showOrHideMenu,
1416           final List<SequenceI> forSequences, String calcId,
1417           final List<String> types, final boolean allTypes,
1418           final boolean actionIsShow)
1419   {
1420     String label = types.toString(); // [a, b, c]
1421     label = label.substring(1, label.length() - 1);
1422     final MenuItem item = new MenuItem(label);
1423     item.addActionListener(new java.awt.event.ActionListener()
1424     {
1425       @Override
1426       public void actionPerformed(ActionEvent e)
1427       {
1428         AlignmentUtils.showOrHideSequenceAnnotations(ap.getAlignment(),
1429                 types, forSequences, allTypes, actionIsShow);
1430         refresh();
1431       }
1432     });
1433     showOrHideMenu.add(item);
1434   }
1435
1436 }