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