6b32efafb54ea04a8981fe4b8c068904cf25c8aa
[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[] beginRange = mf.getMappedPositions(start, start);
843       start = beginRange[0];
844       int[] endRange = mf.getMappedPositions(end, end);
845       end = endRange[endRange.length - 1];
846     }
847     StringBuilder desc = new StringBuilder();
848     desc.append(sf.getType()).append(" ").append(String.valueOf(start));
849     if (start != end)
850     {
851       desc.append(sf.isContactFeature() ? ":" : "-");
852       desc.append(String.valueOf(end));
853     }
854     String description = sf.getDescription();
855     if (description != null)
856     {
857       desc.append(" ");
858       description = StringUtils.stripHtmlTags(description);
859
860       /*
861        * truncate overlong descriptions unless they contain an href
862        * (as truncation could leave corrupted html)
863        */
864       boolean hasLink = description.indexOf("a href") > -1;
865       if (description.length() > FEATURE_DESC_MAX && !hasLink)
866       {
867         description = description.substring(0, FEATURE_DESC_MAX) + "...";
868       }
869       desc.append(description);
870     }
871     String featureGroup = sf.getFeatureGroup();
872     if (featureGroup != null)
873     {
874       desc.append(" (").append(featureGroup).append(")");
875     }
876     String htmlText = JvSwingUtils.wrapTooltip(true, desc.toString());
877     JMenuItem item = new JMenuItem(htmlText);
878     item.addActionListener(new ActionListener()
879     {
880       @Override
881       public void actionPerformed(ActionEvent e)
882       {
883         showFeatureDetails(sf, seqName, mf);
884       }
885     });
886     details.add(item);
887   }
888
889   /**
890    * Opens a panel showing a text report of feature details
891    * 
892    * @param sf
893    * @param seqName
894    * @param mf
895    */
896   protected void showFeatureDetails(SequenceFeature sf, String seqName,
897           MappedFeatures mf)
898   {
899     JInternalFrame details;
900     if (Platform.isJS())
901     {
902       details = new JInternalFrame();
903       JPanel panel = new JPanel(new BorderLayout());
904       panel.setOpaque(true);
905       panel.setBackground(Color.white);
906       // TODO JAL-3026 set style of table correctly for feature details
907       JLabel reprt = new JLabel(MessageManager
908               .formatMessage("label.html_content", new Object[]
909               { sf.getDetailsReport(seqName, mf) }));
910       reprt.setBackground(Color.WHITE);
911       reprt.setOpaque(true);
912       panel.add(reprt, BorderLayout.CENTER);
913       details.setContentPane(panel);
914       details.pack();
915     }
916     else
917     /**
918      * Java only
919      * 
920      * @j2sIgnore
921      */
922     {
923       CutAndPasteHtmlTransfer cap = new CutAndPasteHtmlTransfer();
924       // it appears Java's CSS does not support border-collapse :-(
925       cap.addStylesheetRule("table { border-collapse: collapse;}");
926       cap.addStylesheetRule("table, td, th {border: 1px solid black;}");
927       cap.setText(sf.getDetailsReport(seqName, mf));
928       details = cap;
929     }
930     Desktop.addInternalFrame(details,
931             MessageManager.getString("label.feature_details"), 500, 500);
932   }
933
934   /**
935    * Adds a 'Link' menu item with a sub-menu item for each hyperlink provided.
936    * When seq is not null, these are links for the sequence id, which may be to
937    * external web sites for the sequence accession, and/or links embedded in
938    * non-positional features. When seq is null, only links embedded in the
939    * provided features are added. If no links are found, the menu is not added.
940    * 
941    * @param seq
942    * @param features
943    */
944   void addLinks(final SequenceI seq, List<SequenceFeature> features)
945   {
946     JMenu linkMenu = buildLinkMenu(forIdPanel ? seq : null, features);
947
948     // only add link menu if it has entries
949     if (linkMenu.getItemCount() > 0)
950     {
951       if (forIdPanel)
952       {
953         sequenceMenu.add(linkMenu);
954       }
955       else
956       {
957         add(linkMenu);
958       }
959     }
960   }
961
962   /**
963    * Add annotation types to 'Show annotations' and/or 'Hide annotations' menus.
964    * "All" is added first, followed by a separator. Then add any annotation
965    * types associated with the current selection. Separate menus are built for
966    * the selected sequence group (if any), and the selected sequence.
967    * <p>
968    * Some annotation rows are always rendered together - these can be identified
969    * by a common graphGroup property > -1. Only one of each group will be marked
970    * as visible (to avoid duplication of the display). For such groups we add a
971    * composite type name, e.g.
972    * <p>
973    * IUPredWS (Long), IUPredWS (Short)
974    * 
975    * @param seq
976    */
977   protected void buildAnnotationTypesMenus(JMenu showMenu, JMenu hideMenu,
978           List<SequenceI> forSequences)
979   {
980     showMenu.removeAll();
981     hideMenu.removeAll();
982
983     final List<String> all = Arrays
984             .asList(new String[]
985             { MessageManager.getString("label.all") });
986     addAnnotationTypeToShowHide(showMenu, forSequences, "", all, true,
987             true);
988     addAnnotationTypeToShowHide(hideMenu, forSequences, "", all, true,
989             false);
990     showMenu.addSeparator();
991     hideMenu.addSeparator();
992
993     final AlignmentAnnotation[] annotations = ap.getAlignment()
994             .getAlignmentAnnotation();
995
996     /*
997      * Find shown/hidden annotations types, distinguished by source (calcId),
998      * and grouped by graphGroup. Using LinkedHashMap means we will retrieve in
999      * the insertion order, which is the order of the annotations on the
1000      * alignment.
1001      */
1002     Map<String, List<List<String>>> shownTypes = new LinkedHashMap<>();
1003     Map<String, List<List<String>>> hiddenTypes = new LinkedHashMap<>();
1004     AlignmentAnnotationUtils.getShownHiddenTypes(shownTypes, hiddenTypes,
1005             AlignmentAnnotationUtils.asList(annotations), forSequences);
1006
1007     for (String calcId : hiddenTypes.keySet())
1008     {
1009       for (List<String> type : hiddenTypes.get(calcId))
1010       {
1011         addAnnotationTypeToShowHide(showMenu, forSequences, calcId, type,
1012                 false, true);
1013       }
1014     }
1015     // grey out 'show annotations' if none are hidden
1016     showMenu.setEnabled(!hiddenTypes.isEmpty());
1017
1018     for (String calcId : shownTypes.keySet())
1019     {
1020       for (List<String> type : shownTypes.get(calcId))
1021       {
1022         addAnnotationTypeToShowHide(hideMenu, forSequences, calcId, type,
1023                 false, false);
1024       }
1025     }
1026     // grey out 'hide annotations' if none are shown
1027     hideMenu.setEnabled(!shownTypes.isEmpty());
1028   }
1029
1030   /**
1031    * Returns a list of sequences - either the current selection group (if there
1032    * is one), else the specified single sequence.
1033    * 
1034    * @param seq
1035    * @return
1036    */
1037   protected List<SequenceI> getSequenceScope(SequenceI seq)
1038   {
1039     List<SequenceI> forSequences = null;
1040     final SequenceGroup selectionGroup = ap.av.getSelectionGroup();
1041     if (selectionGroup != null && selectionGroup.getSize() > 0)
1042     {
1043       forSequences = selectionGroup.getSequences();
1044     }
1045     else
1046     {
1047       forSequences = seq == null ? Collections.<SequenceI> emptyList()
1048               : Arrays.asList(seq);
1049     }
1050     return forSequences;
1051   }
1052
1053   /**
1054    * Add one annotation type to the 'Show Annotations' or 'Hide Annotations'
1055    * menus.
1056    * 
1057    * @param showOrHideMenu
1058    *          the menu to add to
1059    * @param forSequences
1060    *          the sequences whose annotations may be shown or hidden
1061    * @param calcId
1062    * @param types
1063    *          the label to add
1064    * @param allTypes
1065    *          if true this is a special label meaning 'All'
1066    * @param actionIsShow
1067    *          if true, the select menu item action is to show the annotation
1068    *          type, else hide
1069    */
1070   protected void addAnnotationTypeToShowHide(JMenu showOrHideMenu,
1071           final List<SequenceI> forSequences, String calcId,
1072           final List<String> types, final boolean allTypes,
1073           final boolean actionIsShow)
1074   {
1075     String label = types.toString(); // [a, b, c]
1076     label = label.substring(1, label.length() - 1); // a, b, c
1077     final JMenuItem item = new JMenuItem(label);
1078     item.setToolTipText(calcId);
1079     item.addActionListener(new ActionListener()
1080     {
1081       @Override
1082       public void actionPerformed(ActionEvent e)
1083       {
1084         AlignmentUtils.showOrHideSequenceAnnotations(ap.getAlignment(),
1085                 types, forSequences, allTypes, actionIsShow);
1086         refresh();
1087       }
1088     });
1089     showOrHideMenu.add(item);
1090   }
1091
1092   private void buildGroupURLMenu(SequenceGroup sg, List<String> groupLinks)
1093   {
1094
1095     // TODO: usability: thread off the generation of group url content so root
1096     // menu appears asap
1097     // sequence only URLs
1098     // ID/regex match URLs
1099     JMenu groupLinksMenu = new JMenu(
1100             MessageManager.getString("action.group_link"));
1101     // three types of url that might be created.
1102     JMenu[] linkMenus = new JMenu[] { null,
1103         new JMenu(MessageManager.getString("action.ids")),
1104         new JMenu(MessageManager.getString("action.sequences")),
1105         new JMenu(MessageManager.getString("action.ids_sequences")) };
1106
1107     SequenceI[] seqs = ap.av.getSelectionAsNewSequence();
1108     String[][] idandseqs = GroupUrlLink.formStrings(seqs);
1109     Hashtable<String, Object[]> commonDbrefs = new Hashtable<>();
1110     for (int sq = 0; sq < seqs.length; sq++)
1111     {
1112
1113       int start = seqs[sq].findPosition(sg.getStartRes()),
1114               end = seqs[sq].findPosition(sg.getEndRes());
1115       // just collect ids from dataset sequence
1116       // TODO: check if IDs collected from selecton group intersects with the
1117       // current selection, too
1118       SequenceI sqi = seqs[sq];
1119       while (sqi.getDatasetSequence() != null)
1120       {
1121         sqi = sqi.getDatasetSequence();
1122       }
1123       List<DBRefEntry> dbr = sqi.getDBRefs();
1124       int nd;
1125       if (dbr != null && (nd = dbr.size()) > 0)
1126       {
1127         for (int d = 0; d < nd; d++)
1128         {
1129           DBRefEntry e = dbr.get(d);
1130           String src = e.getSource(); // jalview.util.DBRefUtils.getCanonicalName(dbr[d].getSource()).toUpperCase(Locale.ROOT);
1131           Object[] sarray = commonDbrefs.get(src);
1132           if (sarray == null)
1133           {
1134             sarray = new Object[2];
1135             sarray[0] = new int[] { 0 };
1136             sarray[1] = new String[seqs.length];
1137
1138             commonDbrefs.put(src, sarray);
1139           }
1140
1141           if (((String[]) sarray[1])[sq] == null)
1142           {
1143             if (!e.hasMap() || (e.getMap()
1144                     .locateMappedRange(start, end) != null))
1145             {
1146               ((String[]) sarray[1])[sq] = e.getAccessionId();
1147               ((int[]) sarray[0])[0]++;
1148             }
1149           }
1150         }
1151       }
1152     }
1153     // now create group links for all distinct ID/sequence sets.
1154     boolean addMenu = false; // indicates if there are any group links to give
1155                              // to user
1156     for (String link : groupLinks)
1157     {
1158       GroupUrlLink urlLink = null;
1159       try
1160       {
1161         urlLink = new GroupUrlLink(link);
1162       } catch (Exception foo)
1163       {
1164         Cache.log.error("Exception for GroupURLLink '" + link + "'", foo);
1165         continue;
1166       }
1167       if (!urlLink.isValid())
1168       {
1169         Cache.log.error(urlLink.getInvalidMessage());
1170         continue;
1171       }
1172       final String label = urlLink.getLabel();
1173       boolean usingNames = false;
1174       // Now see which parts of the group apply for this URL
1175       String ltarget = urlLink.getTarget(); // jalview.util.DBRefUtils.getCanonicalName(urlLink.getTarget());
1176       Object[] idset = commonDbrefs.get(ltarget.toUpperCase(Locale.ROOT));
1177       String[] seqstr, ids; // input to makeUrl
1178       if (idset != null)
1179       {
1180         int numinput = ((int[]) idset[0])[0];
1181         String[] allids = ((String[]) idset[1]);
1182         seqstr = new String[numinput];
1183         ids = new String[numinput];
1184         for (int sq = 0, idcount = 0; sq < seqs.length; sq++)
1185         {
1186           if (allids[sq] != null)
1187           {
1188             ids[idcount] = allids[sq];
1189             seqstr[idcount++] = idandseqs[1][sq];
1190           }
1191         }
1192       }
1193       else
1194       {
1195         // just use the id/seq set
1196         seqstr = idandseqs[1];
1197         ids = idandseqs[0];
1198         usingNames = true;
1199       }
1200       // and try and make the groupURL!
1201
1202       Object[] urlset = null;
1203       try
1204       {
1205         urlset = urlLink.makeUrlStubs(ids, seqstr,
1206                 "FromJalview" + System.currentTimeMillis(), false);
1207       } catch (UrlStringTooLongException e)
1208       {
1209       }
1210       if (urlset != null)
1211       {
1212         int type = urlLink.getGroupURLType() & 3;
1213         // first two bits ofurlLink type bitfield are sequenceids and sequences
1214         // TODO: FUTURE: ensure the groupURL menu structure can be generalised
1215         addshowLink(linkMenus[type],
1216                 label + (((type & 1) == 1)
1217                         ? ("(" + (usingNames ? "Names" : ltarget) + ")")
1218                         : ""),
1219                 urlLink, urlset);
1220         addMenu = true;
1221       }
1222     }
1223     if (addMenu)
1224     {
1225       groupLinksMenu = new JMenu(
1226               MessageManager.getString("action.group_link"));
1227       for (int m = 0; m < linkMenus.length; m++)
1228       {
1229         if (linkMenus[m] != null
1230                 && linkMenus[m].getMenuComponentCount() > 0)
1231         {
1232           groupLinksMenu.add(linkMenus[m]);
1233         }
1234       }
1235
1236       groupMenu.add(groupLinksMenu);
1237     }
1238   }
1239
1240   /**
1241    * DOCUMENT ME!
1242    * 
1243    * @throws Exception
1244    *           DOCUMENT ME!
1245    */
1246   private void jbInit() throws Exception
1247   {
1248     groupMenu.setText(MessageManager.getString("label.selection"));
1249     groupName.setText(MessageManager.getString("label.name"));
1250     groupName.addActionListener(new ActionListener()
1251     {
1252       @Override
1253       public void actionPerformed(ActionEvent e)
1254       {
1255         groupName_actionPerformed();
1256       }
1257     });
1258     sequenceMenu.setText(MessageManager.getString("label.sequence"));
1259
1260     JMenuItem sequenceName = new JMenuItem(
1261             MessageManager.getString("label.edit_name_description"));
1262     sequenceName.addActionListener(new ActionListener()
1263     {
1264       @Override
1265       public void actionPerformed(ActionEvent e)
1266       {
1267         sequenceName_actionPerformed();
1268       }
1269     });
1270     JMenuItem chooseAnnotations = new JMenuItem(
1271             MessageManager.getString("action.choose_annotations"));
1272     chooseAnnotations.addActionListener(new ActionListener()
1273     {
1274       @Override
1275       public void actionPerformed(ActionEvent e)
1276       {
1277         chooseAnnotations_actionPerformed(e);
1278       }
1279     });
1280     JMenuItem sequenceDetails = new JMenuItem(
1281             MessageManager.getString("label.sequence_details"));
1282     sequenceDetails.addActionListener(new ActionListener()
1283     {
1284       @Override
1285       public void actionPerformed(ActionEvent e)
1286       {
1287         createSequenceDetailsReport(new SequenceI[] { sequence });
1288       }
1289     });
1290     JMenuItem sequenceSelDetails = new JMenuItem(
1291             MessageManager.getString("label.sequence_details"));
1292     sequenceSelDetails.addActionListener(new ActionListener()
1293     {
1294       @Override
1295       public void actionPerformed(ActionEvent e)
1296       {
1297         createSequenceDetailsReport(ap.av.getSequenceSelection());
1298       }
1299     });
1300
1301     unGroupMenuItem
1302             .setText(MessageManager.getString("action.remove_group"));
1303     unGroupMenuItem.addActionListener(new ActionListener()
1304     {
1305       @Override
1306       public void actionPerformed(ActionEvent e)
1307       {
1308         unGroupMenuItem_actionPerformed();
1309       }
1310     });
1311     createGroupMenuItem
1312             .setText(MessageManager.getString("action.create_group"));
1313     createGroupMenuItem.addActionListener(new ActionListener()
1314     {
1315       @Override
1316       public void actionPerformed(ActionEvent e)
1317       {
1318         createGroupMenuItem_actionPerformed();
1319       }
1320     });
1321
1322     JMenuItem outline = new JMenuItem(
1323             MessageManager.getString("action.border_colour"));
1324     outline.addActionListener(new ActionListener()
1325     {
1326       @Override
1327       public void actionPerformed(ActionEvent e)
1328       {
1329         outline_actionPerformed();
1330       }
1331     });
1332     showBoxes.setText(MessageManager.getString("action.boxes"));
1333     showBoxes.setState(true);
1334     showBoxes.addActionListener(new ActionListener()
1335     {
1336       @Override
1337       public void actionPerformed(ActionEvent e)
1338       {
1339         showBoxes_actionPerformed();
1340       }
1341     });
1342     showText.setText(MessageManager.getString("action.text"));
1343     showText.setState(true);
1344     showText.addActionListener(new ActionListener()
1345     {
1346       @Override
1347       public void actionPerformed(ActionEvent e)
1348       {
1349         showText_actionPerformed();
1350       }
1351     });
1352     showColourText.setText(MessageManager.getString("label.colour_text"));
1353     showColourText.addActionListener(new ActionListener()
1354     {
1355       @Override
1356       public void actionPerformed(ActionEvent e)
1357       {
1358         showColourText_actionPerformed();
1359       }
1360     });
1361     displayNonconserved
1362             .setText(MessageManager.getString("label.show_non_conserved"));
1363     displayNonconserved.setState(true);
1364     displayNonconserved.addActionListener(new ActionListener()
1365     {
1366       @Override
1367       public void actionPerformed(ActionEvent e)
1368       {
1369         showNonconserved_actionPerformed();
1370       }
1371     });
1372     editMenu.setText(MessageManager.getString("action.edit"));
1373     JMenuItem cut = new JMenuItem(MessageManager.getString("action.cut"));
1374     cut.addActionListener(new ActionListener()
1375     {
1376       @Override
1377       public void actionPerformed(ActionEvent e)
1378       {
1379         cut_actionPerformed();
1380       }
1381     });
1382     upperCase.setText(MessageManager.getString("label.to_upper_case"));
1383     upperCase.addActionListener(new ActionListener()
1384     {
1385       @Override
1386       public void actionPerformed(ActionEvent e)
1387       {
1388         changeCase(e);
1389       }
1390     });
1391     JMenuItem copy = new JMenuItem(MessageManager.getString("action.copy"));
1392     copy.addActionListener(new ActionListener()
1393     {
1394       @Override
1395       public void actionPerformed(ActionEvent e)
1396       {
1397         copy_actionPerformed();
1398       }
1399     });
1400     lowerCase.setText(MessageManager.getString("label.to_lower_case"));
1401     lowerCase.addActionListener(new ActionListener()
1402     {
1403       @Override
1404       public void actionPerformed(ActionEvent e)
1405       {
1406         changeCase(e);
1407       }
1408     });
1409     toggle.setText(MessageManager.getString("label.toggle_case"));
1410     toggle.addActionListener(new ActionListener()
1411     {
1412       @Override
1413       public void actionPerformed(ActionEvent e)
1414       {
1415         changeCase(e);
1416       }
1417     });
1418     outputMenu.setText(
1419             MessageManager.getString("label.out_to_textbox") + "...");
1420     seqShowAnnotationsMenu
1421             .setText(MessageManager.getString("label.show_annotations"));
1422     seqHideAnnotationsMenu
1423             .setText(MessageManager.getString("label.hide_annotations"));
1424     groupShowAnnotationsMenu
1425             .setText(MessageManager.getString("label.show_annotations"));
1426     groupHideAnnotationsMenu
1427             .setText(MessageManager.getString("label.hide_annotations"));
1428     JMenuItem sequenceFeature = new JMenuItem(
1429             MessageManager.getString("label.create_sequence_feature"));
1430     sequenceFeature.addActionListener(new ActionListener()
1431     {
1432       @Override
1433       public void actionPerformed(ActionEvent e)
1434       {
1435         sequenceFeature_actionPerformed();
1436       }
1437     });
1438     editGroupMenu.setText(MessageManager.getString("label.group"));
1439     chooseStructure.setText(
1440             MessageManager.getString("label.show_pdbstruct_dialog"));
1441     chooseStructure.addActionListener(new ActionListener()
1442     {
1443       @Override
1444       public void actionPerformed(ActionEvent actionEvent)
1445       {
1446         SequenceI[] selectedSeqs = new SequenceI[] { sequence };
1447         if (ap.av.getSelectionGroup() != null)
1448         {
1449           selectedSeqs = ap.av.getSequenceSelection();
1450         }
1451         new StructureChooser(selectedSeqs, sequence, ap);
1452       }
1453     });
1454
1455     rnaStructureMenu
1456             .setText(MessageManager.getString("label.view_rna_structure"));
1457
1458     // colStructureMenu.setText("Colour By Structure");
1459     JMenuItem editSequence = new JMenuItem(
1460             MessageManager.getString("label.edit_sequence") + "...");
1461     editSequence.addActionListener(new ActionListener()
1462     {
1463       @Override
1464       public void actionPerformed(ActionEvent actionEvent)
1465       {
1466         editSequence_actionPerformed();
1467       }
1468     });
1469     makeReferenceSeq.setText(
1470             MessageManager.getString("label.mark_as_representative"));
1471     makeReferenceSeq.addActionListener(new ActionListener()
1472     {
1473
1474       @Override
1475       public void actionPerformed(ActionEvent actionEvent)
1476       {
1477         makeReferenceSeq_actionPerformed(actionEvent);
1478
1479       }
1480     });
1481
1482     groupMenu.add(sequenceSelDetails);
1483     add(groupMenu);
1484     add(sequenceMenu);
1485     add(rnaStructureMenu);
1486     add(chooseStructure);
1487     if (forIdPanel)
1488     {
1489       JMenuItem hideInsertions = new JMenuItem(
1490               MessageManager.getString("label.hide_insertions"));
1491       hideInsertions.addActionListener(new ActionListener()
1492       {
1493
1494         @Override
1495         public void actionPerformed(ActionEvent e)
1496         {
1497           hideInsertions_actionPerformed(e);
1498         }
1499       });
1500       add(hideInsertions);
1501     }
1502     // annotations configuration panel suppressed for now
1503     // groupMenu.add(chooseAnnotations);
1504
1505     /*
1506      * Add show/hide annotations to the Sequence menu, and to the Selection menu
1507      * (if a selection group is in force).
1508      */
1509     sequenceMenu.add(seqShowAnnotationsMenu);
1510     sequenceMenu.add(seqHideAnnotationsMenu);
1511     sequenceMenu.add(seqAddReferenceAnnotations);
1512     groupMenu.add(groupShowAnnotationsMenu);
1513     groupMenu.add(groupHideAnnotationsMenu);
1514     groupMenu.add(groupAddReferenceAnnotations);
1515     groupMenu.add(editMenu);
1516     groupMenu.add(outputMenu);
1517     groupMenu.add(sequenceFeature);
1518     groupMenu.add(createGroupMenuItem);
1519     groupMenu.add(unGroupMenuItem);
1520     groupMenu.add(editGroupMenu);
1521     sequenceMenu.add(sequenceName);
1522     sequenceMenu.add(sequenceDetails);
1523     sequenceMenu.add(makeReferenceSeq);
1524
1525     initColourMenu();
1526     buildColourMenu();
1527
1528     editMenu.add(copy);
1529     editMenu.add(cut);
1530     editMenu.add(editSequence);
1531     editMenu.add(upperCase);
1532     editMenu.add(lowerCase);
1533     editMenu.add(toggle);
1534     editGroupMenu.add(groupName);
1535     editGroupMenu.add(colourMenu);
1536     editGroupMenu.add(showBoxes);
1537     editGroupMenu.add(showText);
1538     editGroupMenu.add(showColourText);
1539     editGroupMenu.add(outline);
1540     editGroupMenu.add(displayNonconserved);
1541   }
1542
1543   /**
1544    * Constructs the entries for the colour menu
1545    */
1546   protected void initColourMenu()
1547   {
1548     colourMenu.setText(MessageManager.getString("label.group_colour"));
1549     textColour.setText(MessageManager.getString("label.text_colour"));
1550     textColour.addActionListener(new ActionListener()
1551     {
1552       @Override
1553       public void actionPerformed(ActionEvent e)
1554       {
1555         textColour_actionPerformed();
1556       }
1557     });
1558
1559     abovePIDColour.setText(
1560             MessageManager.getString("label.above_identity_threshold"));
1561     abovePIDColour.addActionListener(new ActionListener()
1562     {
1563       @Override
1564       public void actionPerformed(ActionEvent e)
1565       {
1566         abovePIDColour_actionPerformed(abovePIDColour.isSelected());
1567       }
1568     });
1569
1570     modifyPID.setText(
1571             MessageManager.getString("label.modify_identity_threshold"));
1572     modifyPID.addActionListener(new ActionListener()
1573     {
1574       @Override
1575       public void actionPerformed(ActionEvent e)
1576       {
1577         modifyPID_actionPerformed();
1578       }
1579     });
1580
1581     conservationMenuItem
1582             .setText(MessageManager.getString("action.by_conservation"));
1583     conservationMenuItem.addActionListener(new ActionListener()
1584     {
1585       @Override
1586       public void actionPerformed(ActionEvent e)
1587       {
1588         conservationMenuItem_actionPerformed(
1589                 conservationMenuItem.isSelected());
1590       }
1591     });
1592
1593     annotationColour = new JRadioButtonMenuItem(
1594             MessageManager.getString("action.by_annotation"));
1595     annotationColour.setName(ResidueColourScheme.ANNOTATION_COLOUR);
1596     annotationColour.setEnabled(false);
1597     annotationColour.setToolTipText(
1598             MessageManager.getString("label.by_annotation_tooltip"));
1599
1600     modifyConservation.setText(MessageManager
1601             .getString("label.modify_conservation_threshold"));
1602     modifyConservation.addActionListener(new ActionListener()
1603     {
1604       @Override
1605       public void actionPerformed(ActionEvent e)
1606       {
1607         modifyConservation_actionPerformed();
1608       }
1609     });
1610   }
1611
1612   /**
1613    * Builds the group colour sub-menu, including any user-defined colours which
1614    * were loaded at startup or during the Jalview session
1615    */
1616   protected void buildColourMenu()
1617   {
1618     SequenceGroup sg = ap.av.getSelectionGroup();
1619     if (sg == null)
1620     {
1621       /*
1622        * popup menu with no sequence group scope
1623        */
1624       return;
1625     }
1626     colourMenu.removeAll();
1627     colourMenu.add(textColour);
1628     colourMenu.addSeparator();
1629
1630     ButtonGroup bg = ColourMenuHelper.addMenuItems(colourMenu, this, sg,
1631             false);
1632     bg.add(annotationColour);
1633     colourMenu.add(annotationColour);
1634
1635     colourMenu.addSeparator();
1636     colourMenu.add(conservationMenuItem);
1637     colourMenu.add(modifyConservation);
1638     colourMenu.add(abovePIDColour);
1639     colourMenu.add(modifyPID);
1640   }
1641
1642   protected void modifyConservation_actionPerformed()
1643   {
1644     SequenceGroup sg = getGroup();
1645     if (sg.cs != null)
1646     {
1647       SliderPanel.setConservationSlider(ap, sg.cs, sg.getName());
1648       SliderPanel.showConservationSlider();
1649     }
1650   }
1651
1652   protected void modifyPID_actionPerformed()
1653   {
1654     SequenceGroup sg = getGroup();
1655     if (sg.cs != null)
1656     {
1657       // int threshold = SliderPanel.setPIDSliderSource(ap, sg.cs, getGroup()
1658       // .getName());
1659       // sg.cs.setThreshold(threshold, ap.av.isIgnoreGapsConsensus());
1660       SliderPanel.setPIDSliderSource(ap, sg.cs, getGroup().getName());
1661       SliderPanel.showPIDSlider();
1662     }
1663   }
1664
1665   /**
1666    * Check for any annotations on the underlying dataset sequences (for the
1667    * current selection group) which are not 'on the alignment'.If any are found,
1668    * enable the option to add them to the alignment. The criteria for 'on the
1669    * alignment' is finding an alignment annotation on the alignment, matched on
1670    * calcId, label and sequenceRef.
1671    * 
1672    * A tooltip is also constructed that displays the source (calcId) and type
1673    * (label) of the annotations that can be added.
1674    * 
1675    * @param menuItem
1676    * @param forSequences
1677    */
1678   protected void configureReferenceAnnotationsMenu(JMenuItem menuItem,
1679           List<SequenceI> forSequences)
1680   {
1681     menuItem.setEnabled(false);
1682
1683     /*
1684      * Temporary store to hold distinct calcId / type pairs for the tooltip.
1685      * Using TreeMap means calcIds are shown in alphabetical order.
1686      */
1687     SortedMap<String, String> tipEntries = new TreeMap<>();
1688     final Map<SequenceI, List<AlignmentAnnotation>> candidates = new LinkedHashMap<>();
1689     AlignmentI al = this.ap.av.getAlignment();
1690     AlignmentUtils.findAddableReferenceAnnotations(forSequences, tipEntries,
1691             candidates, al);
1692     if (!candidates.isEmpty())
1693     {
1694       StringBuilder tooltip = new StringBuilder(64);
1695       tooltip.append(MessageManager.getString("label.add_annotations_for"));
1696
1697       /*
1698        * Found annotations that could be added. Enable the menu item, and
1699        * configure its tooltip and action.
1700        */
1701       menuItem.setEnabled(true);
1702       for (String calcId : tipEntries.keySet())
1703       {
1704         tooltip.append("<br/>" + calcId + "/" + tipEntries.get(calcId));
1705       }
1706       String tooltipText = JvSwingUtils.wrapTooltip(true,
1707               tooltip.toString());
1708       menuItem.setToolTipText(tooltipText);
1709
1710       menuItem.addActionListener(new ActionListener()
1711       {
1712         @Override
1713         public void actionPerformed(ActionEvent e)
1714         {
1715           addReferenceAnnotations_actionPerformed(candidates);
1716         }
1717       });
1718     }
1719   }
1720
1721   /**
1722    * Add annotations to the sequences and to the alignment.
1723    * 
1724    * @param candidates
1725    *          a map whose keys are sequences on the alignment, and values a list
1726    *          of annotations to add to each sequence
1727    */
1728   protected void addReferenceAnnotations_actionPerformed(
1729           Map<SequenceI, List<AlignmentAnnotation>> candidates)
1730   {
1731     final SequenceGroup selectionGroup = this.ap.av.getSelectionGroup();
1732     final AlignmentI alignment = this.ap.getAlignment();
1733     AlignmentUtils.addReferenceAnnotations(candidates, alignment,
1734             selectionGroup);
1735     refresh();
1736   }
1737
1738   protected void makeReferenceSeq_actionPerformed(ActionEvent actionEvent)
1739   {
1740     if (!ap.av.getAlignment().hasSeqrep())
1741     {
1742       // initialise the display flags so the user sees something happen
1743       ap.av.setDisplayReferenceSeq(true);
1744       ap.av.setColourByReferenceSeq(true);
1745       ap.av.getAlignment().setSeqrep(sequence);
1746     }
1747     else
1748     {
1749       if (ap.av.getAlignment().getSeqrep() == sequence)
1750       {
1751         ap.av.getAlignment().setSeqrep(null);
1752       }
1753       else
1754       {
1755         ap.av.getAlignment().setSeqrep(sequence);
1756       }
1757     }
1758     refresh();
1759   }
1760
1761   protected void hideInsertions_actionPerformed(ActionEvent actionEvent)
1762   {
1763     HiddenColumns hidden = ap.av.getAlignment().getHiddenColumns();
1764     BitSet inserts = new BitSet();
1765
1766     boolean markedPopup = false;
1767     // mark inserts in current selection
1768     if (ap.av.getSelectionGroup() != null)
1769     {
1770       // mark just the columns in the selection group to be hidden
1771       inserts.set(ap.av.getSelectionGroup().getStartRes(),
1772               ap.av.getSelectionGroup().getEndRes() + 1); // TODO why +1?
1773
1774       // now clear columns without gaps
1775       for (SequenceI sq : ap.av.getSelectionGroup().getSequences())
1776       {
1777         if (sq == sequence)
1778         {
1779           markedPopup = true;
1780         }
1781         inserts.and(sq.getInsertionsAsBits());
1782       }
1783       hidden.clearAndHideColumns(inserts, ap.av.getSelectionGroup().getStartRes(),
1784               ap.av.getSelectionGroup().getEndRes());
1785     }
1786
1787     // now mark for sequence under popup if we haven't already done it
1788     else if (!markedPopup && sequence != null)
1789     {
1790       inserts.or(sequence.getInsertionsAsBits());
1791
1792       // and set hidden columns accordingly
1793       hidden.hideColumns(inserts);
1794     }
1795     refresh();
1796   }
1797
1798   protected void sequenceSelectionDetails_actionPerformed()
1799   {
1800     createSequenceDetailsReport(ap.av.getSequenceSelection());
1801   }
1802
1803   public void createSequenceDetailsReport(SequenceI[] sequences)
1804   {
1805     StringBuilder contents = new StringBuilder(128);
1806     contents.append("<html><body>");
1807     for (SequenceI seq : sequences)
1808     {
1809       contents.append("<p><h2>" + MessageManager.formatMessage(
1810               "label.create_sequence_details_report_annotation_for",
1811               new Object[]
1812               { seq.getDisplayId(true) }) + "</h2></p><p>");
1813       new SequenceAnnotationReport(false).createSequenceAnnotationReport(
1814               contents, seq, true, true, ap.getSeqPanel().seqCanvas.fr);
1815       contents.append("</p>");
1816     }
1817     contents.append("</body></html>");
1818     String report = contents.toString();
1819
1820     JInternalFrame frame;
1821     if (Platform.isJS())
1822     {
1823       JLabel textLabel = new JLabel();
1824       textLabel.setText(report);
1825       textLabel.setBackground(Color.WHITE);
1826       JPanel pane = new JPanel(new BorderLayout());
1827       pane.setOpaque(true);
1828       pane.setBackground(Color.WHITE);
1829       pane.add(textLabel, BorderLayout.NORTH);
1830       frame = new JInternalFrame();
1831       frame.getContentPane().add(new JScrollPane(pane));
1832     }
1833     else
1834     /**
1835      * Java only
1836      * 
1837      * @j2sIgnore
1838      */
1839     {
1840       CutAndPasteHtmlTransfer cap = new CutAndPasteHtmlTransfer();
1841       cap.setText(report);
1842       frame = cap;
1843     }
1844
1845     Desktop.addInternalFrame(frame,
1846             MessageManager.formatMessage("label.sequence_details_for",
1847                     (sequences.length == 1 ? new Object[]
1848                     { sequences[0].getDisplayId(true) }
1849                             : new Object[]
1850                             { MessageManager
1851                                     .getString("label.selection") })),
1852             500, 400);
1853   }
1854
1855   protected void showNonconserved_actionPerformed()
1856   {
1857     getGroup().setShowNonconserved(displayNonconserved.isSelected());
1858     refresh();
1859   }
1860
1861   /**
1862    * call to refresh view after settings change
1863    */
1864   void refresh()
1865   {
1866     ap.updateAnnotation();
1867     // removed paintAlignment(true) here:
1868     // updateAnnotation calls paintAlignment already, so don't need to call
1869     // again
1870
1871     PaintRefresher.Refresh(this, ap.av.getSequenceSetId());
1872   }
1873
1874   /*
1875    * protected void covariationColour_actionPerformed() { getGroup().cs = new
1876    * CovariationColourScheme(sequence.getAnnotation()[0]); refresh(); }
1877    */
1878   /**
1879    * DOCUMENT ME!
1880    * 
1881    * @param selected
1882    * 
1883    * @param e
1884    *          DOCUMENT ME!
1885    */
1886   public void abovePIDColour_actionPerformed(boolean selected)
1887   {
1888     SequenceGroup sg = getGroup();
1889     if (sg.cs == null)
1890     {
1891       return;
1892     }
1893
1894     if (selected)
1895     {
1896       sg.cs.setConsensus(AAFrequency.calculate(
1897               sg.getSequences(ap.av.getHiddenRepSequences()),
1898               sg.getStartRes(), sg.getEndRes() + 1));
1899
1900       int threshold = SliderPanel.setPIDSliderSource(ap,
1901               sg.getGroupColourScheme(), getGroup().getName());
1902
1903       sg.cs.setThreshold(threshold, ap.av.isIgnoreGapsConsensus());
1904
1905       SliderPanel.showPIDSlider();
1906     }
1907     else
1908     // remove PIDColouring
1909     {
1910       sg.cs.setThreshold(0, ap.av.isIgnoreGapsConsensus());
1911       SliderPanel.hidePIDSlider();
1912     }
1913     modifyPID.setEnabled(selected);
1914
1915     refresh();
1916   }
1917
1918   /**
1919    * Open a panel where the user can choose which types of sequence annotation
1920    * to show or hide.
1921    * 
1922    * @param e
1923    */
1924   protected void chooseAnnotations_actionPerformed(ActionEvent e)
1925   {
1926     // todo correct way to guard against opening a duplicate panel?
1927     new AnnotationChooser(ap);
1928   }
1929
1930   /**
1931    * DOCUMENT ME!
1932    * 
1933    * @param e
1934    *          DOCUMENT ME!
1935    */
1936   public void conservationMenuItem_actionPerformed(boolean selected)
1937   {
1938     SequenceGroup sg = getGroup();
1939     if (sg.cs == null)
1940     {
1941       return;
1942     }
1943
1944     if (selected)
1945     {
1946       // JBPNote: Conservation name shouldn't be i18n translated
1947       Conservation c = new Conservation("Group",
1948               sg.getSequences(ap.av.getHiddenRepSequences()),
1949               sg.getStartRes(), sg.getEndRes() + 1);
1950
1951       c.calculate();
1952       c.verdict(false, ap.av.getConsPercGaps());
1953       sg.cs.setConservation(c);
1954
1955       SliderPanel.setConservationSlider(ap, sg.getGroupColourScheme(),
1956               sg.getName());
1957       SliderPanel.showConservationSlider();
1958     }
1959     else
1960     // remove ConservationColouring
1961     {
1962       sg.cs.setConservation(null);
1963       SliderPanel.hideConservationSlider();
1964     }
1965     modifyConservation.setEnabled(selected);
1966
1967     refresh();
1968   }
1969
1970   /**
1971    * Shows a dialog where group name and description may be edited
1972    */
1973   protected void groupName_actionPerformed()
1974   {
1975     SequenceGroup sg = getGroup();
1976     EditNameDialog dialog = new EditNameDialog(sg.getName(),
1977             sg.getDescription(),
1978             MessageManager.getString("label.group_name"),
1979             MessageManager.getString("label.group_description"));
1980     dialog.showDialog(ap.alignFrame,
1981             MessageManager.getString("label.edit_group_name_description"),
1982             new Runnable()
1983             {
1984               @Override
1985               public void run()
1986               {
1987                 sg.setName(dialog.getName());
1988                 sg.setDescription(dialog.getDescription());
1989                 refresh();
1990               }
1991             });
1992   }
1993
1994   /**
1995    * Get selection group - adding it to the alignment if necessary.
1996    * 
1997    * @return sequence group to operate on
1998    */
1999   SequenceGroup getGroup()
2000   {
2001     SequenceGroup sg = ap.av.getSelectionGroup();
2002     // this method won't add a new group if it already exists
2003     if (sg != null)
2004     {
2005       ap.av.getAlignment().addGroup(sg);
2006     }
2007
2008     return sg;
2009   }
2010
2011   /**
2012    * Shows a dialog where the sequence name and description may be edited. If a
2013    * name containing spaces is entered, these are converted to underscores, with a
2014    * warning message.
2015    */
2016   void sequenceName_actionPerformed()
2017   {
2018     EditNameDialog dialog = new EditNameDialog(sequence.getName(),
2019             sequence.getDescription(),
2020             MessageManager.getString("label.sequence_name"),
2021             MessageManager.getString("label.sequence_description"));
2022     dialog.showDialog(ap.alignFrame,
2023             MessageManager.getString(
2024                     "label.edit_sequence_name_description"),
2025             new Runnable()
2026             {
2027               @Override
2028               public void run()
2029               {
2030                 if (dialog.getName() != null)
2031                 {
2032                   if (dialog.getName().indexOf(" ") > -1)
2033                   {
2034                     JvOptionPane.showMessageDialog(ap,
2035                             MessageManager.getString(
2036                                     "label.spaces_converted_to_underscores"),
2037                             MessageManager.getString(
2038                                     "label.no_spaces_allowed_sequence_name"),
2039                             JvOptionPane.WARNING_MESSAGE);
2040                   }
2041                   sequence.setName(dialog.getName().replace(' ', '_'));
2042                   ap.paintAlignment(false, false);
2043                 }
2044                 sequence.setDescription(dialog.getDescription());
2045                 ap.av.firePropertyChange("alignment", null,
2046                         ap.av.getAlignment().getSequences());
2047               }
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
2078             .getString("label.select_outline_colour");
2079     ColourChooserListener listener = new ColourChooserListener()
2080     {
2081       @Override
2082       public void colourSelected(Color c)
2083       {
2084         getGroup().setOutlineColour(c);
2085         refresh();
2086       }
2087     };
2088     JalviewColourChooser.showColourChooser(Desktop.getDesktop(),
2089             title, Color.BLUE, listener);
2090   }
2091
2092   /**
2093    * DOCUMENT ME!
2094    * 
2095    * @param e
2096    *          DOCUMENT ME!
2097    */
2098   public void showBoxes_actionPerformed()
2099   {
2100     getGroup().setDisplayBoxes(showBoxes.isSelected());
2101     refresh();
2102   }
2103
2104   /**
2105    * DOCUMENT ME!
2106    * 
2107    * @param e
2108    *          DOCUMENT ME!
2109    */
2110   public void showText_actionPerformed()
2111   {
2112     getGroup().setDisplayText(showText.isSelected());
2113     refresh();
2114   }
2115
2116   /**
2117    * DOCUMENT ME!
2118    * 
2119    * @param e
2120    *          DOCUMENT ME!
2121    */
2122   public void showColourText_actionPerformed()
2123   {
2124     getGroup().setColourText(showColourText.isSelected());
2125     refresh();
2126   }
2127
2128   void hideSequences(boolean representGroup)
2129   {
2130     ap.av.hideSequences(sequence, representGroup);
2131   }
2132
2133   public void copy_actionPerformed()
2134   {
2135     ap.alignFrame.copy_actionPerformed();
2136   }
2137
2138   public void cut_actionPerformed()
2139   {
2140     ap.alignFrame.cut_actionPerformed();
2141   }
2142
2143   void changeCase(ActionEvent e)
2144   {
2145     Object source = e.getSource();
2146     SequenceGroup sg = ap.av.getSelectionGroup();
2147
2148     if (sg != null)
2149     {
2150       List<int[]> startEnd = ap.av.getVisibleRegionBoundaries(
2151               sg.getStartRes(), sg.getEndRes() + 1);
2152
2153       String description;
2154       int caseChange;
2155
2156       if (source == toggle)
2157       {
2158         description = MessageManager.getString("label.toggle_case");
2159         caseChange = ChangeCaseCommand.TOGGLE_CASE;
2160       }
2161       else if (source == upperCase)
2162       {
2163         description = MessageManager.getString("label.to_upper_case");
2164         caseChange = ChangeCaseCommand.TO_UPPER;
2165       }
2166       else
2167       {
2168         description = MessageManager.getString("label.to_lower_case");
2169         caseChange = ChangeCaseCommand.TO_LOWER;
2170       }
2171
2172       ChangeCaseCommand caseCommand = new ChangeCaseCommand(description,
2173               sg.getSequencesAsArray(ap.av.getHiddenRepSequences()),
2174               startEnd, caseChange);
2175
2176       ap.alignFrame.addHistoryItem(caseCommand);
2177
2178       ap.av.firePropertyChange("alignment", null,
2179               ap.av.getAlignment().getSequences());
2180
2181     }
2182   }
2183
2184   public void outputText_actionPerformed(ActionEvent e)
2185   {
2186     CutAndPasteTransfer cap = new CutAndPasteTransfer();
2187     cap.setForInput(null);
2188     Desktop.addInternalFrame(cap, MessageManager
2189             .formatMessage("label.alignment_output_command", new Object[]
2190             { e.getActionCommand() }), 600, 500);
2191
2192     String[] omitHidden = null;
2193
2194     System.out.println("PROMPT USER HERE"); // TODO: decide if a 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               new Runnable()
2272               {
2273                 @Override
2274                 public void run()
2275                 {
2276                   EditCommand editCommand = new EditCommand(
2277                           MessageManager.getString("label.edit_sequences"),
2278                           Action.REPLACE,
2279                           dialog.getName().replace(' ',
2280                                   ap.av.getGapCharacter()),
2281                           sg.getSequencesAsArray(
2282                                   ap.av.getHiddenRepSequences()),
2283                           sg.getStartRes(), sg.getEndRes() + 1,
2284                           ap.av.getAlignment());
2285                   ap.alignFrame.addHistoryItem(editCommand);
2286                   ap.av.firePropertyChange("alignment", null,
2287                           ap.av.getAlignment().getSequences());
2288                 }
2289               });
2290     }
2291   }
2292
2293   /**
2294    * Action on user selecting an item from the colour menu (that does not have
2295    * its bespoke action handler)
2296    * 
2297    * @return
2298    */
2299   @Override
2300   public void changeColour_actionPerformed(String colourSchemeName)
2301   {
2302     SequenceGroup sg = getGroup();
2303     /*
2304      * switch to the chosen colour scheme (or null for None)
2305      */
2306     ColourSchemeI colourScheme = ColourSchemes.getInstance()
2307             .getColourScheme(colourSchemeName, ap.av, sg,
2308                     ap.av.getHiddenRepSequences());
2309     sg.setColourScheme(colourScheme);
2310     if (colourScheme instanceof Blosum62ColourScheme
2311             || colourScheme instanceof PIDColourScheme)
2312     {
2313       sg.cs.setConsensus(AAFrequency.calculate(
2314               sg.getSequences(ap.av.getHiddenRepSequences()),
2315               sg.getStartRes(), sg.getEndRes() + 1));
2316     }
2317
2318     refresh();
2319   }
2320
2321 }