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