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