src/jalview/appletgui/APopupMenu.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.appletgui;
  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.JalviewLite;
  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.PDBEntry;
  34 import jalview.datamodel.SequenceFeature;
  35 import jalview.datamodel.SequenceGroup;
  36 import jalview.datamodel.SequenceI;
  37 import jalview.io.AppletFormatAdapter;
  38 import jalview.io.DataSourceType;
  39 import jalview.io.FileFormat;
  40 import jalview.io.SequenceAnnotationReport;
  41 import jalview.schemes.Blosum62ColourScheme;
  42 import jalview.schemes.BuriedColourScheme;
  43 import jalview.schemes.ClustalxColourScheme;
  44 import jalview.schemes.HelixColourScheme;
  45 import jalview.schemes.HydrophobicColourScheme;
  46 import jalview.schemes.NucleotideColourScheme;
  47 import jalview.schemes.PIDColourScheme;
  48 import jalview.schemes.PurinePyrimidineColourScheme;
  49 import jalview.schemes.StrandColourScheme;
  50 import jalview.schemes.TaylorColourScheme;
  51 import jalview.schemes.TurnColourScheme;
  52 import jalview.schemes.ZappoColourScheme;
  53 import jalview.util.MessageManager;
  54 import jalview.util.UrlLink;
  55
  56 import java.awt.CheckboxMenuItem;
  57 import java.awt.Frame;
  58 import java.awt.Menu;
  59 import java.awt.MenuItem;
  60 import java.awt.event.ActionEvent;
  61 import java.awt.event.ActionListener;
  62 import java.awt.event.ItemEvent;
  63 import java.awt.event.ItemListener;
  64 import java.util.Arrays;
  65 import java.util.Collection;
  66 import java.util.Collections;
  67 import java.util.LinkedHashMap;
  68 import java.util.List;
  69 import java.util.Map;
  70 import java.util.SortedMap;
  71 import java.util.TreeMap;
  72 import java.util.Vector;
  73
  74 public class APopupMenu extends java.awt.PopupMenu implements
  75         ActionListener, ItemListener
  76 {
  77   Menu groupMenu = new Menu();
  78
  79   MenuItem editGroupName = new MenuItem();
  80
  81   protected MenuItem clustalColour = new MenuItem();
  82
  83   protected MenuItem zappoColour = new MenuItem();
  84
  85   protected MenuItem taylorColour = new MenuItem();
  86
  87   protected MenuItem hydrophobicityColour = new MenuItem();
  88
  89   protected MenuItem helixColour = new MenuItem();
  90
  91   protected MenuItem strandColour = new MenuItem();
  92
  93   protected MenuItem turnColour = new MenuItem();
  94
  95   protected MenuItem buriedColour = new MenuItem();
  96
  97   protected CheckboxMenuItem abovePIDColour = new CheckboxMenuItem();
  98
  99   protected MenuItem userDefinedColour = new MenuItem();
 100
 101   protected MenuItem PIDColour = new MenuItem();
 102
 103   protected MenuItem BLOSUM62Colour = new MenuItem();
 104
 105   MenuItem noColourmenuItem = new MenuItem();
 106
 107   protected CheckboxMenuItem conservationMenuItem = new CheckboxMenuItem();
 108
 109   final AlignmentPanel ap;
 110
 111   MenuItem unGroupMenuItem = new MenuItem();
 112
 113   MenuItem createGroupMenuItem = new MenuItem();
 114
 115   MenuItem nucleotideMenuItem = new MenuItem();
 116
 117   MenuItem purinePyrimidineMenuItem = new MenuItem();
 118
 119   Menu colourMenu = new Menu();
 120
 121   CheckboxMenuItem showBoxes = new CheckboxMenuItem();
 122
 123   CheckboxMenuItem showText = new CheckboxMenuItem();
 124
 125   CheckboxMenuItem showColourText = new CheckboxMenuItem();
 126
 127   CheckboxMenuItem displayNonconserved = new CheckboxMenuItem();
 128
 129   Menu seqShowAnnotationsMenu = new Menu(
 130           MessageManager.getString("label.show_annotations"));
 131
 132   Menu seqHideAnnotationsMenu = new Menu(
 133           MessageManager.getString("label.hide_annotations"));
 134
 135   MenuItem seqAddReferenceAnnotations = new MenuItem(
 136           MessageManager.getString("label.add_reference_annotations"));
 137
 138   Menu groupShowAnnotationsMenu = new Menu(
 139           MessageManager.getString("label.show_annotations"));
 140
 141   Menu groupHideAnnotationsMenu = new Menu(
 142           MessageManager.getString("label.hide_annotations"));
 143
 144   MenuItem groupAddReferenceAnnotations = new MenuItem(
 145           MessageManager.getString("label.add_reference_annotations"));
 146
 147   Menu editMenu = new Menu(MessageManager.getString("action.edit"));
 148
 149   MenuItem copy = new MenuItem(MessageManager.getString("action.copy"));
 150
 151   MenuItem cut = new MenuItem(MessageManager.getString("action.cut"));
 152
 153   MenuItem toUpper = new MenuItem(
 154           MessageManager.getString("label.to_upper_case"));
 155
 156   MenuItem toLower = new MenuItem(
 157           MessageManager.getString("label.to_lower_case"));
 158
 159   MenuItem toggleCase = new MenuItem(
 160           MessageManager.getString("label.toggle_case"));
 161
 162   Menu outputmenu = new Menu();
 163
 164   Menu seqMenu = new Menu();
 165
 166   MenuItem pdb = new MenuItem();
 167
 168   MenuItem hideSeqs = new MenuItem();
 169
 170   MenuItem repGroup = new MenuItem();
 171
 172   MenuItem sequenceName = new MenuItem(
 173           MessageManager.getString("label.edit_name_description"));
 174
 175   MenuItem sequenceFeature = new MenuItem(
 176           MessageManager.getString("label.create_sequence_feature"));
 177
 178   MenuItem editSequence = new MenuItem(
 179           MessageManager.getString("label.edit_sequence"));
 180
 181   MenuItem sequenceDetails = new MenuItem(
 182           MessageManager.getString("label.sequence_details"));
 183
 184   MenuItem selSeqDetails = new MenuItem(
 185           MessageManager.getString("label.sequence_details"));
 186
 187   MenuItem makeReferenceSeq = new MenuItem();
 188
 189   SequenceI seq;
 190
 191   MenuItem revealAll = new MenuItem();
 192
 193   MenuItem revealSeq = new MenuItem();
 194
 195   /**
 196    * index of sequence to be revealed
 197    */
 198   int revealSeq_index = -1;
 199
 200   Menu menu1 = new Menu();
 201
 202   public APopupMenu(AlignmentPanel apanel, final SequenceI seq,
 203           Vector<String> links)
 204   {
 205     // /////////////////////////////////////////////////////////
 206     // If this is activated from the sequence panel, the user may want to
 207     // edit or annotate a particular residue. Therefore display the residue menu
 208     //
 209     // If from the IDPanel, we must display the sequence menu
 210     // ////////////////////////////////////////////////////////
 211
 212     this.ap = apanel;
 213     this.seq = seq;
 214
 215     try
 216     {
 217       jbInit();
 218     } catch (Exception e)
 219     {
 220       e.printStackTrace();
 221     }
 222
 223     for (String ff : FileFormat.getWritableFormats(true))
 224     {
 225       MenuItem item = new MenuItem(ff);
 226
 227       item.addActionListener(this);
 228       outputmenu.add(item);
 229     }
 230
 231     buildAnnotationSubmenus();
 232
 233     SequenceGroup sg = ap.av.getSelectionGroup();
 234     if (sg != null && sg.getSize() > 0)
 235     {
 236       editGroupName.setLabel(MessageManager.formatMessage(
 237               "label.name_param", new Object[] { sg.getName() }));
 238       showText.setState(sg.getDisplayText());
 239       showColourText.setState(sg.getColourText());
 240       showBoxes.setState(sg.getDisplayBoxes());
 241       displayNonconserved.setState(sg.getShowNonconserved());
 242       if (!ap.av.getAlignment().getGroups().contains(sg))
 243       {
 244         menu1.setLabel(MessageManager.getString("action.edit_new_group"));
 245         groupMenu.remove(unGroupMenuItem);
 246       }
 247       else
 248       {
 249         menu1.setLabel(MessageManager.getString("action.edit_group"));
 250         groupMenu.remove(createGroupMenuItem);
 251       }
 252
 253     }
 254     else
 255     {
 256       remove(hideSeqs);
 257       remove(groupMenu);
 258     }
 259
 260     if (links != null && links.size() > 0)
 261     {
 262       addFeatureLinks(seq, links);
 263     }
 264
 265     // TODO: add group link menu entry here
 266     if (seq != null)
 267     {
 268       seqMenu.setLabel(seq.getName());
 269       if (seq == ap.av.getAlignment().getSeqrep())
 270       {
 271         makeReferenceSeq.setLabel(MessageManager
 272                 .getString("action.unmark_as_reference"));// Unmark
 273                                                           // representative");
 274       }
 275       else
 276       {
 277         makeReferenceSeq.setLabel(MessageManager
 278                 .getString("action.set_as_reference")); // );
 279       }
 280       repGroup.setLabel(MessageManager.formatMessage(
 281               "label.represent_group_with", new Object[] { seq.getName() }));
 282     }
 283     else
 284     {
 285       remove(seqMenu);
 286     }
 287
 288     if (!ap.av.hasHiddenRows())
 289     {
 290       remove(revealAll);
 291       remove(revealSeq);
 292     }
 293     else
 294     {
 295       final int index = ap.av.getAlignment().findIndex(seq);
 296
 297       if (ap.av.adjustForHiddenSeqs(index)
 298               - ap.av.adjustForHiddenSeqs(index - 1) > 1)
 299       {
 300         revealSeq_index = index;
 301       }
 302       else
 303       {
 304         remove(revealSeq);
 305       }
 306     }
 307   }
 308
 309   /**
 310    * Adds a 'Link' menu item with a sub-menu item for each hyperlink provided.
 311    *
 312    * @param seq
 313    * @param links
 314    */
 315   void addFeatureLinks(final SequenceI seq, List<String> links)
 316   {
 317     Menu linkMenu = new Menu(MessageManager.getString("action.link"));
 318     Map<String, List<String>> linkset = new LinkedHashMap<String, List<String>>();
 319
 320     for (String link : links)
 321     {
 322       UrlLink urlLink = null;
 323       try
 324       {
 325         urlLink = new UrlLink(link);
 326       } catch (Exception foo)
 327       {
 328         System.err.println("Exception for URLLink '" + link + "': "
 329                 + foo.getMessage());
 330         continue;
 331       }
 332
 333       if (!urlLink.isValid())
 334       {
 335         System.err.println(urlLink.getInvalidMessage());
 336         continue;
 337       }
 338
 339       urlLink.createLinksFromSeq(seq, linkset);
 340     }
 341
 342     addshowLinks(linkMenu, linkset.values());
 343
 344     // disable link menu if there are no valid entries
 345     if (linkMenu.getItemCount() > 0)
 346     {
 347       linkMenu.setEnabled(true);
 348     }
 349     else
 350     {
 351       linkMenu.setEnabled(false);
 352     }
 353
 354     if (seq != null)
 355     {
 356       seqMenu.add(linkMenu);
 357     }
 358     else
 359     {
 360       add(linkMenu);
 361     }
 362
 363   }
 364
 365   private void addshowLinks(Menu linkMenu, Collection<List<String>> linkset)
 366   {
 367     for (List<String> linkstrset : linkset)
 368     {
 369       // split linkstr into label and url
 370       addshowLink(linkMenu, linkstrset.get(1), linkstrset.get(3));
 371     }
 372   }
 373
 374   /**
 375    * Build menus for annotation types that may be shown or hidden, and for
 376    * 'reference annotations' that may be added to the alignment.
 377    */
 378   private void buildAnnotationSubmenus()
 379   {
 380     /*
 381      * First for the currently selected sequence (if there is one):
 382      */
 383     final List<SequenceI> selectedSequence = (seq == null ? Collections
 384             .<SequenceI> emptyList() : Arrays.asList(seq));
 385     buildAnnotationTypesMenus(seqShowAnnotationsMenu,
 386             seqHideAnnotationsMenu, selectedSequence);
 387     configureReferenceAnnotationsMenu(seqAddReferenceAnnotations,
 388             selectedSequence);
 389
 390     /*
 391      * and repeat for the current selection group (if there is one):
 392      */
 393     final List<SequenceI> selectedGroup = (ap.av.getSelectionGroup() == null ? Collections
 394             .<SequenceI> emptyList() : ap.av.getSelectionGroup()
 395             .getSequences());
 396     buildAnnotationTypesMenus(groupShowAnnotationsMenu,
 397             groupHideAnnotationsMenu, selectedGroup);
 398     configureReferenceAnnotationsMenu(groupAddReferenceAnnotations,
 399             selectedGroup);
 400   }
 401
 402   /**
 403    * Determine whether or not to enable 'add reference annotations' menu item.
 404    * It is enable if there are any annotations, on any of the selected
 405    * sequences, which are not yet on the alignment (visible or not).
 406    *
 407    * @param menu
 408    * @param forSequences
 409    */
 410   private void configureReferenceAnnotationsMenu(MenuItem menuItem,
 411           List<SequenceI> forSequences)
 412   {
 413     menuItem.setEnabled(false);
 414
 415     /*
 416      * Temporary store to hold distinct calcId / type pairs for the tooltip.
 417      * Using TreeMap means calcIds are shown in alphabetical order.
 418      */
 419     SortedMap<String, String> tipEntries = new TreeMap<String, String>();
 420     final Map<SequenceI, List<AlignmentAnnotation>> candidates = new LinkedHashMap<SequenceI, List<AlignmentAnnotation>>();
 421     AlignmentI al = this.ap.av.getAlignment();
 422     AlignmentUtils.findAddableReferenceAnnotations(forSequences,
 423             tipEntries, candidates, al);
 424     if (!candidates.isEmpty())
 425     {
 426       StringBuilder tooltip = new StringBuilder(64);
 427       tooltip.append(MessageManager.getString("label.add_annotations_for"));
 428
 429       /*
 430        * Found annotations that could be added. Enable the menu item, and
 431        * configure its action.
 432        */
 433       menuItem.setEnabled(true);
 434
 435       menuItem.addActionListener(new ActionListener()
 436       {
 437         @Override
 438         public void actionPerformed(ActionEvent e)
 439         {
 440           addReferenceAnnotations_actionPerformed(candidates);
 441         }
 442       });
 443     }
 444   }
 445
 446   /**
 447    * Add annotations to the sequences and to the alignment.
 448    *
 449    * @param candidates
 450    *          a map whose keys are sequences on the alignment, and values a list
 451    *          of annotations to add to each sequence
 452    */
 453   protected void addReferenceAnnotations_actionPerformed(
 454           Map<SequenceI, List<AlignmentAnnotation>> candidates)
 455   {
 456     final SequenceGroup selectionGroup = this.ap.av.getSelectionGroup();
 457     final AlignmentI alignment = this.ap.getAlignment();
 458     AlignmentUtils.addReferenceAnnotations(candidates, alignment,
 459             selectionGroup);
 460     refresh();
 461   }
 462
 463   /**
 464    * add a show URL menu item to the given linkMenu
 465    *
 466    * @param linkMenu
 467    * @param target
 468    *          - menu label string
 469    * @param url
 470    *          - url to open
 471    */
 472   private void addshowLink(Menu linkMenu, final String target,
 473           final String url)
 474   {
 475     addshowLink(linkMenu, target, target, url);
 476   }
 477
 478   /**
 479    * add a show URL menu item to the given linkMenu
 480    *
 481    * @param linkMenu
 482    * @param target
 483    *          - URL target window
 484    * @param label
 485    *          - menu label string
 486    * @param url
 487    *          - url to open
 488    */
 489   private void addshowLink(Menu linkMenu, final String target,
 490           final String label, final String url)
 491   {
 492     MenuItem item = new MenuItem(label);
 493     item.addActionListener(new java.awt.event.ActionListener()
 494     {
 495       @Override
 496       public void actionPerformed(ActionEvent e)
 497       {
 498         ap.alignFrame.showURL(url, target);
 499       }
 500     });
 501     linkMenu.add(item);
 502   }
 503
 504   @Override
 505   public void itemStateChanged(ItemEvent evt)
 506   {
 507     if (evt.getSource() == abovePIDColour)
 508     {
 509       abovePIDColour_itemStateChanged();
 510     }
 511     else if (evt.getSource() == showColourText)
 512     {
 513       showColourText_itemStateChanged();
 514     }
 515     else if (evt.getSource() == showText)
 516     {
 517       showText_itemStateChanged();
 518     }
 519     else if (evt.getSource() == showBoxes)
 520     {
 521       showBoxes_itemStateChanged();
 522     }
 523     else if (evt.getSource() == displayNonconserved)
 524     {
 525       this.showNonconserved_itemStateChanged();
 526     }
 527   }
 528
 529   @Override
 530   public void actionPerformed(ActionEvent evt)
 531   {
 532     Object source = evt.getSource();
 533     if (source == clustalColour)
 534     {
 535       clustalColour_actionPerformed();
 536     }
 537     else if (source == zappoColour)
 538     {
 539       zappoColour_actionPerformed();
 540     }
 541     else if (source == taylorColour)
 542     {
 543       taylorColour_actionPerformed();
 544     }
 545     else if (source == hydrophobicityColour)
 546     {
 547       hydrophobicityColour_actionPerformed();
 548     }
 549     else if (source == helixColour)
 550     {
 551       helixColour_actionPerformed();
 552     }
 553     else if (source == strandColour)
 554     {
 555       strandColour_actionPerformed();
 556     }
 557     else if (source == turnColour)
 558     {
 559       turnColour_actionPerformed();
 560     }
 561     else if (source == buriedColour)
 562     {
 563       buriedColour_actionPerformed();
 564     }
 565     else if (source == nucleotideMenuItem)
 566     {
 567       nucleotideMenuItem_actionPerformed();
 568     }
 569     else if (source == purinePyrimidineMenuItem)
 570     {
 571       purinePyrimidineColour_actionPerformed();
 572     }
 573
 574     else if (source == userDefinedColour)
 575     {
 576       userDefinedColour_actionPerformed();
 577     }
 578     else if (source == PIDColour)
 579     {
 580       PIDColour_actionPerformed();
 581     }
 582     else if (source == BLOSUM62Colour)
 583     {
 584       BLOSUM62Colour_actionPerformed();
 585     }
 586     else if (source == noColourmenuItem)
 587     {
 588       noColourmenuItem_actionPerformed();
 589     }
 590     else if (source == conservationMenuItem)
 591     {
 592       conservationMenuItem_itemStateChanged();
 593     }
 594     else if (source == unGroupMenuItem)
 595     {
 596       unGroupMenuItem_actionPerformed();
 597     }
 598
 599     else if (source == createGroupMenuItem)
 600     {
 601       createGroupMenuItem_actionPerformed();
 602     }
 603
 604     else if (source == sequenceName)
 605     {
 606       editName();
 607     }
 608     else if (source == makeReferenceSeq)
 609     {
 610       makeReferenceSeq_actionPerformed();
 611     }
 612     else if (source == sequenceDetails)
 613     {
 614       showSequenceDetails();
 615     }
 616     else if (source == selSeqDetails)
 617     {
 618       showSequenceSelectionDetails();
 619     }
 620     else if (source == pdb)
 621     {
 622       addPDB();
 623     }
 624     else if (source == hideSeqs)
 625     {
 626       hideSequences(false);
 627     }
 628     else if (source == repGroup)
 629     {
 630       hideSequences(true);
 631     }
 632     else if (source == revealSeq)
 633     {
 634       ap.av.showSequence(revealSeq_index);
 635     }
 636     else if (source == revealAll)
 637     {
 638       ap.av.showAllHiddenSeqs();
 639     }
 640
 641     else if (source == editGroupName)
 642     {
 643       EditNameDialog dialog = new EditNameDialog(getGroup().getName(),
 644               getGroup().getDescription(), "       Group Name",
 645               "Group Description", ap.alignFrame,
 646               "Edit Group Name / Description", 500, 100, true);
 647
 648       if (dialog.accept)
 649       {
 650         getGroup().setName(dialog.getName().replace(' ', '_'));
 651         getGroup().setDescription(dialog.getDescription());
 652       }
 653
 654     }
 655     else if (source == copy)
 656     {
 657       ap.alignFrame.copy_actionPerformed();
 658     }
 659     else if (source == cut)
 660     {
 661       ap.alignFrame.cut_actionPerformed();
 662     }
 663     else if (source == editSequence)
 664     {
 665       SequenceGroup sg = ap.av.getSelectionGroup();
 666
 667       if (sg != null)
 668       {
 669         if (seq == null)
 670         {
 671           seq = sg.getSequenceAt(0);
 672         }
 673
 674         EditNameDialog dialog = new EditNameDialog(seq.getSequenceAsString(
 675                 sg.getStartRes(), sg.getEndRes() + 1), null,
 676                 "Edit Sequence ", null,
 677
 678                 ap.alignFrame, "Edit Sequence", 500, 100, true);
 679
 680         if (dialog.accept)
 681         {
 682           EditCommand editCommand = new EditCommand(
 683                   MessageManager.getString("label.edit_sequences"),
 684                   Action.REPLACE, dialog.getName().replace(' ',
 685                           ap.av.getGapCharacter()),
 686                   sg.getSequencesAsArray(ap.av.getHiddenRepSequences()),
 687                   sg.getStartRes(), sg.getEndRes() + 1,
 688                   ap.av.getAlignment());
 689
 690           ap.alignFrame.addHistoryItem(editCommand);
 691
 692           ap.av.firePropertyChange("alignment", null, ap.av.getAlignment()
 693                   .getSequences());
 694         }
 695       }
 696     }
 697     else if (source == toUpper || source == toLower || source == toggleCase)
 698     {
 699       SequenceGroup sg = ap.av.getSelectionGroup();
 700       if (sg != null)
 701       {
 702         List<int[]> startEnd = ap.av.getVisibleRegionBoundaries(
 703                 sg.getStartRes(), sg.getEndRes() + 1);
 704
 705         String description;
 706         int caseChange;
 707
 708         if (source == toggleCase)
 709         {
 710           description = "Toggle Case";
 711           caseChange = ChangeCaseCommand.TOGGLE_CASE;
 712         }
 713         else if (source == toUpper)
 714         {
 715           description = "To Upper Case";
 716           caseChange = ChangeCaseCommand.TO_UPPER;
 717         }
 718         else
 719         {
 720           description = "To Lower Case";
 721           caseChange = ChangeCaseCommand.TO_LOWER;
 722         }
 723
 724         ChangeCaseCommand caseCommand = new ChangeCaseCommand(description,
 725                 sg.getSequencesAsArray(ap.av.getHiddenRepSequences()),
 726                 startEnd, caseChange);
 727
 728         ap.alignFrame.addHistoryItem(caseCommand);
 729
 730         ap.av.firePropertyChange("alignment", null, ap.av.getAlignment()
 731                 .getSequences());
 732
 733       }
 734     }
 735     else if (source == sequenceFeature)
 736     {
 737       SequenceGroup sg = ap.av.getSelectionGroup();
 738       if (sg == null)
 739       {
 740         return;
 741       }
 742
 743       int rsize = 0, gSize = sg.getSize();
 744       SequenceI[] rseqs, seqs = new SequenceI[gSize];
 745       SequenceFeature[] tfeatures, features = new SequenceFeature[gSize];
 746
 747       for (int i = 0; i < gSize; i++)
 748       {
 749         int start = sg.getSequenceAt(i).findPosition(sg.getStartRes());
 750         int end = sg.findEndRes(sg.getSequenceAt(i));
 751         if (start <= end)
 752         {
 753           seqs[rsize] = sg.getSequenceAt(i);
 754           features[rsize] = new SequenceFeature(null, null, null, start,
 755                   end, "Jalview");
 756           rsize++;
 757         }
 758       }
 759       rseqs = new SequenceI[rsize];
 760       tfeatures = new SequenceFeature[rsize];
 761       System.arraycopy(seqs, 0, rseqs, 0, rsize);
 762       System.arraycopy(features, 0, tfeatures, 0, rsize);
 763       features = tfeatures;
 764       seqs = rseqs;
 765
 766       if (ap.seqPanel.seqCanvas.getFeatureRenderer().amendFeatures(seqs,
 767               features, true, ap))
 768       {
 769         ap.alignFrame.sequenceFeatures.setState(true);
 770         ap.av.setShowSequenceFeatures(true);
 771         ;
 772         ap.highlightSearchResults(null);
 773       }
 774     }
 775     else
 776     {
 777       outputText(evt);
 778     }
 779
 780   }
 781
 782   void outputText(ActionEvent e)
 783   {
 784     CutAndPasteTransfer cap = new CutAndPasteTransfer(true, ap.alignFrame);
 785
 786     Frame frame = new Frame();
 787     frame.add(cap);
 788     JalviewLite.addFrame(frame, MessageManager.formatMessage(
 789             "label.selection_output_command",
 790             new Object[] { e.getActionCommand() }), 600, 500);
 791     // JBPNote: getSelectionAsNewSequence behaviour has changed - this method
 792     // now returns a full copy of sequence data
 793     // TODO consider using getSequenceSelection instead here
 794
 795     FileFormat fileFormat = FileFormat.valueOf(e.getActionCommand());
 796     cap.setText(new AppletFormatAdapter().formatSequences(fileFormat,
 797             ap.av.getShowJVSuffix(), ap, true));
 798
 799   }
 800
 801   protected void showSequenceSelectionDetails()
 802   {
 803     createSequenceDetailsReport(ap.av.getSequenceSelection());
 804   }
 805
 806   protected void showSequenceDetails()
 807   {
 808     createSequenceDetailsReport(new SequenceI[] { seq });
 809   }
 810
 811   public void createSequenceDetailsReport(SequenceI[] sequences)
 812   {
 813
 814     CutAndPasteTransfer cap = new CutAndPasteTransfer(false, ap.alignFrame);
 815
 816     StringBuilder contents = new StringBuilder(128);
 817     for (SequenceI seq : sequences)
 818     {
 819       contents.append(MessageManager.formatMessage(
 820               "label.annotation_for_displayid",
 821               new Object[] { seq.getDisplayId(true) }));
 822       new SequenceAnnotationReport(null).createSequenceAnnotationReport(
 823               contents,
 824               seq,
 825               true,
 826               true,
 827               (ap.seqPanel.seqCanvas.fr != null) ? ap.seqPanel.seqCanvas.fr
 828                       .getMinMax() : null);
 829       contents.append("</p>");
 830     }
 831     Frame frame = new Frame();
 832     frame.add(cap);
 833     jalview.bin.JalviewLite.addFrame(frame, "Sequence Details for "
 834             + (sequences.length == 1 ? sequences[0].getDisplayId(true)
 835                     : "Selection"), 600, 500);
 836     cap.setText(MessageManager.formatMessage("label.html_content",
 837             new Object[] { contents.toString() }));
 838   }
 839
 840   void editName()
 841   {
 842     EditNameDialog dialog = new EditNameDialog(seq.getName(),
 843             seq.getDescription(), "       Sequence Name",
 844             "Sequence Description", ap.alignFrame,
 845             "Edit Sequence Name / Description", 500, 100, true);
 846
 847     if (dialog.accept)
 848     {
 849       seq.setName(dialog.getName());
 850       seq.setDescription(dialog.getDescription());
 851       ap.paintAlignment(false);
 852     }
 853   }
 854
 855   void addPDB()
 856   {
 857     Vector<PDBEntry> pdbs = seq.getAllPDBEntries();
 858     if (pdbs != null&& !pdbs.isEmpty())
 859     {
 860       PDBEntry entry = pdbs.firstElement();
 861
 862       if (ap.av.applet.jmolAvailable)
 863       {
 864         new jalview.appletgui.AppletJmol(entry, new SequenceI[] { seq },
 865                 null, ap, DataSourceType.URL);
 866       }
 867       else
 868       {
 869         new MCview.AppletPDBViewer(entry, new SequenceI[] { seq }, null,
 870                 ap, DataSourceType.URL);
 871       }
 872
 873     }
 874     else
 875     {
 876       CutAndPasteTransfer cap = new CutAndPasteTransfer(true, ap.alignFrame);
 877       cap.setText(MessageManager.getString("label.paste_pdb_file"));
 878       cap.setPDBImport(seq);
 879       Frame frame = new Frame();
 880       frame.add(cap);
 881       jalview.bin.JalviewLite.addFrame(frame, MessageManager.formatMessage(
 882               "label.paste_pdb_file_for_sequence",
 883               new Object[] { seq.getName() }), 400, 300);
 884     }
 885   }
 886
 887   private void jbInit() throws Exception
 888   {
 889     groupMenu.setLabel(MessageManager.getString("label.selection"));
 890     sequenceFeature.addActionListener(this);
 891
 892     editGroupName.addActionListener(this);
 893     unGroupMenuItem.setLabel(MessageManager
 894             .getString("action.remove_group"));
 895     unGroupMenuItem.addActionListener(this);
 896
 897     createGroupMenuItem.setLabel(MessageManager
 898             .getString("action.create_group"));
 899     createGroupMenuItem.addActionListener(this);
 900
 901     nucleotideMenuItem.setLabel(MessageManager
 902             .getString("label.nucleotide"));
 903     nucleotideMenuItem.addActionListener(this);
 904     purinePyrimidineMenuItem.setLabel(MessageManager
 905             .getString("label.purine_pyrimidine"));
 906     purinePyrimidineMenuItem.addActionListener(this);
 907     conservationMenuItem.addItemListener(this);
 908     abovePIDColour.addItemListener(this);
 909     colourMenu.setLabel(MessageManager.getString("label.group_colour"));
 910     showBoxes.setLabel(MessageManager.getString("action.boxes"));
 911     showBoxes.setState(true);
 912     showBoxes.addItemListener(this);
 913     sequenceName.addActionListener(this);
 914     sequenceDetails.addActionListener(this);
 915     selSeqDetails.addActionListener(this);
 916     displayNonconserved.setLabel(MessageManager
 917             .getString("label.show_non_conserved"));
 918     displayNonconserved.setState(false);
 919     displayNonconserved.addItemListener(this);
 920     showText.setLabel(MessageManager.getString("action.text"));
 921     showText.addItemListener(this);
 922     showColourText.setLabel(MessageManager.getString("label.colour_text"));
 923     showColourText.addItemListener(this);
 924     outputmenu.setLabel(MessageManager.getString("label.out_to_textbox"));
 925     seqMenu.setLabel(MessageManager.getString("label.sequence"));
 926     pdb.setLabel(MessageManager.getString("label.view_pdb_structure"));
 927     hideSeqs.setLabel(MessageManager.getString("action.hide_sequences"));
 928     repGroup.setLabel(MessageManager.formatMessage(
 929             "label.represent_group_with", new Object[] { "" }));
 930     revealAll.setLabel(MessageManager.getString("action.reveal_all"));
 931     revealSeq.setLabel(MessageManager.getString("action.reveal_sequences"));
 932     menu1.setLabel(MessageManager.getString("label.group:"));
 933     add(groupMenu);
 934     this.add(seqMenu);
 935     this.add(hideSeqs);
 936     this.add(revealSeq);
 937     this.add(revealAll);
 938     // groupMenu.add(selSeqDetails);
 939     groupMenu.add(groupShowAnnotationsMenu);
 940     groupMenu.add(groupHideAnnotationsMenu);
 941     groupMenu.add(groupAddReferenceAnnotations);
 942     groupMenu.add(editMenu);
 943     groupMenu.add(outputmenu);
 944     groupMenu.add(sequenceFeature);
 945     groupMenu.add(createGroupMenuItem);
 946     groupMenu.add(unGroupMenuItem);
 947     groupMenu.add(menu1);
 948
 949     colourMenu.add(noColourmenuItem);
 950     colourMenu.add(clustalColour);
 951     colourMenu.add(BLOSUM62Colour);
 952     colourMenu.add(PIDColour);
 953     colourMenu.add(zappoColour);
 954     colourMenu.add(taylorColour);
 955     colourMenu.add(hydrophobicityColour);
 956     colourMenu.add(helixColour);
 957     colourMenu.add(strandColour);
 958     colourMenu.add(turnColour);
 959     colourMenu.add(buriedColour);
 960     colourMenu.add(nucleotideMenuItem);
 961     colourMenu.add(purinePyrimidineMenuItem);
 962     colourMenu.add(userDefinedColour);
 963     colourMenu.addSeparator();
 964     colourMenu.add(abovePIDColour);
 965     colourMenu.add(conservationMenuItem);
 966
 967     noColourmenuItem.setLabel(MessageManager.getString("label.none"));
 968     noColourmenuItem.addActionListener(this);
 969
 970     clustalColour.setLabel(MessageManager.getString("label.clustalx"));
 971     clustalColour.addActionListener(this);
 972     zappoColour.setLabel(MessageManager.getString("label.zappo"));
 973     zappoColour.addActionListener(this);
 974     taylorColour.setLabel(MessageManager.getString("label.taylor"));
 975     taylorColour.addActionListener(this);
 976     hydrophobicityColour.setLabel(MessageManager
 977             .getString("label.hydrophobicity"));
 978     hydrophobicityColour.addActionListener(this);
 979     helixColour
 980             .setLabel(MessageManager.getString("label.helix_propensity"));
 981     helixColour.addActionListener(this);
 982     strandColour.setLabel(MessageManager
 983             .getString("label.strand_propensity"));
 984     strandColour.addActionListener(this);
 985     turnColour.setLabel(MessageManager.getString("label.turn_propensity"));
 986     turnColour.addActionListener(this);
 987     buriedColour.setLabel(MessageManager.getString("label.buried_index"));
 988     buriedColour.addActionListener(this);
 989     abovePIDColour.setLabel(MessageManager
 990             .getString("label.above_identity_threshold"));
 991
 992     userDefinedColour.setLabel(MessageManager
 993             .getString("action.user_defined"));
 994     userDefinedColour.addActionListener(this);
 995     PIDColour.setLabel(MessageManager
 996             .getString("label.percentage_identity"));
 997     PIDColour.addActionListener(this);
 998     BLOSUM62Colour.setLabel(MessageManager
 999             .getString("label.blosum62_score"));
1000     BLOSUM62Colour.addActionListener(this);
1001     conservationMenuItem.setLabel(MessageManager
1002             .getString("label.conservation"));
1003
1004     editMenu.add(copy);
1005     copy.addActionListener(this);
1006     editMenu.add(cut);
1007     cut.addActionListener(this);
1008
1009     editMenu.add(editSequence);
1010     editSequence.addActionListener(this);
1011
1012     editMenu.add(toUpper);
1013     toUpper.addActionListener(this);
1014     editMenu.add(toLower);
1015     toLower.addActionListener(this);
1016     editMenu.add(toggleCase);
1017     seqMenu.add(seqShowAnnotationsMenu);
1018     seqMenu.add(seqHideAnnotationsMenu);
1019     seqMenu.add(seqAddReferenceAnnotations);
1020     seqMenu.add(sequenceName);
1021     seqMenu.add(makeReferenceSeq);
1022     // seqMenu.add(sequenceDetails);
1023
1024     if (!ap.av.applet.useXtrnalSviewer)
1025     {
1026       seqMenu.add(pdb);
1027     }
1028     seqMenu.add(repGroup);
1029     menu1.add(editGroupName);
1030     menu1.add(colourMenu);
1031     menu1.add(showBoxes);
1032     menu1.add(showText);
1033     menu1.add(showColourText);
1034     menu1.add(displayNonconserved);
1035     toggleCase.addActionListener(this);
1036     pdb.addActionListener(this);
1037     hideSeqs.addActionListener(this);
1038     repGroup.addActionListener(this);
1039     revealAll.addActionListener(this);
1040     revealSeq.addActionListener(this);
1041     makeReferenceSeq.addActionListener(this);
1042   }
1043
1044   void refresh()
1045   {
1046     ap.paintAlignment(true);
1047   }
1048
1049   protected void clustalColour_actionPerformed()
1050   {
1051     SequenceGroup sg = getGroup();
1052     sg.cs = new ClustalxColourScheme(sg, ap.av.getHiddenRepSequences());
1053     refresh();
1054   }
1055
1056   protected void zappoColour_actionPerformed()
1057   {
1058     getGroup().cs = new ZappoColourScheme();
1059     refresh();
1060   }
1061
1062   protected void taylorColour_actionPerformed()
1063   {
1064     getGroup().cs = new TaylorColourScheme();
1065     refresh();
1066   }
1067
1068   protected void hydrophobicityColour_actionPerformed()
1069   {
1070     getGroup().cs = new HydrophobicColourScheme();
1071     refresh();
1072   }
1073
1074   protected void helixColour_actionPerformed()
1075   {
1076     getGroup().cs = new HelixColourScheme();
1077     refresh();
1078   }
1079
1080   protected void strandColour_actionPerformed()
1081   {
1082     getGroup().cs = new StrandColourScheme();
1083     refresh();
1084   }
1085
1086   protected void turnColour_actionPerformed()
1087   {
1088     getGroup().cs = new TurnColourScheme();
1089     refresh();
1090   }
1091
1092   protected void buriedColour_actionPerformed()
1093   {
1094     getGroup().cs = new BuriedColourScheme();
1095     refresh();
1096   }
1097
1098   public void nucleotideMenuItem_actionPerformed()
1099   {
1100     getGroup().cs = new NucleotideColourScheme();
1101     refresh();
1102   }
1103
1104   public void purinePyrimidineColour_actionPerformed()
1105   {
1106     getGroup().cs = new PurinePyrimidineColourScheme();
1107     refresh();
1108   }
1109
1110   protected void abovePIDColour_itemStateChanged()
1111   {
1112     SequenceGroup sg = getGroup();
1113     if (sg.cs == null)
1114     {
1115       return;
1116     }
1117
1118     if (abovePIDColour.getState())
1119     {
1120       sg.cs.setConsensus(AAFrequency.calculate(sg.getSequences(ap.av
1121               .getHiddenRepSequences()), 0, ap.av.getAlignment().getWidth()));
1122       int threshold = SliderPanel.setPIDSliderSource(ap, sg.cs, getGroup()
1123               .getName());
1124
1125       sg.cs.setThreshold(threshold, ap.av.isIgnoreGapsConsensus());
1126
1127       SliderPanel.showPIDSlider();
1128
1129     }
1130     else
1131     // remove PIDColouring
1132     {
1133       sg.cs.setThreshold(0, ap.av.isIgnoreGapsConsensus());
1134     }
1135
1136     refresh();
1137
1138   }
1139
1140   protected void userDefinedColour_actionPerformed()
1141   {
1142     new UserDefinedColours(ap, getGroup());
1143   }
1144
1145   protected void PIDColour_actionPerformed()
1146   {
1147     SequenceGroup sg = getGroup();
1148     sg.cs = new PIDColourScheme();
1149     sg.cs.setConsensus(AAFrequency.calculate(sg.getSequences(ap.av
1150             .getHiddenRepSequences()), 0, ap.av.getAlignment().getWidth()));
1151     refresh();
1152   }
1153
1154   protected void BLOSUM62Colour_actionPerformed()
1155   {
1156     SequenceGroup sg = getGroup();
1157
1158     sg.cs = new Blosum62ColourScheme();
1159
1160     sg.cs.setConsensus(AAFrequency.calculate(sg.getSequences(ap.av
1161             .getHiddenRepSequences()), 0, ap.av.getAlignment().getWidth()));
1162
1163     refresh();
1164   }
1165
1166   protected void noColourmenuItem_actionPerformed()
1167   {
1168     getGroup().cs = null;
1169     refresh();
1170   }
1171
1172   protected void conservationMenuItem_itemStateChanged()
1173   {
1174     SequenceGroup sg = getGroup();
1175     if (sg.cs == null)
1176     {
1177       return;
1178     }
1179
1180     if (conservationMenuItem.getState())
1181     {
1182       sg.cs.setConservation(Conservation.calculateConservation("Group", sg
1183               .getSequences(ap.av.getHiddenRepSequences()), 0, ap.av
1184               .getAlignment().getWidth(), false, ap.av.getConsPercGaps(),
1185               false));
1186       SliderPanel.setConservationSlider(ap, sg.cs, sg.getName());
1187       SliderPanel.showConservationSlider();
1188     }
1189     else
1190     // remove ConservationColouring
1191     {
1192       sg.cs.setConservation(null);
1193     }
1194
1195     refresh();
1196   }
1197
1198   SequenceGroup getGroup()
1199   {
1200     SequenceGroup sg = ap.av.getSelectionGroup();
1201
1202     // this method won't add a new group if it already exists
1203     if (sg != null)
1204     {
1205       ap.av.getAlignment().addGroup(sg);
1206     }
1207
1208     return sg;
1209   }
1210
1211   void unGroupMenuItem_actionPerformed()
1212   {
1213     SequenceGroup sg = ap.av.getSelectionGroup();
1214     ap.av.getAlignment().deleteGroup(sg);
1215     ap.av.setSelectionGroup(null);
1216     ap.paintAlignment(true);
1217   }
1218
1219   void createGroupMenuItem_actionPerformed()
1220   {
1221     getGroup(); // implicitly create group
1222     refresh();
1223   }
1224
1225   public void showColourText_itemStateChanged()
1226   {
1227     getGroup().setColourText(showColourText.getState());
1228     refresh();
1229   }
1230
1231   public void showText_itemStateChanged()
1232   {
1233     getGroup().setDisplayText(showText.getState());
1234     refresh();
1235   }
1236
1237   public void makeReferenceSeq_actionPerformed()
1238   {
1239     if (!ap.av.getAlignment().hasSeqrep())
1240     {
1241       // initialise the display flags so the user sees something happen
1242       ap.av.setDisplayReferenceSeq(true);
1243       ap.av.setColourByReferenceSeq(true);
1244       ap.av.getAlignment().setSeqrep(seq);
1245     }
1246     else
1247     {
1248       if (ap.av.getAlignment().getSeqrep() == seq)
1249       {
1250         ap.av.getAlignment().setSeqrep(null);
1251       }
1252       else
1253       {
1254         ap.av.getAlignment().setSeqrep(seq);
1255       }
1256     }
1257     refresh();
1258   }
1259
1260   public void showNonconserved_itemStateChanged()
1261   {
1262     getGroup().setShowNonconserved(this.displayNonconserved.getState());
1263     refresh();
1264   }
1265
1266   public void showBoxes_itemStateChanged()
1267   {
1268     getGroup().setDisplayBoxes(showBoxes.getState());
1269     refresh();
1270   }
1271
1272   void hideSequences(boolean representGroup)
1273   {
1274     ap.av.hideSequences(seq, representGroup);
1275   }
1276
1277   /**
1278    * Add annotation types to 'Show annotations' and/or 'Hide annotations' menus.
1279    * "All" is added first, followed by a separator. Then add any annotation
1280    * types associated with the current selection. Separate menus are built for
1281    * the selected sequence group (if any), and the selected sequence.
1282    * <p>
1283    * Some annotation rows are always rendered together - these can be identified
1284    * by a common graphGroup property > -1. Only one of each group will be marked
1285    * as visible (to avoid duplication of the display). For such groups we add a
1286    * composite type name, e.g.
1287    * <p>
1288    * IUPredWS (Long), IUPredWS (Short)
1289    *
1290    * @param seq
1291    */
1292   protected void buildAnnotationTypesMenus(Menu showMenu, Menu hideMenu,
1293           List<SequenceI> forSequences)
1294   {
1295     showMenu.removeAll();
1296     hideMenu.removeAll();
1297
1298     final List<String> all = Arrays.asList(new String[] { MessageManager
1299             .getString("label.all") });
1300     addAnnotationTypeToShowHide(showMenu, forSequences, "", all, true, true);
1301     addAnnotationTypeToShowHide(hideMenu, forSequences, "", all, true,
1302             false);
1303     showMenu.addSeparator();
1304     hideMenu.addSeparator();
1305
1306     final AlignmentAnnotation[] annotations = ap.getAlignment()
1307             .getAlignmentAnnotation();
1308
1309     /*
1310      * Find shown/hidden annotations types, distinguished by source (calcId),
1311      * and grouped by graphGroup. Using LinkedHashMap means we will retrieve in
1312      * the insertion order, which is the order of the annotations on the
1313      * alignment.
1314      */
1315     Map<String, List<List<String>>> shownTypes = new LinkedHashMap<String, List<List<String>>>();
1316     Map<String, List<List<String>>> hiddenTypes = new LinkedHashMap<String, List<List<String>>>();
1317     AlignmentAnnotationUtils.getShownHiddenTypes(shownTypes, hiddenTypes,
1318             AlignmentAnnotationUtils.asList(annotations), forSequences);
1319
1320     for (String calcId : hiddenTypes.keySet())
1321     {
1322       for (List<String> type : hiddenTypes.get(calcId))
1323       {
1324         addAnnotationTypeToShowHide(showMenu, forSequences, calcId, type,
1325                 false, true);
1326       }
1327     }
1328     // grey out 'show annotations' if none are hidden
1329     showMenu.setEnabled(!hiddenTypes.isEmpty());
1330
1331     for (String calcId : shownTypes.keySet())
1332     {
1333       for (List<String> type : shownTypes.get(calcId))
1334       {
1335         addAnnotationTypeToShowHide(hideMenu, forSequences, calcId, type,
1336                 false, false);
1337       }
1338     }
1339     // grey out 'hide annotations' if none are shown
1340     hideMenu.setEnabled(!shownTypes.isEmpty());
1341   }
1342
1343   /**
1344    * Add one annotation type to the 'Show Annotations' or 'Hide Annotations'
1345    * menus.
1346    *
1347    * @param showOrHideMenu
1348    *          the menu to add to
1349    * @param forSequences
1350    *          the sequences whose annotations may be shown or hidden
1351    * @param calcId
1352    * @param types
1353    *          the label to add
1354    * @param allTypes
1355    *          if true this is a special label meaning 'All'
1356    * @param actionIsShow
1357    *          if true, the select menu item action is to show the annotation
1358    *          type, else hide
1359    */
1360   protected void addAnnotationTypeToShowHide(Menu showOrHideMenu,
1361           final List<SequenceI> forSequences, String calcId,
1362           final List<String> types, final boolean allTypes,
1363           final boolean actionIsShow)
1364   {
1365     String label = types.toString(); // [a, b, c]
1366     label = label.substring(1, label.length() - 1);
1367     final MenuItem item = new MenuItem(label);
1368     item.addActionListener(new java.awt.event.ActionListener()
1369     {
1370       @Override
1371       public void actionPerformed(ActionEvent e)
1372       {
1373         AlignmentUtils.showOrHideSequenceAnnotations(ap.getAlignment(),
1374                 types, forSequences, allTypes, actionIsShow);
1375         refresh();
1376       }
1377     });
1378     showOrHideMenu.add(item);
1379   }
1380
1381 }