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