JAL-3725 restrict mapped virtual feature location to mapped region
[jalview.git] / src / jalview / gui / PopupMenu.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.gui;
22
23 import java.util.Locale;
24
25 import java.awt.BorderLayout;
26 import java.awt.Color;
27 import java.awt.event.ActionEvent;
28 import java.awt.event.ActionListener;
29 import java.util.ArrayList;
30 import java.util.Arrays;
31 import java.util.BitSet;
32 import java.util.Collection;
33 import java.util.Collections;
34 import java.util.Hashtable;
35 import java.util.LinkedHashMap;
36 import java.util.List;
37 import java.util.Map;
38 import java.util.Objects;
39 import java.util.SortedMap;
40 import java.util.TreeMap;
41 import java.util.Vector;
42
43 import javax.swing.ButtonGroup;
44 import javax.swing.JCheckBoxMenuItem;
45 import javax.swing.JInternalFrame;
46 import javax.swing.JLabel;
47 import javax.swing.JMenu;
48 import javax.swing.JMenuItem;
49 import javax.swing.JPanel;
50 import javax.swing.JPopupMenu;
51 import javax.swing.JRadioButtonMenuItem;
52 import javax.swing.JScrollPane;
53
54 import jalview.analysis.AAFrequency;
55 import jalview.analysis.AlignmentAnnotationUtils;
56 import jalview.analysis.AlignmentUtils;
57 import jalview.analysis.Conservation;
58 import jalview.api.AlignViewportI;
59 import jalview.bin.Cache;
60 import jalview.commands.ChangeCaseCommand;
61 import jalview.commands.EditCommand;
62 import jalview.commands.EditCommand.Action;
63 import jalview.datamodel.AlignmentAnnotation;
64 import jalview.datamodel.AlignmentI;
65 import jalview.datamodel.DBRefEntry;
66 import jalview.datamodel.HiddenColumns;
67 import jalview.datamodel.MappedFeatures;
68 import jalview.datamodel.PDBEntry;
69 import jalview.datamodel.SequenceFeature;
70 import jalview.datamodel.SequenceGroup;
71 import jalview.datamodel.SequenceI;
72 import jalview.gui.ColourMenuHelper.ColourChangeListener;
73 import jalview.gui.JalviewColourChooser.ColourChooserListener;
74 import jalview.io.FileFormatI;
75 import jalview.io.FileFormats;
76 import jalview.io.FormatAdapter;
77 import jalview.io.SequenceAnnotationReport;
78 import jalview.schemes.Blosum62ColourScheme;
79 import jalview.schemes.ColourSchemeI;
80 import jalview.schemes.ColourSchemes;
81 import jalview.schemes.PIDColourScheme;
82 import jalview.schemes.ResidueColourScheme;
83 import jalview.util.Comparison;
84 import jalview.util.GroupUrlLink;
85 import jalview.util.GroupUrlLink.UrlStringTooLongException;
86 import jalview.util.MessageManager;
87 import jalview.util.Platform;
88 import jalview.util.StringUtils;
89 import jalview.util.UrlLink;
90 import jalview.viewmodel.seqfeatures.FeatureRendererModel;
91
92 /**
93  * The popup menu that is displayed on right-click on a sequence id, or in the
94  * sequence alignment.
95  */
96 public class PopupMenu extends JPopupMenu implements ColourChangeListener
97 {
98   /*
99    * maximum length of feature description to include in popup menu item text
100    */
101   private static final int FEATURE_DESC_MAX = 40;
102
103   /*
104    * true for ID Panel menu, false for alignment panel menu
105    */
106   private final boolean forIdPanel;
107
108   private final AlignmentPanel ap;
109
110   /*
111    * the sequence under the cursor when clicked
112    * (additional sequences may be selected)
113    */
114   private final SequenceI sequence;
115
116   JMenu groupMenu = new JMenu();
117
118   JMenuItem groupName = new JMenuItem();
119
120   protected JCheckBoxMenuItem abovePIDColour = new JCheckBoxMenuItem();
121
122   protected JMenuItem modifyPID = new JMenuItem();
123
124   protected JCheckBoxMenuItem conservationMenuItem = new JCheckBoxMenuItem();
125
126   protected JRadioButtonMenuItem annotationColour;
127
128   protected JMenuItem modifyConservation = new JMenuItem();
129
130   JMenu sequenceMenu = new JMenu();
131
132   JMenuItem makeReferenceSeq = new JMenuItem();
133
134   JMenuItem createGroupMenuItem = new JMenuItem();
135
136   JMenuItem unGroupMenuItem = new JMenuItem();
137
138   JMenu colourMenu = new JMenu();
139
140   JCheckBoxMenuItem showBoxes = new JCheckBoxMenuItem();
141
142   JCheckBoxMenuItem showText = new JCheckBoxMenuItem();
143
144   JCheckBoxMenuItem showColourText = new JCheckBoxMenuItem();
145
146   JCheckBoxMenuItem displayNonconserved = new JCheckBoxMenuItem();
147
148   JMenu editMenu = new JMenu();
149
150   JMenuItem upperCase = new JMenuItem();
151
152   JMenuItem lowerCase = new JMenuItem();
153
154   JMenuItem toggle = new JMenuItem();
155
156   JMenu outputMenu = new JMenu();
157
158   JMenu seqShowAnnotationsMenu = new JMenu();
159
160   JMenu seqHideAnnotationsMenu = new JMenu();
161
162   JMenuItem seqAddReferenceAnnotations = new JMenuItem(
163           MessageManager.getString("label.add_reference_annotations"));
164
165   JMenu groupShowAnnotationsMenu = new JMenu();
166
167   JMenu groupHideAnnotationsMenu = new JMenu();
168
169   JMenuItem groupAddReferenceAnnotations = new JMenuItem(
170           MessageManager.getString("label.add_reference_annotations"));
171
172   JMenuItem textColour = new JMenuItem();
173
174   JMenu editGroupMenu = new JMenu();
175
176   JMenuItem chooseStructure = new JMenuItem();
177
178   JMenu rnaStructureMenu = new JMenu();
179
180   /**
181    * Constructs a menu with sub-menu items for any hyperlinks for the sequence
182    * and/or features provided. Hyperlinks may include a lookup by sequence id,
183    * or database cross-references, depending on which links are enabled in user
184    * preferences.
185    * 
186    * @param seq
187    * @param features
188    * @return
189    */
190   protected static JMenu buildLinkMenu(final SequenceI seq,
191           List<SequenceFeature> features)
192   {
193     JMenu linkMenu = new JMenu(MessageManager.getString("action.link"));
194
195     List<String> nlinks = null;
196     if (seq != null)
197     {
198       nlinks = Preferences.sequenceUrlLinks.getLinksForMenu();
199       UrlLink.sort(nlinks);
200     }
201     else
202     {
203       nlinks = new ArrayList<>();
204     }
205
206     if (features != null)
207     {
208       for (SequenceFeature sf : features)
209       {
210         if (sf.links != null)
211         {
212           for (String link : sf.links)
213           {
214             nlinks.add(link);
215           }
216         }
217       }
218     }
219
220     /*
221      * instantiate the hyperlinklink templates from sequence data;
222      * note the order of the templates is preserved in the map
223      */
224     Map<String, List<String>> linkset = new LinkedHashMap<>();
225     for (String link : nlinks)
226     {
227       UrlLink urlLink = null;
228       try
229       {
230         urlLink = new UrlLink(link);
231       } catch (Exception foo)
232       {
233         Cache.log.error("Exception for URLLink '" + link + "'", foo);
234         continue;
235       }
236
237       if (!urlLink.isValid())
238       {
239         Cache.log.error(urlLink.getInvalidMessage());
240         continue;
241       }
242
243       urlLink.createLinksFromSeq(seq, linkset);
244     }
245
246     /*
247      * construct menu items for the hyperlinks (still preserving
248      * the order of the sorted templates)
249      */
250     addUrlLinks(linkMenu, linkset.values());
251
252     return linkMenu;
253   }
254
255   /**
256    * A helper method that builds menu items from the given links, with action
257    * handlers to open the link URL, and adds them to the linkMenu. Each provided
258    * link should be a list whose second item is the menu text, and whose fourth
259    * item is the URL to open when the menu item is selected.
260    * 
261    * @param linkMenu
262    * @param linkset
263    */
264   static private void addUrlLinks(JMenu linkMenu,
265           Collection<List<String>> linkset)
266   {
267     for (List<String> linkstrset : linkset)
268     {
269       final String url = linkstrset.get(3);
270       JMenuItem item = new JMenuItem(linkstrset.get(1));
271       item.setToolTipText(MessageManager
272               .formatMessage("label.open_url_param", new Object[]
273               { url }));
274       item.addActionListener(new ActionListener()
275       {
276         @Override
277         public void actionPerformed(ActionEvent e)
278         {
279           new Thread(new Runnable()
280           {
281             @Override
282             public void run()
283             {
284               showLink(url);
285             }
286           }).start();
287         }
288       });
289       linkMenu.add(item);
290     }
291   }
292
293   /**
294    * Opens the provided url in the default web browser, or shows an error
295    * message if this fails
296    * 
297    * @param url
298    */
299   static void showLink(String url)
300   {
301     try
302     {
303       jalview.util.BrowserLauncher.openURL(url);
304     } catch (Exception ex)
305     {
306       JvOptionPane.showInternalMessageDialog(Desktop.desktop,
307               MessageManager.getString("label.web_browser_not_found_unix"),
308               MessageManager.getString("label.web_browser_not_found"),
309               JvOptionPane.WARNING_MESSAGE);
310
311       ex.printStackTrace();
312     }
313   }
314
315   /**
316    * add a late bound groupURL item to the given linkMenu
317    * 
318    * @param linkMenu
319    * @param label
320    *          - menu label string
321    * @param urlgenerator
322    *          GroupURLLink used to generate URL
323    * @param urlstub
324    *          Object array returned from the makeUrlStubs function.
325    */
326   static void addshowLink(JMenu linkMenu, String label,
327           final GroupUrlLink urlgenerator, final Object[] urlstub)
328   {
329     JMenuItem item = new JMenuItem(label);
330     item.setToolTipText(MessageManager
331             .formatMessage("label.open_url_seqs_param", new Object[]
332             { urlgenerator.getUrl_prefix(),
333                 urlgenerator.getNumberInvolved(urlstub) }));
334     // TODO: put in info about what is being sent.
335     item.addActionListener(new ActionListener()
336     {
337       @Override
338       public void actionPerformed(ActionEvent e)
339       {
340         new Thread(new Runnable()
341         {
342
343           @Override
344           public void run()
345           {
346             try
347             {
348               showLink(urlgenerator.constructFrom(urlstub));
349             } catch (UrlStringTooLongException e2)
350             {
351             }
352           }
353
354         }).start();
355       }
356     });
357
358     linkMenu.add(item);
359   }
360
361   /**
362    * Constructor for a PopupMenu for a click in the alignment panel (on a residue)
363    * 
364    * @param ap
365    *              the panel in which the mouse is clicked
366    * @param seq
367    *              the sequence under the mouse
368    * @throws NullPointerException
369    *                                if seq is null
370    */
371   public PopupMenu(final AlignmentPanel ap, SequenceI seq, int column)
372   {
373     this(false, ap, seq, column, null);
374   }
375
376   /**
377    * Constructor for a PopupMenu for a click in the sequence id panel
378    * 
379    * @param alignPanel
380    *                     the panel in which the mouse is clicked
381    * @param seq
382    *                     the sequence under the mouse click
383    * @param groupLinks
384    *                     templates for sequence external links
385    * @throws NullPointerException
386    *                                if seq is null
387    */
388   public PopupMenu(final AlignmentPanel alignPanel, final SequenceI seq,
389           List<String> groupLinks)
390   {
391     this(true, alignPanel, seq, -1, groupLinks);
392   }
393
394   /**
395    * Private constructor that constructs a popup menu for either sequence ID
396    * Panel, or alignment context
397    * 
398    * @param fromIdPanel
399    * @param alignPanel
400    * @param seq
401    * @param column
402    *                      aligned column position (0...)
403    * @param groupLinks
404    */
405   private PopupMenu(boolean fromIdPanel,
406           final AlignmentPanel alignPanel,
407           final SequenceI seq, final int column, List<String> groupLinks)
408   {
409     Objects.requireNonNull(seq);
410     this.forIdPanel = fromIdPanel;
411     this.ap = alignPanel;
412     sequence = seq;
413
414     for (String ff : FileFormats.getInstance().getWritableFormats(true))
415     {
416       JMenuItem item = new JMenuItem(ff);
417
418       item.addActionListener(new ActionListener()
419       {
420         @Override
421         public void actionPerformed(ActionEvent e)
422         {
423           outputText_actionPerformed(e);
424         }
425       });
426
427       outputMenu.add(item);
428     }
429
430     /*
431      * Build menus for annotation types that may be shown or hidden, and for
432      * 'reference annotations' that may be added to the alignment. First for the
433      * currently selected sequence (if there is one):
434      */
435     final List<SequenceI> selectedSequence = (forIdPanel && seq != null
436             ? Arrays.asList(seq)
437             : Collections.<SequenceI> emptyList());
438     buildAnnotationTypesMenus(seqShowAnnotationsMenu,
439             seqHideAnnotationsMenu, selectedSequence);
440     configureReferenceAnnotationsMenu(seqAddReferenceAnnotations,
441             selectedSequence);
442
443     /*
444      * And repeat for the current selection group (if there is one):
445      */
446     final List<SequenceI> selectedGroup = (alignPanel.av.getSelectionGroup() == null
447             ? Collections.<SequenceI> emptyList()
448             : alignPanel.av.getSelectionGroup().getSequences());
449     buildAnnotationTypesMenus(groupShowAnnotationsMenu,
450             groupHideAnnotationsMenu, selectedGroup);
451     configureReferenceAnnotationsMenu(groupAddReferenceAnnotations,
452             selectedGroup);
453
454     try
455     {
456       jbInit();
457     } catch (Exception e)
458     {
459       e.printStackTrace();
460     }
461
462     if (forIdPanel)
463     {
464       JMenuItem menuItem;
465       sequenceMenu.setText(sequence.getName());
466       if (seq == alignPanel.av.getAlignment().getSeqrep())
467       {
468         makeReferenceSeq.setText(
469                 MessageManager.getString("action.unmark_as_reference"));
470       }
471       else
472       {
473         makeReferenceSeq.setText(
474                 MessageManager.getString("action.set_as_reference"));
475       }
476
477       if (!alignPanel.av.getAlignment().isNucleotide())
478       {
479         remove(rnaStructureMenu);
480       }
481       else
482       {
483         int origCount = rnaStructureMenu.getItemCount();
484         /*
485          * add menu items to 2D-render any alignment or sequence secondary
486          * structure annotation
487          */
488         AlignmentAnnotation[] aas = alignPanel.av.getAlignment()
489                 .getAlignmentAnnotation();
490         if (aas != null)
491         {
492           for (final AlignmentAnnotation aa : aas)
493           {
494             if (aa.isValidStruc() && aa.sequenceRef == null)
495             {
496               /*
497                * valid alignment RNA secondary structure annotation
498                */
499               menuItem = new JMenuItem();
500               menuItem.setText(MessageManager.formatMessage(
501                       "label.2d_rna_structure_line", new Object[]
502                       { aa.label }));
503               menuItem.addActionListener(new ActionListener()
504               {
505                 @Override
506                 public void actionPerformed(ActionEvent e)
507                 {
508                   new AppVarna(seq, aa, alignPanel);
509                 }
510               });
511               rnaStructureMenu.add(menuItem);
512             }
513           }
514         }
515
516         if (seq.getAnnotation() != null)
517         {
518           AlignmentAnnotation seqAnns[] = seq.getAnnotation();
519           for (final AlignmentAnnotation aa : seqAnns)
520           {
521             if (aa.isValidStruc())
522             {
523               /*
524                * valid sequence RNA secondary structure annotation
525                */
526               // TODO: make rnastrucF a bit more nice
527               menuItem = new JMenuItem();
528               menuItem.setText(MessageManager.formatMessage(
529                       "label.2d_rna_sequence_name", new Object[]
530                       { seq.getName() }));
531               menuItem.addActionListener(new ActionListener()
532               {
533                 @Override
534                 public void actionPerformed(ActionEvent e)
535                 {
536                   // TODO: VARNA does'nt print gaps in the sequence
537                   new AppVarna(seq, aa, alignPanel);
538                 }
539               });
540               rnaStructureMenu.add(menuItem);
541             }
542           }
543         }
544         if (rnaStructureMenu.getItemCount() == origCount)
545         {
546           remove(rnaStructureMenu);
547         }
548       }
549
550       menuItem = new JMenuItem(
551               MessageManager.getString("action.hide_sequences"));
552       menuItem.addActionListener(new ActionListener()
553       {
554         @Override
555         public void actionPerformed(ActionEvent e)
556         {
557           hideSequences(false);
558         }
559       });
560       add(menuItem);
561
562       if (alignPanel.av.getSelectionGroup() != null
563               && alignPanel.av.getSelectionGroup().getSize() > 1)
564       {
565         menuItem = new JMenuItem(MessageManager
566                 .formatMessage("label.represent_group_with", new Object[]
567                 { seq.getName() }));
568         menuItem.addActionListener(new ActionListener()
569         {
570           @Override
571           public void actionPerformed(ActionEvent e)
572           {
573             hideSequences(true);
574           }
575         });
576         sequenceMenu.add(menuItem);
577       }
578
579       if (alignPanel.av.hasHiddenRows())
580       {
581         final int index = alignPanel.av.getAlignment().findIndex(seq);
582
583         if (alignPanel.av.adjustForHiddenSeqs(index)
584                 - alignPanel.av.adjustForHiddenSeqs(index - 1) > 1)
585         {
586           menuItem = new JMenuItem(
587                   MessageManager.getString("action.reveal_sequences"));
588           menuItem.addActionListener(new ActionListener()
589           {
590             @Override
591             public void actionPerformed(ActionEvent e)
592             {
593               alignPanel.av.showSequence(index);
594               if (alignPanel.overviewPanel != null)
595               {
596                 alignPanel.overviewPanel.updateOverviewImage();
597               }
598             }
599           });
600           add(menuItem);
601         }
602       }
603     }
604
605     /*
606      * offer 'Reveal All'
607      * - in the IdPanel (seq not null) if any sequence is hidden
608      * - in the IdPanel or SeqPanel if all sequences are hidden (seq is null)
609      */
610     if (alignPanel.av.hasHiddenRows())
611     {
612       boolean addOption = seq != null;
613       if (!addOption && alignPanel.av.getAlignment().getHeight() == 0)
614       {
615         addOption = true;
616       }
617       if (addOption)
618       {
619         JMenuItem menuItem = new JMenuItem(
620                 MessageManager.getString("action.reveal_all"));
621         menuItem.addActionListener(new ActionListener()
622         {
623           @Override
624           public void actionPerformed(ActionEvent e)
625           {
626             alignPanel.av.showAllHiddenSeqs();
627             if (alignPanel.overviewPanel != null)
628             {
629               alignPanel.overviewPanel.updateOverviewImage();
630             }
631           }
632         });
633         add(menuItem);
634       }
635     }
636
637     SequenceGroup sg = alignPanel.av.getSelectionGroup();
638     boolean isDefinedGroup = (sg != null)
639             ? alignPanel.av.getAlignment().getGroups().contains(sg)
640             : false;
641
642     if (sg != null && sg.getSize() > 0)
643     {
644       groupName.setText(MessageManager
645               .getString("label.edit_name_and_description_current_group"));
646
647       ColourMenuHelper.setColourSelected(colourMenu, sg.getColourScheme());
648
649       conservationMenuItem.setEnabled(!sg.isNucleotide());
650
651       if (sg.cs != null)
652       {
653         if (sg.cs.conservationApplied())
654         {
655           conservationMenuItem.setSelected(true);
656         }
657         if (sg.cs.getThreshold() > 0)
658         {
659           abovePIDColour.setSelected(true);
660         }
661       }
662       modifyConservation.setEnabled(conservationMenuItem.isSelected());
663       modifyPID.setEnabled(abovePIDColour.isSelected());
664       displayNonconserved.setSelected(sg.getShowNonconserved());
665       showText.setSelected(sg.getDisplayText());
666       showColourText.setSelected(sg.getColourText());
667       showBoxes.setSelected(sg.getDisplayBoxes());
668       // add any groupURLs to the groupURL submenu and make it visible
669       if (groupLinks != null && groupLinks.size() > 0)
670       {
671         buildGroupURLMenu(sg, groupLinks);
672       }
673       // Add a 'show all structures' for the current selection
674       Hashtable<String, PDBEntry> pdbe = new Hashtable<>(), reppdb = new Hashtable<>();
675
676       SequenceI sqass = null;
677       for (SequenceI sq : alignPanel.av.getSequenceSelection())
678       {
679         Vector<PDBEntry> pes = sq.getDatasetSequence().getAllPDBEntries();
680         if (pes != null && pes.size() > 0)
681         {
682           reppdb.put(pes.get(0).getId(), pes.get(0));
683           for (PDBEntry pe : pes)
684           {
685             pdbe.put(pe.getId(), pe);
686             if (sqass == null)
687             {
688               sqass = sq;
689             }
690           }
691         }
692       }
693       if (pdbe.size() > 0)
694       {
695         final PDBEntry[] pe = pdbe.values()
696                 .toArray(new PDBEntry[pdbe.size()]),
697                 pr = reppdb.values().toArray(new PDBEntry[reppdb.size()]);
698         final JMenuItem gpdbview, rpdbview;
699       }
700     }
701     else
702     {
703       groupMenu.setVisible(false);
704       editMenu.setVisible(false);
705     }
706
707     if (!isDefinedGroup)
708     {
709       createGroupMenuItem.setVisible(true);
710       unGroupMenuItem.setVisible(false);
711       editGroupMenu.setText(MessageManager.getString("action.edit_new_group"));
712     }
713     else
714     {
715       createGroupMenuItem.setVisible(false);
716       unGroupMenuItem.setVisible(true);
717       editGroupMenu.setText(MessageManager.getString("action.edit_group"));
718     }
719
720     if (!forIdPanel)
721     {
722       sequenceMenu.setVisible(false);
723       chooseStructure.setVisible(false);
724       rnaStructureMenu.setVisible(false);
725     }
726
727     addLinksAndFeatures(seq, column);
728   }
729
730   /**
731    * Adds
732    * <ul>
733    * <li>configured sequence database links (ID panel popup menu)</li>
734    * <li>non-positional feature links (ID panel popup menu)</li>
735    * <li>positional feature links (alignment panel popup menu)</li>
736    * <li>feature details links (alignment panel popup menu)</li>
737    * </ul>
738    * If this panel is also showed complementary (CDS/protein) features, then links
739    * to their feature details are also added.
740    * 
741    * @param seq
742    * @param column
743    */
744   void addLinksAndFeatures(final SequenceI seq, final int column)
745   {
746     List<SequenceFeature> features = null;
747     if (forIdPanel)
748     {
749       features = sequence.getFeatures().getNonPositionalFeatures();
750     }
751     else
752     {
753       features = ap.getFeatureRenderer().findFeaturesAtColumn(sequence,
754               column + 1);
755     }
756
757     addLinks(seq, features);
758
759     if (!forIdPanel)
760     {
761       addFeatureDetails(features, seq, column);
762     }
763   }
764
765   /**
766    * Add a menu item to show feature details for each sequence feature. Any
767    * linked 'virtual' features (CDS/protein) are also optionally found and
768    * included.
769    * 
770    * @param features
771    * @param seq
772    * @param column
773    */
774   protected void addFeatureDetails(List<SequenceFeature> features,
775           final SequenceI seq, final int column)
776   {
777     /*
778      * add features in CDS/protein complement at the corresponding
779      * position if configured to do so
780      */
781     MappedFeatures mf = null;
782     if (ap.av.isShowComplementFeatures())
783     {
784       if (!Comparison.isGap(sequence.getCharAt(column)))
785       {
786         AlignViewportI complement = ap.getAlignViewport()
787                 .getCodingComplement();
788         AlignFrame af = Desktop.getAlignFrameFor(complement);
789         FeatureRendererModel fr2 = af.getFeatureRenderer();
790         int seqPos = sequence.findPosition(column);
791         mf = fr2.findComplementFeaturesAtResidue(sequence, seqPos);
792       }
793     }
794
795     if (features.isEmpty() && mf == null)
796     {
797       /*
798        * no features to show at this position
799        */
800       return;
801     }
802
803     JMenu details = new JMenu(
804             MessageManager.getString("label.feature_details"));
805     add(details);
806
807     String name = seq.getName();
808     for (final SequenceFeature sf : features)
809     {
810       addFeatureDetailsMenuItem(details, name, sf, null);
811     }
812
813     if (mf != null)
814     {
815       for (final SequenceFeature sf : mf.features)
816       {
817         addFeatureDetailsMenuItem(details, name, sf, mf);
818       }
819     }
820   }
821
822   /**
823    * A helper method to add one menu item whose action is to show details for
824    * one feature. The menu text includes feature description, but this may be
825    * truncated.
826    * 
827    * @param details
828    * @param seqName
829    * @param sf
830    * @param mf
831    */
832   void addFeatureDetailsMenuItem(JMenu details, final String seqName,
833           final SequenceFeature sf, MappedFeatures mf)
834   {
835     int start = sf.getBegin();
836     int end = sf.getEnd();
837     if (mf != null)
838     {
839       /*
840        * show local rather than linked feature coordinates
841        */
842       int[] localRange = mf.getMappedPositions(start, end);
843       if (localRange == null)
844       {
845         return;
846       }
847       start = localRange[0];
848       end = localRange[localRange.length - 1];
849     }
850     StringBuilder desc = new StringBuilder();
851     desc.append(sf.getType()).append(" ").append(String.valueOf(start));
852     if (start != end)
853     {
854       desc.append(sf.isContactFeature() ? ":" : "-");
855       desc.append(String.valueOf(end));
856     }
857     String description = sf.getDescription();
858     if (description != null)
859     {
860       desc.append(" ");
861       description = StringUtils.stripHtmlTags(description);
862
863       /*
864        * truncate overlong descriptions unless they contain an href
865        * (as truncation could leave corrupted html)
866        */
867       boolean hasLink = description.indexOf("a href") > -1;
868       if (description.length() > FEATURE_DESC_MAX && !hasLink)
869       {
870         description = description.substring(0, FEATURE_DESC_MAX) + "...";
871       }
872       desc.append(description);
873     }
874     String featureGroup = sf.getFeatureGroup();
875     if (featureGroup != null)
876     {
877       desc.append(" (").append(featureGroup).append(")");
878     }
879     String htmlText = JvSwingUtils.wrapTooltip(true, desc.toString());
880     JMenuItem item = new JMenuItem(htmlText);
881     item.addActionListener(new ActionListener()
882     {
883       @Override
884       public void actionPerformed(ActionEvent e)
885       {
886         showFeatureDetails(sf, seqName, mf);
887       }
888     });
889     details.add(item);
890   }
891
892   /**
893    * Opens a panel showing a text report of feature details
894    * 
895    * @param sf
896    * @param seqName
897    * @param mf
898    */
899   protected void showFeatureDetails(SequenceFeature sf, String seqName,
900           MappedFeatures mf)
901   {
902     JInternalFrame details;
903     if (Platform.isJS())
904     {
905       details = new JInternalFrame();
906       JPanel panel = new JPanel(new BorderLayout());
907       panel.setOpaque(true);
908       panel.setBackground(Color.white);
909       // TODO JAL-3026 set style of table correctly for feature details
910       JLabel reprt = new JLabel(MessageManager
911               .formatMessage("label.html_content", new Object[]
912               { sf.getDetailsReport(seqName, mf) }));
913       reprt.setBackground(Color.WHITE);
914       reprt.setOpaque(true);
915       panel.add(reprt, BorderLayout.CENTER);
916       details.setContentPane(panel);
917       details.pack();
918     }
919     else
920     /**
921      * Java only
922      * 
923      * @j2sIgnore
924      */
925     {
926       CutAndPasteHtmlTransfer cap = new CutAndPasteHtmlTransfer();
927       // it appears Java's CSS does not support border-collapse :-(
928       cap.addStylesheetRule("table { border-collapse: collapse;}");
929       cap.addStylesheetRule("table, td, th {border: 1px solid black;}");
930       cap.setText(sf.getDetailsReport(seqName, mf));
931       details = cap;
932     }
933     Desktop.addInternalFrame(details,
934             MessageManager.getString("label.feature_details"), 500, 500);
935   }
936
937   /**
938    * Adds a 'Link' menu item with a sub-menu item for each hyperlink provided.
939    * When seq is not null, these are links for the sequence id, which may be to
940    * external web sites for the sequence accession, and/or links embedded in
941    * non-positional features. When seq is null, only links embedded in the
942    * provided features are added. If no links are found, the menu is not added.
943    * 
944    * @param seq
945    * @param features
946    */
947   void addLinks(final SequenceI seq, List<SequenceFeature> features)
948   {
949     JMenu linkMenu = buildLinkMenu(forIdPanel ? seq : null, features);
950
951     // only add link menu if it has entries
952     if (linkMenu.getItemCount() > 0)
953     {
954       if (forIdPanel)
955       {
956         sequenceMenu.add(linkMenu);
957       }
958       else
959       {
960         add(linkMenu);
961       }
962     }
963   }
964
965   /**
966    * Add annotation types to 'Show annotations' and/or 'Hide annotations' menus.
967    * "All" is added first, followed by a separator. Then add any annotation
968    * types associated with the current selection. Separate menus are built for
969    * the selected sequence group (if any), and the selected sequence.
970    * <p>
971    * Some annotation rows are always rendered together - these can be identified
972    * by a common graphGroup property > -1. Only one of each group will be marked
973    * as visible (to avoid duplication of the display). For such groups we add a
974    * composite type name, e.g.
975    * <p>
976    * IUPredWS (Long), IUPredWS (Short)
977    * 
978    * @param seq
979    */
980   protected void buildAnnotationTypesMenus(JMenu showMenu, JMenu hideMenu,
981           List<SequenceI> forSequences)
982   {
983     showMenu.removeAll();
984     hideMenu.removeAll();
985
986     final List<String> all = Arrays
987             .asList(new String[]
988             { MessageManager.getString("label.all") });
989     addAnnotationTypeToShowHide(showMenu, forSequences, "", all, true,
990             true);
991     addAnnotationTypeToShowHide(hideMenu, forSequences, "", all, true,
992             false);
993     showMenu.addSeparator();
994     hideMenu.addSeparator();
995
996     final AlignmentAnnotation[] annotations = ap.getAlignment()
997             .getAlignmentAnnotation();
998
999     /*
1000      * Find shown/hidden annotations types, distinguished by source (calcId),
1001      * and grouped by graphGroup. Using LinkedHashMap means we will retrieve in
1002      * the insertion order, which is the order of the annotations on the
1003      * alignment.
1004      */
1005     Map<String, List<List<String>>> shownTypes = new LinkedHashMap<>();
1006     Map<String, List<List<String>>> hiddenTypes = new LinkedHashMap<>();
1007     AlignmentAnnotationUtils.getShownHiddenTypes(shownTypes, hiddenTypes,
1008             AlignmentAnnotationUtils.asList(annotations), forSequences);
1009
1010     for (String calcId : hiddenTypes.keySet())
1011     {
1012       for (List<String> type : hiddenTypes.get(calcId))
1013       {
1014         addAnnotationTypeToShowHide(showMenu, forSequences, calcId, type,
1015                 false, true);
1016       }
1017     }
1018     // grey out 'show annotations' if none are hidden
1019     showMenu.setEnabled(!hiddenTypes.isEmpty());
1020
1021     for (String calcId : shownTypes.keySet())
1022     {
1023       for (List<String> type : shownTypes.get(calcId))
1024       {
1025         addAnnotationTypeToShowHide(hideMenu, forSequences, calcId, type,
1026                 false, false);
1027       }
1028     }
1029     // grey out 'hide annotations' if none are shown
1030     hideMenu.setEnabled(!shownTypes.isEmpty());
1031   }
1032
1033   /**
1034    * Returns a list of sequences - either the current selection group (if there
1035    * is one), else the specified single sequence.
1036    * 
1037    * @param seq
1038    * @return
1039    */
1040   protected List<SequenceI> getSequenceScope(SequenceI seq)
1041   {
1042     List<SequenceI> forSequences = null;
1043     final SequenceGroup selectionGroup = ap.av.getSelectionGroup();
1044     if (selectionGroup != null && selectionGroup.getSize() > 0)
1045     {
1046       forSequences = selectionGroup.getSequences();
1047     }
1048     else
1049     {
1050       forSequences = seq == null ? Collections.<SequenceI> emptyList()
1051               : Arrays.asList(seq);
1052     }
1053     return forSequences;
1054   }
1055
1056   /**
1057    * Add one annotation type to the 'Show Annotations' or 'Hide Annotations'
1058    * menus.
1059    * 
1060    * @param showOrHideMenu
1061    *          the menu to add to
1062    * @param forSequences
1063    *          the sequences whose annotations may be shown or hidden
1064    * @param calcId
1065    * @param types
1066    *          the label to add
1067    * @param allTypes
1068    *          if true this is a special label meaning 'All'
1069    * @param actionIsShow
1070    *          if true, the select menu item action is to show the annotation
1071    *          type, else hide
1072    */
1073   protected void addAnnotationTypeToShowHide(JMenu showOrHideMenu,
1074           final List<SequenceI> forSequences, String calcId,
1075           final List<String> types, final boolean allTypes,
1076           final boolean actionIsShow)
1077   {
1078     String label = types.toString(); // [a, b, c]
1079     label = label.substring(1, label.length() - 1); // a, b, c
1080     final JMenuItem item = new JMenuItem(label);
1081     item.setToolTipText(calcId);
1082     item.addActionListener(new ActionListener()
1083     {
1084       @Override
1085       public void actionPerformed(ActionEvent e)
1086       {
1087         AlignmentUtils.showOrHideSequenceAnnotations(ap.getAlignment(),
1088                 types, forSequences, allTypes, actionIsShow);
1089         refresh();
1090       }
1091     });
1092     showOrHideMenu.add(item);
1093   }
1094
1095   private void buildGroupURLMenu(SequenceGroup sg, List<String> groupLinks)
1096   {
1097
1098     // TODO: usability: thread off the generation of group url content so root
1099     // menu appears asap
1100     // sequence only URLs
1101     // ID/regex match URLs
1102     JMenu groupLinksMenu = new JMenu(
1103             MessageManager.getString("action.group_link"));
1104     // three types of url that might be created.
1105     JMenu[] linkMenus = new JMenu[] { null,
1106         new JMenu(MessageManager.getString("action.ids")),
1107         new JMenu(MessageManager.getString("action.sequences")),
1108         new JMenu(MessageManager.getString("action.ids_sequences")) };
1109
1110     SequenceI[] seqs = ap.av.getSelectionAsNewSequence();
1111     String[][] idandseqs = GroupUrlLink.formStrings(seqs);
1112     Hashtable<String, Object[]> commonDbrefs = new Hashtable<>();
1113     for (int sq = 0; sq < seqs.length; sq++)
1114     {
1115
1116       int start = seqs[sq].findPosition(sg.getStartRes()),
1117               end = seqs[sq].findPosition(sg.getEndRes());
1118       // just collect ids from dataset sequence
1119       // TODO: check if IDs collected from selecton group intersects with the
1120       // current selection, too
1121       SequenceI sqi = seqs[sq];
1122       while (sqi.getDatasetSequence() != null)
1123       {
1124         sqi = sqi.getDatasetSequence();
1125       }
1126       List<DBRefEntry> dbr = sqi.getDBRefs();
1127       int nd;
1128       if (dbr != null && (nd = dbr.size()) > 0)
1129       {
1130         for (int d = 0; d < nd; d++)
1131         {
1132           DBRefEntry e = dbr.get(d);
1133           String src = e.getSource(); // jalview.util.DBRefUtils.getCanonicalName(dbr[d].getSource()).toUpperCase(Locale.ROOT);
1134           Object[] sarray = commonDbrefs.get(src);
1135           if (sarray == null)
1136           {
1137             sarray = new Object[2];
1138             sarray[0] = new int[] { 0 };
1139             sarray[1] = new String[seqs.length];
1140
1141             commonDbrefs.put(src, sarray);
1142           }
1143
1144           if (((String[]) sarray[1])[sq] == null)
1145           {
1146             if (!e.hasMap() || (e.getMap()
1147                     .locateMappedRange(start, end) != null))
1148             {
1149               ((String[]) sarray[1])[sq] = e.getAccessionId();
1150               ((int[]) sarray[0])[0]++;
1151             }
1152           }
1153         }
1154       }
1155     }
1156     // now create group links for all distinct ID/sequence sets.
1157     boolean addMenu = false; // indicates if there are any group links to give
1158                              // to user
1159     for (String link : groupLinks)
1160     {
1161       GroupUrlLink urlLink = null;
1162       try
1163       {
1164         urlLink = new GroupUrlLink(link);
1165       } catch (Exception foo)
1166       {
1167         Cache.log.error("Exception for GroupURLLink '" + link + "'", foo);
1168         continue;
1169       }
1170       if (!urlLink.isValid())
1171       {
1172         Cache.log.error(urlLink.getInvalidMessage());
1173         continue;
1174       }
1175       final String label = urlLink.getLabel();
1176       boolean usingNames = false;
1177       // Now see which parts of the group apply for this URL
1178       String ltarget = urlLink.getTarget(); // jalview.util.DBRefUtils.getCanonicalName(urlLink.getTarget());
1179       Object[] idset = commonDbrefs.get(ltarget.toUpperCase(Locale.ROOT));
1180       String[] seqstr, ids; // input to makeUrl
1181       if (idset != null)
1182       {
1183         int numinput = ((int[]) idset[0])[0];
1184         String[] allids = ((String[]) idset[1]);
1185         seqstr = new String[numinput];
1186         ids = new String[numinput];
1187         for (int sq = 0, idcount = 0; sq < seqs.length; sq++)
1188         {
1189           if (allids[sq] != null)
1190           {
1191             ids[idcount] = allids[sq];
1192             seqstr[idcount++] = idandseqs[1][sq];
1193           }
1194         }
1195       }
1196       else
1197       {
1198         // just use the id/seq set
1199         seqstr = idandseqs[1];
1200         ids = idandseqs[0];
1201         usingNames = true;
1202       }
1203       // and try and make the groupURL!
1204
1205       Object[] urlset = null;
1206       try
1207       {
1208         urlset = urlLink.makeUrlStubs(ids, seqstr,
1209                 "FromJalview" + System.currentTimeMillis(), false);
1210       } catch (UrlStringTooLongException e)
1211       {
1212       }
1213       if (urlset != null)
1214       {
1215         int type = urlLink.getGroupURLType() & 3;
1216         // first two bits ofurlLink type bitfield are sequenceids and sequences
1217         // TODO: FUTURE: ensure the groupURL menu structure can be generalised
1218         addshowLink(linkMenus[type],
1219                 label + (((type & 1) == 1)
1220                         ? ("(" + (usingNames ? "Names" : ltarget) + ")")
1221                         : ""),
1222                 urlLink, urlset);
1223         addMenu = true;
1224       }
1225     }
1226     if (addMenu)
1227     {
1228       groupLinksMenu = new JMenu(
1229               MessageManager.getString("action.group_link"));
1230       for (int m = 0; m < linkMenus.length; m++)
1231       {
1232         if (linkMenus[m] != null
1233                 && linkMenus[m].getMenuComponentCount() > 0)
1234         {
1235           groupLinksMenu.add(linkMenus[m]);
1236         }
1237       }
1238
1239       groupMenu.add(groupLinksMenu);
1240     }
1241   }
1242
1243   /**
1244    * DOCUMENT ME!
1245    * 
1246    * @throws Exception
1247    *           DOCUMENT ME!
1248    */
1249   private void jbInit() throws Exception
1250   {
1251     groupMenu.setText(MessageManager.getString("label.selection"));
1252     groupName.setText(MessageManager.getString("label.name"));
1253     groupName.addActionListener(new ActionListener()
1254     {
1255       @Override
1256       public void actionPerformed(ActionEvent e)
1257       {
1258         groupName_actionPerformed();
1259       }
1260     });
1261     sequenceMenu.setText(MessageManager.getString("label.sequence"));
1262
1263     JMenuItem sequenceName = new JMenuItem(
1264             MessageManager.getString("label.edit_name_description"));
1265     sequenceName.addActionListener(new ActionListener()
1266     {
1267       @Override
1268       public void actionPerformed(ActionEvent e)
1269       {
1270         sequenceName_actionPerformed();
1271       }
1272     });
1273     JMenuItem chooseAnnotations = new JMenuItem(
1274             MessageManager.getString("action.choose_annotations"));
1275     chooseAnnotations.addActionListener(new ActionListener()
1276     {
1277       @Override
1278       public void actionPerformed(ActionEvent e)
1279       {
1280         chooseAnnotations_actionPerformed(e);
1281       }
1282     });
1283     JMenuItem sequenceDetails = new JMenuItem(
1284             MessageManager.getString("label.sequence_details"));
1285     sequenceDetails.addActionListener(new ActionListener()
1286     {
1287       @Override
1288       public void actionPerformed(ActionEvent e)
1289       {
1290         createSequenceDetailsReport(new SequenceI[] { sequence });
1291       }
1292     });
1293     JMenuItem sequenceSelDetails = new JMenuItem(
1294             MessageManager.getString("label.sequence_details"));
1295     sequenceSelDetails.addActionListener(new ActionListener()
1296     {
1297       @Override
1298       public void actionPerformed(ActionEvent e)
1299       {
1300         createSequenceDetailsReport(ap.av.getSequenceSelection());
1301       }
1302     });
1303
1304     unGroupMenuItem
1305             .setText(MessageManager.getString("action.remove_group"));
1306     unGroupMenuItem.addActionListener(new ActionListener()
1307     {
1308       @Override
1309       public void actionPerformed(ActionEvent e)
1310       {
1311         unGroupMenuItem_actionPerformed();
1312       }
1313     });
1314     createGroupMenuItem
1315             .setText(MessageManager.getString("action.create_group"));
1316     createGroupMenuItem.addActionListener(new ActionListener()
1317     {
1318       @Override
1319       public void actionPerformed(ActionEvent e)
1320       {
1321         createGroupMenuItem_actionPerformed();
1322       }
1323     });
1324
1325     JMenuItem outline = new JMenuItem(
1326             MessageManager.getString("action.border_colour"));
1327     outline.addActionListener(new ActionListener()
1328     {
1329       @Override
1330       public void actionPerformed(ActionEvent e)
1331       {
1332         outline_actionPerformed();
1333       }
1334     });
1335     showBoxes.setText(MessageManager.getString("action.boxes"));
1336     showBoxes.setState(true);
1337     showBoxes.addActionListener(new ActionListener()
1338     {
1339       @Override
1340       public void actionPerformed(ActionEvent e)
1341       {
1342         showBoxes_actionPerformed();
1343       }
1344     });
1345     showText.setText(MessageManager.getString("action.text"));
1346     showText.setState(true);
1347     showText.addActionListener(new ActionListener()
1348     {
1349       @Override
1350       public void actionPerformed(ActionEvent e)
1351       {
1352         showText_actionPerformed();
1353       }
1354     });
1355     showColourText.setText(MessageManager.getString("label.colour_text"));
1356     showColourText.addActionListener(new ActionListener()
1357     {
1358       @Override
1359       public void actionPerformed(ActionEvent e)
1360       {
1361         showColourText_actionPerformed();
1362       }
1363     });
1364     displayNonconserved
1365             .setText(MessageManager.getString("label.show_non_conserved"));
1366     displayNonconserved.setState(true);
1367     displayNonconserved.addActionListener(new ActionListener()
1368     {
1369       @Override
1370       public void actionPerformed(ActionEvent e)
1371       {
1372         showNonconserved_actionPerformed();
1373       }
1374     });
1375     editMenu.setText(MessageManager.getString("action.edit"));
1376     JMenuItem cut = new JMenuItem(MessageManager.getString("action.cut"));
1377     cut.addActionListener(new ActionListener()
1378     {
1379       @Override
1380       public void actionPerformed(ActionEvent e)
1381       {
1382         cut_actionPerformed();
1383       }
1384     });
1385     upperCase.setText(MessageManager.getString("label.to_upper_case"));
1386     upperCase.addActionListener(new ActionListener()
1387     {
1388       @Override
1389       public void actionPerformed(ActionEvent e)
1390       {
1391         changeCase(e);
1392       }
1393     });
1394     JMenuItem copy = new JMenuItem(MessageManager.getString("action.copy"));
1395     copy.addActionListener(new ActionListener()
1396     {
1397       @Override
1398       public void actionPerformed(ActionEvent e)
1399       {
1400         copy_actionPerformed();
1401       }
1402     });
1403     lowerCase.setText(MessageManager.getString("label.to_lower_case"));
1404     lowerCase.addActionListener(new ActionListener()
1405     {
1406       @Override
1407       public void actionPerformed(ActionEvent e)
1408       {
1409         changeCase(e);
1410       }
1411     });
1412     toggle.setText(MessageManager.getString("label.toggle_case"));
1413     toggle.addActionListener(new ActionListener()
1414     {
1415       @Override
1416       public void actionPerformed(ActionEvent e)
1417       {
1418         changeCase(e);
1419       }
1420     });
1421     outputMenu.setText(
1422             MessageManager.getString("label.out_to_textbox") + "...");
1423     seqShowAnnotationsMenu
1424             .setText(MessageManager.getString("label.show_annotations"));
1425     seqHideAnnotationsMenu
1426             .setText(MessageManager.getString("label.hide_annotations"));
1427     groupShowAnnotationsMenu
1428             .setText(MessageManager.getString("label.show_annotations"));
1429     groupHideAnnotationsMenu
1430             .setText(MessageManager.getString("label.hide_annotations"));
1431     JMenuItem sequenceFeature = new JMenuItem(
1432             MessageManager.getString("label.create_sequence_feature"));
1433     sequenceFeature.addActionListener(new ActionListener()
1434     {
1435       @Override
1436       public void actionPerformed(ActionEvent e)
1437       {
1438         sequenceFeature_actionPerformed();
1439       }
1440     });
1441     editGroupMenu.setText(MessageManager.getString("label.group"));
1442     chooseStructure.setText(
1443             MessageManager.getString("label.show_pdbstruct_dialog"));
1444     chooseStructure.addActionListener(new ActionListener()
1445     {
1446       @Override
1447       public void actionPerformed(ActionEvent actionEvent)
1448       {
1449         SequenceI[] selectedSeqs = new SequenceI[] { sequence };
1450         if (ap.av.getSelectionGroup() != null)
1451         {
1452           selectedSeqs = ap.av.getSequenceSelection();
1453         }
1454         new StructureChooser(selectedSeqs, sequence, ap);
1455       }
1456     });
1457
1458     rnaStructureMenu
1459             .setText(MessageManager.getString("label.view_rna_structure"));
1460
1461     // colStructureMenu.setText("Colour By Structure");
1462     JMenuItem editSequence = new JMenuItem(
1463             MessageManager.getString("label.edit_sequence") + "...");
1464     editSequence.addActionListener(new ActionListener()
1465     {
1466       @Override
1467       public void actionPerformed(ActionEvent actionEvent)
1468       {
1469         editSequence_actionPerformed();
1470       }
1471     });
1472     makeReferenceSeq.setText(
1473             MessageManager.getString("label.mark_as_representative"));
1474     makeReferenceSeq.addActionListener(new ActionListener()
1475     {
1476
1477       @Override
1478       public void actionPerformed(ActionEvent actionEvent)
1479       {
1480         makeReferenceSeq_actionPerformed(actionEvent);
1481
1482       }
1483     });
1484
1485     groupMenu.add(sequenceSelDetails);
1486     add(groupMenu);
1487     add(sequenceMenu);
1488     add(rnaStructureMenu);
1489     add(chooseStructure);
1490     if (forIdPanel)
1491     {
1492       JMenuItem hideInsertions = new JMenuItem(
1493               MessageManager.getString("label.hide_insertions"));
1494       hideInsertions.addActionListener(new ActionListener()
1495       {
1496
1497         @Override
1498         public void actionPerformed(ActionEvent e)
1499         {
1500           hideInsertions_actionPerformed(e);
1501         }
1502       });
1503       add(hideInsertions);
1504     }
1505     // annotations configuration panel suppressed for now
1506     // groupMenu.add(chooseAnnotations);
1507
1508     /*
1509      * Add show/hide annotations to the Sequence menu, and to the Selection menu
1510      * (if a selection group is in force).
1511      */
1512     sequenceMenu.add(seqShowAnnotationsMenu);
1513     sequenceMenu.add(seqHideAnnotationsMenu);
1514     sequenceMenu.add(seqAddReferenceAnnotations);
1515     groupMenu.add(groupShowAnnotationsMenu);
1516     groupMenu.add(groupHideAnnotationsMenu);
1517     groupMenu.add(groupAddReferenceAnnotations);
1518     groupMenu.add(editMenu);
1519     groupMenu.add(outputMenu);
1520     groupMenu.add(sequenceFeature);
1521     groupMenu.add(createGroupMenuItem);
1522     groupMenu.add(unGroupMenuItem);
1523     groupMenu.add(editGroupMenu);
1524     sequenceMenu.add(sequenceName);
1525     sequenceMenu.add(sequenceDetails);
1526     sequenceMenu.add(makeReferenceSeq);
1527
1528     initColourMenu();
1529     buildColourMenu();
1530
1531     editMenu.add(copy);
1532     editMenu.add(cut);
1533     editMenu.add(editSequence);
1534     editMenu.add(upperCase);
1535     editMenu.add(lowerCase);
1536     editMenu.add(toggle);
1537     editGroupMenu.add(groupName);
1538     editGroupMenu.add(colourMenu);
1539     editGroupMenu.add(showBoxes);
1540     editGroupMenu.add(showText);
1541     editGroupMenu.add(showColourText);
1542     editGroupMenu.add(outline);
1543     editGroupMenu.add(displayNonconserved);
1544   }
1545
1546   /**
1547    * Constructs the entries for the colour menu
1548    */
1549   protected void initColourMenu()
1550   {
1551     colourMenu.setText(MessageManager.getString("label.group_colour"));
1552     textColour.setText(MessageManager.getString("label.text_colour"));
1553     textColour.addActionListener(new ActionListener()
1554     {
1555       @Override
1556       public void actionPerformed(ActionEvent e)
1557       {
1558         textColour_actionPerformed();
1559       }
1560     });
1561
1562     abovePIDColour.setText(
1563             MessageManager.getString("label.above_identity_threshold"));
1564     abovePIDColour.addActionListener(new ActionListener()
1565     {
1566       @Override
1567       public void actionPerformed(ActionEvent e)
1568       {
1569         abovePIDColour_actionPerformed(abovePIDColour.isSelected());
1570       }
1571     });
1572
1573     modifyPID.setText(
1574             MessageManager.getString("label.modify_identity_threshold"));
1575     modifyPID.addActionListener(new ActionListener()
1576     {
1577       @Override
1578       public void actionPerformed(ActionEvent e)
1579       {
1580         modifyPID_actionPerformed();
1581       }
1582     });
1583
1584     conservationMenuItem
1585             .setText(MessageManager.getString("action.by_conservation"));
1586     conservationMenuItem.addActionListener(new ActionListener()
1587     {
1588       @Override
1589       public void actionPerformed(ActionEvent e)
1590       {
1591         conservationMenuItem_actionPerformed(
1592                 conservationMenuItem.isSelected());
1593       }
1594     });
1595
1596     annotationColour = new JRadioButtonMenuItem(
1597             MessageManager.getString("action.by_annotation"));
1598     annotationColour.setName(ResidueColourScheme.ANNOTATION_COLOUR);
1599     annotationColour.setEnabled(false);
1600     annotationColour.setToolTipText(
1601             MessageManager.getString("label.by_annotation_tooltip"));
1602
1603     modifyConservation.setText(MessageManager
1604             .getString("label.modify_conservation_threshold"));
1605     modifyConservation.addActionListener(new ActionListener()
1606     {
1607       @Override
1608       public void actionPerformed(ActionEvent e)
1609       {
1610         modifyConservation_actionPerformed();
1611       }
1612     });
1613   }
1614
1615   /**
1616    * Builds the group colour sub-menu, including any user-defined colours which
1617    * were loaded at startup or during the Jalview session
1618    */
1619   protected void buildColourMenu()
1620   {
1621     SequenceGroup sg = ap.av.getSelectionGroup();
1622     if (sg == null)
1623     {
1624       /*
1625        * popup menu with no sequence group scope
1626        */
1627       return;
1628     }
1629     colourMenu.removeAll();
1630     colourMenu.add(textColour);
1631     colourMenu.addSeparator();
1632
1633     ButtonGroup bg = ColourMenuHelper.addMenuItems(colourMenu, this, sg,
1634             false);
1635     bg.add(annotationColour);
1636     colourMenu.add(annotationColour);
1637
1638     colourMenu.addSeparator();
1639     colourMenu.add(conservationMenuItem);
1640     colourMenu.add(modifyConservation);
1641     colourMenu.add(abovePIDColour);
1642     colourMenu.add(modifyPID);
1643   }
1644
1645   protected void modifyConservation_actionPerformed()
1646   {
1647     SequenceGroup sg = getGroup();
1648     if (sg.cs != null)
1649     {
1650       SliderPanel.setConservationSlider(ap, sg.cs, sg.getName());
1651       SliderPanel.showConservationSlider();
1652     }
1653   }
1654
1655   protected void modifyPID_actionPerformed()
1656   {
1657     SequenceGroup sg = getGroup();
1658     if (sg.cs != null)
1659     {
1660       // int threshold = SliderPanel.setPIDSliderSource(ap, sg.cs, getGroup()
1661       // .getName());
1662       // sg.cs.setThreshold(threshold, ap.av.isIgnoreGapsConsensus());
1663       SliderPanel.setPIDSliderSource(ap, sg.cs, getGroup().getName());
1664       SliderPanel.showPIDSlider();
1665     }
1666   }
1667
1668   /**
1669    * Check for any annotations on the underlying dataset sequences (for the
1670    * current selection group) which are not 'on the alignment'.If any are found,
1671    * enable the option to add them to the alignment. The criteria for 'on the
1672    * alignment' is finding an alignment annotation on the alignment, matched on
1673    * calcId, label and sequenceRef.
1674    * 
1675    * A tooltip is also constructed that displays the source (calcId) and type
1676    * (label) of the annotations that can be added.
1677    * 
1678    * @param menuItem
1679    * @param forSequences
1680    */
1681   protected void configureReferenceAnnotationsMenu(JMenuItem menuItem,
1682           List<SequenceI> forSequences)
1683   {
1684     menuItem.setEnabled(false);
1685
1686     /*
1687      * Temporary store to hold distinct calcId / type pairs for the tooltip.
1688      * Using TreeMap means calcIds are shown in alphabetical order.
1689      */
1690     SortedMap<String, String> tipEntries = new TreeMap<>();
1691     final Map<SequenceI, List<AlignmentAnnotation>> candidates = new LinkedHashMap<>();
1692     AlignmentI al = this.ap.av.getAlignment();
1693     AlignmentUtils.findAddableReferenceAnnotations(forSequences, tipEntries,
1694             candidates, al);
1695     if (!candidates.isEmpty())
1696     {
1697       StringBuilder tooltip = new StringBuilder(64);
1698       tooltip.append(MessageManager.getString("label.add_annotations_for"));
1699
1700       /*
1701        * Found annotations that could be added. Enable the menu item, and
1702        * configure its tooltip and action.
1703        */
1704       menuItem.setEnabled(true);
1705       for (String calcId : tipEntries.keySet())
1706       {
1707         tooltip.append("<br/>" + calcId + "/" + tipEntries.get(calcId));
1708       }
1709       String tooltipText = JvSwingUtils.wrapTooltip(true,
1710               tooltip.toString());
1711       menuItem.setToolTipText(tooltipText);
1712
1713       menuItem.addActionListener(new ActionListener()
1714       {
1715         @Override
1716         public void actionPerformed(ActionEvent e)
1717         {
1718           addReferenceAnnotations_actionPerformed(candidates);
1719         }
1720       });
1721     }
1722   }
1723
1724   /**
1725    * Add annotations to the sequences and to the alignment.
1726    * 
1727    * @param candidates
1728    *          a map whose keys are sequences on the alignment, and values a list
1729    *          of annotations to add to each sequence
1730    */
1731   protected void addReferenceAnnotations_actionPerformed(
1732           Map<SequenceI, List<AlignmentAnnotation>> candidates)
1733   {
1734     final SequenceGroup selectionGroup = this.ap.av.getSelectionGroup();
1735     final AlignmentI alignment = this.ap.getAlignment();
1736     AlignmentUtils.addReferenceAnnotations(candidates, alignment,
1737             selectionGroup);
1738     refresh();
1739   }
1740
1741   protected void makeReferenceSeq_actionPerformed(ActionEvent actionEvent)
1742   {
1743     if (!ap.av.getAlignment().hasSeqrep())
1744     {
1745       // initialise the display flags so the user sees something happen
1746       ap.av.setDisplayReferenceSeq(true);
1747       ap.av.setColourByReferenceSeq(true);
1748       ap.av.getAlignment().setSeqrep(sequence);
1749     }
1750     else
1751     {
1752       if (ap.av.getAlignment().getSeqrep() == sequence)
1753       {
1754         ap.av.getAlignment().setSeqrep(null);
1755       }
1756       else
1757       {
1758         ap.av.getAlignment().setSeqrep(sequence);
1759       }
1760     }
1761     refresh();
1762   }
1763
1764   protected void hideInsertions_actionPerformed(ActionEvent actionEvent)
1765   {
1766     HiddenColumns hidden = ap.av.getAlignment().getHiddenColumns();
1767     BitSet inserts = new BitSet();
1768
1769     boolean markedPopup = false;
1770     // mark inserts in current selection
1771     if (ap.av.getSelectionGroup() != null)
1772     {
1773       // mark just the columns in the selection group to be hidden
1774       inserts.set(ap.av.getSelectionGroup().getStartRes(),
1775               ap.av.getSelectionGroup().getEndRes() + 1); // TODO why +1?
1776
1777       // now clear columns without gaps
1778       for (SequenceI sq : ap.av.getSelectionGroup().getSequences())
1779       {
1780         if (sq == sequence)
1781         {
1782           markedPopup = true;
1783         }
1784         inserts.and(sq.getInsertionsAsBits());
1785       }
1786       hidden.clearAndHideColumns(inserts, ap.av.getSelectionGroup().getStartRes(),
1787               ap.av.getSelectionGroup().getEndRes());
1788     }
1789
1790     // now mark for sequence under popup if we haven't already done it
1791     else if (!markedPopup && sequence != null)
1792     {
1793       inserts.or(sequence.getInsertionsAsBits());
1794
1795       // and set hidden columns accordingly
1796       hidden.hideColumns(inserts);
1797     }
1798     refresh();
1799   }
1800
1801   protected void sequenceSelectionDetails_actionPerformed()
1802   {
1803     createSequenceDetailsReport(ap.av.getSequenceSelection());
1804   }
1805
1806   public void createSequenceDetailsReport(SequenceI[] sequences)
1807   {
1808     StringBuilder contents = new StringBuilder(128);
1809     contents.append("<html><body>");
1810     for (SequenceI seq : sequences)
1811     {
1812       contents.append("<p><h2>" + MessageManager.formatMessage(
1813               "label.create_sequence_details_report_annotation_for",
1814               new Object[]
1815               { seq.getDisplayId(true) }) + "</h2></p><p>");
1816       new SequenceAnnotationReport(false).createSequenceAnnotationReport(
1817               contents, seq, true, true, ap.getSeqPanel().seqCanvas.fr);
1818       contents.append("</p>");
1819     }
1820     contents.append("</body></html>");
1821     String report = contents.toString();
1822
1823     JInternalFrame frame;
1824     if (Platform.isJS())
1825     {
1826       JLabel textLabel = new JLabel();
1827       textLabel.setText(report);
1828       textLabel.setBackground(Color.WHITE);
1829       JPanel pane = new JPanel(new BorderLayout());
1830       pane.setOpaque(true);
1831       pane.setBackground(Color.WHITE);
1832       pane.add(textLabel, BorderLayout.NORTH);
1833       frame = new JInternalFrame();
1834       frame.getContentPane().add(new JScrollPane(pane));
1835     }
1836     else
1837     /**
1838      * Java only
1839      * 
1840      * @j2sIgnore
1841      */
1842     {
1843       CutAndPasteHtmlTransfer cap = new CutAndPasteHtmlTransfer();
1844       cap.setText(report);
1845       frame = cap;
1846     }
1847
1848     Desktop.addInternalFrame(frame,
1849             MessageManager.formatMessage("label.sequence_details_for",
1850                     (sequences.length == 1 ? new Object[]
1851                     { sequences[0].getDisplayId(true) }
1852                             : new Object[]
1853                             { MessageManager
1854                                     .getString("label.selection") })),
1855             500, 400);
1856   }
1857
1858   protected void showNonconserved_actionPerformed()
1859   {
1860     getGroup().setShowNonconserved(displayNonconserved.isSelected());
1861     refresh();
1862   }
1863
1864   /**
1865    * call to refresh view after settings change
1866    */
1867   void refresh()
1868   {
1869     ap.updateAnnotation();
1870     // removed paintAlignment(true) here:
1871     // updateAnnotation calls paintAlignment already, so don't need to call
1872     // again
1873
1874     PaintRefresher.Refresh(this, ap.av.getSequenceSetId());
1875   }
1876
1877   /*
1878    * protected void covariationColour_actionPerformed() { getGroup().cs = new
1879    * CovariationColourScheme(sequence.getAnnotation()[0]); refresh(); }
1880    */
1881   /**
1882    * DOCUMENT ME!
1883    * 
1884    * @param selected
1885    * 
1886    * @param e
1887    *          DOCUMENT ME!
1888    */
1889   public void abovePIDColour_actionPerformed(boolean selected)
1890   {
1891     SequenceGroup sg = getGroup();
1892     if (sg.cs == null)
1893     {
1894       return;
1895     }
1896
1897     if (selected)
1898     {
1899       sg.cs.setConsensus(AAFrequency.calculate(
1900               sg.getSequences(ap.av.getHiddenRepSequences()),
1901               sg.getStartRes(), sg.getEndRes() + 1));
1902
1903       int threshold = SliderPanel.setPIDSliderSource(ap,
1904               sg.getGroupColourScheme(), getGroup().getName());
1905
1906       sg.cs.setThreshold(threshold, ap.av.isIgnoreGapsConsensus());
1907
1908       SliderPanel.showPIDSlider();
1909     }
1910     else
1911     // remove PIDColouring
1912     {
1913       sg.cs.setThreshold(0, ap.av.isIgnoreGapsConsensus());
1914       SliderPanel.hidePIDSlider();
1915     }
1916     modifyPID.setEnabled(selected);
1917
1918     refresh();
1919   }
1920
1921   /**
1922    * Open a panel where the user can choose which types of sequence annotation
1923    * to show or hide.
1924    * 
1925    * @param e
1926    */
1927   protected void chooseAnnotations_actionPerformed(ActionEvent e)
1928   {
1929     // todo correct way to guard against opening a duplicate panel?
1930     new AnnotationChooser(ap);
1931   }
1932
1933   /**
1934    * DOCUMENT ME!
1935    * 
1936    * @param e
1937    *          DOCUMENT ME!
1938    */
1939   public void conservationMenuItem_actionPerformed(boolean selected)
1940   {
1941     SequenceGroup sg = getGroup();
1942     if (sg.cs == null)
1943     {
1944       return;
1945     }
1946
1947     if (selected)
1948     {
1949       // JBPNote: Conservation name shouldn't be i18n translated
1950       Conservation c = new Conservation("Group",
1951               sg.getSequences(ap.av.getHiddenRepSequences()),
1952               sg.getStartRes(), sg.getEndRes() + 1);
1953
1954       c.calculate();
1955       c.verdict(false, ap.av.getConsPercGaps());
1956       sg.cs.setConservation(c);
1957
1958       SliderPanel.setConservationSlider(ap, sg.getGroupColourScheme(),
1959               sg.getName());
1960       SliderPanel.showConservationSlider();
1961     }
1962     else
1963     // remove ConservationColouring
1964     {
1965       sg.cs.setConservation(null);
1966       SliderPanel.hideConservationSlider();
1967     }
1968     modifyConservation.setEnabled(selected);
1969
1970     refresh();
1971   }
1972
1973   /**
1974    * Shows a dialog where group name and description may be edited
1975    */
1976   protected void groupName_actionPerformed()
1977   {
1978     SequenceGroup sg = getGroup();
1979     EditNameDialog dialog = new EditNameDialog(sg.getName(),
1980             sg.getDescription(),
1981             MessageManager.getString("label.group_name"),
1982             MessageManager.getString("label.group_description"));
1983     dialog.showDialog(ap.alignFrame,
1984             MessageManager.getString("label.edit_group_name_description"),
1985             new Runnable()
1986             {
1987               @Override
1988               public void run()
1989               {
1990                 sg.setName(dialog.getName());
1991                 sg.setDescription(dialog.getDescription());
1992                 refresh();
1993               }
1994             });
1995   }
1996
1997   /**
1998    * Get selection group - adding it to the alignment if necessary.
1999    * 
2000    * @return sequence group to operate on
2001    */
2002   SequenceGroup getGroup()
2003   {
2004     SequenceGroup sg = ap.av.getSelectionGroup();
2005     // this method won't add a new group if it already exists
2006     if (sg != null)
2007     {
2008       ap.av.getAlignment().addGroup(sg);
2009     }
2010
2011     return sg;
2012   }
2013
2014   /**
2015    * Shows a dialog where the sequence name and description may be edited. If a
2016    * name containing spaces is entered, these are converted to underscores, with a
2017    * warning message.
2018    */
2019   void sequenceName_actionPerformed()
2020   {
2021     EditNameDialog dialog = new EditNameDialog(sequence.getName(),
2022             sequence.getDescription(),
2023             MessageManager.getString("label.sequence_name"),
2024             MessageManager.getString("label.sequence_description"));
2025     dialog.showDialog(ap.alignFrame,
2026             MessageManager.getString(
2027                     "label.edit_sequence_name_description"),
2028             new Runnable()
2029             {
2030               @Override
2031               public void run()
2032               {
2033                 if (dialog.getName() != null)
2034                 {
2035                   if (dialog.getName().indexOf(" ") > -1)
2036                   {
2037                     JvOptionPane.showMessageDialog(ap,
2038                             MessageManager.getString(
2039                                     "label.spaces_converted_to_underscores"),
2040                             MessageManager.getString(
2041                                     "label.no_spaces_allowed_sequence_name"),
2042                             JvOptionPane.WARNING_MESSAGE);
2043                   }
2044                   sequence.setName(dialog.getName().replace(' ', '_'));
2045                   ap.paintAlignment(false, false);
2046                 }
2047                 sequence.setDescription(dialog.getDescription());
2048                 ap.av.firePropertyChange("alignment", null,
2049                         ap.av.getAlignment().getSequences());
2050               }
2051             });
2052   }
2053
2054   /**
2055    * DOCUMENT ME!
2056    * 
2057    * @param e
2058    *          DOCUMENT ME!
2059    */
2060   void unGroupMenuItem_actionPerformed()
2061   {
2062     SequenceGroup sg = ap.av.getSelectionGroup();
2063     ap.av.getAlignment().deleteGroup(sg);
2064     ap.av.setSelectionGroup(null);
2065     refresh();
2066   }
2067
2068   void createGroupMenuItem_actionPerformed()
2069   {
2070     getGroup(); // implicitly creates group - note - should apply defaults / use
2071                 // standard alignment window logic for this
2072     refresh();
2073   }
2074
2075   /**
2076    * Offers a colour chooser and sets the selected colour as the group outline
2077    */
2078   protected void outline_actionPerformed()
2079   {
2080     String title = MessageManager
2081             .getString("label.select_outline_colour");
2082     ColourChooserListener listener = new ColourChooserListener()
2083     {
2084       @Override
2085       public void colourSelected(Color c)
2086       {
2087         getGroup().setOutlineColour(c);
2088         refresh();
2089       }
2090     };
2091     JalviewColourChooser.showColourChooser(Desktop.getDesktop(),
2092             title, Color.BLUE, listener);
2093   }
2094
2095   /**
2096    * DOCUMENT ME!
2097    * 
2098    * @param e
2099    *          DOCUMENT ME!
2100    */
2101   public void showBoxes_actionPerformed()
2102   {
2103     getGroup().setDisplayBoxes(showBoxes.isSelected());
2104     refresh();
2105   }
2106
2107   /**
2108    * DOCUMENT ME!
2109    * 
2110    * @param e
2111    *          DOCUMENT ME!
2112    */
2113   public void showText_actionPerformed()
2114   {
2115     getGroup().setDisplayText(showText.isSelected());
2116     refresh();
2117   }
2118
2119   /**
2120    * DOCUMENT ME!
2121    * 
2122    * @param e
2123    *          DOCUMENT ME!
2124    */
2125   public void showColourText_actionPerformed()
2126   {
2127     getGroup().setColourText(showColourText.isSelected());
2128     refresh();
2129   }
2130
2131   void hideSequences(boolean representGroup)
2132   {
2133     ap.av.hideSequences(sequence, representGroup);
2134   }
2135
2136   public void copy_actionPerformed()
2137   {
2138     ap.alignFrame.copy_actionPerformed();
2139   }
2140
2141   public void cut_actionPerformed()
2142   {
2143     ap.alignFrame.cut_actionPerformed();
2144   }
2145
2146   void changeCase(ActionEvent e)
2147   {
2148     Object source = e.getSource();
2149     SequenceGroup sg = ap.av.getSelectionGroup();
2150
2151     if (sg != null)
2152     {
2153       List<int[]> startEnd = ap.av.getVisibleRegionBoundaries(
2154               sg.getStartRes(), sg.getEndRes() + 1);
2155
2156       String description;
2157       int caseChange;
2158
2159       if (source == toggle)
2160       {
2161         description = MessageManager.getString("label.toggle_case");
2162         caseChange = ChangeCaseCommand.TOGGLE_CASE;
2163       }
2164       else if (source == upperCase)
2165       {
2166         description = MessageManager.getString("label.to_upper_case");
2167         caseChange = ChangeCaseCommand.TO_UPPER;
2168       }
2169       else
2170       {
2171         description = MessageManager.getString("label.to_lower_case");
2172         caseChange = ChangeCaseCommand.TO_LOWER;
2173       }
2174
2175       ChangeCaseCommand caseCommand = new ChangeCaseCommand(description,
2176               sg.getSequencesAsArray(ap.av.getHiddenRepSequences()),
2177               startEnd, caseChange);
2178
2179       ap.alignFrame.addHistoryItem(caseCommand);
2180
2181       ap.av.firePropertyChange("alignment", null,
2182               ap.av.getAlignment().getSequences());
2183
2184     }
2185   }
2186
2187   public void outputText_actionPerformed(ActionEvent e)
2188   {
2189     CutAndPasteTransfer cap = new CutAndPasteTransfer();
2190     cap.setForInput(null);
2191     Desktop.addInternalFrame(cap, MessageManager
2192             .formatMessage("label.alignment_output_command", new Object[]
2193             { e.getActionCommand() }), 600, 500);
2194
2195     String[] omitHidden = null;
2196
2197     System.out.println("PROMPT USER HERE"); // TODO: decide if a prompt happens
2198     // or we simply trust the user wants
2199     // wysiwig behaviour
2200
2201     FileFormatI fileFormat = FileFormats.getInstance()
2202             .forName(e.getActionCommand());
2203     cap.setText(
2204             new FormatAdapter(ap).formatSequences(fileFormat, ap, true));
2205   }
2206
2207   public void sequenceFeature_actionPerformed()
2208   {
2209     SequenceGroup sg = ap.av.getSelectionGroup();
2210     if (sg == null)
2211     {
2212       return;
2213     }
2214
2215     List<SequenceI> seqs = new ArrayList<>();
2216     List<SequenceFeature> features = new ArrayList<>();
2217
2218     /*
2219      * assemble dataset sequences, and template new sequence features,
2220      * for the amend features dialog
2221      */
2222     int gSize = sg.getSize();
2223     for (int i = 0; i < gSize; i++)
2224     {
2225       int start = sg.getSequenceAt(i).findPosition(sg.getStartRes());
2226       int end = sg.findEndRes(sg.getSequenceAt(i));
2227       if (start <= end)
2228       {
2229         seqs.add(sg.getSequenceAt(i).getDatasetSequence());
2230         features.add(new SequenceFeature(null, null, start, end, null));
2231       }
2232     }
2233
2234     /*
2235      * an entirely gapped region will generate empty lists of sequence / features
2236      */
2237     if (!seqs.isEmpty())
2238     {
2239       new FeatureEditor(ap, seqs, features, true).showDialog();
2240     }
2241   }
2242
2243   public void textColour_actionPerformed()
2244   {
2245     SequenceGroup sg = getGroup();
2246     if (sg != null)
2247     {
2248       new TextColourChooser().chooseColour(ap, sg);
2249     }
2250   }
2251
2252   /**
2253    * Shows a dialog where sequence characters may be edited. Any changes are
2254    * applied, and added as an available 'Undo' item in the edit commands
2255    * history.
2256    */
2257   public void editSequence_actionPerformed()
2258   {
2259     SequenceGroup sg = ap.av.getSelectionGroup();
2260
2261     SequenceI seq = sequence;
2262     if (sg != null)
2263     {
2264       if (seq == null)
2265       {
2266         seq = sg.getSequenceAt(0);
2267       }
2268
2269       EditNameDialog dialog = new EditNameDialog(
2270               seq.getSequenceAsString(sg.getStartRes(), sg.getEndRes() + 1),
2271               null, MessageManager.getString("label.edit_sequence"), null);
2272       dialog.showDialog(ap.alignFrame,
2273               MessageManager.getString("label.edit_sequence"),
2274               new Runnable()
2275               {
2276                 @Override
2277                 public void run()
2278                 {
2279                   EditCommand editCommand = new EditCommand(
2280                           MessageManager.getString("label.edit_sequences"),
2281                           Action.REPLACE,
2282                           dialog.getName().replace(' ',
2283                                   ap.av.getGapCharacter()),
2284                           sg.getSequencesAsArray(
2285                                   ap.av.getHiddenRepSequences()),
2286                           sg.getStartRes(), sg.getEndRes() + 1,
2287                           ap.av.getAlignment());
2288                   ap.alignFrame.addHistoryItem(editCommand);
2289                   ap.av.firePropertyChange("alignment", null,
2290                           ap.av.getAlignment().getSequences());
2291                 }
2292               });
2293     }
2294   }
2295
2296   /**
2297    * Action on user selecting an item from the colour menu (that does not have
2298    * its bespoke action handler)
2299    * 
2300    * @return
2301    */
2302   @Override
2303   public void changeColour_actionPerformed(String colourSchemeName)
2304   {
2305     SequenceGroup sg = getGroup();
2306     /*
2307      * switch to the chosen colour scheme (or null for None)
2308      */
2309     ColourSchemeI colourScheme = ColourSchemes.getInstance()
2310             .getColourScheme(colourSchemeName, ap.av, sg,
2311                     ap.av.getHiddenRepSequences());
2312     sg.setColourScheme(colourScheme);
2313     if (colourScheme instanceof Blosum62ColourScheme
2314             || colourScheme instanceof PIDColourScheme)
2315     {
2316       sg.cs.setConsensus(AAFrequency.calculate(
2317               sg.getSequences(ap.av.getHiddenRepSequences()),
2318               sg.getStartRes(), sg.getEndRes() + 1));
2319     }
2320
2321     refresh();
2322   }
2323
2324 }