src/jalview/appletgui/APopupMenu.java

   1 /*
   2  * Jalview - A Sequence Alignment Editor and Viewer (Version 2.8.2)
   3  * Copyright (C) 2014 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.Conservation;
  25 import jalview.commands.ChangeCaseCommand;
  26 import jalview.commands.EditCommand;
  27 import jalview.commands.EditCommand.Action;
  28 import jalview.datamodel.DBRefEntry;
  29 import jalview.datamodel.PDBEntry;
  30 import jalview.datamodel.Sequence;
  31 import jalview.datamodel.SequenceFeature;
  32 import jalview.datamodel.SequenceGroup;
  33 import jalview.datamodel.SequenceI;
  34 import jalview.io.AppletFormatAdapter;
  35 import jalview.io.SequenceAnnotationReport;
  36 import jalview.schemes.Blosum62ColourScheme;
  37 import jalview.schemes.BuriedColourScheme;
  38 import jalview.schemes.ClustalxColourScheme;
  39 import jalview.schemes.HelixColourScheme;
  40 import jalview.schemes.HydrophobicColourScheme;
  41 import jalview.schemes.NucleotideColourScheme;
  42 import jalview.schemes.PIDColourScheme;
  43 import jalview.schemes.ResidueProperties;
  44 import jalview.schemes.StrandColourScheme;
  45 import jalview.schemes.TaylorColourScheme;
  46 import jalview.schemes.TurnColourScheme;
  47 import jalview.schemes.ZappoColourScheme;
  48 import jalview.util.MessageManager;
  49 import jalview.util.UrlLink;
  50
  51 import java.awt.CheckboxMenuItem;
  52 import java.awt.Frame;
  53 import java.awt.Menu;
  54 import java.awt.MenuItem;
  55 import java.awt.event.ActionEvent;
  56 import java.awt.event.ActionListener;
  57 import java.awt.event.ItemEvent;
  58 import java.awt.event.ItemListener;
  59 import java.util.List;
  60 import java.util.Vector;
  61
  62 public class APopupMenu extends java.awt.PopupMenu implements
  63         ActionListener, ItemListener
  64 {
  65   Menu groupMenu = new Menu();
  66
  67   MenuItem editGroupName = new MenuItem();
  68
  69   protected MenuItem clustalColour = new MenuItem();
  70
  71   protected MenuItem zappoColour = new MenuItem();
  72
  73   protected MenuItem taylorColour = new MenuItem();
  74
  75   protected MenuItem hydrophobicityColour = new MenuItem();
  76
  77   protected MenuItem helixColour = new MenuItem();
  78
  79   protected MenuItem strandColour = new MenuItem();
  80
  81   protected MenuItem turnColour = new MenuItem();
  82
  83   protected MenuItem buriedColour = new MenuItem();
  84
  85   protected CheckboxMenuItem abovePIDColour = new CheckboxMenuItem();
  86
  87   protected MenuItem userDefinedColour = new MenuItem();
  88
  89   protected MenuItem PIDColour = new MenuItem();
  90
  91   protected MenuItem BLOSUM62Colour = new MenuItem();
  92
  93   MenuItem noColourmenuItem = new MenuItem();
  94
  95   protected CheckboxMenuItem conservationMenuItem = new CheckboxMenuItem();
  96
  97   final AlignmentPanel ap;
  98
  99   MenuItem unGroupMenuItem = new MenuItem();
 100
 101   MenuItem createGroupMenuItem = new MenuItem();
 102
 103   MenuItem nucleotideMenuItem = new MenuItem();
 104
 105   Menu colourMenu = new Menu();
 106
 107   CheckboxMenuItem showBoxes = new CheckboxMenuItem();
 108
 109   CheckboxMenuItem showText = new CheckboxMenuItem();
 110
 111   CheckboxMenuItem showColourText = new CheckboxMenuItem();
 112
 113   CheckboxMenuItem displayNonconserved = new CheckboxMenuItem();
 114
 115   Menu editMenu = new Menu(MessageManager.getString("action.edit"));
 116
 117   MenuItem copy = new MenuItem(MessageManager.getString("action.copy"));
 118
 119   MenuItem cut = new MenuItem(MessageManager.getString("action.cut"));
 120
 121   MenuItem toUpper = new MenuItem(
 122           MessageManager.getString("label.to_upper_case"));
 123
 124   MenuItem toLower = new MenuItem(
 125           MessageManager.getString("label.to_lower_case"));
 126
 127   MenuItem toggleCase = new MenuItem(
 128           MessageManager.getString("label.toggle_case"));
 129
 130   Menu outputmenu = new Menu();
 131
 132   Menu seqMenu = new Menu();
 133
 134   MenuItem pdb = new MenuItem();
 135
 136   MenuItem hideSeqs = new MenuItem();
 137
 138   MenuItem repGroup = new MenuItem();
 139
 140   MenuItem sequenceName = new MenuItem(
 141           MessageManager.getString("label.edit_name_description"));
 142
 143   MenuItem sequenceFeature = new MenuItem(
 144           MessageManager.getString("label.create_sequence_feature"));
 145
 146   MenuItem editSequence = new MenuItem(
 147           MessageManager.getString("label.edit_sequence"));
 148
 149   MenuItem sequenceDetails = new MenuItem(
 150           MessageManager.getString("label.sequence_details") + "...");
 151
 152   MenuItem selSeqDetails = new MenuItem(
 153           MessageManager.getString("label.sequence_details") + "...");
 154
 155   MenuItem makeReferenceSeq = new MenuItem();
 156
 157   Sequence seq;
 158
 159   MenuItem revealAll = new MenuItem();
 160
 161   MenuItem revealSeq = new MenuItem();
 162
 163   /**
 164    * index of sequence to be revealed
 165    */
 166   int revealSeq_index = -1;
 167
 168   Menu menu1 = new Menu();
 169
 170   public APopupMenu(AlignmentPanel apanel, final Sequence seq, Vector links)
 171   {
 172     // /////////////////////////////////////////////////////////
 173     // If this is activated from the sequence panel, the user may want to
 174     // edit or annotate a particular residue. Therefore display the residue menu
 175     //
 176     // If from the IDPanel, we must display the sequence menu
 177     // ////////////////////////////////////////////////////////
 178
 179     this.ap = apanel;
 180     this.seq = seq;
 181
 182     try
 183     {
 184       jbInit();
 185     } catch (Exception e)
 186     {
 187       e.printStackTrace();
 188     }
 189
 190     for (int i = 0; i < jalview.io.AppletFormatAdapter.WRITEABLE_FORMATS.length; i++)
 191     {
 192       MenuItem item = new MenuItem(
 193               jalview.io.AppletFormatAdapter.WRITEABLE_FORMATS[i]);
 194
 195       item.addActionListener(this);
 196       outputmenu.add(item);
 197     }
 198
 199     SequenceGroup sg = ap.av.getSelectionGroup();
 200
 201     if (sg != null && sg.getSize() > 0)
 202     {
 203       editGroupName.setLabel(MessageManager.formatMessage(
 204               "label.name_param", new String[]
 205               { sg.getName() }));
 206       showText.setState(sg.getDisplayText());
 207       showColourText.setState(sg.getColourText());
 208       showBoxes.setState(sg.getDisplayBoxes());
 209       displayNonconserved.setState(sg.getShowNonconserved());
 210       if (!ap.av.getAlignment().getGroups().contains(sg))
 211       {
 212         menu1.setLabel(MessageManager.getString("action.edit_new_group"));
 213         groupMenu.remove(unGroupMenuItem);
 214       }
 215       else
 216       {
 217         menu1.setLabel(MessageManager.getString("action.edit_group"));
 218         groupMenu.remove(createGroupMenuItem);
 219       }
 220
 221     }
 222     else
 223     {
 224       remove(hideSeqs);
 225       remove(groupMenu);
 226     }
 227
 228     if (links != null && links.size() > 0)
 229     {
 230       Menu linkMenu = new Menu(MessageManager.getString("action.link"));
 231       String link;
 232       for (int i = 0; i < links.size(); i++)
 233       {
 234         link = links.elementAt(i).toString();
 235         UrlLink urlLink = new UrlLink(link);
 236         if (!urlLink.isValid())
 237         {
 238           System.err.println(urlLink.getInvalidMessage());
 239           continue;
 240         }
 241         final String target = urlLink.getTarget(); // link.substring(0,
 242         // link.indexOf("|"));
 243         final String label = urlLink.getLabel();
 244         if (seq != null && urlLink.isDynamic())
 245         {
 246
 247           // collect matching db-refs
 248           DBRefEntry[] dbr = jalview.util.DBRefUtils.selectRefs(
 249                   seq.getDBRef(), new String[]
 250                   { target });
 251           // collect id string too
 252           String id = seq.getName();
 253           String descr = seq.getDescription();
 254           if (descr != null && descr.length() < 1)
 255           {
 256             descr = null;
 257           }
 258           if (dbr != null)
 259           {
 260             for (int r = 0; r < dbr.length; r++)
 261             {
 262               if (id != null && dbr[r].getAccessionId().equals(id))
 263               {
 264                 // suppress duplicate link creation for the bare sequence ID
 265                 // string with this link
 266                 id = null;
 267               }
 268               // create Bare ID link for this RUL
 269               String[] urls = urlLink.makeUrls(dbr[r].getAccessionId(),
 270                       true);
 271               if (urls != null)
 272               {
 273                 for (int u = 0; u < urls.length; u += 2)
 274                 {
 275                   addshowLink(linkMenu, label + "|" + urls[u], urls[u + 1]);
 276                 }
 277               }
 278             }
 279           }
 280           if (id != null)
 281           {
 282             // create Bare ID link for this RUL
 283             String[] urls = urlLink.makeUrls(id, true);
 284             if (urls != null)
 285             {
 286               for (int u = 0; u < urls.length; u += 2)
 287               {
 288                 addshowLink(linkMenu, label, urls[u + 1]);
 289               }
 290             }
 291             // addshowLink(linkMenu, target, url_pref + id + url_suff);
 292           }
 293           // Now construct URLs from description but only try to do it for regex
 294           // URL links
 295           if (descr != null && urlLink.getRegexReplace() != null)
 296           {
 297             // create link for this URL from description only if regex matches
 298             String[] urls = urlLink.makeUrls(descr, true);
 299             if (urls != null)
 300             {
 301               for (int u = 0; u < urls.length; u += 2)
 302               {
 303                 addshowLink(linkMenu, label, urls[u + 1]);
 304               }
 305             }
 306           }
 307         }
 308         else
 309         {
 310           addshowLink(linkMenu, target, urlLink.getUrl_prefix()); // link.substring(link.lastIndexOf("|")+1));
 311         }
 312         /*
 313          * final String url;
 314          *
 315          * if (link.indexOf("$SEQUENCE_ID$") > -1) { // Substitute SEQUENCE_ID
 316          * string and any matching database reference accessions String url_pref
 317          * = link.substring(link.indexOf("|") + 1,
 318          * link.indexOf("$SEQUENCE_ID$"));
 319          *
 320          * String url_suff = link.substring(link.indexOf("$SEQUENCE_ID$") + 13);
 321          * // collect matching db-refs DBRefEntry[] dbr =
 322          * jalview.util.DBRefUtils.selectRefs(seq.getDBRef(), new
 323          * String[]{target}); // collect id string too String id =
 324          * seq.getName(); if (id.indexOf("|") > -1) { id =
 325          * id.substring(id.lastIndexOf("|") + 1); } if (dbr!=null) { for (int
 326          * r=0;r<dbr.length; r++) { if (dbr[r].getAccessionId().equals(id)) { //
 327          * suppress duplicate link creation for the bare sequence ID string with
 328          * this link id = null; } addshowLink(linkMenu,
 329          * dbr[r].getSource()+"|"+dbr[r].getAccessionId(), target,
 330          * url_pref+dbr[r].getAccessionId()+url_suff); } } if (id!=null) { //
 331          * create Bare ID link for this RUL addshowLink(linkMenu, target,
 332          * url_pref + id + url_suff); } } else { addshowLink(linkMenu, target,
 333          * link.substring(link.lastIndexOf("|")+1)); }
 334          */
 335       }
 336       if (linkMenu.getItemCount() > 0)
 337       {
 338         if (seq != null)
 339         {
 340           seqMenu.add(linkMenu);
 341         }
 342         else
 343         {
 344           add(linkMenu);
 345         }
 346       }
 347     }
 348     // TODO: add group link menu entry here
 349     if (seq != null)
 350     {
 351       seqMenu.setLabel(seq.getName());
 352       if (seq == ap.av.getAlignment().getSeqrep())
 353       {
 354         makeReferenceSeq.setLabel(MessageManager
 355                 .getString("action.unmark_as_reference"));// Unmark
 356                                                           // representative");
 357       }
 358       else
 359       {
 360         makeReferenceSeq.setLabel(MessageManager
 361                 .getString("action.set_as_reference")); // );
 362       }
 363       repGroup.setLabel(MessageManager.formatMessage(
 364               "label.represent_group_with", new String[]
 365               { seq.getName() }));
 366     }
 367     else
 368     {
 369       remove(seqMenu);
 370     }
 371
 372     if (!ap.av.hasHiddenRows())
 373     {
 374       remove(revealAll);
 375       remove(revealSeq);
 376     }
 377     else
 378     {
 379       final int index = ap.av.getAlignment().findIndex(seq);
 380
 381       if (ap.av.adjustForHiddenSeqs(index)
 382               - ap.av.adjustForHiddenSeqs(index - 1) > 1)
 383       {
 384         revealSeq_index = index;
 385       }
 386       else
 387       {
 388         remove(revealSeq);
 389       }
 390     }
 391   }
 392
 393   /**
 394    * add a show URL menu item to the given linkMenu
 395    *
 396    * @param linkMenu
 397    * @param target
 398    *          - menu label string
 399    * @param url
 400    *          - url to open
 401    */
 402   private void addshowLink(Menu linkMenu, final String target,
 403           final String url)
 404   {
 405     addshowLink(linkMenu, target, target, url);
 406   }
 407
 408   /**
 409    * add a show URL menu item to the given linkMenu
 410    *
 411    * @param linkMenu
 412    * @param target
 413    *          - URL target window
 414    * @param label
 415    *          - menu label string
 416    * @param url
 417    *          - url to open
 418    */
 419   private void addshowLink(Menu linkMenu, final String target,
 420           final String label, final String url)
 421   {
 422     MenuItem item = new MenuItem(label);
 423     item.addActionListener(new java.awt.event.ActionListener()
 424     {
 425       public void actionPerformed(ActionEvent e)
 426       {
 427         ap.alignFrame.showURL(url, target);
 428       }
 429     });
 430     linkMenu.add(item);
 431   }
 432
 433   public void itemStateChanged(ItemEvent evt)
 434   {
 435     if (evt.getSource() == abovePIDColour)
 436     {
 437       abovePIDColour_itemStateChanged();
 438     }
 439     else if (evt.getSource() == showColourText)
 440     {
 441       showColourText_itemStateChanged();
 442     }
 443     else if (evt.getSource() == showText)
 444     {
 445       showText_itemStateChanged();
 446     }
 447     else if (evt.getSource() == showBoxes)
 448     {
 449       showBoxes_itemStateChanged();
 450     }
 451     else if (evt.getSource() == displayNonconserved)
 452     {
 453       this.showNonconserved_itemStateChanged();
 454     }
 455   }
 456
 457   public void actionPerformed(ActionEvent evt)
 458   {
 459     Object source = evt.getSource();
 460     if (source == clustalColour)
 461     {
 462       clustalColour_actionPerformed();
 463     }
 464     else if (source == zappoColour)
 465     {
 466       zappoColour_actionPerformed();
 467     }
 468     else if (source == taylorColour)
 469     {
 470       taylorColour_actionPerformed();
 471     }
 472     else if (source == hydrophobicityColour)
 473     {
 474       hydrophobicityColour_actionPerformed();
 475     }
 476     else if (source == helixColour)
 477     {
 478       helixColour_actionPerformed();
 479     }
 480     else if (source == strandColour)
 481     {
 482       strandColour_actionPerformed();
 483     }
 484     else if (source == turnColour)
 485     {
 486       turnColour_actionPerformed();
 487     }
 488     else if (source == buriedColour)
 489     {
 490       buriedColour_actionPerformed();
 491     }
 492     else if (source == nucleotideMenuItem)
 493     {
 494       nucleotideMenuItem_actionPerformed();
 495     }
 496
 497     else if (source == userDefinedColour)
 498     {
 499       userDefinedColour_actionPerformed();
 500     }
 501     else if (source == PIDColour)
 502     {
 503       PIDColour_actionPerformed();
 504     }
 505     else if (source == BLOSUM62Colour)
 506     {
 507       BLOSUM62Colour_actionPerformed();
 508     }
 509     else if (source == noColourmenuItem)
 510     {
 511       noColourmenuItem_actionPerformed();
 512     }
 513     else if (source == conservationMenuItem)
 514     {
 515       conservationMenuItem_itemStateChanged();
 516     }
 517     else if (source == unGroupMenuItem)
 518     {
 519       unGroupMenuItem_actionPerformed();
 520     }
 521
 522     else if (source == createGroupMenuItem)
 523     {
 524       createGroupMenuItem_actionPerformed();
 525     }
 526
 527     else if (source == sequenceName)
 528     {
 529       editName();
 530     }
 531     else if (source == makeReferenceSeq)
 532     {
 533       makeReferenceSeq_actionPerformed();
 534     }
 535     else if (source == sequenceDetails)
 536     {
 537       showSequenceDetails();
 538     }
 539     else if (source == selSeqDetails)
 540     {
 541       showSequenceSelectionDetails();
 542     }
 543     else if (source == pdb)
 544     {
 545       addPDB();
 546     }
 547     else if (source == hideSeqs)
 548     {
 549       hideSequences(false);
 550     }
 551     else if (source == repGroup)
 552     {
 553       hideSequences(true);
 554     }
 555     else if (source == revealSeq)
 556     {
 557       ap.av.showSequence(revealSeq_index);
 558     }
 559     else if (source == revealAll)
 560     {
 561       ap.av.showAllHiddenSeqs();
 562     }
 563
 564     else if (source == editGroupName)
 565     {
 566       EditNameDialog dialog = new EditNameDialog(getGroup().getName(),
 567               getGroup().getDescription(), "       Group Name",
 568               "Group Description", ap.alignFrame,
 569               "Edit Group Name / Description", 500, 100, true);
 570
 571       if (dialog.accept)
 572       {
 573         getGroup().setName(dialog.getName().replace(' ', '_'));
 574         getGroup().setDescription(dialog.getDescription());
 575       }
 576
 577     }
 578     else if (source == copy)
 579     {
 580       ap.alignFrame.copy_actionPerformed();
 581     }
 582     else if (source == cut)
 583     {
 584       ap.alignFrame.cut_actionPerformed();
 585     }
 586     else if (source == editSequence)
 587     {
 588       SequenceGroup sg = ap.av.getSelectionGroup();
 589
 590       if (sg != null)
 591       {
 592         if (seq == null)
 593         {
 594           seq = (Sequence) sg.getSequenceAt(0);
 595         }
 596
 597         EditNameDialog dialog = new EditNameDialog(seq.getSequenceAsString(
 598                 sg.getStartRes(), sg.getEndRes() + 1), null,
 599                 "Edit Sequence ", null,
 600
 601                 ap.alignFrame, "Edit Sequence", 500, 100, true);
 602
 603         if (dialog.accept)
 604         {
 605           EditCommand editCommand = new EditCommand(MessageManager.getString("label.edit_sequences"),
 606                   Action.REPLACE, dialog.getName().replace(' ',
 607                           ap.av.getGapCharacter()),
 608                   sg.getSequencesAsArray(ap.av.getHiddenRepSequences()),
 609                   sg.getStartRes(), sg.getEndRes() + 1,
 610                   ap.av.getAlignment());
 611
 612           ap.alignFrame.addHistoryItem(editCommand);
 613
 614           ap.av.firePropertyChange("alignment", null, ap.av.getAlignment()
 615                   .getSequences());
 616         }
 617       }
 618     }
 619     else if (source == toUpper || source == toLower || source == toggleCase)
 620     {
 621       SequenceGroup sg = ap.av.getSelectionGroup();
 622       if (sg != null)
 623       {
 624         List<int[]> startEnd = ap.av.getVisibleRegionBoundaries(
 625                 sg.getStartRes(), sg.getEndRes() + 1);
 626
 627         String description;
 628         int caseChange;
 629
 630         if (source == toggleCase)
 631         {
 632           description = "Toggle Case";
 633           caseChange = ChangeCaseCommand.TOGGLE_CASE;
 634         }
 635         else if (source == toUpper)
 636         {
 637           description = "To Upper Case";
 638           caseChange = ChangeCaseCommand.TO_UPPER;
 639         }
 640         else
 641         {
 642           description = "To Lower Case";
 643           caseChange = ChangeCaseCommand.TO_LOWER;
 644         }
 645
 646         ChangeCaseCommand caseCommand = new ChangeCaseCommand(description,
 647                 sg.getSequencesAsArray(ap.av.getHiddenRepSequences()),
 648                 startEnd, caseChange);
 649
 650         ap.alignFrame.addHistoryItem(caseCommand);
 651
 652         ap.av.firePropertyChange("alignment", null, ap.av.getAlignment()
 653                 .getSequences());
 654
 655       }
 656     }
 657     else if (source == sequenceFeature)
 658     {
 659       SequenceGroup sg = ap.av.getSelectionGroup();
 660       if (sg == null)
 661       {
 662         return;
 663       }
 664
 665       int rsize = 0, gSize = sg.getSize();
 666       SequenceI[] rseqs, seqs = new SequenceI[gSize];
 667       SequenceFeature[] tfeatures, features = new SequenceFeature[gSize];
 668
 669       for (int i = 0; i < gSize; i++)
 670       {
 671         int start = sg.getSequenceAt(i).findPosition(sg.getStartRes());
 672         int end = sg.findEndRes(sg.getSequenceAt(i));
 673         if (start <= end)
 674         {
 675           seqs[rsize] = sg.getSequenceAt(i);
 676           features[rsize] = new SequenceFeature(null, null, null, start,
 677                   end, "Jalview");
 678           rsize++;
 679         }
 680       }
 681       rseqs = new SequenceI[rsize];
 682       tfeatures = new SequenceFeature[rsize];
 683       System.arraycopy(seqs, 0, rseqs, 0, rsize);
 684       System.arraycopy(features, 0, tfeatures, 0, rsize);
 685       features = tfeatures;
 686       seqs = rseqs;
 687
 688       if (ap.seqPanel.seqCanvas.getFeatureRenderer().amendFeatures(seqs,
 689               features, true, ap))
 690       {
 691         ap.alignFrame.sequenceFeatures.setState(true);
 692         ap.av.setShowSequenceFeatures(true);;
 693         ap.highlightSearchResults(null);
 694       }
 695     }
 696     else
 697     {
 698       outputText(evt);
 699     }
 700
 701   }
 702
 703   void outputText(ActionEvent e)
 704   {
 705     CutAndPasteTransfer cap = new CutAndPasteTransfer(true, ap.alignFrame);
 706
 707     Frame frame = new Frame();
 708     frame.add(cap);
 709     jalview.bin.JalviewLite.addFrame(frame, MessageManager.formatMessage(
 710             "label.selection_output_command", new String[]
 711             { e.getActionCommand() }), 600, 500);
 712     // JBPNote: getSelectionAsNewSequence behaviour has changed - this method
 713     // now returns a full copy of sequence data
 714     // TODO consider using getSequenceSelection instead here
 715
 716     cap.setText(new jalview.io.AppletFormatAdapter().formatSequences(
 717             e.getActionCommand(), ap.av.getShowJVSuffix(), ap.av, true));
 718
 719   }
 720
 721   protected void showSequenceSelectionDetails()
 722   {
 723     createSequenceDetailsReport(ap.av.getSequenceSelection());
 724   }
 725
 726   protected void showSequenceDetails()
 727   {
 728     createSequenceDetailsReport(new SequenceI[]
 729     { seq });
 730   }
 731
 732   public void createSequenceDetailsReport(SequenceI[] sequences)
 733   {
 734
 735     CutAndPasteTransfer cap = new CutAndPasteTransfer(false, ap.alignFrame);
 736
 737     StringBuffer contents = new StringBuffer();
 738     for (SequenceI seq : sequences)
 739     {
 740       contents.append(MessageManager.formatMessage(
 741               "label.annotation_for_displayid", new String[]
 742               { seq.getDisplayId(true) }));
 743       new SequenceAnnotationReport(null)
 744               .createSequenceAnnotationReport(
 745                       contents,
 746                       seq,
 747                       true,
 748                       true,
 749                       false,
 750                       (ap.seqPanel.seqCanvas.fr != null) ? ap.seqPanel.seqCanvas.fr.getMinMax()
 751                               : null);
 752       contents.append("</p>");
 753     }
 754     Frame frame = new Frame();
 755     frame.add(cap);
 756     jalview.bin.JalviewLite.addFrame(frame, "Sequence Details for "
 757             + (sequences.length == 1 ? sequences[0].getDisplayId(true)
 758                     : "Selection"), 600, 500);
 759     cap.setText(MessageManager.formatMessage("label.html_content",
 760             new String[]
 761             { contents.toString() }));
 762   }
 763
 764   void editName()
 765   {
 766     EditNameDialog dialog = new EditNameDialog(seq.getName(),
 767             seq.getDescription(), "       Sequence Name",
 768             "Sequence Description", ap.alignFrame,
 769             "Edit Sequence Name / Description", 500, 100, true);
 770
 771     if (dialog.accept)
 772     {
 773       seq.setName(dialog.getName());
 774       seq.setDescription(dialog.getDescription());
 775       ap.paintAlignment(false);
 776     }
 777   }
 778
 779   void addPDB()
 780   {
 781     if (seq.getPDBId() != null)
 782     {
 783       PDBEntry entry = (PDBEntry) seq.getPDBId().firstElement();
 784
 785       if (ap.av.applet.jmolAvailable)
 786       {
 787         new jalview.appletgui.AppletJmol(entry, new Sequence[]
 788         { seq }, null, ap, AppletFormatAdapter.URL);
 789       }
 790       else
 791       {
 792         new MCview.AppletPDBViewer(entry, new Sequence[]
 793         { seq }, null, ap, AppletFormatAdapter.URL);
 794       }
 795
 796     }
 797     else
 798     {
 799       CutAndPasteTransfer cap = new CutAndPasteTransfer(true, ap.alignFrame);
 800       cap.setText(MessageManager.getString("label.paste_pdb_file"));
 801       cap.setPDBImport(seq);
 802       Frame frame = new Frame();
 803       frame.add(cap);
 804       jalview.bin.JalviewLite.addFrame(frame, MessageManager.formatMessage(
 805               "label.paste_pdb_file_for_sequence", new String[]
 806               { seq.getName() }), 400, 300);
 807     }
 808   }
 809
 810   private void jbInit() throws Exception
 811   {
 812     groupMenu.setLabel(MessageManager.getString("label.selection"));
 813     sequenceFeature.addActionListener(this);
 814
 815     editGroupName.addActionListener(this);
 816     unGroupMenuItem.setLabel(MessageManager
 817             .getString("action.remove_group"));
 818     unGroupMenuItem.addActionListener(this);
 819
 820     createGroupMenuItem.setLabel(MessageManager
 821             .getString("action.create_group"));
 822     createGroupMenuItem.addActionListener(this);
 823
 824     nucleotideMenuItem.setLabel(MessageManager
 825             .getString("label.nucleotide"));
 826     nucleotideMenuItem.addActionListener(this);
 827     conservationMenuItem.addItemListener(this);
 828     abovePIDColour.addItemListener(this);
 829     colourMenu.setLabel(MessageManager.getString("label.group_colour"));
 830     showBoxes.setLabel(MessageManager.getString("action.boxes"));
 831     showBoxes.setState(true);
 832     showBoxes.addItemListener(this);
 833     sequenceName.addActionListener(this);
 834     sequenceDetails.addActionListener(this);
 835     selSeqDetails.addActionListener(this);
 836     displayNonconserved.setLabel(MessageManager
 837             .getString("label.show_non_conversed"));
 838     displayNonconserved.setState(false);
 839     displayNonconserved.addItemListener(this);
 840     showText.setLabel(MessageManager.getString("action.text"));
 841     showText.addItemListener(this);
 842     showColourText.setLabel(MessageManager.getString("label.colour_text"));
 843     showColourText.addItemListener(this);
 844     outputmenu.setLabel(MessageManager.getString("label.out_to_textbox"));
 845     seqMenu.setLabel(MessageManager.getString("label.sequence"));
 846     pdb.setLabel(MessageManager.getString("label.view_pdb_structure"));
 847     hideSeqs.setLabel(MessageManager.getString("action.hide_sequences"));
 848     repGroup.setLabel(MessageManager.formatMessage(
 849             "label.represent_group_with", new String[]
 850             { "" }));
 851     revealAll.setLabel(MessageManager.getString("action.reveal_all"));
 852     revealSeq.setLabel(MessageManager.getString("action.reveal_sequences"));
 853     menu1.setLabel(MessageManager.getString("label.group") + ":");
 854     add(groupMenu);
 855     this.add(seqMenu);
 856     this.add(hideSeqs);
 857     this.add(revealSeq);
 858     this.add(revealAll);
 859     // groupMenu.add(selSeqDetails);
 860     groupMenu.add(editMenu);
 861     groupMenu.add(outputmenu);
 862     groupMenu.add(sequenceFeature);
 863     groupMenu.add(createGroupMenuItem);
 864     groupMenu.add(unGroupMenuItem);
 865     groupMenu.add(menu1);
 866
 867     colourMenu.add(noColourmenuItem);
 868     colourMenu.add(clustalColour);
 869     colourMenu.add(BLOSUM62Colour);
 870     colourMenu.add(PIDColour);
 871     colourMenu.add(zappoColour);
 872     colourMenu.add(taylorColour);
 873     colourMenu.add(hydrophobicityColour);
 874     colourMenu.add(helixColour);
 875     colourMenu.add(strandColour);
 876     colourMenu.add(turnColour);
 877     colourMenu.add(buriedColour);
 878     colourMenu.add(nucleotideMenuItem);
 879     colourMenu.add(userDefinedColour);
 880     colourMenu.addSeparator();
 881     colourMenu.add(abovePIDColour);
 882     colourMenu.add(conservationMenuItem);
 883
 884     noColourmenuItem.setLabel(MessageManager.getString("label.none"));
 885     noColourmenuItem.addActionListener(this);
 886
 887     clustalColour.setLabel(MessageManager.getString("label.clustalx_colours"));
 888     clustalColour.addActionListener(this);
 889     zappoColour.setLabel(MessageManager.getString("label.zappo"));
 890     zappoColour.addActionListener(this);
 891     taylorColour.setLabel(MessageManager.getString("label.taylor"));
 892     taylorColour.addActionListener(this);
 893     hydrophobicityColour.setLabel(MessageManager.getString("label.hydrophobicity"));
 894     hydrophobicityColour.addActionListener(this);
 895     helixColour.setLabel(MessageManager.getString("label.helix_propensity"));
 896     helixColour.addActionListener(this);
 897     strandColour.setLabel(MessageManager.getString("label.strand_propensity"));
 898     strandColour.addActionListener(this);
 899     turnColour.setLabel(MessageManager.getString("label.turn_propensity"));
 900     turnColour.addActionListener(this);
 901     buriedColour.setLabel(MessageManager.getString("label.buried_index"));
 902     buriedColour.addActionListener(this);
 903     abovePIDColour.setLabel(MessageManager.getString("label.above_identity_percentage"));
 904
 905     userDefinedColour.setLabel(MessageManager.getString("action.user_defined"));
 906     userDefinedColour.addActionListener(this);
 907     PIDColour.setLabel(MessageManager.getString("action.percentage_identity"));
 908     PIDColour.addActionListener(this);
 909     BLOSUM62Colour.setLabel("BLOSUM62");
 910     BLOSUM62Colour.addActionListener(this);
 911     conservationMenuItem.setLabel(MessageManager.getString("label.conservation"));
 912
 913     editMenu.add(copy);
 914     copy.addActionListener(this);
 915     editMenu.add(cut);
 916     cut.addActionListener(this);
 917
 918     editMenu.add(editSequence);
 919     editSequence.addActionListener(this);
 920
 921     editMenu.add(toUpper);
 922     toUpper.addActionListener(this);
 923     editMenu.add(toLower);
 924     toLower.addActionListener(this);
 925     editMenu.add(toggleCase);
 926     seqMenu.add(sequenceName);
 927     seqMenu.add(makeReferenceSeq);
 928     // seqMenu.add(sequenceDetails);
 929
 930     if (!ap.av.applet.useXtrnalSviewer)
 931     {
 932       seqMenu.add(pdb);
 933     }
 934     seqMenu.add(repGroup);
 935     menu1.add(editGroupName);
 936     menu1.add(colourMenu);
 937     menu1.add(showBoxes);
 938     menu1.add(showText);
 939     menu1.add(showColourText);
 940     menu1.add(displayNonconserved);
 941     toggleCase.addActionListener(this);
 942     pdb.addActionListener(this);
 943     hideSeqs.addActionListener(this);
 944     repGroup.addActionListener(this);
 945     revealAll.addActionListener(this);
 946     revealSeq.addActionListener(this);
 947     makeReferenceSeq.addActionListener(this);
 948   }
 949
 950   void refresh()
 951   {
 952     ap.paintAlignment(true);
 953   }
 954
 955   protected void clustalColour_actionPerformed()
 956   {
 957     SequenceGroup sg = getGroup();
 958     sg.cs = new ClustalxColourScheme(sg, ap.av.getHiddenRepSequences());
 959     refresh();
 960   }
 961
 962   protected void zappoColour_actionPerformed()
 963   {
 964     getGroup().cs = new ZappoColourScheme();
 965     refresh();
 966   }
 967
 968   protected void taylorColour_actionPerformed()
 969   {
 970     getGroup().cs = new TaylorColourScheme();
 971     refresh();
 972   }
 973
 974   protected void hydrophobicityColour_actionPerformed()
 975   {
 976     getGroup().cs = new HydrophobicColourScheme();
 977     refresh();
 978   }
 979
 980   protected void helixColour_actionPerformed()
 981   {
 982     getGroup().cs = new HelixColourScheme();
 983     refresh();
 984   }
 985
 986   protected void strandColour_actionPerformed()
 987   {
 988     getGroup().cs = new StrandColourScheme();
 989     refresh();
 990   }
 991
 992   protected void turnColour_actionPerformed()
 993   {
 994     getGroup().cs = new TurnColourScheme();
 995     refresh();
 996   }
 997
 998   protected void buriedColour_actionPerformed()
 999   {
1000     getGroup().cs = new BuriedColourScheme();
1001     refresh();
1002   }
1003
1004   public void nucleotideMenuItem_actionPerformed()
1005   {
1006     getGroup().cs = new NucleotideColourScheme();
1007     refresh();
1008   }
1009
1010   protected void abovePIDColour_itemStateChanged()
1011   {
1012     SequenceGroup sg = getGroup();
1013     if (sg.cs == null)
1014     {
1015       return;
1016     }
1017
1018     if (abovePIDColour.getState())
1019     {
1020       sg.cs.setConsensus(AAFrequency.calculate(sg.getSequences(ap.av
1021               .getHiddenRepSequences()), 0, ap.av.getAlignment().getWidth()));
1022       int threshold = SliderPanel.setPIDSliderSource(ap, sg.cs, getGroup()
1023               .getName());
1024
1025       sg.cs.setThreshold(threshold, ap.av.isIgnoreGapsConsensus());
1026
1027       SliderPanel.showPIDSlider();
1028
1029     }
1030     else
1031     // remove PIDColouring
1032     {
1033       sg.cs.setThreshold(0, ap.av.isIgnoreGapsConsensus());
1034     }
1035
1036     refresh();
1037
1038   }
1039
1040   protected void userDefinedColour_actionPerformed()
1041   {
1042     new UserDefinedColours(ap, getGroup());
1043   }
1044
1045   protected void PIDColour_actionPerformed()
1046   {
1047     SequenceGroup sg = getGroup();
1048     sg.cs = new PIDColourScheme();
1049     sg.cs.setConsensus(AAFrequency.calculate(sg.getSequences(ap.av
1050             .getHiddenRepSequences()), 0, ap.av.getAlignment().getWidth()));
1051     refresh();
1052   }
1053
1054   protected void BLOSUM62Colour_actionPerformed()
1055   {
1056     SequenceGroup sg = getGroup();
1057
1058     sg.cs = new Blosum62ColourScheme();
1059
1060     sg.cs.setConsensus(AAFrequency.calculate(sg.getSequences(ap.av
1061             .getHiddenRepSequences()), 0, ap.av.getAlignment().getWidth()));
1062
1063     refresh();
1064   }
1065
1066   protected void noColourmenuItem_actionPerformed()
1067   {
1068     getGroup().cs = null;
1069     refresh();
1070   }
1071
1072   protected void conservationMenuItem_itemStateChanged()
1073   {
1074     SequenceGroup sg = getGroup();
1075     if (sg.cs == null)
1076     {
1077       return;
1078     }
1079
1080     if (conservationMenuItem.getState())
1081     {
1082
1083       sg.cs.setConservation(Conservation.calculateConservation("Group",
1084               ResidueProperties.propHash, 3, sg.getSequences(ap.av
1085                       .getHiddenRepSequences()), 0, ap.av.getAlignment()
1086                       .getWidth(), false, ap.av.getConsPercGaps(), false));
1087       SliderPanel.setConservationSlider(ap, sg.cs, sg.getName());
1088       SliderPanel.showConservationSlider();
1089     }
1090     else
1091     // remove ConservationColouring
1092     {
1093       sg.cs.setConservation(null);
1094     }
1095
1096     refresh();
1097   }
1098
1099   SequenceGroup getGroup()
1100   {
1101     SequenceGroup sg = ap.av.getSelectionGroup();
1102
1103     // this method won't add a new group if it already exists
1104     if (sg != null)
1105     {
1106       ap.av.getAlignment().addGroup(sg);
1107     }
1108
1109     return sg;
1110   }
1111
1112   void unGroupMenuItem_actionPerformed()
1113   {
1114     SequenceGroup sg = ap.av.getSelectionGroup();
1115     ap.av.getAlignment().deleteGroup(sg);
1116     ap.av.setSelectionGroup(null);
1117     ap.paintAlignment(true);
1118   }
1119
1120   void createGroupMenuItem_actionPerformed()
1121   {
1122     getGroup(); // implicitly create group
1123     refresh();
1124   }
1125
1126   public void showColourText_itemStateChanged()
1127   {
1128     getGroup().setColourText(showColourText.getState());
1129     refresh();
1130   }
1131
1132   public void showText_itemStateChanged()
1133   {
1134     getGroup().setDisplayText(showText.getState());
1135     refresh();
1136   }
1137   public void makeReferenceSeq_actionPerformed()
1138   {
1139     if (!ap.av.getAlignment().hasSeqrep())
1140     {
1141       // initialise the display flags so the user sees something happen
1142       ap.av.setDisplayReferenceSeq(true);
1143       ap.av.setColourByReferenceSeq(true);
1144       ap.av.getAlignment().setSeqrep(seq);
1145     }
1146     else
1147     {
1148       if (ap.av.getAlignment().getSeqrep() == seq)
1149       {
1150         ap.av.getAlignment().setSeqrep(null);
1151       }
1152       else
1153       {
1154         ap.av.getAlignment().setSeqrep(seq);
1155       }
1156     }
1157     refresh();
1158   }
1159
1160   public void showNonconserved_itemStateChanged()
1161   {
1162     getGroup().setShowNonconserved(this.displayNonconserved.getState());
1163     refresh();
1164   }
1165
1166   public void showBoxes_itemStateChanged()
1167   {
1168     getGroup().setDisplayBoxes(showBoxes.getState());
1169     refresh();
1170   }
1171
1172   void hideSequences(boolean representGroup)
1173   {
1174     SequenceGroup sg = ap.av.getSelectionGroup();
1175     if (sg == null || sg.getSize() < 1)
1176     {
1177       ap.av.hideSequence(new SequenceI[]
1178       { seq });
1179       return;
1180     }
1181
1182     ap.av.setSelectionGroup(null);
1183
1184     if (representGroup)
1185     {
1186       ap.av.hideRepSequences(seq, sg);
1187
1188       return;
1189     }
1190
1191     int gsize = sg.getSize();
1192     SequenceI[] hseqs;
1193
1194     hseqs = new SequenceI[gsize];
1195
1196     int index = 0;
1197     for (int i = 0; i < gsize; i++)
1198     {
1199       hseqs[index++] = sg.getSequenceAt(i);
1200     }
1201
1202     ap.av.hideSequence(hseqs);
1203     ap.av.sendSelection();
1204   }
1205
1206 }