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