src/jalview/gui/AlignFrame.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.AlignmentSorter;
  24 import jalview.analysis.AlignmentUtils;
  25 import jalview.analysis.CrossRef;
  26 import jalview.analysis.Dna;
  27 import jalview.analysis.ParseProperties;
  28 import jalview.analysis.SequenceIdMatcher;
  29 import jalview.api.AlignExportSettingI;
  30 import jalview.api.AlignViewControllerGuiI;
  31 import jalview.api.AlignViewControllerI;
  32 import jalview.api.AlignViewportI;
  33 import jalview.api.AlignmentViewPanel;
  34 import jalview.api.FeatureSettingsControllerI;
  35 import jalview.api.SplitContainerI;
  36 import jalview.api.ViewStyleI;
  37 import jalview.api.analysis.ScoreModelI;
  38 import jalview.api.analysis.SimilarityParamsI;
  39 import jalview.bin.Cache;
  40 import jalview.bin.Jalview;
  41 import jalview.commands.CommandI;
  42 import jalview.commands.EditCommand;
  43 import jalview.commands.EditCommand.Action;
  44 import jalview.commands.OrderCommand;
  45 import jalview.commands.RemoveGapColCommand;
  46 import jalview.commands.RemoveGapsCommand;
  47 import jalview.commands.SlideSequencesCommand;
  48 import jalview.commands.TrimRegionCommand;
  49 import jalview.datamodel.AlignedCodonFrame;
  50 import jalview.datamodel.Alignment;
  51 import jalview.datamodel.AlignmentAnnotation;
  52 import jalview.datamodel.AlignmentExportData;
  53 import jalview.datamodel.AlignmentI;
  54 import jalview.datamodel.AlignmentOrder;
  55 import jalview.datamodel.AlignmentView;
  56 import jalview.datamodel.ColumnSelection;
  57 import jalview.datamodel.HiddenSequences;
  58 import jalview.datamodel.PDBEntry;
  59 import jalview.datamodel.SeqCigar;
  60 import jalview.datamodel.Sequence;
  61 import jalview.datamodel.SequenceGroup;
  62 import jalview.datamodel.SequenceI;
  63 import jalview.gui.ColourMenuHelper.ColourChangeListener;
  64 import jalview.gui.ViewSelectionMenu.ViewSetProvider;
  65 import jalview.io.AlignmentProperties;
  66 import jalview.io.AnnotationFile;
  67 import jalview.io.BioJsHTMLOutput;
  68 import jalview.io.DataSourceType;
  69 import jalview.io.FileFormat;
  70 import jalview.io.FileFormatI;
  71 import jalview.io.FileFormats;
  72 import jalview.io.FileLoader;
  73 import jalview.io.FileParse;
  74 import jalview.io.FormatAdapter;
  75 import jalview.io.HtmlSvgOutput;
  76 import jalview.io.IdentifyFile;
  77 import jalview.io.JPredFile;
  78 import jalview.io.JalviewFileChooser;
  79 import jalview.io.JalviewFileView;
  80 import jalview.io.JnetAnnotationMaker;
  81 import jalview.io.NewickFile;
  82 import jalview.io.ScoreMatrixFile;
  83 import jalview.io.TCoffeeScoreFile;
  84 import jalview.jbgui.GAlignFrame;
  85 import jalview.schemes.ColourSchemeI;
  86 import jalview.schemes.ColourSchemes;
  87 import jalview.schemes.ResidueColourScheme;
  88 import jalview.schemes.TCoffeeColourScheme;
  89 import jalview.util.MessageManager;
  90 import jalview.viewmodel.AlignmentViewport;
  91 import jalview.viewmodel.ViewportRanges;
  92 import jalview.ws.DBRefFetcher;
  93 import jalview.ws.DBRefFetcher.FetchFinishedListenerI;
  94 import jalview.ws.jws1.Discoverer;
  95 import jalview.ws.jws2.Jws2Discoverer;
  96 import jalview.ws.jws2.jabaws2.Jws2Instance;
  97 import jalview.ws.seqfetcher.DbSourceProxy;
  98
  99 import java.awt.BorderLayout;
 100 import java.awt.Component;
 101 import java.awt.Rectangle;
 102 import java.awt.Toolkit;
 103 import java.awt.datatransfer.Clipboard;
 104 import java.awt.datatransfer.DataFlavor;
 105 import java.awt.datatransfer.StringSelection;
 106 import java.awt.datatransfer.Transferable;
 107 import java.awt.dnd.DnDConstants;
 108 import java.awt.dnd.DropTargetDragEvent;
 109 import java.awt.dnd.DropTargetDropEvent;
 110 import java.awt.dnd.DropTargetEvent;
 111 import java.awt.dnd.DropTargetListener;
 112 import java.awt.event.ActionEvent;
 113 import java.awt.event.ActionListener;
 114 import java.awt.event.FocusAdapter;
 115 import java.awt.event.FocusEvent;
 116 import java.awt.event.ItemEvent;
 117 import java.awt.event.ItemListener;
 118 import java.awt.event.KeyAdapter;
 119 import java.awt.event.KeyEvent;
 120 import java.awt.event.MouseEvent;
 121 import java.awt.print.PageFormat;
 122 import java.awt.print.PrinterJob;
 123 import java.beans.PropertyChangeEvent;
 124 import java.io.File;
 125 import java.io.FileWriter;
 126 import java.io.PrintWriter;
 127 import java.net.URL;
 128 import java.util.ArrayList;
 129 import java.util.Arrays;
 130 import java.util.Deque;
 131 import java.util.Enumeration;
 132 import java.util.Hashtable;
 133 import java.util.List;
 134 import java.util.Vector;
 135
 136 import javax.swing.JCheckBoxMenuItem;
 137 import javax.swing.JEditorPane;
 138 import javax.swing.JInternalFrame;
 139 import javax.swing.JLayeredPane;
 140 import javax.swing.JMenu;
 141 import javax.swing.JMenuItem;
 142 import javax.swing.JScrollPane;
 143 import javax.swing.SwingUtilities;
 144
 145 /**
 146  * DOCUMENT ME!
 147  *
 148  * @author $author$
 149  * @version $Revision$
 150  */
 151 public class AlignFrame extends GAlignFrame implements DropTargetListener,
 152         IProgressIndicator, AlignViewControllerGuiI, ColourChangeListener
 153 {
 154
 155   public static final int DEFAULT_WIDTH = 700;
 156
 157   public static final int DEFAULT_HEIGHT = 500;
 158
 159   /*
 160    * The currently displayed panel (selected tabbed view if more than one)
 161    */
 162   public AlignmentPanel alignPanel;
 163
 164   AlignViewport viewport;
 165
 166   ViewportRanges vpRanges;
 167
 168   public AlignViewControllerI avc;
 169
 170   List<AlignmentPanel> alignPanels = new ArrayList<AlignmentPanel>();
 171
 172   /**
 173    * Last format used to load or save alignments in this window
 174    */
 175   FileFormatI currentFileFormat = null;
 176
 177   /**
 178    * Current filename for this alignment
 179    */
 180   String fileName = null;
 181
 182   /**
 183    * Creates a new AlignFrame object with specific width and height.
 184    *
 185    * @param al
 186    * @param width
 187    * @param height
 188    */
 189   public AlignFrame(AlignmentI al, int width, int height)
 190   {
 191     this(al, null, width, height);
 192   }
 193
 194   /**
 195    * Creates a new AlignFrame object with specific width, height and
 196    * sequenceSetId
 197    *
 198    * @param al
 199    * @param width
 200    * @param height
 201    * @param sequenceSetId
 202    */
 203   public AlignFrame(AlignmentI al, int width, int height,
 204           String sequenceSetId)
 205   {
 206     this(al, null, width, height, sequenceSetId);
 207   }
 208
 209   /**
 210    * Creates a new AlignFrame object with specific width, height and
 211    * sequenceSetId
 212    *
 213    * @param al
 214    * @param width
 215    * @param height
 216    * @param sequenceSetId
 217    * @param viewId
 218    */
 219   public AlignFrame(AlignmentI al, int width, int height,
 220           String sequenceSetId, String viewId)
 221   {
 222     this(al, null, width, height, sequenceSetId, viewId);
 223   }
 224
 225   /**
 226    * new alignment window with hidden columns
 227    *
 228    * @param al
 229    *          AlignmentI
 230    * @param hiddenColumns
 231    *          ColumnSelection or null
 232    * @param width
 233    *          Width of alignment frame
 234    * @param height
 235    *          height of frame.
 236    */
 237   public AlignFrame(AlignmentI al, ColumnSelection hiddenColumns,
 238           int width, int height)
 239   {
 240     this(al, hiddenColumns, width, height, null);
 241   }
 242
 243   /**
 244    * Create alignment frame for al with hiddenColumns, a specific width and
 245    * height, and specific sequenceId
 246    *
 247    * @param al
 248    * @param hiddenColumns
 249    * @param width
 250    * @param height
 251    * @param sequenceSetId
 252    *          (may be null)
 253    */
 254   public AlignFrame(AlignmentI al, ColumnSelection hiddenColumns,
 255           int width, int height, String sequenceSetId)
 256   {
 257     this(al, hiddenColumns, width, height, sequenceSetId, null);
 258   }
 259
 260   /**
 261    * Create alignment frame for al with hiddenColumns, a specific width and
 262    * height, and specific sequenceId
 263    *
 264    * @param al
 265    * @param hiddenColumns
 266    * @param width
 267    * @param height
 268    * @param sequenceSetId
 269    *          (may be null)
 270    * @param viewId
 271    *          (may be null)
 272    */
 273   public AlignFrame(AlignmentI al, ColumnSelection hiddenColumns,
 274           int width, int height, String sequenceSetId, String viewId)
 275   {
 276     setSize(width, height);
 277
 278     if (al.getDataset() == null)
 279     {
 280       al.setDataset(null);
 281     }
 282
 283     viewport = new AlignViewport(al, hiddenColumns, sequenceSetId, viewId);
 284
 285     alignPanel = new AlignmentPanel(this, viewport);
 286
 287     addAlignmentPanel(alignPanel, true);
 288     init();
 289   }
 290
 291   public AlignFrame(AlignmentI al, SequenceI[] hiddenSeqs,
 292           ColumnSelection hiddenColumns, int width, int height)
 293   {
 294     setSize(width, height);
 295
 296     if (al.getDataset() == null)
 297     {
 298       al.setDataset(null);
 299     }
 300
 301     viewport = new AlignViewport(al, hiddenColumns);
 302
 303     if (hiddenSeqs != null && hiddenSeqs.length > 0)
 304     {
 305       viewport.hideSequence(hiddenSeqs);
 306     }
 307     alignPanel = new AlignmentPanel(this, viewport);
 308     addAlignmentPanel(alignPanel, true);
 309     init();
 310   }
 311
 312   /**
 313    * Make a new AlignFrame from existing alignmentPanels
 314    *
 315    * @param ap
 316    *          AlignmentPanel
 317    * @param av
 318    *          AlignViewport
 319    */
 320   public AlignFrame(AlignmentPanel ap)
 321   {
 322     viewport = ap.av;
 323     alignPanel = ap;
 324     addAlignmentPanel(ap, false);
 325     init();
 326   }
 327
 328   /**
 329    * initalise the alignframe from the underlying viewport data and the
 330    * configurations
 331    */
 332   void init()
 333   {
 334     if (!Jalview.isHeadlessMode())
 335     {
 336       progressBar = new ProgressBar(this.statusPanel, this.statusBar);
 337     }
 338
 339     vpRanges = viewport.getRanges();
 340     avc = new jalview.controller.AlignViewController(this, viewport,
 341             alignPanel);
 342     if (viewport.getAlignmentConservationAnnotation() == null)
 343     {
 344       // BLOSUM62Colour.setEnabled(false);
 345       conservationMenuItem.setEnabled(false);
 346       modifyConservation.setEnabled(false);
 347       // PIDColour.setEnabled(false);
 348       // abovePIDThreshold.setEnabled(false);
 349       // modifyPID.setEnabled(false);
 350     }
 351
 352     String sortby = jalview.bin.Cache.getDefault("SORT_ALIGNMENT",
 353             "No sort");
 354
 355     if (sortby.equals("Id"))
 356     {
 357       sortIDMenuItem_actionPerformed(null);
 358     }
 359     else if (sortby.equals("Pairwise Identity"))
 360     {
 361       sortPairwiseMenuItem_actionPerformed(null);
 362     }
 363
 364     this.alignPanel.av
 365             .setShowAutocalculatedAbove(isShowAutoCalculatedAbove());
 366
 367     setMenusFromViewport(viewport);
 368     buildSortByAnnotationScoresMenu();
 369     calculateTree.addActionListener(new ActionListener()
 370     {
 371
 372       @Override
 373       public void actionPerformed(ActionEvent e)
 374       {
 375         new CalculationChooser(AlignFrame.this);
 376       }
 377     });
 378     buildColourMenu();
 379
 380     if (Desktop.desktop != null)
 381     {
 382       this.setDropTarget(new java.awt.dnd.DropTarget(this, this));
 383       addServiceListeners();
 384       setGUINucleotide();
 385     }
 386
 387     if (viewport.getWrapAlignment())
 388     {
 389       wrapMenuItem_actionPerformed(null);
 390     }
 391
 392     if (jalview.bin.Cache.getDefault("SHOW_OVERVIEW", false))
 393     {
 394       this.overviewMenuItem_actionPerformed(null);
 395     }
 396
 397     addKeyListener();
 398
 399     final List<AlignmentPanel> selviews = new ArrayList<AlignmentPanel>();
 400     final List<AlignmentPanel> origview = new ArrayList<AlignmentPanel>();
 401     final String menuLabel = MessageManager
 402             .getString("label.copy_format_from");
 403     ViewSelectionMenu vsel = new ViewSelectionMenu(menuLabel,
 404             new ViewSetProvider()
 405             {
 406
 407               @Override
 408               public AlignmentPanel[] getAllAlignmentPanels()
 409               {
 410                 origview.clear();
 411                 origview.add(alignPanel);
 412                 // make an array of all alignment panels except for this one
 413                 List<AlignmentPanel> aps = new ArrayList<AlignmentPanel>(
 414                         Arrays.asList(Desktop.getAlignmentPanels(null)));
 415                 aps.remove(AlignFrame.this.alignPanel);
 416                 return aps.toArray(new AlignmentPanel[aps.size()]);
 417               }
 418             }, selviews, new ItemListener()
 419             {
 420
 421               @Override
 422               public void itemStateChanged(ItemEvent e)
 423               {
 424                 if (origview.size() > 0)
 425                 {
 426                   final AlignmentPanel ap = origview.get(0);
 427
 428                   /*
 429                    * Copy the ViewStyle of the selected panel to 'this one'.
 430                    * Don't change value of 'scaleProteinAsCdna' unless copying
 431                    * from a SplitFrame.
 432                    */
 433                   ViewStyleI vs = selviews.get(0).getAlignViewport()
 434                           .getViewStyle();
 435                   boolean fromSplitFrame = selviews.get(0)
 436                           .getAlignViewport().getCodingComplement() != null;
 437                   if (!fromSplitFrame)
 438                   {
 439                     vs.setScaleProteinAsCdna(ap.getAlignViewport()
 440                             .getViewStyle().isScaleProteinAsCdna());
 441                   }
 442                   ap.getAlignViewport().setViewStyle(vs);
 443
 444                   /*
 445                    * Also rescale ViewStyle of SplitFrame complement if there is
 446                    * one _and_ it is set to 'scaledProteinAsCdna'; we don't copy
 447                    * the whole ViewStyle (allow cDNA protein to have different
 448                    * fonts)
 449                    */
 450                   AlignViewportI complement = ap.getAlignViewport()
 451                           .getCodingComplement();
 452                   if (complement != null && vs.isScaleProteinAsCdna())
 453                   {
 454                     AlignFrame af = Desktop.getAlignFrameFor(complement);
 455                     ((SplitFrame) af.getSplitViewContainer())
 456                             .adjustLayout();
 457                     af.setMenusForViewport();
 458                   }
 459
 460                   ap.updateLayout();
 461                   ap.setSelected(true);
 462                   ap.alignFrame.setMenusForViewport();
 463
 464                 }
 465               }
 466             });
 467     if (Cache.getDefault("VERSION", "DEVELOPMENT").toLowerCase()
 468             .indexOf("devel") > -1
 469             || Cache.getDefault("VERSION", "DEVELOPMENT").toLowerCase()
 470                     .indexOf("test") > -1)
 471     {
 472       formatMenu.add(vsel);
 473     }
 474     addFocusListener(new FocusAdapter()
 475     {
 476       @Override
 477       public void focusGained(FocusEvent e)
 478       {
 479         Jalview.setCurrentAlignFrame(AlignFrame.this);
 480       }
 481     });
 482
 483   }
 484
 485   /**
 486    * Change the filename and format for the alignment, and enable the 'reload'
 487    * button functionality.
 488    *
 489    * @param file
 490    *          valid filename
 491    * @param format
 492    *          format of file
 493    */
 494   public void setFileName(String file, FileFormatI format)
 495   {
 496     fileName = file;
 497     setFileFormat(format);
 498     reload.setEnabled(true);
 499   }
 500
 501   /**
 502    * Add a KeyListener with handlers for various KeyPressed and KeyReleased
 503    * events
 504    */
 505   void addKeyListener()
 506   {
 507     addKeyListener(new KeyAdapter()
 508     {
 509       @Override
 510       public void keyPressed(KeyEvent evt)
 511       {
 512         if (viewport.cursorMode
 513                 && ((evt.getKeyCode() >= KeyEvent.VK_0 && evt.getKeyCode() <= KeyEvent.VK_9) || (evt
 514                         .getKeyCode() >= KeyEvent.VK_NUMPAD0 && evt
 515                         .getKeyCode() <= KeyEvent.VK_NUMPAD9))
 516                 && Character.isDigit(evt.getKeyChar()))
 517         {
 518           alignPanel.getSeqPanel().numberPressed(evt.getKeyChar());
 519         }
 520
 521         switch (evt.getKeyCode())
 522         {
 523
 524         case 27: // escape key
 525           deselectAllSequenceMenuItem_actionPerformed(null);
 526
 527           break;
 528
 529         case KeyEvent.VK_DOWN:
 530           if (evt.isAltDown() || !viewport.cursorMode)
 531           {
 532             moveSelectedSequences(false);
 533           }
 534           if (viewport.cursorMode)
 535           {
 536             alignPanel.getSeqPanel().moveCursor(0, 1);
 537           }
 538           break;
 539
 540         case KeyEvent.VK_UP:
 541           if (evt.isAltDown() || !viewport.cursorMode)
 542           {
 543             moveSelectedSequences(true);
 544           }
 545           if (viewport.cursorMode)
 546           {
 547             alignPanel.getSeqPanel().moveCursor(0, -1);
 548           }
 549
 550           break;
 551
 552         case KeyEvent.VK_LEFT:
 553           if (evt.isAltDown() || !viewport.cursorMode)
 554           {
 555             slideSequences(false, alignPanel.getSeqPanel().getKeyboardNo1());
 556           }
 557           else
 558           {
 559             alignPanel.getSeqPanel().moveCursor(-1, 0);
 560           }
 561
 562           break;
 563
 564         case KeyEvent.VK_RIGHT:
 565           if (evt.isAltDown() || !viewport.cursorMode)
 566           {
 567             slideSequences(true, alignPanel.getSeqPanel().getKeyboardNo1());
 568           }
 569           else
 570           {
 571             alignPanel.getSeqPanel().moveCursor(1, 0);
 572           }
 573           break;
 574
 575         case KeyEvent.VK_SPACE:
 576           if (viewport.cursorMode)
 577           {
 578             alignPanel.getSeqPanel().insertGapAtCursor(
 579                     evt.isControlDown() || evt.isShiftDown()
 580                             || evt.isAltDown());
 581           }
 582           break;
 583
 584         // case KeyEvent.VK_A:
 585         // if (viewport.cursorMode)
 586         // {
 587         // alignPanel.seqPanel.insertNucAtCursor(false,"A");
 588         // //System.out.println("A");
 589         // }
 590         // break;
 591         /*
 592          * case KeyEvent.VK_CLOSE_BRACKET: if (viewport.cursorMode) {
 593          * System.out.println("closing bracket"); } break;
 594          */
 595         case KeyEvent.VK_DELETE:
 596         case KeyEvent.VK_BACK_SPACE:
 597           if (!viewport.cursorMode)
 598           {
 599             cut_actionPerformed(null);
 600           }
 601           else
 602           {
 603             alignPanel.getSeqPanel().deleteGapAtCursor(
 604                     evt.isControlDown() || evt.isShiftDown()
 605                             || evt.isAltDown());
 606           }
 607
 608           break;
 609
 610         case KeyEvent.VK_S:
 611           if (viewport.cursorMode)
 612           {
 613             alignPanel.getSeqPanel().setCursorRow();
 614           }
 615           break;
 616         case KeyEvent.VK_C:
 617           if (viewport.cursorMode && !evt.isControlDown())
 618           {
 619             alignPanel.getSeqPanel().setCursorColumn();
 620           }
 621           break;
 622         case KeyEvent.VK_P:
 623           if (viewport.cursorMode)
 624           {
 625             alignPanel.getSeqPanel().setCursorPosition();
 626           }
 627           break;
 628
 629         case KeyEvent.VK_ENTER:
 630         case KeyEvent.VK_COMMA:
 631           if (viewport.cursorMode)
 632           {
 633             alignPanel.getSeqPanel().setCursorRowAndColumn();
 634           }
 635           break;
 636
 637         case KeyEvent.VK_Q:
 638           if (viewport.cursorMode)
 639           {
 640             alignPanel.getSeqPanel().setSelectionAreaAtCursor(true);
 641           }
 642           break;
 643         case KeyEvent.VK_M:
 644           if (viewport.cursorMode)
 645           {
 646             alignPanel.getSeqPanel().setSelectionAreaAtCursor(false);
 647           }
 648           break;
 649
 650         case KeyEvent.VK_F2:
 651           viewport.cursorMode = !viewport.cursorMode;
 652           statusBar.setText(MessageManager.formatMessage(
 653                   "label.keyboard_editing_mode",
 654                   new String[] { (viewport.cursorMode ? "on" : "off") }));
 655           if (viewport.cursorMode)
 656           {
 657             alignPanel.getSeqPanel().seqCanvas.cursorX = vpRanges
 658                     .getStartRes();
 659             alignPanel.getSeqPanel().seqCanvas.cursorY = vpRanges
 660                     .getStartSeq();
 661           }
 662           alignPanel.getSeqPanel().seqCanvas.repaint();
 663           break;
 664
 665         case KeyEvent.VK_F1:
 666           try
 667           {
 668             Help.showHelpWindow();
 669           } catch (Exception ex)
 670           {
 671             ex.printStackTrace();
 672           }
 673           break;
 674         case KeyEvent.VK_H:
 675         {
 676           boolean toggleSeqs = !evt.isControlDown();
 677           boolean toggleCols = !evt.isShiftDown();
 678           toggleHiddenRegions(toggleSeqs, toggleCols);
 679           break;
 680         }
 681         case KeyEvent.VK_B:
 682         {
 683           boolean toggleSel = evt.isControlDown() || evt.isMetaDown();
 684           boolean modifyExisting = true; // always modify, don't clear
 685                                          // evt.isShiftDown();
 686           boolean invertHighlighted = evt.isAltDown();
 687           avc.markHighlightedColumns(invertHighlighted, modifyExisting,
 688                   toggleSel);
 689           break;
 690         }
 691         case KeyEvent.VK_PAGE_UP:
 692           if (viewport.getWrapAlignment())
 693           {
 694             alignPanel.scrollUp(true);
 695           }
 696           else
 697           {
 698             alignPanel.setScrollValues(vpRanges.getStartRes(),
 699                     2 * vpRanges.getStartSeq() - vpRanges.getEndSeq());
 700           }
 701           break;
 702         case KeyEvent.VK_PAGE_DOWN:
 703           if (viewport.getWrapAlignment())
 704           {
 705             alignPanel.scrollUp(false);
 706           }
 707           else
 708           {
 709             alignPanel.setScrollValues(vpRanges.getStartRes(),
 710                     vpRanges.getEndSeq());
 711           }
 712           break;
 713         }
 714       }
 715
 716       @Override
 717       public void keyReleased(KeyEvent evt)
 718       {
 719         switch (evt.getKeyCode())
 720         {
 721         case KeyEvent.VK_LEFT:
 722           if (evt.isAltDown() || !viewport.cursorMode)
 723           {
 724             viewport.firePropertyChange("alignment", null, viewport
 725                     .getAlignment().getSequences());
 726           }
 727           break;
 728
 729         case KeyEvent.VK_RIGHT:
 730           if (evt.isAltDown() || !viewport.cursorMode)
 731           {
 732             viewport.firePropertyChange("alignment", null, viewport
 733                     .getAlignment().getSequences());
 734           }
 735           break;
 736         }
 737       }
 738     });
 739   }
 740
 741   public void addAlignmentPanel(final AlignmentPanel ap, boolean newPanel)
 742   {
 743     ap.alignFrame = this;
 744     avc = new jalview.controller.AlignViewController(this, viewport,
 745             alignPanel);
 746
 747     alignPanels.add(ap);
 748
 749     PaintRefresher.Register(ap, ap.av.getSequenceSetId());
 750
 751     int aSize = alignPanels.size();
 752
 753     tabbedPane.setVisible(aSize > 1 || ap.av.viewName != null);
 754
 755     if (aSize == 1 && ap.av.viewName == null)
 756     {
 757       this.getContentPane().add(ap, BorderLayout.CENTER);
 758     }
 759     else
 760     {
 761       if (aSize == 2)
 762       {
 763         setInitialTabVisible();
 764       }
 765
 766       expandViews.setEnabled(true);
 767       gatherViews.setEnabled(true);
 768       tabbedPane.addTab(ap.av.viewName, ap);
 769
 770       ap.setVisible(false);
 771     }
 772
 773     if (newPanel)
 774     {
 775       if (ap.av.isPadGaps())
 776       {
 777         ap.av.getAlignment().padGaps();
 778       }
 779       ap.av.updateConservation(ap);
 780       ap.av.updateConsensus(ap);
 781       ap.av.updateStrucConsensus(ap);
 782     }
 783   }
 784
 785   public void setInitialTabVisible()
 786   {
 787     expandViews.setEnabled(true);
 788     gatherViews.setEnabled(true);
 789     tabbedPane.setVisible(true);
 790     AlignmentPanel first = alignPanels.get(0);
 791     tabbedPane.addTab(first.av.viewName, first);
 792     this.getContentPane().add(tabbedPane, BorderLayout.CENTER);
 793   }
 794
 795   public AlignViewport getViewport()
 796   {
 797     return viewport;
 798   }
 799
 800   /* Set up intrinsic listeners for dynamically generated GUI bits. */
 801   private void addServiceListeners()
 802   {
 803     final java.beans.PropertyChangeListener thisListener;
 804     Desktop.instance.addJalviewPropertyChangeListener("services",
 805             thisListener = new java.beans.PropertyChangeListener()
 806             {
 807               @Override
 808               public void propertyChange(PropertyChangeEvent evt)
 809               {
 810                 // // System.out.println("Discoverer property change.");
 811                 // if (evt.getPropertyName().equals("services"))
 812                 {
 813                   SwingUtilities.invokeLater(new Runnable()
 814                   {
 815
 816                     @Override
 817                     public void run()
 818                     {
 819                       System.err
 820                               .println("Rebuild WS Menu for service change");
 821                       BuildWebServiceMenu();
 822                     }
 823
 824                   });
 825                 }
 826               }
 827             });
 828     addInternalFrameListener(new javax.swing.event.InternalFrameAdapter()
 829     {
 830       @Override
 831       public void internalFrameClosed(
 832               javax.swing.event.InternalFrameEvent evt)
 833       {
 834         // System.out.println("deregistering discoverer listener");
 835         Desktop.instance.removeJalviewPropertyChangeListener("services",
 836                 thisListener);
 837         closeMenuItem_actionPerformed(true);
 838       };
 839     });
 840     // Finally, build the menu once to get current service state
 841     new Thread(new Runnable()
 842     {
 843       @Override
 844       public void run()
 845       {
 846         BuildWebServiceMenu();
 847       }
 848     }).start();
 849   }
 850
 851   /**
 852    * Configure menu items that vary according to whether the alignment is
 853    * nucleotide or protein
 854    */
 855   public void setGUINucleotide()
 856   {
 857     AlignmentI al = getViewport().getAlignment();
 858     boolean nucleotide = al.isNucleotide();
 859
 860     showTranslation.setVisible(nucleotide);
 861     showReverse.setVisible(nucleotide);
 862     showReverseComplement.setVisible(nucleotide);
 863     conservationMenuItem.setEnabled(!nucleotide);
 864     modifyConservation.setEnabled(!nucleotide
 865             && conservationMenuItem.isSelected());
 866     showGroupConservation.setEnabled(!nucleotide);
 867
 868     showComplementMenuItem.setText(nucleotide ? MessageManager
 869             .getString("label.protein") : MessageManager
 870             .getString("label.nucleotide"));
 871   }
 872
 873   /**
 874    * set up menus for the current viewport. This may be called after any
 875    * operation that affects the data in the current view (selection changed,
 876    * etc) to update the menus to reflect the new state.
 877    */
 878   @Override
 879   public void setMenusForViewport()
 880   {
 881     setMenusFromViewport(viewport);
 882   }
 883
 884   /**
 885    * Need to call this method when tabs are selected for multiple views, or when
 886    * loading from Jalview2XML.java
 887    *
 888    * @param av
 889    *          AlignViewport
 890    */
 891   void setMenusFromViewport(AlignViewport av)
 892   {
 893     padGapsMenuitem.setSelected(av.isPadGaps());
 894     colourTextMenuItem.setSelected(av.isShowColourText());
 895     abovePIDThreshold.setSelected(av.getAbovePIDThreshold());
 896     modifyPID.setEnabled(abovePIDThreshold.isSelected());
 897     conservationMenuItem.setSelected(av.getConservationSelected());
 898     modifyConservation.setEnabled(conservationMenuItem.isSelected());
 899     seqLimits.setSelected(av.getShowJVSuffix());
 900     idRightAlign.setSelected(av.isRightAlignIds());
 901     centreColumnLabelsMenuItem.setState(av.isCentreColumnLabels());
 902     renderGapsMenuItem.setSelected(av.isRenderGaps());
 903     wrapMenuItem.setSelected(av.getWrapAlignment());
 904     scaleAbove.setVisible(av.getWrapAlignment());
 905     scaleLeft.setVisible(av.getWrapAlignment());
 906     scaleRight.setVisible(av.getWrapAlignment());
 907     annotationPanelMenuItem.setState(av.isShowAnnotation());
 908     /*
 909      * Show/hide annotations only enabled if annotation panel is shown
 910      */
 911     showAllSeqAnnotations.setEnabled(annotationPanelMenuItem.getState());
 912     hideAllSeqAnnotations.setEnabled(annotationPanelMenuItem.getState());
 913     showAllAlAnnotations.setEnabled(annotationPanelMenuItem.getState());
 914     hideAllAlAnnotations.setEnabled(annotationPanelMenuItem.getState());
 915     viewBoxesMenuItem.setSelected(av.getShowBoxes());
 916     viewTextMenuItem.setSelected(av.getShowText());
 917     showNonconservedMenuItem.setSelected(av.getShowUnconserved());
 918     showGroupConsensus.setSelected(av.isShowGroupConsensus());
 919     showGroupConservation.setSelected(av.isShowGroupConservation());
 920     showConsensusHistogram.setSelected(av.isShowConsensusHistogram());
 921     showSequenceLogo.setSelected(av.isShowSequenceLogo());
 922     normaliseSequenceLogo.setSelected(av.isNormaliseSequenceLogo());
 923
 924     ColourMenuHelper.setColourSelected(colourMenu,
 925             av.getGlobalColourScheme());
 926
 927     showSeqFeatures.setSelected(av.isShowSequenceFeatures());
 928     hiddenMarkers.setState(av.getShowHiddenMarkers());
 929     applyToAllGroups.setState(av.getColourAppliesToAllGroups());
 930     showNpFeatsMenuitem.setSelected(av.isShowNPFeats());
 931     showDbRefsMenuitem.setSelected(av.isShowDBRefs());
 932     autoCalculate.setSelected(av.autoCalculateConsensus);
 933     sortByTree.setSelected(av.sortByTree);
 934     listenToViewSelections.setSelected(av.followSelection);
 935
 936     showProducts.setEnabled(canShowProducts());
 937     setGroovyEnabled(Desktop.getGroovyConsole() != null);
 938
 939     updateEditMenuBar();
 940   }
 941
 942   /**
 943    * Set the enabled state of the 'Run Groovy' option in the Calculate menu
 944    *
 945    * @param b
 946    */
 947   public void setGroovyEnabled(boolean b)
 948   {
 949     runGroovy.setEnabled(b);
 950   }
 951
 952   private IProgressIndicator progressBar;
 953
 954   /*
 955    * (non-Javadoc)
 956    *
 957    * @see jalview.gui.IProgressIndicator#setProgressBar(java.lang.String, long)
 958    */
 959   @Override
 960   public void setProgressBar(String message, long id)
 961   {
 962     progressBar.setProgressBar(message, id);
 963   }
 964
 965   @Override
 966   public void registerHandler(final long id,
 967           final IProgressIndicatorHandler handler)
 968   {
 969     progressBar.registerHandler(id, handler);
 970   }
 971
 972   /**
 973    *
 974    * @return true if any progress bars are still active
 975    */
 976   @Override
 977   public boolean operationInProgress()
 978   {
 979     return progressBar.operationInProgress();
 980   }
 981
 982   @Override
 983   public void setStatus(String text)
 984   {
 985     statusBar.setText(text);
 986   }
 987
 988   /*
 989    * Added so Castor Mapping file can obtain Jalview Version
 990    */
 991   public String getVersion()
 992   {
 993     return jalview.bin.Cache.getProperty("VERSION");
 994   }
 995
 996   public FeatureRenderer getFeatureRenderer()
 997   {
 998     return alignPanel.getSeqPanel().seqCanvas.getFeatureRenderer();
 999   }
1000
1001   @Override
1002   public void fetchSequence_actionPerformed(ActionEvent e)
1003   {
1004     new jalview.gui.SequenceFetcher(this);
1005   }
1006
1007   @Override
1008   public void addFromFile_actionPerformed(ActionEvent e)
1009   {
1010     Desktop.instance.inputLocalFileMenuItem_actionPerformed(viewport);
1011   }
1012
1013   @Override
1014   public void reload_actionPerformed(ActionEvent e)
1015   {
1016     if (fileName != null)
1017     {
1018       // TODO: JAL-1108 - ensure all associated frames are closed regardless of
1019       // originating file's format
1020       // TODO: work out how to recover feature settings for correct view(s) when
1021       // file is reloaded.
1022       if (FileFormat.Jalview.equals(currentFileFormat))
1023       {
1024         JInternalFrame[] frames = Desktop.desktop.getAllFrames();
1025         for (int i = 0; i < frames.length; i++)
1026         {
1027           if (frames[i] instanceof AlignFrame && frames[i] != this
1028                   && ((AlignFrame) frames[i]).fileName != null
1029                   && ((AlignFrame) frames[i]).fileName.equals(fileName))
1030           {
1031             try
1032             {
1033               frames[i].setSelected(true);
1034               Desktop.instance.closeAssociatedWindows();
1035             } catch (java.beans.PropertyVetoException ex)
1036             {
1037             }
1038           }
1039
1040         }
1041         Desktop.instance.closeAssociatedWindows();
1042
1043         FileLoader loader = new FileLoader();
1044         DataSourceType protocol = fileName.startsWith("http:") ? DataSourceType.URL
1045                 : DataSourceType.FILE;
1046         loader.LoadFile(viewport, fileName, protocol, currentFileFormat);
1047       }
1048       else
1049       {
1050         Rectangle bounds = this.getBounds();
1051
1052         FileLoader loader = new FileLoader();
1053         DataSourceType protocol = fileName.startsWith("http:") ? DataSourceType.URL
1054                 : DataSourceType.FILE;
1055         AlignFrame newframe = loader.LoadFileWaitTillLoaded(fileName,
1056                 protocol, currentFileFormat);
1057
1058         newframe.setBounds(bounds);
1059         if (featureSettings != null && featureSettings.isShowing())
1060         {
1061           final Rectangle fspos = featureSettings.frame.getBounds();
1062           // TODO: need a 'show feature settings' function that takes bounds -
1063           // need to refactor Desktop.addFrame
1064           newframe.featureSettings_actionPerformed(null);
1065           final FeatureSettings nfs = newframe.featureSettings;
1066           SwingUtilities.invokeLater(new Runnable()
1067           {
1068             @Override
1069             public void run()
1070             {
1071               nfs.frame.setBounds(fspos);
1072             }
1073           });
1074           this.featureSettings.close();
1075           this.featureSettings = null;
1076         }
1077         this.closeMenuItem_actionPerformed(true);
1078       }
1079     }
1080   }
1081
1082   @Override
1083   public void addFromText_actionPerformed(ActionEvent e)
1084   {
1085     Desktop.instance.inputTextboxMenuItem_actionPerformed(viewport
1086             .getAlignPanel());
1087   }
1088
1089   @Override
1090   public void addFromURL_actionPerformed(ActionEvent e)
1091   {
1092     Desktop.instance.inputURLMenuItem_actionPerformed(viewport);
1093   }
1094
1095   @Override
1096   public void save_actionPerformed(ActionEvent e)
1097   {
1098     if (fileName == null || (currentFileFormat == null)
1099             || fileName.startsWith("http"))
1100     {
1101       saveAs_actionPerformed(null);
1102     }
1103     else
1104     {
1105       saveAlignment(fileName, currentFileFormat);
1106     }
1107   }
1108
1109   /**
1110    * DOCUMENT ME!
1111    *
1112    * @param e
1113    *          DOCUMENT ME!
1114    */
1115   @Override
1116   public void saveAs_actionPerformed(ActionEvent e)
1117   {
1118     String format = currentFileFormat == null ? null : currentFileFormat
1119             .getName();
1120     JalviewFileChooser chooser = JalviewFileChooser.forWrite(
1121             Cache.getProperty("LAST_DIRECTORY"), format);
1122
1123     chooser.setFileView(new JalviewFileView());
1124     chooser.setDialogTitle(MessageManager
1125             .getString("label.save_alignment_to_file"));
1126     chooser.setToolTipText(MessageManager.getString("action.save"));
1127
1128     int value = chooser.showSaveDialog(this);
1129
1130     if (value == JalviewFileChooser.APPROVE_OPTION)
1131     {
1132       currentFileFormat = chooser.getSelectedFormat();
1133       while (currentFileFormat == null)
1134       {
1135         JvOptionPane
1136                 .showInternalMessageDialog(
1137                         Desktop.desktop,
1138                         MessageManager
1139                                 .getString("label.select_file_format_before_saving"),
1140                         MessageManager
1141                                 .getString("label.file_format_not_specified"),
1142                         JvOptionPane.WARNING_MESSAGE);
1143         currentFileFormat = chooser.getSelectedFormat();
1144         value = chooser.showSaveDialog(this);
1145         if (value != JalviewFileChooser.APPROVE_OPTION)
1146         {
1147           return;
1148         }
1149       }
1150
1151       fileName = chooser.getSelectedFile().getPath();
1152
1153       Cache.setProperty("DEFAULT_FILE_FORMAT", currentFileFormat.getName());
1154
1155       Cache.setProperty("LAST_DIRECTORY", fileName);
1156       saveAlignment(fileName, currentFileFormat);
1157     }
1158   }
1159
1160   public boolean saveAlignment(String file, FileFormatI format)
1161   {
1162     boolean success = true;
1163
1164     if (FileFormat.Jalview.equals(format))
1165     {
1166       String shortName = title;
1167
1168       if (shortName.indexOf(java.io.File.separatorChar) > -1)
1169       {
1170         shortName = shortName.substring(shortName
1171                 .lastIndexOf(java.io.File.separatorChar) + 1);
1172       }
1173
1174       success = new Jalview2XML().saveAlignment(this, file, shortName);
1175
1176       statusBar.setText(MessageManager.formatMessage(
1177               "label.successfully_saved_to_file_in_format", new Object[] {
1178                   fileName, format }));
1179
1180     }
1181     else
1182     {
1183       AlignmentExportData exportData = getAlignmentForExport(format,
1184               viewport, null);
1185       if (exportData.getSettings().isCancelled())
1186       {
1187         return false;
1188       }
1189       FormatAdapter f = new FormatAdapter(alignPanel,
1190               exportData.getSettings());
1191       String output = f.formatSequences(
1192               format,
1193               exportData.getAlignment(), // class cast exceptions will
1194               // occur in the distant future
1195               exportData.getOmitHidden(), exportData.getStartEndPostions(),
1196               f.getCacheSuffixDefault(format),
1197               viewport.getColumnSelection());
1198
1199       if (output == null)
1200       {
1201         success = false;
1202       }
1203       else
1204       {
1205         try
1206         {
1207           PrintWriter out = new PrintWriter(new FileWriter(file));
1208
1209           out.print(output);
1210           out.close();
1211           this.setTitle(file);
1212           statusBar.setText(MessageManager.formatMessage(
1213                   "label.successfully_saved_to_file_in_format",
1214                   new Object[] { fileName, format.getName() }));
1215         } catch (Exception ex)
1216         {
1217           success = false;
1218           ex.printStackTrace();
1219         }
1220       }
1221     }
1222
1223     if (!success)
1224     {
1225       JvOptionPane.showInternalMessageDialog(this, MessageManager
1226               .formatMessage("label.couldnt_save_file",
1227                       new Object[] { fileName }), MessageManager
1228               .getString("label.error_saving_file"),
1229               JvOptionPane.WARNING_MESSAGE);
1230     }
1231
1232     return success;
1233   }
1234
1235   private void warningMessage(String warning, String title)
1236   {
1237     if (new jalview.util.Platform().isHeadless())
1238     {
1239       System.err.println("Warning: " + title + "\nWarning: " + warning);
1240
1241     }
1242     else
1243     {
1244       JvOptionPane.showInternalMessageDialog(this, warning, title,
1245               JvOptionPane.WARNING_MESSAGE);
1246     }
1247     return;
1248   }
1249
1250   /**
1251    * DOCUMENT ME!
1252    *
1253    * @param e
1254    *          DOCUMENT ME!
1255    */
1256   @Override
1257   protected void outputText_actionPerformed(ActionEvent e)
1258   {
1259     FileFormatI fileFormat = FileFormats.getInstance().forName(
1260             e.getActionCommand());
1261     AlignmentExportData exportData = getAlignmentForExport(fileFormat,
1262             viewport, null);
1263     if (exportData.getSettings().isCancelled())
1264     {
1265       return;
1266     }
1267     CutAndPasteTransfer cap = new CutAndPasteTransfer();
1268     cap.setForInput(null);
1269     try
1270     {
1271       FileFormatI format = fileFormat;
1272       cap.setText(new FormatAdapter(alignPanel, exportData.getSettings())
1273               .formatSequences(format, exportData.getAlignment(),
1274                       exportData.getOmitHidden(),
1275                       exportData.getStartEndPostions(),
1276                       viewport.getColumnSelection()));
1277       Desktop.addInternalFrame(cap, MessageManager.formatMessage(
1278               "label.alignment_output_command",
1279               new Object[] { e.getActionCommand() }), 600, 500);
1280     } catch (OutOfMemoryError oom)
1281     {
1282       new OOMWarning("Outputting alignment as " + e.getActionCommand(), oom);
1283       cap.dispose();
1284     }
1285
1286   }
1287
1288   public static AlignmentExportData getAlignmentForExport(
1289           FileFormatI format, AlignViewportI viewport,
1290           AlignExportSettingI exportSettings)
1291   {
1292     AlignmentI alignmentToExport = null;
1293     AlignExportSettingI settings = exportSettings;
1294     String[] omitHidden = null;
1295
1296     HiddenSequences hiddenSeqs = viewport.getAlignment()
1297             .getHiddenSequences();
1298
1299     alignmentToExport = viewport.getAlignment();
1300
1301     boolean hasHiddenSeqs = hiddenSeqs.getSize() > 0;
1302     if (settings == null)
1303     {
1304       settings = new AlignExportSettings(hasHiddenSeqs,
1305               viewport.hasHiddenColumns(), format);
1306     }
1307     // settings.isExportAnnotations();
1308
1309     if (viewport.hasHiddenColumns() && !settings.isExportHiddenColumns())
1310     {
1311       omitHidden = viewport.getViewAsString(false,
1312               settings.isExportHiddenSequences());
1313     }
1314
1315     int[] alignmentStartEnd = new int[2];
1316     if (hasHiddenSeqs && settings.isExportHiddenSequences())
1317     {
1318       alignmentToExport = hiddenSeqs.getFullAlignment();
1319     }
1320     else
1321     {
1322       alignmentToExport = viewport.getAlignment();
1323     }
1324     alignmentStartEnd = alignmentToExport
1325             .getVisibleStartAndEndIndex(viewport.getColumnSelection()
1326                     .getHiddenColumns());
1327     AlignmentExportData ed = new AlignmentExportData(alignmentToExport,
1328             omitHidden, alignmentStartEnd, settings);
1329     return ed;
1330   }
1331
1332   /**
1333    * DOCUMENT ME!
1334    *
1335    * @param e
1336    *          DOCUMENT ME!
1337    */
1338   @Override
1339   protected void htmlMenuItem_actionPerformed(ActionEvent e)
1340   {
1341     HtmlSvgOutput htmlSVG = new HtmlSvgOutput(alignPanel);
1342     htmlSVG.exportHTML(null);
1343   }
1344
1345   @Override
1346   public void bioJSMenuItem_actionPerformed(ActionEvent e)
1347   {
1348     BioJsHTMLOutput bjs = new BioJsHTMLOutput(alignPanel);
1349     bjs.exportHTML(null);
1350   }
1351
1352   public void createImageMap(File file, String image)
1353   {
1354     alignPanel.makePNGImageMap(file, image);
1355   }
1356
1357   /**
1358    * DOCUMENT ME!
1359    *
1360    * @param e
1361    *          DOCUMENT ME!
1362    */
1363   @Override
1364   public void createPNG(File f)
1365   {
1366     alignPanel.makePNG(f);
1367   }
1368
1369   /**
1370    * DOCUMENT ME!
1371    *
1372    * @param e
1373    *          DOCUMENT ME!
1374    */
1375   @Override
1376   public void createEPS(File f)
1377   {
1378     alignPanel.makeEPS(f);
1379   }
1380
1381   @Override
1382   public void createSVG(File f)
1383   {
1384     alignPanel.makeSVG(f);
1385   }
1386
1387   @Override
1388   public void pageSetup_actionPerformed(ActionEvent e)
1389   {
1390     PrinterJob printJob = PrinterJob.getPrinterJob();
1391     PrintThread.pf = printJob.pageDialog(printJob.defaultPage());
1392   }
1393
1394   /**
1395    * DOCUMENT ME!
1396    *
1397    * @param e
1398    *          DOCUMENT ME!
1399    */
1400   @Override
1401   public void printMenuItem_actionPerformed(ActionEvent e)
1402   {
1403     // Putting in a thread avoids Swing painting problems
1404     PrintThread thread = new PrintThread(alignPanel);
1405     thread.start();
1406   }
1407
1408   @Override
1409   public void exportFeatures_actionPerformed(ActionEvent e)
1410   {
1411     new AnnotationExporter().exportFeatures(alignPanel);
1412   }
1413
1414   @Override
1415   public void exportAnnotations_actionPerformed(ActionEvent e)
1416   {
1417     new AnnotationExporter().exportAnnotations(alignPanel);
1418   }
1419
1420   @Override
1421   public void associatedData_actionPerformed(ActionEvent e)
1422   {
1423     // Pick the tree file
1424     JalviewFileChooser chooser = new JalviewFileChooser(
1425             jalview.bin.Cache.getProperty("LAST_DIRECTORY"));
1426     chooser.setFileView(new JalviewFileView());
1427     chooser.setDialogTitle(MessageManager
1428             .getString("label.load_jalview_annotations"));
1429     chooser.setToolTipText(MessageManager
1430             .getString("label.load_jalview_annotations"));
1431
1432     int value = chooser.showOpenDialog(null);
1433
1434     if (value == JalviewFileChooser.APPROVE_OPTION)
1435     {
1436       String choice = chooser.getSelectedFile().getPath();
1437       jalview.bin.Cache.setProperty("LAST_DIRECTORY", choice);
1438       loadJalviewDataFile(choice, null, null, null);
1439     }
1440
1441   }
1442
1443   /**
1444    * Close the current view or all views in the alignment frame. If the frame
1445    * only contains one view then the alignment will be removed from memory.
1446    *
1447    * @param closeAllTabs
1448    */
1449   @Override
1450   public void closeMenuItem_actionPerformed(boolean closeAllTabs)
1451   {
1452     if (alignPanels != null && alignPanels.size() < 2)
1453     {
1454       closeAllTabs = true;
1455     }
1456
1457     try
1458     {
1459       if (alignPanels != null)
1460       {
1461         if (closeAllTabs)
1462         {
1463           if (this.isClosed())
1464           {
1465             // really close all the windows - otherwise wait till
1466             // setClosed(true) is called
1467             for (int i = 0; i < alignPanels.size(); i++)
1468             {
1469               AlignmentPanel ap = alignPanels.get(i);
1470               ap.closePanel();
1471             }
1472           }
1473         }
1474         else
1475         {
1476           closeView(alignPanel);
1477         }
1478       }
1479
1480       if (closeAllTabs)
1481       {
1482         /*
1483          * this will raise an INTERNAL_FRAME_CLOSED event and this method will
1484          * be called recursively, with the frame now in 'closed' state
1485          */
1486         this.setClosed(true);
1487       }
1488     } catch (Exception ex)
1489     {
1490       ex.printStackTrace();
1491     }
1492   }
1493
1494   /**
1495    * Close the specified panel and close up tabs appropriately.
1496    *
1497    * @param panelToClose
1498    */
1499   public void closeView(AlignmentPanel panelToClose)
1500   {
1501     int index = tabbedPane.getSelectedIndex();
1502     int closedindex = tabbedPane.indexOfComponent(panelToClose);
1503     alignPanels.remove(panelToClose);
1504     panelToClose.closePanel();
1505     panelToClose = null;
1506
1507     tabbedPane.removeTabAt(closedindex);
1508     tabbedPane.validate();
1509
1510     if (index > closedindex || index == tabbedPane.getTabCount())
1511     {
1512       // modify currently selected tab index if necessary.
1513       index--;
1514     }
1515
1516     this.tabSelectionChanged(index);
1517   }
1518
1519   /**
1520    * DOCUMENT ME!
1521    */
1522   void updateEditMenuBar()
1523   {
1524
1525     if (viewport.getHistoryList().size() > 0)
1526     {
1527       undoMenuItem.setEnabled(true);
1528       CommandI command = viewport.getHistoryList().peek();
1529       undoMenuItem.setText(MessageManager.formatMessage(
1530               "label.undo_command",
1531               new Object[] { command.getDescription() }));
1532     }
1533     else
1534     {
1535       undoMenuItem.setEnabled(false);
1536       undoMenuItem.setText(MessageManager.getString("action.undo"));
1537     }
1538
1539     if (viewport.getRedoList().size() > 0)
1540     {
1541       redoMenuItem.setEnabled(true);
1542
1543       CommandI command = viewport.getRedoList().peek();
1544       redoMenuItem.setText(MessageManager.formatMessage(
1545               "label.redo_command",
1546               new Object[] { command.getDescription() }));
1547     }
1548     else
1549     {
1550       redoMenuItem.setEnabled(false);
1551       redoMenuItem.setText(MessageManager.getString("action.redo"));
1552     }
1553   }
1554
1555   @Override
1556   public void addHistoryItem(CommandI command)
1557   {
1558     if (command.getSize() > 0)
1559     {
1560       viewport.addToHistoryList(command);
1561       viewport.clearRedoList();
1562       updateEditMenuBar();
1563       viewport.updateHiddenColumns();
1564       // viewport.hasHiddenColumns = (viewport.getColumnSelection() != null
1565       // && viewport.getColumnSelection().getHiddenColumns() != null &&
1566       // viewport.getColumnSelection()
1567       // .getHiddenColumns().size() > 0);
1568     }
1569   }
1570
1571   /**
1572    *
1573    * @return alignment objects for all views
1574    */
1575   AlignmentI[] getViewAlignments()
1576   {
1577     if (alignPanels != null)
1578     {
1579       AlignmentI[] als = new AlignmentI[alignPanels.size()];
1580       int i = 0;
1581       for (AlignmentPanel ap : alignPanels)
1582       {
1583         als[i++] = ap.av.getAlignment();
1584       }
1585       return als;
1586     }
1587     if (viewport != null)
1588     {
1589       return new AlignmentI[] { viewport.getAlignment() };
1590     }
1591     return null;
1592   }
1593
1594   /**
1595    * DOCUMENT ME!
1596    *
1597    * @param e
1598    *          DOCUMENT ME!
1599    */
1600   @Override
1601   protected void undoMenuItem_actionPerformed(ActionEvent e)
1602   {
1603     if (viewport.getHistoryList().isEmpty())
1604     {
1605       return;
1606     }
1607     CommandI command = viewport.getHistoryList().pop();
1608     viewport.addToRedoList(command);
1609     command.undoCommand(getViewAlignments());
1610
1611     AlignmentViewport originalSource = getOriginatingSource(command);
1612     updateEditMenuBar();
1613
1614     if (originalSource != null)
1615     {
1616       if (originalSource != viewport)
1617       {
1618         Cache.log
1619                 .warn("Implementation worry: mismatch of viewport origin for undo");
1620       }
1621       originalSource.updateHiddenColumns();
1622       // originalSource.hasHiddenColumns = (viewport.getColumnSelection() !=
1623       // null
1624       // && viewport.getColumnSelection().getHiddenColumns() != null &&
1625       // viewport.getColumnSelection()
1626       // .getHiddenColumns().size() > 0);
1627       originalSource.firePropertyChange("alignment", null, originalSource
1628               .getAlignment().getSequences());
1629     }
1630   }
1631
1632   /**
1633    * DOCUMENT ME!
1634    *
1635    * @param e
1636    *          DOCUMENT ME!
1637    */
1638   @Override
1639   protected void redoMenuItem_actionPerformed(ActionEvent e)
1640   {
1641     if (viewport.getRedoList().size() < 1)
1642     {
1643       return;
1644     }
1645
1646     CommandI command = viewport.getRedoList().pop();
1647     viewport.addToHistoryList(command);
1648     command.doCommand(getViewAlignments());
1649
1650     AlignmentViewport originalSource = getOriginatingSource(command);
1651     updateEditMenuBar();
1652
1653     if (originalSource != null)
1654     {
1655
1656       if (originalSource != viewport)
1657       {
1658         Cache.log
1659                 .warn("Implementation worry: mismatch of viewport origin for redo");
1660       }
1661       originalSource.updateHiddenColumns();
1662       // originalSource.hasHiddenColumns = (viewport.getColumnSelection() !=
1663       // null
1664       // && viewport.getColumnSelection().getHiddenColumns() != null &&
1665       // viewport.getColumnSelection()
1666       // .getHiddenColumns().size() > 0);
1667       originalSource.firePropertyChange("alignment", null, originalSource
1668               .getAlignment().getSequences());
1669     }
1670   }
1671
1672   AlignmentViewport getOriginatingSource(CommandI command)
1673   {
1674     AlignmentViewport originalSource = null;
1675     // For sequence removal and addition, we need to fire
1676     // the property change event FROM the viewport where the
1677     // original alignment was altered
1678     AlignmentI al = null;
1679     if (command instanceof EditCommand)
1680     {
1681       EditCommand editCommand = (EditCommand) command;
1682       al = editCommand.getAlignment();
1683       List<Component> comps = PaintRefresher.components.get(viewport
1684               .getSequenceSetId());
1685
1686       for (Component comp : comps)
1687       {
1688         if (comp instanceof AlignmentPanel)
1689         {
1690           if (al == ((AlignmentPanel) comp).av.getAlignment())
1691           {
1692             originalSource = ((AlignmentPanel) comp).av;
1693             break;
1694           }
1695         }
1696       }
1697     }
1698
1699     if (originalSource == null)
1700     {
1701       // The original view is closed, we must validate
1702       // the current view against the closed view first
1703       if (al != null)
1704       {
1705         PaintRefresher.validateSequences(al, viewport.getAlignment());
1706       }
1707
1708       originalSource = viewport;
1709     }
1710
1711     return originalSource;
1712   }
1713
1714   /**
1715    * DOCUMENT ME!
1716    *
1717    * @param up
1718    *          DOCUMENT ME!
1719    */
1720   public void moveSelectedSequences(boolean up)
1721   {
1722     SequenceGroup sg = viewport.getSelectionGroup();
1723
1724     if (sg == null)
1725     {
1726       return;
1727     }
1728     viewport.getAlignment().moveSelectedSequencesByOne(sg,
1729             viewport.getHiddenRepSequences(), up);
1730     alignPanel.paintAlignment(true);
1731   }
1732
1733   synchronized void slideSequences(boolean right, int size)
1734   {
1735     List<SequenceI> sg = new ArrayList<SequenceI>();
1736     if (viewport.cursorMode)
1737     {
1738       sg.add(viewport.getAlignment().getSequenceAt(
1739               alignPanel.getSeqPanel().seqCanvas.cursorY));
1740     }
1741     else if (viewport.getSelectionGroup() != null
1742             && viewport.getSelectionGroup().getSize() != viewport
1743                     .getAlignment().getHeight())
1744     {
1745       sg = viewport.getSelectionGroup().getSequences(
1746               viewport.getHiddenRepSequences());
1747     }
1748
1749     if (sg.size() < 1)
1750     {
1751       return;
1752     }
1753
1754     List<SequenceI> invertGroup = new ArrayList<SequenceI>();
1755
1756     for (SequenceI seq : viewport.getAlignment().getSequences())
1757     {
1758       if (!sg.contains(seq))
1759       {
1760         invertGroup.add(seq);
1761       }
1762     }
1763
1764     SequenceI[] seqs1 = sg.toArray(new SequenceI[0]);
1765
1766     SequenceI[] seqs2 = new SequenceI[invertGroup.size()];
1767     for (int i = 0; i < invertGroup.size(); i++)
1768     {
1769       seqs2[i] = invertGroup.get(i);
1770     }
1771
1772     SlideSequencesCommand ssc;
1773     if (right)
1774     {
1775       ssc = new SlideSequencesCommand("Slide Sequences", seqs2, seqs1,
1776               size, viewport.getGapCharacter());
1777     }
1778     else
1779     {
1780       ssc = new SlideSequencesCommand("Slide Sequences", seqs1, seqs2,
1781               size, viewport.getGapCharacter());
1782     }
1783
1784     int groupAdjustment = 0;
1785     if (ssc.getGapsInsertedBegin() && right)
1786     {
1787       if (viewport.cursorMode)
1788       {
1789         alignPanel.getSeqPanel().moveCursor(size, 0);
1790       }
1791       else
1792       {
1793         groupAdjustment = size;
1794       }
1795     }
1796     else if (!ssc.getGapsInsertedBegin() && !right)
1797     {
1798       if (viewport.cursorMode)
1799       {
1800         alignPanel.getSeqPanel().moveCursor(-size, 0);
1801       }
1802       else
1803       {
1804         groupAdjustment = -size;
1805       }
1806     }
1807
1808     if (groupAdjustment != 0)
1809     {
1810       viewport.getSelectionGroup().setStartRes(
1811               viewport.getSelectionGroup().getStartRes() + groupAdjustment);
1812       viewport.getSelectionGroup().setEndRes(
1813               viewport.getSelectionGroup().getEndRes() + groupAdjustment);
1814     }
1815
1816     /*
1817      * just extend the last slide command if compatible; but not if in
1818      * SplitFrame mode (to ensure all edits are broadcast - JAL-1802)
1819      */
1820     boolean appendHistoryItem = false;
1821     Deque<CommandI> historyList = viewport.getHistoryList();
1822     boolean inSplitFrame = getSplitViewContainer() != null;
1823     if (!inSplitFrame && historyList != null && historyList.size() > 0
1824             && historyList.peek() instanceof SlideSequencesCommand)
1825     {
1826       appendHistoryItem = ssc
1827               .appendSlideCommand((SlideSequencesCommand) historyList
1828                       .peek());
1829     }
1830
1831     if (!appendHistoryItem)
1832     {
1833       addHistoryItem(ssc);
1834     }
1835
1836     repaint();
1837   }
1838
1839   /**
1840    * DOCUMENT ME!
1841    *
1842    * @param e
1843    *          DOCUMENT ME!
1844    */
1845   @Override
1846   protected void copy_actionPerformed(ActionEvent e)
1847   {
1848     System.gc();
1849     if (viewport.getSelectionGroup() == null)
1850     {
1851       return;
1852     }
1853     // TODO: preserve the ordering of displayed alignment annotation in any
1854     // internal paste (particularly sequence associated annotation)
1855     SequenceI[] seqs = viewport.getSelectionAsNewSequence();
1856     String[] omitHidden = null;
1857
1858     if (viewport.hasHiddenColumns())
1859     {
1860       omitHidden = viewport.getViewAsString(true);
1861     }
1862
1863     String output = new FormatAdapter().formatSequences(FileFormat.Fasta,
1864             seqs, omitHidden, null);
1865
1866     StringSelection ss = new StringSelection(output);
1867
1868     try
1869     {
1870       jalview.gui.Desktop.internalCopy = true;
1871       // Its really worth setting the clipboard contents
1872       // to empty before setting the large StringSelection!!
1873       Toolkit.getDefaultToolkit().getSystemClipboard()
1874               .setContents(new StringSelection(""), null);
1875
1876       Toolkit.getDefaultToolkit().getSystemClipboard()
1877               .setContents(ss, Desktop.instance);
1878     } catch (OutOfMemoryError er)
1879     {
1880       new OOMWarning("copying region", er);
1881       return;
1882     }
1883
1884     ArrayList<int[]> hiddenColumns = null;
1885     if (viewport.hasHiddenColumns())
1886     {
1887       hiddenColumns = new ArrayList<int[]>();
1888       int hiddenOffset = viewport.getSelectionGroup().getStartRes(), hiddenCutoff = viewport
1889               .getSelectionGroup().getEndRes();
1890       for (int[] region : viewport.getColumnSelection().getHiddenColumns())
1891       {
1892         if (region[0] >= hiddenOffset && region[1] <= hiddenCutoff)
1893         {
1894           hiddenColumns.add(new int[] { region[0] - hiddenOffset,
1895               region[1] - hiddenOffset });
1896         }
1897       }
1898     }
1899
1900     Desktop.jalviewClipboard = new Object[] { seqs,
1901         viewport.getAlignment().getDataset(), hiddenColumns };
1902     statusBar.setText(MessageManager.formatMessage(
1903             "label.copied_sequences_to_clipboard", new Object[] { Integer
1904                     .valueOf(seqs.length).toString() }));
1905   }
1906
1907   /**
1908    * DOCUMENT ME!
1909    *
1910    * @param e
1911    *          DOCUMENT ME!
1912    */
1913   @Override
1914   protected void pasteNew_actionPerformed(ActionEvent e)
1915   {
1916     paste(true);
1917   }
1918
1919   /**
1920    * DOCUMENT ME!
1921    *
1922    * @param e
1923    *          DOCUMENT ME!
1924    */
1925   @Override
1926   protected void pasteThis_actionPerformed(ActionEvent e)
1927   {
1928     paste(false);
1929   }
1930
1931   /**
1932    * Paste contents of Jalview clipboard
1933    *
1934    * @param newAlignment
1935    *          true to paste to a new alignment, otherwise add to this.
1936    */
1937   void paste(boolean newAlignment)
1938   {
1939     boolean externalPaste = true;
1940     try
1941     {
1942       Clipboard c = Toolkit.getDefaultToolkit().getSystemClipboard();
1943       Transferable contents = c.getContents(this);
1944
1945       if (contents == null)
1946       {
1947         return;
1948       }
1949
1950       String str;
1951       FileFormatI format;
1952       try
1953       {
1954         str = (String) contents.getTransferData(DataFlavor.stringFlavor);
1955         if (str.length() < 1)
1956         {
1957           return;
1958         }
1959
1960         format = new IdentifyFile().identify(str, DataSourceType.PASTE);
1961
1962       } catch (OutOfMemoryError er)
1963       {
1964         new OOMWarning("Out of memory pasting sequences!!", er);
1965         return;
1966       }
1967
1968       SequenceI[] sequences;
1969       boolean annotationAdded = false;
1970       AlignmentI alignment = null;
1971
1972       if (Desktop.jalviewClipboard != null)
1973       {
1974         // The clipboard was filled from within Jalview, we must use the
1975         // sequences
1976         // And dataset from the copied alignment
1977         SequenceI[] newseq = (SequenceI[]) Desktop.jalviewClipboard[0];
1978         // be doubly sure that we create *new* sequence objects.
1979         sequences = new SequenceI[newseq.length];
1980         for (int i = 0; i < newseq.length; i++)
1981         {
1982           sequences[i] = new Sequence(newseq[i]);
1983         }
1984         alignment = new Alignment(sequences);
1985         externalPaste = false;
1986       }
1987       else
1988       {
1989         // parse the clipboard as an alignment.
1990         alignment = new FormatAdapter().readFile(str, DataSourceType.PASTE,
1991                 format);
1992         sequences = alignment.getSequencesArray();
1993       }
1994
1995       int alwidth = 0;
1996       ArrayList<Integer> newGraphGroups = new ArrayList<Integer>();
1997       int fgroup = -1;
1998
1999       if (newAlignment)
2000       {
2001
2002         if (Desktop.jalviewClipboard != null)
2003         {
2004           // dataset is inherited
2005           alignment.setDataset((Alignment) Desktop.jalviewClipboard[1]);
2006         }
2007         else
2008         {
2009           // new dataset is constructed
2010           alignment.setDataset(null);
2011         }
2012         alwidth = alignment.getWidth() + 1;
2013       }
2014       else
2015       {
2016         AlignmentI pastedal = alignment; // preserve pasted alignment object
2017         // Add pasted sequences and dataset into existing alignment.
2018         alignment = viewport.getAlignment();
2019         alwidth = alignment.getWidth() + 1;
2020         // decide if we need to import sequences from an existing dataset
2021         boolean importDs = Desktop.jalviewClipboard != null
2022                 && Desktop.jalviewClipboard[1] != alignment.getDataset();
2023         // importDs==true instructs us to copy over new dataset sequences from
2024         // an existing alignment
2025         Vector newDs = (importDs) ? new Vector() : null; // used to create
2026         // minimum dataset set
2027
2028         for (int i = 0; i < sequences.length; i++)
2029         {
2030           if (importDs)
2031           {
2032             newDs.addElement(null);
2033           }
2034           SequenceI ds = sequences[i].getDatasetSequence(); // null for a simple
2035           // paste
2036           if (importDs && ds != null)
2037           {
2038             if (!newDs.contains(ds))
2039             {
2040               newDs.setElementAt(ds, i);
2041               ds = new Sequence(ds);
2042               // update with new dataset sequence
2043               sequences[i].setDatasetSequence(ds);
2044             }
2045             else
2046             {
2047               ds = sequences[newDs.indexOf(ds)].getDatasetSequence();
2048             }
2049           }
2050           else
2051           {
2052             // copy and derive new dataset sequence
2053             sequences[i] = sequences[i].deriveSequence();
2054             alignment.getDataset().addSequence(
2055                     sequences[i].getDatasetSequence());
2056             // TODO: avoid creation of duplicate dataset sequences with a
2057             // 'contains' method using SequenceI.equals()/SequenceI.contains()
2058           }
2059           alignment.addSequence(sequences[i]); // merges dataset
2060         }
2061         if (newDs != null)
2062         {
2063           newDs.clear(); // tidy up
2064         }
2065         if (alignment.getAlignmentAnnotation() != null)
2066         {
2067           for (AlignmentAnnotation alan : alignment
2068                   .getAlignmentAnnotation())
2069           {
2070             if (alan.graphGroup > fgroup)
2071             {
2072               fgroup = alan.graphGroup;
2073             }
2074           }
2075         }
2076         if (pastedal.getAlignmentAnnotation() != null)
2077         {
2078           // Add any annotation attached to alignment.
2079           AlignmentAnnotation[] alann = pastedal.getAlignmentAnnotation();
2080           for (int i = 0; i < alann.length; i++)
2081           {
2082             annotationAdded = true;
2083             if (alann[i].sequenceRef == null && !alann[i].autoCalculated)
2084             {
2085               AlignmentAnnotation newann = new AlignmentAnnotation(alann[i]);
2086               if (newann.graphGroup > -1)
2087               {
2088                 if (newGraphGroups.size() <= newann.graphGroup
2089                         || newGraphGroups.get(newann.graphGroup) == null)
2090                 {
2091                   for (int q = newGraphGroups.size(); q <= newann.graphGroup; q++)
2092                   {
2093                     newGraphGroups.add(q, null);
2094                   }
2095                   newGraphGroups.set(newann.graphGroup, new Integer(
2096                           ++fgroup));
2097                 }
2098                 newann.graphGroup = newGraphGroups.get(newann.graphGroup)
2099                         .intValue();
2100               }
2101
2102               newann.padAnnotation(alwidth);
2103               alignment.addAnnotation(newann);
2104             }
2105           }
2106         }
2107       }
2108       if (!newAlignment)
2109       {
2110         // /////
2111         // ADD HISTORY ITEM
2112         //
2113         addHistoryItem(new EditCommand(
2114                 MessageManager.getString("label.add_sequences"),
2115                 Action.PASTE, sequences, 0, alignment.getWidth(), alignment));
2116       }
2117       // Add any annotations attached to sequences
2118       for (int i = 0; i < sequences.length; i++)
2119       {
2120         if (sequences[i].getAnnotation() != null)
2121         {
2122           AlignmentAnnotation newann;
2123           for (int a = 0; a < sequences[i].getAnnotation().length; a++)
2124           {
2125             annotationAdded = true;
2126             newann = sequences[i].getAnnotation()[a];
2127             newann.adjustForAlignment();
2128             newann.padAnnotation(alwidth);
2129             if (newann.graphGroup > -1)
2130             {
2131               if (newann.graphGroup > -1)
2132               {
2133                 if (newGraphGroups.size() <= newann.graphGroup
2134                         || newGraphGroups.get(newann.graphGroup) == null)
2135                 {
2136                   for (int q = newGraphGroups.size(); q <= newann.graphGroup; q++)
2137                   {
2138                     newGraphGroups.add(q, null);
2139                   }
2140                   newGraphGroups.set(newann.graphGroup, new Integer(
2141                           ++fgroup));
2142                 }
2143                 newann.graphGroup = newGraphGroups.get(newann.graphGroup)
2144                         .intValue();
2145               }
2146             }
2147             alignment.addAnnotation(sequences[i].getAnnotation()[a]); // annotation
2148             // was
2149             // duplicated
2150             // earlier
2151             alignment
2152                     .setAnnotationIndex(sequences[i].getAnnotation()[a], a);
2153           }
2154         }
2155       }
2156       if (!newAlignment)
2157       {
2158
2159         // propagate alignment changed.
2160         vpRanges.setEndSeq(alignment.getHeight());
2161         if (annotationAdded)
2162         {
2163           // Duplicate sequence annotation in all views.
2164           AlignmentI[] alview = this.getViewAlignments();
2165           for (int i = 0; i < sequences.length; i++)
2166           {
2167             AlignmentAnnotation sann[] = sequences[i].getAnnotation();
2168             if (sann == null)
2169             {
2170               continue;
2171             }
2172             for (int avnum = 0; avnum < alview.length; avnum++)
2173             {
2174               if (alview[avnum] != alignment)
2175               {
2176                 // duplicate in a view other than the one with input focus
2177                 int avwidth = alview[avnum].getWidth() + 1;
2178                 // this relies on sann being preserved after we
2179                 // modify the sequence's annotation array for each duplication
2180                 for (int a = 0; a < sann.length; a++)
2181                 {
2182                   AlignmentAnnotation newann = new AlignmentAnnotation(
2183                           sann[a]);
2184                   sequences[i].addAlignmentAnnotation(newann);
2185                   newann.padAnnotation(avwidth);
2186                   alview[avnum].addAnnotation(newann); // annotation was
2187                   // duplicated earlier
2188                   // TODO JAL-1145 graphGroups are not updated for sequence
2189                   // annotation added to several views. This may cause
2190                   // strangeness
2191                   alview[avnum].setAnnotationIndex(newann, a);
2192                 }
2193               }
2194             }
2195           }
2196           buildSortByAnnotationScoresMenu();
2197         }
2198         viewport.firePropertyChange("alignment", null,
2199                 alignment.getSequences());
2200         if (alignPanels != null)
2201         {
2202           for (AlignmentPanel ap : alignPanels)
2203           {
2204             ap.validateAnnotationDimensions(false);
2205           }
2206         }
2207         else
2208         {
2209           alignPanel.validateAnnotationDimensions(false);
2210         }
2211
2212       }
2213       else
2214       {
2215         AlignFrame af = new AlignFrame(alignment, DEFAULT_WIDTH,
2216                 DEFAULT_HEIGHT);
2217         String newtitle = new String("Copied sequences");
2218
2219         if (Desktop.jalviewClipboard != null
2220                 && Desktop.jalviewClipboard[2] != null)
2221         {
2222           List<int[]> hc = (List<int[]>) Desktop.jalviewClipboard[2];
2223           for (int[] region : hc)
2224           {
2225             af.viewport.hideColumns(region[0], region[1]);
2226           }
2227         }
2228
2229         // >>>This is a fix for the moment, until a better solution is
2230         // found!!<<<
2231         af.alignPanel.getSeqPanel().seqCanvas.getFeatureRenderer()
2232                 .transferSettings(
2233                         alignPanel.getSeqPanel().seqCanvas
2234                                 .getFeatureRenderer());
2235
2236         // TODO: maintain provenance of an alignment, rather than just make the
2237         // title a concatenation of operations.
2238         if (!externalPaste)
2239         {
2240           if (title.startsWith("Copied sequences"))
2241           {
2242             newtitle = title;
2243           }
2244           else
2245           {
2246             newtitle = newtitle.concat("- from " + title);
2247           }
2248         }
2249         else
2250         {
2251           newtitle = new String("Pasted sequences");
2252         }
2253
2254         Desktop.addInternalFrame(af, newtitle, DEFAULT_WIDTH,
2255                 DEFAULT_HEIGHT);
2256
2257       }
2258
2259     } catch (Exception ex)
2260     {
2261       ex.printStackTrace();
2262       System.out.println("Exception whilst pasting: " + ex);
2263       // could be anything being pasted in here
2264     }
2265
2266   }
2267
2268   @Override
2269   protected void expand_newalign(ActionEvent e)
2270   {
2271     try
2272     {
2273       AlignmentI alignment = AlignmentUtils.expandContext(getViewport()
2274               .getAlignment(), -1);
2275       AlignFrame af = new AlignFrame(alignment, DEFAULT_WIDTH,
2276               DEFAULT_HEIGHT);
2277       String newtitle = new String("Flanking alignment");
2278
2279       if (Desktop.jalviewClipboard != null
2280               && Desktop.jalviewClipboard[2] != null)
2281       {
2282         List<int[]> hc = (List<int[]>) Desktop.jalviewClipboard[2];
2283         for (int region[] : hc)
2284         {
2285           af.viewport.hideColumns(region[0], region[1]);
2286         }
2287       }
2288
2289       // >>>This is a fix for the moment, until a better solution is
2290       // found!!<<<
2291       af.alignPanel.getSeqPanel().seqCanvas.getFeatureRenderer()
2292               .transferSettings(
2293                       alignPanel.getSeqPanel().seqCanvas
2294                               .getFeatureRenderer());
2295
2296       // TODO: maintain provenance of an alignment, rather than just make the
2297       // title a concatenation of operations.
2298       {
2299         if (title.startsWith("Copied sequences"))
2300         {
2301           newtitle = title;
2302         }
2303         else
2304         {
2305           newtitle = newtitle.concat("- from " + title);
2306         }
2307       }
2308
2309       Desktop.addInternalFrame(af, newtitle, DEFAULT_WIDTH, DEFAULT_HEIGHT);
2310
2311     } catch (Exception ex)
2312     {
2313       ex.printStackTrace();
2314       System.out.println("Exception whilst pasting: " + ex);
2315       // could be anything being pasted in here
2316     } catch (OutOfMemoryError oom)
2317     {
2318       new OOMWarning("Viewing flanking region of alignment", oom);
2319     }
2320   }
2321
2322   /**
2323    * DOCUMENT ME!
2324    *
2325    * @param e
2326    *          DOCUMENT ME!
2327    */
2328   @Override
2329   protected void cut_actionPerformed(ActionEvent e)
2330   {
2331     copy_actionPerformed(null);
2332     delete_actionPerformed(null);
2333   }
2334
2335   /**
2336    * DOCUMENT ME!
2337    *
2338    * @param e
2339    *          DOCUMENT ME!
2340    */
2341   @Override
2342   protected void delete_actionPerformed(ActionEvent evt)
2343   {
2344
2345     SequenceGroup sg = viewport.getSelectionGroup();
2346     if (sg == null)
2347     {
2348       return;
2349     }
2350
2351     /*
2352      * If the cut affects all sequences, warn, remove highlighted columns
2353      */
2354     if (sg.getSize() == viewport.getAlignment().getHeight())
2355     {
2356       boolean isEntireAlignWidth = (((sg.getEndRes() - sg.getStartRes()) + 1) == viewport
2357               .getAlignment().getWidth()) ? true : false;
2358       if (isEntireAlignWidth)
2359       {
2360         int confirm = JvOptionPane.showConfirmDialog(this,
2361                 MessageManager.getString("warn.delete_all"), // $NON-NLS-1$
2362                 MessageManager.getString("label.delete_all"), // $NON-NLS-1$
2363                 JvOptionPane.OK_CANCEL_OPTION);
2364
2365         if (confirm == JvOptionPane.CANCEL_OPTION
2366                 || confirm == JvOptionPane.CLOSED_OPTION)
2367         {
2368           return;
2369         }
2370       }
2371       viewport.getColumnSelection().removeElements(sg.getStartRes(),
2372               sg.getEndRes() + 1);
2373     }
2374     SequenceI[] cut = sg.getSequences()
2375             .toArray(new SequenceI[sg.getSize()]);
2376
2377     addHistoryItem(new EditCommand(
2378             MessageManager.getString("label.cut_sequences"), Action.CUT,
2379             cut, sg.getStartRes(), sg.getEndRes() - sg.getStartRes() + 1,
2380             viewport.getAlignment()));
2381
2382     viewport.setSelectionGroup(null);
2383     viewport.sendSelection();
2384     viewport.getAlignment().deleteGroup(sg);
2385
2386     viewport.firePropertyChange("alignment", null, viewport.getAlignment()
2387             .getSequences());
2388     if (viewport.getAlignment().getHeight() < 1)
2389     {
2390       try
2391       {
2392         this.setClosed(true);
2393       } catch (Exception ex)
2394       {
2395       }
2396     }
2397   }
2398
2399   /**
2400    * DOCUMENT ME!
2401    *
2402    * @param e
2403    *          DOCUMENT ME!
2404    */
2405   @Override
2406   protected void deleteGroups_actionPerformed(ActionEvent e)
2407   {
2408     if (avc.deleteGroups())
2409     {
2410       PaintRefresher.Refresh(this, viewport.getSequenceSetId());
2411       alignPanel.updateAnnotation();
2412       alignPanel.paintAlignment(true);
2413     }
2414   }
2415
2416   /**
2417    * DOCUMENT ME!
2418    *
2419    * @param e
2420    *          DOCUMENT ME!
2421    */
2422   @Override
2423   public void selectAllSequenceMenuItem_actionPerformed(ActionEvent e)
2424   {
2425     SequenceGroup sg = new SequenceGroup();
2426
2427     for (int i = 0; i < viewport.getAlignment().getSequences().size(); i++)
2428     {
2429       sg.addSequence(viewport.getAlignment().getSequenceAt(i), false);
2430     }
2431
2432     sg.setEndRes(viewport.getAlignment().getWidth() - 1);
2433     viewport.setSelectionGroup(sg);
2434     viewport.sendSelection();
2435     // JAL-2034 - should delegate to
2436     // alignPanel to decide if overview needs
2437     // updating.
2438     alignPanel.paintAlignment(false);
2439     PaintRefresher.Refresh(alignPanel, viewport.getSequenceSetId());
2440   }
2441
2442   /**
2443    * DOCUMENT ME!
2444    *
2445    * @param e
2446    *          DOCUMENT ME!
2447    */
2448   @Override
2449   public void deselectAllSequenceMenuItem_actionPerformed(ActionEvent e)
2450   {
2451     if (viewport.cursorMode)
2452     {
2453       alignPanel.getSeqPanel().keyboardNo1 = null;
2454       alignPanel.getSeqPanel().keyboardNo2 = null;
2455     }
2456     viewport.setSelectionGroup(null);
2457     viewport.getColumnSelection().clear();
2458     viewport.setSelectionGroup(null);
2459     alignPanel.getSeqPanel().seqCanvas.highlightSearchResults(null);
2460     alignPanel.getIdPanel().getIdCanvas().searchResults = null;
2461     // JAL-2034 - should delegate to
2462     // alignPanel to decide if overview needs
2463     // updating.
2464     alignPanel.paintAlignment(false);
2465     PaintRefresher.Refresh(alignPanel, viewport.getSequenceSetId());
2466     viewport.sendSelection();
2467   }
2468
2469   /**
2470    * DOCUMENT ME!
2471    *
2472    * @param e
2473    *          DOCUMENT ME!
2474    */
2475   @Override
2476   public void invertSequenceMenuItem_actionPerformed(ActionEvent e)
2477   {
2478     SequenceGroup sg = viewport.getSelectionGroup();
2479
2480     if (sg == null)
2481     {
2482       selectAllSequenceMenuItem_actionPerformed(null);
2483
2484       return;
2485     }
2486
2487     for (int i = 0; i < viewport.getAlignment().getSequences().size(); i++)
2488     {
2489       sg.addOrRemove(viewport.getAlignment().getSequenceAt(i), false);
2490     }
2491     // JAL-2034 - should delegate to
2492     // alignPanel to decide if overview needs
2493     // updating.
2494
2495     alignPanel.paintAlignment(true);
2496     PaintRefresher.Refresh(alignPanel, viewport.getSequenceSetId());
2497     viewport.sendSelection();
2498   }
2499
2500   @Override
2501   public void invertColSel_actionPerformed(ActionEvent e)
2502   {
2503     viewport.invertColumnSelection();
2504     alignPanel.paintAlignment(true);
2505     viewport.sendSelection();
2506   }
2507
2508   /**
2509    * DOCUMENT ME!
2510    *
2511    * @param e
2512    *          DOCUMENT ME!
2513    */
2514   @Override
2515   public void remove2LeftMenuItem_actionPerformed(ActionEvent e)
2516   {
2517     trimAlignment(true);
2518   }
2519
2520   /**
2521    * DOCUMENT ME!
2522    *
2523    * @param e
2524    *          DOCUMENT ME!
2525    */
2526   @Override
2527   public void remove2RightMenuItem_actionPerformed(ActionEvent e)
2528   {
2529     trimAlignment(false);
2530   }
2531
2532   void trimAlignment(boolean trimLeft)
2533   {
2534     ColumnSelection colSel = viewport.getColumnSelection();
2535     int column;
2536
2537     if (!colSel.isEmpty())
2538     {
2539       if (trimLeft)
2540       {
2541         column = colSel.getMin();
2542       }
2543       else
2544       {
2545         column = colSel.getMax();
2546       }
2547
2548       SequenceI[] seqs;
2549       if (viewport.getSelectionGroup() != null)
2550       {
2551         seqs = viewport.getSelectionGroup().getSequencesAsArray(
2552                 viewport.getHiddenRepSequences());
2553       }
2554       else
2555       {
2556         seqs = viewport.getAlignment().getSequencesArray();
2557       }
2558
2559       TrimRegionCommand trimRegion;
2560       if (trimLeft)
2561       {
2562         trimRegion = new TrimRegionCommand("Remove Left", true, seqs,
2563                 column, viewport.getAlignment());
2564         vpRanges.setStartRes(0);
2565       }
2566       else
2567       {
2568         trimRegion = new TrimRegionCommand("Remove Right", false, seqs,
2569                 column, viewport.getAlignment());
2570       }
2571
2572       statusBar.setText(MessageManager.formatMessage(
2573               "label.removed_columns",
2574               new String[] { Integer.valueOf(trimRegion.getSize())
2575                       .toString() }));
2576
2577       addHistoryItem(trimRegion);
2578
2579       for (SequenceGroup sg : viewport.getAlignment().getGroups())
2580       {
2581         if ((trimLeft && !sg.adjustForRemoveLeft(column))
2582                 || (!trimLeft && !sg.adjustForRemoveRight(column)))
2583         {
2584           viewport.getAlignment().deleteGroup(sg);
2585         }
2586       }
2587
2588       viewport.firePropertyChange("alignment", null, viewport
2589               .getAlignment().getSequences());
2590     }
2591   }
2592
2593   /**
2594    * DOCUMENT ME!
2595    *
2596    * @param e
2597    *          DOCUMENT ME!
2598    */
2599   @Override
2600   public void removeGappedColumnMenuItem_actionPerformed(ActionEvent e)
2601   {
2602     int start = 0, end = viewport.getAlignment().getWidth() - 1;
2603
2604     SequenceI[] seqs;
2605     if (viewport.getSelectionGroup() != null)
2606     {
2607       seqs = viewport.getSelectionGroup().getSequencesAsArray(
2608               viewport.getHiddenRepSequences());
2609       start = viewport.getSelectionGroup().getStartRes();
2610       end = viewport.getSelectionGroup().getEndRes();
2611     }
2612     else
2613     {
2614       seqs = viewport.getAlignment().getSequencesArray();
2615     }
2616
2617     RemoveGapColCommand removeGapCols = new RemoveGapColCommand(
2618             "Remove Gapped Columns", seqs, start, end,
2619             viewport.getAlignment());
2620
2621     addHistoryItem(removeGapCols);
2622
2623     statusBar.setText(MessageManager.formatMessage(
2624             "label.removed_empty_columns",
2625             new Object[] { Integer.valueOf(removeGapCols.getSize())
2626                     .toString() }));
2627
2628     // This is to maintain viewport position on first residue
2629     // of first sequence
2630     SequenceI seq = viewport.getAlignment().getSequenceAt(0);
2631     int startRes = seq.findPosition(vpRanges.getStartRes());
2632     // ShiftList shifts;
2633     // viewport.getAlignment().removeGaps(shifts=new ShiftList());
2634     // edit.alColumnChanges=shifts.getInverse();
2635     // if (viewport.hasHiddenColumns)
2636     // viewport.getColumnSelection().compensateForEdits(shifts);
2637     vpRanges.setStartRes(seq.findIndex(startRes) - 1);
2638     viewport.firePropertyChange("alignment", null, viewport.getAlignment()
2639             .getSequences());
2640
2641   }
2642
2643   /**
2644    * DOCUMENT ME!
2645    *
2646    * @param e
2647    *          DOCUMENT ME!
2648    */
2649   @Override
2650   public void removeAllGapsMenuItem_actionPerformed(ActionEvent e)
2651   {
2652     int start = 0, end = viewport.getAlignment().getWidth() - 1;
2653
2654     SequenceI[] seqs;
2655     if (viewport.getSelectionGroup() != null)
2656     {
2657       seqs = viewport.getSelectionGroup().getSequencesAsArray(
2658               viewport.getHiddenRepSequences());
2659       start = viewport.getSelectionGroup().getStartRes();
2660       end = viewport.getSelectionGroup().getEndRes();
2661     }
2662     else
2663     {
2664       seqs = viewport.getAlignment().getSequencesArray();
2665     }
2666
2667     // This is to maintain viewport position on first residue
2668     // of first sequence
2669     SequenceI seq = viewport.getAlignment().getSequenceAt(0);
2670     int startRes = seq.findPosition(vpRanges.getStartRes());
2671
2672     addHistoryItem(new RemoveGapsCommand("Remove Gaps", seqs, start, end,
2673             viewport.getAlignment()));
2674
2675     vpRanges.setStartRes(seq.findIndex(startRes) - 1);
2676
2677     viewport.firePropertyChange("alignment", null, viewport.getAlignment()
2678             .getSequences());
2679
2680   }
2681
2682   /**
2683    * DOCUMENT ME!
2684    *
2685    * @param e
2686    *          DOCUMENT ME!
2687    */
2688   @Override
2689   public void padGapsMenuitem_actionPerformed(ActionEvent e)
2690   {
2691     viewport.setPadGaps(padGapsMenuitem.isSelected());
2692     viewport.firePropertyChange("alignment", null, viewport.getAlignment()
2693             .getSequences());
2694   }
2695
2696   /**
2697    * DOCUMENT ME!
2698    *
2699    * @param e
2700    *          DOCUMENT ME!
2701    */
2702   @Override
2703   public void findMenuItem_actionPerformed(ActionEvent e)
2704   {
2705     new Finder();
2706   }
2707
2708   /**
2709    * Create a new view of the current alignment.
2710    */
2711   @Override
2712   public void newView_actionPerformed(ActionEvent e)
2713   {
2714     newView(null, true);
2715   }
2716
2717   /**
2718    * Creates and shows a new view of the current alignment.
2719    *
2720    * @param viewTitle
2721    *          title of newly created view; if null, one will be generated
2722    * @param copyAnnotation
2723    *          if true then duplicate all annnotation, groups and settings
2724    * @return new alignment panel, already displayed.
2725    */
2726   public AlignmentPanel newView(String viewTitle, boolean copyAnnotation)
2727   {
2728     /*
2729      * Create a new AlignmentPanel (with its own, new Viewport)
2730      */
2731     AlignmentPanel newap = new Jalview2XML().copyAlignPanel(alignPanel,
2732             true);
2733     if (!copyAnnotation)
2734     {
2735       /*
2736        * remove all groups and annotation except for the automatic stuff
2737        */
2738       newap.av.getAlignment().deleteAllGroups();
2739       newap.av.getAlignment().deleteAllAnnotations(false);
2740     }
2741
2742     newap.av.setGatherViewsHere(false);
2743
2744     if (viewport.viewName == null)
2745     {
2746       viewport.viewName = MessageManager
2747               .getString("label.view_name_original");
2748     }
2749
2750     /*
2751      * Views share the same edits undo and redo stacks
2752      */
2753     newap.av.setHistoryList(viewport.getHistoryList());
2754     newap.av.setRedoList(viewport.getRedoList());
2755
2756     /*
2757      * Views share the same mappings; need to deregister any new mappings
2758      * created by copyAlignPanel, and register the new reference to the shared
2759      * mappings
2760      */
2761     newap.av.replaceMappings(viewport.getAlignment());
2762
2763     /*
2764      * start up cDNA consensus (if applicable) now mappings are in place
2765      */
2766     if (newap.av.initComplementConsensus())
2767     {
2768       newap.refresh(true); // adjust layout of annotations
2769     }
2770
2771     newap.av.viewName = getNewViewName(viewTitle);
2772
2773     addAlignmentPanel(newap, true);
2774     newap.alignmentChanged();
2775
2776     if (alignPanels.size() == 2)
2777     {
2778       viewport.setGatherViewsHere(true);
2779     }
2780     tabbedPane.setSelectedIndex(tabbedPane.getTabCount() - 1);
2781     return newap;
2782   }
2783
2784   /**
2785    * Make a new name for the view, ensuring it is unique within the current
2786    * sequenceSetId. (This used to be essential for Jalview Project archives, but
2787    * these now use viewId. Unique view names are still desirable for usability.)
2788    *
2789    * @param viewTitle
2790    * @return
2791    */
2792   protected String getNewViewName(String viewTitle)
2793   {
2794     int index = Desktop.getViewCount(viewport.getSequenceSetId());
2795     boolean addFirstIndex = false;
2796     if (viewTitle == null || viewTitle.trim().length() == 0)
2797     {
2798       viewTitle = MessageManager.getString("action.view");
2799       addFirstIndex = true;
2800     }
2801     else
2802     {
2803       index = 1;// we count from 1 if given a specific name
2804     }
2805     String newViewName = viewTitle + ((addFirstIndex) ? " " + index : "");
2806
2807     List<Component> comps = PaintRefresher.components.get(viewport
2808             .getSequenceSetId());
2809
2810     List<String> existingNames = getExistingViewNames(comps);
2811
2812     while (existingNames.contains(newViewName))
2813     {
2814       newViewName = viewTitle + " " + (++index);
2815     }
2816     return newViewName;
2817   }
2818
2819   /**
2820    * Returns a list of distinct view names found in the given list of
2821    * components. View names are held on the viewport of an AlignmentPanel.
2822    *
2823    * @param comps
2824    * @return
2825    */
2826   protected List<String> getExistingViewNames(List<Component> comps)
2827   {
2828     List<String> existingNames = new ArrayList<String>();
2829     for (Component comp : comps)
2830     {
2831       if (comp instanceof AlignmentPanel)
2832       {
2833         AlignmentPanel ap = (AlignmentPanel) comp;
2834         if (!existingNames.contains(ap.av.viewName))
2835         {
2836           existingNames.add(ap.av.viewName);
2837         }
2838       }
2839     }
2840     return existingNames;
2841   }
2842
2843   /**
2844    * Explode tabbed views into separate windows.
2845    */
2846   @Override
2847   public void expandViews_actionPerformed(ActionEvent e)
2848   {
2849     Desktop.explodeViews(this);
2850   }
2851
2852   /**
2853    * Gather views in separate windows back into a tabbed presentation.
2854    */
2855   @Override
2856   public void gatherViews_actionPerformed(ActionEvent e)
2857   {
2858     Desktop.instance.gatherViews(this);
2859   }
2860
2861   /**
2862    * DOCUMENT ME!
2863    *
2864    * @param e
2865    *          DOCUMENT ME!
2866    */
2867   @Override
2868   public void font_actionPerformed(ActionEvent e)
2869   {
2870     new FontChooser(alignPanel);
2871   }
2872
2873   /**
2874    * DOCUMENT ME!
2875    *
2876    * @param e
2877    *          DOCUMENT ME!
2878    */
2879   @Override
2880   protected void seqLimit_actionPerformed(ActionEvent e)
2881   {
2882     viewport.setShowJVSuffix(seqLimits.isSelected());
2883
2884     alignPanel.getIdPanel().getIdCanvas()
2885             .setPreferredSize(alignPanel.calculateIdWidth());
2886     alignPanel.paintAlignment(true);
2887   }
2888
2889   @Override
2890   public void idRightAlign_actionPerformed(ActionEvent e)
2891   {
2892     viewport.setRightAlignIds(idRightAlign.isSelected());
2893     alignPanel.paintAlignment(true);
2894   }
2895
2896   @Override
2897   public void centreColumnLabels_actionPerformed(ActionEvent e)
2898   {
2899     viewport.setCentreColumnLabels(centreColumnLabelsMenuItem.getState());
2900     alignPanel.paintAlignment(true);
2901   }
2902
2903   /*
2904    * (non-Javadoc)
2905    *
2906    * @see jalview.jbgui.GAlignFrame#followHighlight_actionPerformed()
2907    */
2908   @Override
2909   protected void followHighlight_actionPerformed()
2910   {
2911     /*
2912      * Set the 'follow' flag on the Viewport (and scroll to position if now
2913      * true).
2914      */
2915     final boolean state = this.followHighlightMenuItem.getState();
2916     viewport.setFollowHighlight(state);
2917     if (state)
2918     {
2919       alignPanel.scrollToPosition(viewport.getSearchResults(), false);
2920     }
2921   }
2922
2923   /**
2924    * DOCUMENT ME!
2925    *
2926    * @param e
2927    *          DOCUMENT ME!
2928    */
2929   @Override
2930   protected void colourTextMenuItem_actionPerformed(ActionEvent e)
2931   {
2932     viewport.setColourText(colourTextMenuItem.isSelected());
2933     alignPanel.paintAlignment(true);
2934   }
2935
2936   /**
2937    * DOCUMENT ME!
2938    *
2939    * @param e
2940    *          DOCUMENT ME!
2941    */
2942   @Override
2943   public void wrapMenuItem_actionPerformed(ActionEvent e)
2944   {
2945     scaleAbove.setVisible(wrapMenuItem.isSelected());
2946     scaleLeft.setVisible(wrapMenuItem.isSelected());
2947     scaleRight.setVisible(wrapMenuItem.isSelected());
2948     viewport.setWrapAlignment(wrapMenuItem.isSelected());
2949     alignPanel.updateLayout();
2950   }
2951
2952   @Override
2953   public void showAllSeqs_actionPerformed(ActionEvent e)
2954   {
2955     viewport.showAllHiddenSeqs();
2956   }
2957
2958   @Override
2959   public void showAllColumns_actionPerformed(ActionEvent e)
2960   {
2961     viewport.showAllHiddenColumns();
2962     repaint();
2963     viewport.sendSelection();
2964   }
2965
2966   @Override
2967   public void hideSelSequences_actionPerformed(ActionEvent e)
2968   {
2969     viewport.hideAllSelectedSeqs();
2970     // alignPanel.paintAlignment(true);
2971   }
2972
2973   /**
2974    * called by key handler and the hide all/show all menu items
2975    *
2976    * @param toggleSeqs
2977    * @param toggleCols
2978    */
2979   private void toggleHiddenRegions(boolean toggleSeqs, boolean toggleCols)
2980   {
2981
2982     boolean hide = false;
2983     SequenceGroup sg = viewport.getSelectionGroup();
2984     if (!toggleSeqs && !toggleCols)
2985     {
2986       // Hide everything by the current selection - this is a hack - we do the
2987       // invert and then hide
2988       // first check that there will be visible columns after the invert.
2989       if (viewport.hasSelectedColumns()
2990               || (sg != null && sg.getSize() > 0 && sg.getStartRes() <= sg
2991                       .getEndRes()))
2992       {
2993         // now invert the sequence set, if required - empty selection implies
2994         // that no hiding is required.
2995         if (sg != null)
2996         {
2997           invertSequenceMenuItem_actionPerformed(null);
2998           sg = viewport.getSelectionGroup();
2999           toggleSeqs = true;
3000
3001         }
3002         viewport.expandColSelection(sg, true);
3003         // finally invert the column selection and get the new sequence
3004         // selection.
3005         invertColSel_actionPerformed(null);
3006         toggleCols = true;
3007       }
3008     }
3009
3010     if (toggleSeqs)
3011     {
3012       if (sg != null && sg.getSize() != viewport.getAlignment().getHeight())
3013       {
3014         hideSelSequences_actionPerformed(null);
3015         hide = true;
3016       }
3017       else if (!(toggleCols && viewport.hasSelectedColumns()))
3018       {
3019         showAllSeqs_actionPerformed(null);
3020       }
3021     }
3022
3023     if (toggleCols)
3024     {
3025       if (viewport.hasSelectedColumns())
3026       {
3027         hideSelColumns_actionPerformed(null);
3028         if (!toggleSeqs)
3029         {
3030           viewport.setSelectionGroup(sg);
3031         }
3032       }
3033       else if (!hide)
3034       {
3035         showAllColumns_actionPerformed(null);
3036       }
3037     }
3038   }
3039
3040   /*
3041    * (non-Javadoc)
3042    *
3043    * @see
3044    * jalview.jbgui.GAlignFrame#hideAllButSelection_actionPerformed(java.awt.
3045    * event.ActionEvent)
3046    */
3047   @Override
3048   public void hideAllButSelection_actionPerformed(ActionEvent e)
3049   {
3050     toggleHiddenRegions(false, false);
3051     viewport.sendSelection();
3052   }
3053
3054   /*
3055    * (non-Javadoc)
3056    *
3057    * @see
3058    * jalview.jbgui.GAlignFrame#hideAllSelection_actionPerformed(java.awt.event
3059    * .ActionEvent)
3060    */
3061   @Override
3062   public void hideAllSelection_actionPerformed(ActionEvent e)
3063   {
3064     SequenceGroup sg = viewport.getSelectionGroup();
3065     viewport.expandColSelection(sg, false);
3066     viewport.hideAllSelectedSeqs();
3067     viewport.hideSelectedColumns();
3068     alignPanel.paintAlignment(true);
3069     viewport.sendSelection();
3070   }
3071
3072   /*
3073    * (non-Javadoc)
3074    *
3075    * @see
3076    * jalview.jbgui.GAlignFrame#showAllhidden_actionPerformed(java.awt.event.
3077    * ActionEvent)
3078    */
3079   @Override
3080   public void showAllhidden_actionPerformed(ActionEvent e)
3081   {
3082     viewport.showAllHiddenColumns();
3083     viewport.showAllHiddenSeqs();
3084     alignPanel.paintAlignment(true);
3085     viewport.sendSelection();
3086   }
3087
3088   @Override
3089   public void hideSelColumns_actionPerformed(ActionEvent e)
3090   {
3091     viewport.hideSelectedColumns();
3092     alignPanel.paintAlignment(true);
3093     viewport.sendSelection();
3094   }
3095
3096   @Override
3097   public void hiddenMarkers_actionPerformed(ActionEvent e)
3098   {
3099     viewport.setShowHiddenMarkers(hiddenMarkers.isSelected());
3100     repaint();
3101   }
3102
3103   /**
3104    * DOCUMENT ME!
3105    *
3106    * @param e
3107    *          DOCUMENT ME!
3108    */
3109   @Override
3110   protected void scaleAbove_actionPerformed(ActionEvent e)
3111   {
3112     viewport.setScaleAboveWrapped(scaleAbove.isSelected());
3113     alignPanel.paintAlignment(true);
3114   }
3115
3116   /**
3117    * DOCUMENT ME!
3118    *
3119    * @param e
3120    *          DOCUMENT ME!
3121    */
3122   @Override
3123   protected void scaleLeft_actionPerformed(ActionEvent e)
3124   {
3125     viewport.setScaleLeftWrapped(scaleLeft.isSelected());
3126     alignPanel.paintAlignment(true);
3127   }
3128
3129   /**
3130    * DOCUMENT ME!
3131    *
3132    * @param e
3133    *          DOCUMENT ME!
3134    */
3135   @Override
3136   protected void scaleRight_actionPerformed(ActionEvent e)
3137   {
3138     viewport.setScaleRightWrapped(scaleRight.isSelected());
3139     alignPanel.paintAlignment(true);
3140   }
3141
3142   /**
3143    * DOCUMENT ME!
3144    *
3145    * @param e
3146    *          DOCUMENT ME!
3147    */
3148   @Override
3149   public void viewBoxesMenuItem_actionPerformed(ActionEvent e)
3150   {
3151     viewport.setShowBoxes(viewBoxesMenuItem.isSelected());
3152     alignPanel.paintAlignment(true);
3153   }
3154
3155   /**
3156    * DOCUMENT ME!
3157    *
3158    * @param e
3159    *          DOCUMENT ME!
3160    */
3161   @Override
3162   public void viewTextMenuItem_actionPerformed(ActionEvent e)
3163   {
3164     viewport.setShowText(viewTextMenuItem.isSelected());
3165     alignPanel.paintAlignment(true);
3166   }
3167
3168   /**
3169    * DOCUMENT ME!
3170    *
3171    * @param e
3172    *          DOCUMENT ME!
3173    */
3174   @Override
3175   protected void renderGapsMenuItem_actionPerformed(ActionEvent e)
3176   {
3177     viewport.setRenderGaps(renderGapsMenuItem.isSelected());
3178     alignPanel.paintAlignment(true);
3179   }
3180
3181   public FeatureSettings featureSettings;
3182
3183   @Override
3184   public FeatureSettingsControllerI getFeatureSettingsUI()
3185   {
3186     return featureSettings;
3187   }
3188
3189   @Override
3190   public void featureSettings_actionPerformed(ActionEvent e)
3191   {
3192     if (featureSettings != null)
3193     {
3194       featureSettings.close();
3195       featureSettings = null;
3196     }
3197     if (!showSeqFeatures.isSelected())
3198     {
3199       // make sure features are actually displayed
3200       showSeqFeatures.setSelected(true);
3201       showSeqFeatures_actionPerformed(null);
3202     }
3203     featureSettings = new FeatureSettings(this);
3204   }
3205
3206   /**
3207    * Set or clear 'Show Sequence Features'
3208    *
3209    * @param evt
3210    *          DOCUMENT ME!
3211    */
3212   @Override
3213   public void showSeqFeatures_actionPerformed(ActionEvent evt)
3214   {
3215     viewport.setShowSequenceFeatures(showSeqFeatures.isSelected());
3216     alignPanel.paintAlignment(true);
3217     if (alignPanel.getOverviewPanel() != null)
3218     {
3219       alignPanel.getOverviewPanel().updateOverviewImage();
3220     }
3221   }
3222
3223   /**
3224    * Action on toggle of the 'Show annotations' menu item. This shows or hides
3225    * the annotations panel as a whole.
3226    *
3227    * The options to show/hide all annotations should be enabled when the panel
3228    * is shown, and disabled when the panel is hidden.
3229    *
3230    * @param e
3231    */
3232   @Override
3233   public void annotationPanelMenuItem_actionPerformed(ActionEvent e)
3234   {
3235     final boolean setVisible = annotationPanelMenuItem.isSelected();
3236     viewport.setShowAnnotation(setVisible);
3237     this.showAllSeqAnnotations.setEnabled(setVisible);
3238     this.hideAllSeqAnnotations.setEnabled(setVisible);
3239     this.showAllAlAnnotations.setEnabled(setVisible);
3240     this.hideAllAlAnnotations.setEnabled(setVisible);
3241     alignPanel.updateLayout();
3242   }
3243
3244   @Override
3245   public void alignmentProperties()
3246   {
3247     JEditorPane editPane = new JEditorPane("text/html", "");
3248     editPane.setEditable(false);
3249     StringBuffer contents = new AlignmentProperties(viewport.getAlignment())
3250             .formatAsHtml();
3251     editPane.setText(MessageManager.formatMessage("label.html_content",
3252             new Object[] { contents.toString() }));
3253     JInternalFrame frame = new JInternalFrame();
3254     frame.getContentPane().add(new JScrollPane(editPane));
3255
3256     Desktop.addInternalFrame(frame, MessageManager.formatMessage(
3257             "label.alignment_properties", new Object[] { getTitle() }),
3258             500, 400);
3259   }
3260
3261   /**
3262    * DOCUMENT ME!
3263    *
3264    * @param e
3265    *          DOCUMENT ME!
3266    */
3267   @Override
3268   public void overviewMenuItem_actionPerformed(ActionEvent e)
3269   {
3270     if (alignPanel.overviewPanel != null)
3271     {
3272       return;
3273     }
3274
3275     JInternalFrame frame = new JInternalFrame();
3276     OverviewPanel overview = new OverviewPanel(alignPanel);
3277     frame.setContentPane(overview);
3278     Desktop.addInternalFrame(frame, MessageManager.formatMessage(
3279             "label.overview_params", new Object[] { this.getTitle() }),
3280             frame.getWidth(), frame.getHeight());
3281     frame.pack();
3282     frame.setLayer(JLayeredPane.PALETTE_LAYER);
3283     frame.addInternalFrameListener(new javax.swing.event.InternalFrameAdapter()
3284     {
3285       @Override
3286       public void internalFrameClosed(
3287               javax.swing.event.InternalFrameEvent evt)
3288       {
3289         alignPanel.setOverviewPanel(null);
3290       };
3291     });
3292
3293     alignPanel.setOverviewPanel(overview);
3294   }
3295
3296   @Override
3297   public void textColour_actionPerformed()
3298   {
3299     new TextColourChooser().chooseColour(alignPanel, null);
3300   }
3301
3302   /*
3303    * public void covariationColour_actionPerformed() {
3304    * changeColour(new
3305    * CovariationColourScheme(viewport.getAlignment().getAlignmentAnnotation
3306    * ()[0])); }
3307    */
3308   @Override
3309   public void annotationColour_actionPerformed()
3310   {
3311     new AnnotationColourChooser(viewport, alignPanel);
3312   }
3313
3314   @Override
3315   public void annotationColumn_actionPerformed(ActionEvent e)
3316   {
3317     new AnnotationColumnChooser(viewport, alignPanel);
3318   }
3319
3320   /**
3321    * Action on the user checking or unchecking the option to apply the selected
3322    * colour scheme to all groups. If unchecked, groups may have their own
3323    * independent colour schemes.
3324    *
3325    * @param selected
3326    */
3327   @Override
3328   public void applyToAllGroups_actionPerformed(boolean selected)
3329   {
3330     viewport.setColourAppliesToAllGroups(selected);
3331   }
3332
3333   /**
3334    * Action on user selecting a colour from the colour menu
3335    *
3336    * @param name
3337    *          the name (not the menu item label!) of the colour scheme
3338    */
3339   @Override
3340   public void changeColour_actionPerformed(String name)
3341   {
3342     /*
3343      * 'User Defined' opens a panel to configure or load a
3344      * user-defined colour scheme
3345      */
3346     if (ResidueColourScheme.USER_DEFINED.equals(name))
3347     {
3348       new UserDefinedColours(alignPanel);
3349       return;
3350     }
3351
3352     /*
3353      * otherwise set the chosen colour scheme (or null for 'None')
3354      */
3355     ColourSchemeI cs = ColourSchemes.getInstance().getColourScheme(name,
3356             viewport.getAlignment(), viewport.getHiddenRepSequences());
3357     changeColour(cs);
3358   }
3359
3360   /**
3361    * Actions on setting or changing the alignment colour scheme
3362    *
3363    * @param cs
3364    */
3365   @Override
3366   public void changeColour(ColourSchemeI cs)
3367   {
3368     // TODO: pull up to controller method
3369     ColourMenuHelper.setColourSelected(colourMenu, cs);
3370
3371     viewport.setGlobalColourScheme(cs);
3372
3373     alignPanel.paintAlignment(true);
3374   }
3375
3376   /**
3377    * Show the PID threshold slider panel
3378    */
3379   @Override
3380   protected void modifyPID_actionPerformed()
3381   {
3382     SliderPanel.setPIDSliderSource(alignPanel,
3383             viewport.getResidueShading(), alignPanel.getViewName());
3384     SliderPanel.showPIDSlider();
3385   }
3386
3387   /**
3388    * Show the Conservation slider panel
3389    */
3390   @Override
3391   protected void modifyConservation_actionPerformed()
3392   {
3393     SliderPanel.setConservationSlider(alignPanel,
3394             viewport.getResidueShading(), alignPanel.getViewName());
3395     SliderPanel.showConservationSlider();
3396   }
3397
3398   /**
3399    * Action on selecting or deselecting (Colour) By Conservation
3400    */
3401   @Override
3402   public void conservationMenuItem_actionPerformed(boolean selected)
3403   {
3404     modifyConservation.setEnabled(selected);
3405     viewport.setConservationSelected(selected);
3406     viewport.getResidueShading().setConservationApplied(selected);
3407
3408     changeColour(viewport.getGlobalColourScheme());
3409     if (selected)
3410     {
3411       modifyConservation_actionPerformed();
3412     }
3413     else
3414     {
3415       SliderPanel.hideConservationSlider();
3416     }
3417   }
3418
3419   /**
3420    * Action on selecting or deselecting (Colour) Above PID Threshold
3421    */
3422   @Override
3423   public void abovePIDThreshold_actionPerformed(boolean selected)
3424   {
3425     modifyPID.setEnabled(selected);
3426     viewport.setAbovePIDThreshold(selected);
3427     if (!selected)
3428     {
3429       viewport.getResidueShading().setThreshold(0,
3430               viewport.isIgnoreGapsConsensus());
3431     }
3432
3433     changeColour(viewport.getGlobalColourScheme());
3434     if (selected)
3435     {
3436       modifyPID_actionPerformed();
3437     }
3438     else
3439     {
3440       SliderPanel.hidePIDSlider();
3441     }
3442   }
3443
3444   /**
3445    * DOCUMENT ME!
3446    *
3447    * @param e
3448    *          DOCUMENT ME!
3449    */
3450   @Override
3451   public void sortPairwiseMenuItem_actionPerformed(ActionEvent e)
3452   {
3453     SequenceI[] oldOrder = viewport.getAlignment().getSequencesArray();
3454     AlignmentSorter.sortByPID(viewport.getAlignment(), viewport
3455             .getAlignment().getSequenceAt(0));
3456     addHistoryItem(new OrderCommand("Pairwise Sort", oldOrder,
3457             viewport.getAlignment()));
3458     alignPanel.paintAlignment(true);
3459   }
3460
3461   /**
3462    * DOCUMENT ME!
3463    *
3464    * @param e
3465    *          DOCUMENT ME!
3466    */
3467   @Override
3468   public void sortIDMenuItem_actionPerformed(ActionEvent e)
3469   {
3470     SequenceI[] oldOrder = viewport.getAlignment().getSequencesArray();
3471     AlignmentSorter.sortByID(viewport.getAlignment());
3472     addHistoryItem(new OrderCommand("ID Sort", oldOrder,
3473             viewport.getAlignment()));
3474     alignPanel.paintAlignment(true);
3475   }
3476
3477   /**
3478    * DOCUMENT ME!
3479    *
3480    * @param e
3481    *          DOCUMENT ME!
3482    */
3483   @Override
3484   public void sortLengthMenuItem_actionPerformed(ActionEvent e)
3485   {
3486     SequenceI[] oldOrder = viewport.getAlignment().getSequencesArray();
3487     AlignmentSorter.sortByLength(viewport.getAlignment());
3488     addHistoryItem(new OrderCommand("Length Sort", oldOrder,
3489             viewport.getAlignment()));
3490     alignPanel.paintAlignment(true);
3491   }
3492
3493   /**
3494    * DOCUMENT ME!
3495    *
3496    * @param e
3497    *          DOCUMENT ME!
3498    */
3499   @Override
3500   public void sortGroupMenuItem_actionPerformed(ActionEvent e)
3501   {
3502     SequenceI[] oldOrder = viewport.getAlignment().getSequencesArray();
3503     AlignmentSorter.sortByGroup(viewport.getAlignment());
3504     addHistoryItem(new OrderCommand("Group Sort", oldOrder,
3505             viewport.getAlignment()));
3506
3507     alignPanel.paintAlignment(true);
3508   }
3509
3510   /**
3511    * DOCUMENT ME!
3512    *
3513    * @param e
3514    *          DOCUMENT ME!
3515    */
3516   @Override
3517   public void removeRedundancyMenuItem_actionPerformed(ActionEvent e)
3518   {
3519     new RedundancyPanel(alignPanel, this);
3520   }
3521
3522   /**
3523    * DOCUMENT ME!
3524    *
3525    * @param e
3526    *          DOCUMENT ME!
3527    */
3528   @Override
3529   public void pairwiseAlignmentMenuItem_actionPerformed(ActionEvent e)
3530   {
3531     if ((viewport.getSelectionGroup() == null)
3532             || (viewport.getSelectionGroup().getSize() < 2))
3533     {
3534       JvOptionPane.showInternalMessageDialog(this, MessageManager
3535               .getString("label.you_must_select_least_two_sequences"),
3536               MessageManager.getString("label.invalid_selection"),
3537               JvOptionPane.WARNING_MESSAGE);
3538     }
3539     else
3540     {
3541       JInternalFrame frame = new JInternalFrame();
3542       frame.setContentPane(new PairwiseAlignPanel(viewport));
3543       Desktop.addInternalFrame(frame,
3544               MessageManager.getString("action.pairwise_alignment"), 600,
3545               500);
3546     }
3547   }
3548
3549   /**
3550    * DOCUMENT ME!
3551    *
3552    * @param e
3553    *          DOCUMENT ME!
3554    */
3555   @Override
3556   public void PCAMenuItem_actionPerformed(ActionEvent e)
3557   {
3558     if (((viewport.getSelectionGroup() != null)
3559             && (viewport.getSelectionGroup().getSize() < 4) && (viewport
3560             .getSelectionGroup().getSize() > 0))
3561             || (viewport.getAlignment().getHeight() < 4))
3562     {
3563       JvOptionPane
3564               .showInternalMessageDialog(
3565                       this,
3566                       MessageManager
3567                               .getString("label.principal_component_analysis_must_take_least_four_input_sequences"),
3568                       MessageManager
3569                               .getString("label.sequence_selection_insufficient"),
3570                       JvOptionPane.WARNING_MESSAGE);
3571
3572       return;
3573     }
3574
3575     new PCAPanel(alignPanel);
3576   }
3577
3578   @Override
3579   public void autoCalculate_actionPerformed(ActionEvent e)
3580   {
3581     viewport.autoCalculateConsensus = autoCalculate.isSelected();
3582     if (viewport.autoCalculateConsensus)
3583     {
3584       viewport.firePropertyChange("alignment", null, viewport
3585               .getAlignment().getSequences());
3586     }
3587   }
3588
3589   @Override
3590   public void sortByTreeOption_actionPerformed(ActionEvent e)
3591   {
3592     viewport.sortByTree = sortByTree.isSelected();
3593   }
3594
3595   @Override
3596   protected void listenToViewSelections_actionPerformed(ActionEvent e)
3597   {
3598     viewport.followSelection = listenToViewSelections.isSelected();
3599   }
3600
3601   /**
3602    * Constructs a tree panel and adds it to the desktop
3603    *
3604    * @param type
3605    *          tree type (NJ or AV)
3606    * @param sm
3607    *          distance or similarity score model used to compute the tree
3608    * @param options
3609    *          parameters for the distance or similarity calculation
3610    */
3611   void newTreePanel(String type, ScoreModelI sm, SimilarityParamsI options)
3612   {
3613     String frameTitle = "";
3614     TreePanel tp;
3615
3616     if (viewport.getSelectionGroup() != null
3617             && viewport.getSelectionGroup().getSize() > 0)
3618     {
3619       if (viewport.getSelectionGroup().getSize() < 3)
3620       {
3621         JvOptionPane
3622                 .showMessageDialog(
3623                         Desktop.desktop,
3624                         MessageManager
3625                                 .getString("label.you_need_more_two_sequences_selected_build_tree"),
3626                         MessageManager
3627                                 .getString("label.not_enough_sequences"),
3628                         JvOptionPane.WARNING_MESSAGE);
3629         return;
3630       }
3631
3632       SequenceGroup sg = viewport.getSelectionGroup();
3633
3634       /* Decide if the selection is a column region */
3635       for (SequenceI _s : sg.getSequences())
3636       {
3637         if (_s.getLength() < sg.getEndRes())
3638         {
3639           JvOptionPane
3640                   .showMessageDialog(
3641                           Desktop.desktop,
3642                           MessageManager
3643                                   .getString("label.selected_region_to_tree_may_only_contain_residues_or_gaps"),
3644                           MessageManager
3645                                   .getString("label.sequences_selection_not_aligned"),
3646                           JvOptionPane.WARNING_MESSAGE);
3647
3648           return;
3649         }
3650       }
3651
3652       tp = new TreePanel(alignPanel, type, sm, options);
3653       frameTitle = tp.getPanelTitle() + " on region";
3654     }
3655     else
3656     {
3657       // are the visible sequences aligned?
3658       if (!viewport.getAlignment().isAligned(false))
3659       {
3660         JvOptionPane
3661                 .showMessageDialog(
3662                         Desktop.desktop,
3663                         MessageManager
3664                                 .getString("label.sequences_must_be_aligned_before_creating_tree"),
3665                         MessageManager
3666                                 .getString("label.sequences_not_aligned"),
3667                         JvOptionPane.WARNING_MESSAGE);
3668
3669         return;
3670       }
3671
3672       if (viewport.getAlignment().getHeight() < 2)
3673       {
3674         return;
3675       }
3676
3677       tp = new TreePanel(alignPanel, type, sm, options);
3678       frameTitle = tp.getPanelTitle();
3679     }
3680
3681     frameTitle += " from ";
3682
3683     if (viewport.viewName != null)
3684     {
3685       frameTitle += viewport.viewName + " of ";
3686     }
3687
3688     frameTitle += this.title;
3689
3690     Desktop.addInternalFrame(tp, frameTitle, 600, 500);
3691   }
3692
3693   /**
3694    * DOCUMENT ME!
3695    *
3696    * @param title
3697    *          DOCUMENT ME!
3698    * @param order
3699    *          DOCUMENT ME!
3700    */
3701   public void addSortByOrderMenuItem(String title,
3702           final AlignmentOrder order)
3703   {
3704     final JMenuItem item = new JMenuItem(MessageManager.formatMessage(
3705             "action.by_title_param", new Object[] { title }));
3706     sort.add(item);
3707     item.addActionListener(new java.awt.event.ActionListener()
3708     {
3709       @Override
3710       public void actionPerformed(ActionEvent e)
3711       {
3712         SequenceI[] oldOrder = viewport.getAlignment().getSequencesArray();
3713
3714         // TODO: JBPNote - have to map order entries to curent SequenceI
3715         // pointers
3716         AlignmentSorter.sortBy(viewport.getAlignment(), order);
3717
3718         addHistoryItem(new OrderCommand(order.getName(), oldOrder, viewport
3719                 .getAlignment()));
3720
3721         alignPanel.paintAlignment(true);
3722       }
3723     });
3724   }
3725
3726   /**
3727    * Add a new sort by annotation score menu item
3728    *
3729    * @param sort
3730    *          the menu to add the option to
3731    * @param scoreLabel
3732    *          the label used to retrieve scores for each sequence on the
3733    *          alignment
3734    */
3735   public void addSortByAnnotScoreMenuItem(JMenu sort,
3736           final String scoreLabel)
3737   {
3738     final JMenuItem item = new JMenuItem(scoreLabel);
3739     sort.add(item);
3740     item.addActionListener(new java.awt.event.ActionListener()
3741     {
3742       @Override
3743       public void actionPerformed(ActionEvent e)
3744       {
3745         SequenceI[] oldOrder = viewport.getAlignment().getSequencesArray();
3746         AlignmentSorter.sortByAnnotationScore(scoreLabel,
3747                 viewport.getAlignment());// ,viewport.getSelectionGroup());
3748         addHistoryItem(new OrderCommand("Sort by " + scoreLabel, oldOrder,
3749                 viewport.getAlignment()));
3750         alignPanel.paintAlignment(true);
3751       }
3752     });
3753   }
3754
3755   /**
3756    * last hash for alignment's annotation array - used to minimise cost of
3757    * rebuild.
3758    */
3759   protected int _annotationScoreVectorHash;
3760
3761   /**
3762    * search the alignment and rebuild the sort by annotation score submenu the
3763    * last alignment annotation vector hash is stored to minimize cost of
3764    * rebuilding in subsequence calls.
3765    *
3766    */
3767   @Override
3768   public void buildSortByAnnotationScoresMenu()
3769   {
3770     if (viewport.getAlignment().getAlignmentAnnotation() == null)
3771     {
3772       return;
3773     }
3774
3775     if (viewport.getAlignment().getAlignmentAnnotation().hashCode() != _annotationScoreVectorHash)
3776     {
3777       sortByAnnotScore.removeAll();
3778       // almost certainly a quicker way to do this - but we keep it simple
3779       Hashtable scoreSorts = new Hashtable();
3780       AlignmentAnnotation aann[];
3781       for (SequenceI sqa : viewport.getAlignment().getSequences())
3782       {
3783         aann = sqa.getAnnotation();
3784         for (int i = 0; aann != null && i < aann.length; i++)
3785         {
3786           if (aann[i].hasScore() && aann[i].sequenceRef != null)
3787           {
3788             scoreSorts.put(aann[i].label, aann[i].label);
3789           }
3790         }
3791       }
3792       Enumeration labels = scoreSorts.keys();
3793       while (labels.hasMoreElements())
3794       {
3795         addSortByAnnotScoreMenuItem(sortByAnnotScore,
3796                 (String) labels.nextElement());
3797       }
3798       sortByAnnotScore.setVisible(scoreSorts.size() > 0);
3799       scoreSorts.clear();
3800
3801       _annotationScoreVectorHash = viewport.getAlignment()
3802               .getAlignmentAnnotation().hashCode();
3803     }
3804   }
3805
3806   /**
3807    * Maintain the Order by->Displayed Tree menu. Creates a new menu item for a
3808    * TreePanel with an appropriate <code>jalview.analysis.AlignmentSorter</code>
3809    * call. Listeners are added to remove the menu item when the treePanel is
3810    * closed, and adjust the tree leaf to sequence mapping when the alignment is
3811    * modified.
3812    */
3813   @Override
3814   public void buildTreeSortMenu()
3815   {
3816     sortByTreeMenu.removeAll();
3817
3818     List<Component> comps = PaintRefresher.components.get(viewport
3819             .getSequenceSetId());
3820     List<TreePanel> treePanels = new ArrayList<TreePanel>();
3821     for (Component comp : comps)
3822     {
3823       if (comp instanceof TreePanel)
3824       {
3825         treePanels.add((TreePanel) comp);
3826       }
3827     }
3828
3829     if (treePanels.size() < 1)
3830     {
3831       sortByTreeMenu.setVisible(false);
3832       return;
3833     }
3834
3835     sortByTreeMenu.setVisible(true);
3836
3837     for (final TreePanel tp : treePanels)
3838     {
3839       final JMenuItem item = new JMenuItem(tp.getTitle());
3840       item.addActionListener(new java.awt.event.ActionListener()
3841       {
3842         @Override
3843         public void actionPerformed(ActionEvent e)
3844         {
3845           tp.sortByTree_actionPerformed();
3846           addHistoryItem(tp.sortAlignmentIn(alignPanel));
3847
3848         }
3849       });
3850
3851       sortByTreeMenu.add(item);
3852     }
3853   }
3854
3855   public boolean sortBy(AlignmentOrder alorder, String undoname)
3856   {
3857     SequenceI[] oldOrder = viewport.getAlignment().getSequencesArray();
3858     AlignmentSorter.sortBy(viewport.getAlignment(), alorder);
3859     if (undoname != null)
3860     {
3861       addHistoryItem(new OrderCommand(undoname, oldOrder,
3862               viewport.getAlignment()));
3863     }
3864     alignPanel.paintAlignment(true);
3865     return true;
3866   }
3867
3868   /**
3869    * Work out whether the whole set of sequences or just the selected set will
3870    * be submitted for multiple alignment.
3871    *
3872    */
3873   public jalview.datamodel.AlignmentView gatherSequencesForAlignment()
3874   {
3875     // Now, check we have enough sequences
3876     AlignmentView msa = null;
3877
3878     if ((viewport.getSelectionGroup() != null)
3879             && (viewport.getSelectionGroup().getSize() > 1))
3880     {
3881       // JBPNote UGLY! To prettify, make SequenceGroup and Alignment conform to
3882       // some common interface!
3883       /*
3884        * SequenceGroup seqs = viewport.getSelectionGroup(); int sz; msa = new
3885        * SequenceI[sz = seqs.getSize(false)];
3886        *
3887        * for (int i = 0; i < sz; i++) { msa[i] = (SequenceI)
3888        * seqs.getSequenceAt(i); }
3889        */
3890       msa = viewport.getAlignmentView(true);
3891     }
3892     else if (viewport.getSelectionGroup() != null
3893             && viewport.getSelectionGroup().getSize() == 1)
3894     {
3895       int option = JvOptionPane.showConfirmDialog(this,
3896               MessageManager.getString("warn.oneseq_msainput_selection"),
3897               MessageManager.getString("label.invalid_selection"),
3898               JvOptionPane.OK_CANCEL_OPTION);
3899       if (option == JvOptionPane.OK_OPTION)
3900       {
3901         msa = viewport.getAlignmentView(false);
3902       }
3903     }
3904     else
3905     {
3906       msa = viewport.getAlignmentView(false);
3907     }
3908     return msa;
3909   }
3910
3911   /**
3912    * Decides what is submitted to a secondary structure prediction service: the
3913    * first sequence in the alignment, or in the current selection, or, if the
3914    * alignment is 'aligned' (ie padded with gaps), then the currently selected
3915    * region or the whole alignment. (where the first sequence in the set is the
3916    * one that the prediction will be for).
3917    */
3918   public AlignmentView gatherSeqOrMsaForSecStrPrediction()
3919   {
3920     AlignmentView seqs = null;
3921
3922     if ((viewport.getSelectionGroup() != null)
3923             && (viewport.getSelectionGroup().getSize() > 0))
3924     {
3925       seqs = viewport.getAlignmentView(true);
3926     }
3927     else
3928     {
3929       seqs = viewport.getAlignmentView(false);
3930     }
3931     // limit sequences - JBPNote in future - could spawn multiple prediction
3932     // jobs
3933     // TODO: viewport.getAlignment().isAligned is a global state - the local
3934     // selection may well be aligned - we preserve 2.0.8 behaviour for moment.
3935     if (!viewport.getAlignment().isAligned(false))
3936     {
3937       seqs.setSequences(new SeqCigar[] { seqs.getSequences()[0] });
3938       // TODO: if seqs.getSequences().length>1 then should really have warned
3939       // user!
3940
3941     }
3942     return seqs;
3943   }
3944
3945   /**
3946    * DOCUMENT ME!
3947    *
3948    * @param e
3949    *          DOCUMENT ME!
3950    */
3951   @Override
3952   protected void loadTreeMenuItem_actionPerformed(ActionEvent e)
3953   {
3954     // Pick the tree file
3955     JalviewFileChooser chooser = new JalviewFileChooser(
3956             jalview.bin.Cache.getProperty("LAST_DIRECTORY"));
3957     chooser.setFileView(new JalviewFileView());
3958     chooser.setDialogTitle(MessageManager
3959             .getString("label.select_newick_like_tree_file"));
3960     chooser.setToolTipText(MessageManager.getString("label.load_tree_file"));
3961
3962     int value = chooser.showOpenDialog(null);
3963
3964     if (value == JalviewFileChooser.APPROVE_OPTION)
3965     {
3966       String filePath = chooser.getSelectedFile().getPath();
3967       Cache.setProperty("LAST_DIRECTORY", filePath);
3968       NewickFile fin = null;
3969       try
3970       {
3971         fin = new NewickFile(filePath, DataSourceType.FILE);
3972         viewport.setCurrentTree(showNewickTree(fin, filePath).getTree());
3973       } catch (Exception ex)
3974       {
3975         JvOptionPane
3976                 .showMessageDialog(
3977                         Desktop.desktop,
3978                         ex.getMessage(),
3979                         MessageManager
3980                                 .getString("label.problem_reading_tree_file"),
3981                         JvOptionPane.WARNING_MESSAGE);
3982         ex.printStackTrace();
3983       }
3984       if (fin != null && fin.hasWarningMessage())
3985       {
3986         JvOptionPane.showMessageDialog(Desktop.desktop, fin
3987                 .getWarningMessage(), MessageManager
3988                 .getString("label.possible_problem_with_tree_file"),
3989                 JvOptionPane.WARNING_MESSAGE);
3990       }
3991     }
3992   }
3993
3994   public TreePanel showNewickTree(NewickFile nf, String treeTitle)
3995   {
3996     return showNewickTree(nf, treeTitle, 600, 500, 4, 5);
3997   }
3998
3999   public TreePanel showNewickTree(NewickFile nf, String treeTitle, int w,
4000           int h, int x, int y)
4001   {
4002     return showNewickTree(nf, treeTitle, null, w, h, x, y);
4003   }
4004
4005   /**
4006    * Add a treeviewer for the tree extracted from a Newick file object to the
4007    * current alignment view
4008    *
4009    * @param nf
4010    *          the tree
4011    * @param title
4012    *          tree viewer title
4013    * @param input
4014    *          Associated alignment input data (or null)
4015    * @param w
4016    *          width
4017    * @param h
4018    *          height
4019    * @param x
4020    *          position
4021    * @param y
4022    *          position
4023    * @return TreePanel handle
4024    */
4025   public TreePanel showNewickTree(NewickFile nf, String treeTitle,
4026           AlignmentView input, int w, int h, int x, int y)
4027   {
4028     TreePanel tp = null;
4029
4030     try
4031     {
4032       nf.parse();
4033
4034       if (nf.getTree() != null)
4035       {
4036         tp = new TreePanel(alignPanel, nf, treeTitle, input);
4037
4038         tp.setSize(w, h);
4039
4040         if (x > 0 && y > 0)
4041         {
4042           tp.setLocation(x, y);
4043         }
4044
4045         Desktop.addInternalFrame(tp, treeTitle, w, h);
4046       }
4047     } catch (Exception ex)
4048     {
4049       ex.printStackTrace();
4050     }
4051
4052     return tp;
4053   }
4054
4055   private boolean buildingMenu = false;
4056
4057   /**
4058    * Generates menu items and listener event actions for web service clients
4059    *
4060    */
4061   public void BuildWebServiceMenu()
4062   {
4063     while (buildingMenu)
4064     {
4065       try
4066       {
4067         System.err.println("Waiting for building menu to finish.");
4068         Thread.sleep(10);
4069       } catch (Exception e)
4070       {
4071       }
4072     }
4073     final AlignFrame me = this;
4074     buildingMenu = true;
4075     new Thread(new Runnable()
4076     {
4077       @Override
4078       public void run()
4079       {
4080         final List<JMenuItem> legacyItems = new ArrayList<JMenuItem>();
4081         try
4082         {
4083           // System.err.println("Building ws menu again "
4084           // + Thread.currentThread());
4085           // TODO: add support for context dependent disabling of services based
4086           // on
4087           // alignment and current selection
4088           // TODO: add additional serviceHandle parameter to specify abstract
4089           // handler
4090           // class independently of AbstractName
4091           // TODO: add in rediscovery GUI function to restart discoverer
4092           // TODO: group services by location as well as function and/or
4093           // introduce
4094           // object broker mechanism.
4095           final Vector<JMenu> wsmenu = new Vector<JMenu>();
4096           final IProgressIndicator af = me;
4097
4098           /*
4099            * do not i18n these strings - they are hard-coded in class
4100            * compbio.data.msa.Category, Jws2Discoverer.isRecalculable() and
4101            * SequenceAnnotationWSClient.initSequenceAnnotationWSClient()
4102            */
4103           final JMenu msawsmenu = new JMenu("Alignment");
4104           final JMenu secstrmenu = new JMenu(
4105                   "Secondary Structure Prediction");
4106           final JMenu seqsrchmenu = new JMenu("Sequence Database Search");
4107           final JMenu analymenu = new JMenu("Analysis");
4108           final JMenu dismenu = new JMenu("Protein Disorder");
4109           // JAL-940 - only show secondary structure prediction services from
4110           // the legacy server
4111           if (// Cache.getDefault("SHOW_JWS1_SERVICES", true)
4112               // &&
4113           Discoverer.services != null && (Discoverer.services.size() > 0))
4114           {
4115             // TODO: refactor to allow list of AbstractName/Handler bindings to
4116             // be
4117             // stored or retrieved from elsewhere
4118             // No MSAWS used any more:
4119             // Vector msaws = null; // (Vector)
4120             // Discoverer.services.get("MsaWS");
4121             Vector secstrpr = (Vector) Discoverer.services
4122                     .get("SecStrPred");
4123             if (secstrpr != null)
4124             {
4125               // Add any secondary structure prediction services
4126               for (int i = 0, j = secstrpr.size(); i < j; i++)
4127               {
4128                 final ext.vamsas.ServiceHandle sh = (ext.vamsas.ServiceHandle) secstrpr
4129                         .get(i);
4130                 jalview.ws.WSMenuEntryProviderI impl = jalview.ws.jws1.Discoverer
4131                         .getServiceClient(sh);
4132                 int p = secstrmenu.getItemCount();
4133                 impl.attachWSMenuEntry(secstrmenu, me);
4134                 int q = secstrmenu.getItemCount();
4135                 for (int litm = p; litm < q; litm++)
4136                 {
4137                   legacyItems.add(secstrmenu.getItem(litm));
4138                 }
4139               }
4140             }
4141           }
4142
4143           // Add all submenus in the order they should appear on the web
4144           // services menu
4145           wsmenu.add(msawsmenu);
4146           wsmenu.add(secstrmenu);
4147           wsmenu.add(dismenu);
4148           wsmenu.add(analymenu);
4149           // No search services yet
4150           // wsmenu.add(seqsrchmenu);
4151
4152           javax.swing.SwingUtilities.invokeLater(new Runnable()
4153           {
4154             @Override
4155             public void run()
4156             {
4157               try
4158               {
4159                 webService.removeAll();
4160                 // first, add discovered services onto the webservices menu
4161                 if (wsmenu.size() > 0)
4162                 {
4163                   for (int i = 0, j = wsmenu.size(); i < j; i++)
4164                   {
4165                     webService.add(wsmenu.get(i));
4166                   }
4167                 }
4168                 else
4169                 {
4170                   webService.add(me.webServiceNoServices);
4171                 }
4172                 // TODO: move into separate menu builder class.
4173                 boolean new_sspred = false;
4174                 if (Cache.getDefault("SHOW_JWS2_SERVICES", true))
4175                 {
4176                   Jws2Discoverer jws2servs = Jws2Discoverer.getDiscoverer();
4177                   if (jws2servs != null)
4178                   {
4179                     if (jws2servs.hasServices())
4180                     {
4181                       jws2servs.attachWSMenuEntry(webService, me);
4182                       for (Jws2Instance sv : jws2servs.getServices())
4183                       {
4184                         if (sv.description.toLowerCase().contains("jpred"))
4185                         {
4186                           for (JMenuItem jmi : legacyItems)
4187                           {
4188                             jmi.setVisible(false);
4189                           }
4190                         }
4191                       }
4192
4193                     }
4194                     if (jws2servs.isRunning())
4195                     {
4196                       JMenuItem tm = new JMenuItem(
4197                               "Still discovering JABA Services");
4198                       tm.setEnabled(false);
4199                       webService.add(tm);
4200                     }
4201                   }
4202                 }
4203                 build_urlServiceMenu(me.webService);
4204                 build_fetchdbmenu(webService);
4205                 for (JMenu item : wsmenu)
4206                 {
4207                   if (item.getItemCount() == 0)
4208                   {
4209                     item.setEnabled(false);
4210                   }
4211                   else
4212                   {
4213                     item.setEnabled(true);
4214                   }
4215                 }
4216               } catch (Exception e)
4217               {
4218                 Cache.log
4219                         .debug("Exception during web service menu building process.",
4220                                 e);
4221               }
4222             }
4223           });
4224         } catch (Exception e)
4225         {
4226         }
4227         buildingMenu = false;
4228       }
4229     }).start();
4230
4231   }
4232
4233   /**
4234    * construct any groupURL type service menu entries.
4235    *
4236    * @param webService
4237    */
4238   private void build_urlServiceMenu(JMenu webService)
4239   {
4240     // TODO: remove this code when 2.7 is released
4241     // DEBUG - alignmentView
4242     /*
4243      * JMenuItem testAlView = new JMenuItem("Test AlignmentView"); final
4244      * AlignFrame af = this; testAlView.addActionListener(new ActionListener() {
4245      *
4246      * @Override public void actionPerformed(ActionEvent e) {
4247      * jalview.datamodel.AlignmentView
4248      * .testSelectionViews(af.viewport.getAlignment(),
4249      * af.viewport.getColumnSelection(), af.viewport.selectionGroup); }
4250      *
4251      * }); webService.add(testAlView);
4252      */
4253     // TODO: refactor to RestClient discoverer and merge menu entries for
4254     // rest-style services with other types of analysis/calculation service
4255     // SHmmr test client - still being implemented.
4256     // DEBUG - alignmentView
4257
4258     for (jalview.ws.rest.RestClient client : jalview.ws.rest.RestClient
4259             .getRestClients())
4260     {
4261       client.attachWSMenuEntry(
4262               JvSwingUtils.findOrCreateMenu(webService, client.getAction()),
4263               this);
4264     }
4265   }
4266
4267   /**
4268    * Searches the alignment sequences for xRefs and builds the Show
4269    * Cross-References menu (formerly called Show Products), with database
4270    * sources for which cross-references are found (protein sources for a
4271    * nucleotide alignment and vice versa)
4272    *
4273    * @return true if Show Cross-references menu should be enabled
4274    */
4275   public boolean canShowProducts()
4276   {
4277     SequenceI[] seqs = viewport.getAlignment().getSequencesArray();
4278     AlignmentI dataset = viewport.getAlignment().getDataset();
4279
4280     showProducts.removeAll();
4281     final boolean dna = viewport.getAlignment().isNucleotide();
4282
4283     if (seqs == null || seqs.length == 0)
4284     {
4285       // nothing to see here.
4286       return false;
4287     }
4288
4289     boolean showp = false;
4290     try
4291     {
4292       List<String> ptypes = new CrossRef(seqs, dataset)
4293               .findXrefSourcesForSequences(dna);
4294
4295       for (final String source : ptypes)
4296       {
4297         showp = true;
4298         final AlignFrame af = this;
4299         JMenuItem xtype = new JMenuItem(source);
4300         xtype.addActionListener(new ActionListener()
4301         {
4302           @Override
4303           public void actionPerformed(ActionEvent e)
4304           {
4305             showProductsFor(af.viewport.getSequenceSelection(), dna, source);
4306           }
4307         });
4308         showProducts.add(xtype);
4309       }
4310       showProducts.setVisible(showp);
4311       showProducts.setEnabled(showp);
4312     } catch (Exception e)
4313     {
4314       Cache.log
4315               .warn("canShowProducts threw an exception - please report to help@jalview.org",
4316                       e);
4317       return false;
4318     }
4319     return showp;
4320   }
4321
4322   /**
4323    * Finds and displays cross-references for the selected sequences (protein
4324    * products for nucleotide sequences, dna coding sequences for peptides).
4325    *
4326    * @param sel
4327    *          the sequences to show cross-references for
4328    * @param dna
4329    *          true if from a nucleotide alignment (so showing proteins)
4330    * @param source
4331    *          the database to show cross-references for
4332    */
4333   protected void showProductsFor(final SequenceI[] sel,
4334           final boolean _odna, final String source)
4335   {
4336     new Thread(CrossRefAction.showProductsFor(sel, _odna, source, this))
4337             .start();
4338   }
4339
4340   /**
4341    * Construct and display a new frame containing the translation of this
4342    * frame's DNA sequences to their aligned protein (amino acid) equivalents.
4343    */
4344   @Override
4345   public void showTranslation_actionPerformed(ActionEvent e)
4346   {
4347     AlignmentI al = null;
4348     try
4349     {
4350       Dna dna = new Dna(viewport, viewport.getViewAsVisibleContigs(true));
4351
4352       al = dna.translateCdna();
4353     } catch (Exception ex)
4354     {
4355       jalview.bin.Cache.log.error(
4356               "Exception during translation. Please report this !", ex);
4357       final String msg = MessageManager
4358               .getString("label.error_when_translating_sequences_submit_bug_report");
4359       final String errorTitle = MessageManager
4360               .getString("label.implementation_error")
4361               + MessageManager.getString("label.translation_failed");
4362       JvOptionPane.showMessageDialog(Desktop.desktop, msg, errorTitle,
4363               JvOptionPane.ERROR_MESSAGE);
4364       return;
4365     }
4366     if (al == null || al.getHeight() == 0)
4367     {
4368       final String msg = MessageManager
4369               .getString("label.select_at_least_three_bases_in_at_least_one_sequence_to_cDNA_translation");
4370       final String errorTitle = MessageManager
4371               .getString("label.translation_failed");
4372       JvOptionPane.showMessageDialog(Desktop.desktop, msg, errorTitle,
4373               JvOptionPane.WARNING_MESSAGE);
4374     }
4375     else
4376     {
4377       AlignFrame af = new AlignFrame(al, DEFAULT_WIDTH, DEFAULT_HEIGHT);
4378       af.setFileFormat(this.currentFileFormat);
4379       final String newTitle = MessageManager.formatMessage(
4380               "label.translation_of_params",
4381               new Object[] { this.getTitle() });
4382       af.setTitle(newTitle);
4383       if (Cache.getDefault(Preferences.ENABLE_SPLIT_FRAME, true))
4384       {
4385         final SequenceI[] seqs = viewport.getSelectionAsNewSequence();
4386         viewport.openSplitFrame(af, new Alignment(seqs));
4387       }
4388       else
4389       {
4390         Desktop.addInternalFrame(af, newTitle, DEFAULT_WIDTH,
4391                 DEFAULT_HEIGHT);
4392       }
4393     }
4394   }
4395
4396   /**
4397    * Set the file format
4398    *
4399    * @param format
4400    */
4401   public void setFileFormat(FileFormatI format)
4402   {
4403     this.currentFileFormat = format;
4404   }
4405
4406   /**
4407    * Try to load a features file onto the alignment.
4408    *
4409    * @param file
4410    *          contents or path to retrieve file
4411    * @param sourceType
4412    *          access mode of file (see jalview.io.AlignFile)
4413    * @return true if features file was parsed correctly.
4414    */
4415   public boolean parseFeaturesFile(String file, DataSourceType sourceType)
4416   {
4417     return avc.parseFeaturesFile(file, sourceType,
4418             Cache.getDefault("RELAXEDSEQIDMATCHING", false));
4419
4420   }
4421
4422   @Override
4423   public void refreshFeatureUI(boolean enableIfNecessary)
4424   {
4425     // note - currently this is only still here rather than in the controller
4426     // because of the featureSettings hard reference that is yet to be
4427     // abstracted
4428     if (enableIfNecessary)
4429     {
4430       viewport.setShowSequenceFeatures(true);
4431       showSeqFeatures.setSelected(true);
4432     }
4433
4434   }
4435
4436   @Override
4437   public void dragEnter(DropTargetDragEvent evt)
4438   {
4439   }
4440
4441   @Override
4442   public void dragExit(DropTargetEvent evt)
4443   {
4444   }
4445
4446   @Override
4447   public void dragOver(DropTargetDragEvent evt)
4448   {
4449   }
4450
4451   @Override
4452   public void dropActionChanged(DropTargetDragEvent evt)
4453   {
4454   }
4455
4456   @Override
4457   public void drop(DropTargetDropEvent evt)
4458   {
4459     // JAL-1552 - acceptDrop required before getTransferable call for
4460     // Java's Transferable for native dnd
4461     evt.acceptDrop(DnDConstants.ACTION_COPY_OR_MOVE);
4462     Transferable t = evt.getTransferable();
4463     List<String> files = new ArrayList<String>();
4464     List<DataSourceType> protocols = new ArrayList<DataSourceType>();
4465
4466     try
4467     {
4468       Desktop.transferFromDropTarget(files, protocols, evt, t);
4469     } catch (Exception e)
4470     {
4471       e.printStackTrace();
4472     }
4473     if (files != null)
4474     {
4475       try
4476       {
4477         // check to see if any of these files have names matching sequences in
4478         // the alignment
4479         SequenceIdMatcher idm = new SequenceIdMatcher(viewport
4480                 .getAlignment().getSequencesArray());
4481         /**
4482          * Object[] { String,SequenceI}
4483          */
4484         ArrayList<Object[]> filesmatched = new ArrayList<Object[]>();
4485         ArrayList<String> filesnotmatched = new ArrayList<String>();
4486         for (int i = 0; i < files.size(); i++)
4487         {
4488           String file = files.get(i).toString();
4489           String pdbfn = "";
4490           DataSourceType protocol = FormatAdapter.checkProtocol(file);
4491           if (protocol == DataSourceType.FILE)
4492           {
4493             File fl = new File(file);
4494             pdbfn = fl.getName();
4495           }
4496           else if (protocol == DataSourceType.URL)
4497           {
4498             URL url = new URL(file);
4499             pdbfn = url.getFile();
4500           }
4501           if (pdbfn.length() > 0)
4502           {
4503             // attempt to find a match in the alignment
4504             SequenceI[] mtch = idm.findAllIdMatches(pdbfn);
4505             int l = 0, c = pdbfn.indexOf(".");
4506             while (mtch == null && c != -1)
4507             {
4508               do
4509               {
4510                 l = c;
4511               } while ((c = pdbfn.indexOf(".", l)) > l);
4512               if (l > -1)
4513               {
4514                 pdbfn = pdbfn.substring(0, l);
4515               }
4516               mtch = idm.findAllIdMatches(pdbfn);
4517             }
4518             if (mtch != null)
4519             {
4520               FileFormatI type = null;
4521               try
4522               {
4523                 type = new IdentifyFile().identify(file, protocol);
4524               } catch (Exception ex)
4525               {
4526                 type = null;
4527               }
4528               if (type != null && type.isStructureFile())
4529               {
4530                 filesmatched.add(new Object[] { file, protocol, mtch });
4531                 continue;
4532               }
4533             }
4534             // File wasn't named like one of the sequences or wasn't a PDB file.
4535             filesnotmatched.add(file);
4536           }
4537         }
4538         int assocfiles = 0;
4539         if (filesmatched.size() > 0)
4540         {
4541           if (Cache.getDefault("AUTOASSOCIATE_PDBANDSEQS", false)
4542                   || JvOptionPane
4543                           .showConfirmDialog(
4544                                   this,
4545                                   MessageManager
4546                                           .formatMessage(
4547                                                   "label.automatically_associate_structure_files_with_sequences_same_name",
4548                                                   new Object[] { Integer
4549                                                           .valueOf(
4550                                                                   filesmatched
4551                                                                           .size())
4552                                                           .toString() }),
4553                                   MessageManager
4554                                           .getString("label.automatically_associate_structure_files_by_name"),
4555                                   JvOptionPane.YES_NO_OPTION) == JvOptionPane.YES_OPTION)
4556
4557           {
4558             for (Object[] fm : filesmatched)
4559             {
4560               // try and associate
4561               // TODO: may want to set a standard ID naming formalism for
4562               // associating PDB files which have no IDs.
4563               for (SequenceI toassoc : (SequenceI[]) fm[2])
4564               {
4565                 PDBEntry pe = new AssociatePdbFileWithSeq()
4566                         .associatePdbWithSeq((String) fm[0],
4567                                 (DataSourceType) fm[1], toassoc, false,
4568                                 Desktop.instance);
4569                 if (pe != null)
4570                 {
4571                   System.err.println("Associated file : "
4572                           + ((String) fm[0]) + " with "
4573                           + toassoc.getDisplayId(true));
4574                   assocfiles++;
4575                 }
4576               }
4577               alignPanel.paintAlignment(true);
4578             }
4579           }
4580         }
4581         if (filesnotmatched.size() > 0)
4582         {
4583           if (assocfiles > 0
4584                   && (Cache.getDefault(
4585                           "AUTOASSOCIATE_PDBANDSEQS_IGNOREOTHERS", false) || JvOptionPane
4586                           .showConfirmDialog(
4587                                   this,
4588                                   "<html>"
4589                                           + MessageManager
4590                                                   .formatMessage(
4591                                                           "label.ignore_unmatched_dropped_files_info",
4592                                                           new Object[] { Integer
4593                                                                   .valueOf(
4594                                                                           filesnotmatched
4595                                                                                   .size())
4596                                                                   .toString() })
4597                                           + "</html>",
4598                                   MessageManager
4599                                           .getString("label.ignore_unmatched_dropped_files"),
4600                                   JvOptionPane.YES_NO_OPTION) == JvOptionPane.YES_OPTION))
4601           {
4602             return;
4603           }
4604           for (String fn : filesnotmatched)
4605           {
4606             loadJalviewDataFile(fn, null, null, null);
4607           }
4608
4609         }
4610       } catch (Exception ex)
4611       {
4612         ex.printStackTrace();
4613       }
4614     }
4615   }
4616
4617   /**
4618    * Attempt to load a "dropped" file or URL string, by testing in turn for
4619    * <ul>
4620    * <li>an Annotation file</li>
4621    * <li>a JNet file</li>
4622    * <li>a features file</li>
4623    * <li>else try to interpret as an alignment file</li>
4624    * </ul>
4625    *
4626    * @param file
4627    *          either a filename or a URL string.
4628    */
4629   public void loadJalviewDataFile(String file, DataSourceType sourceType,
4630           FileFormatI format, SequenceI assocSeq)
4631   {
4632     try
4633     {
4634       if (sourceType == null)
4635       {
4636         sourceType = FormatAdapter.checkProtocol(file);
4637       }
4638       // if the file isn't identified, or not positively identified as some
4639       // other filetype (PFAM is default unidentified alignment file type) then
4640       // try to parse as annotation.
4641       boolean isAnnotation = (format == null || FileFormat.Pfam
4642               .equals(format)) ? new AnnotationFile()
4643               .annotateAlignmentView(viewport, file, sourceType) : false;
4644
4645       if (!isAnnotation)
4646       {
4647         // first see if its a T-COFFEE score file
4648         TCoffeeScoreFile tcf = null;
4649         try
4650         {
4651           tcf = new TCoffeeScoreFile(file, sourceType);
4652           if (tcf.isValid())
4653           {
4654             if (tcf.annotateAlignment(viewport.getAlignment(), true))
4655             {
4656               buildColourMenu();
4657               changeColour(new TCoffeeColourScheme(viewport.getAlignment()));
4658               isAnnotation = true;
4659               statusBar
4660                       .setText(MessageManager
4661                               .getString("label.successfully_pasted_tcoffee_scores_to_alignment"));
4662             }
4663             else
4664             {
4665               // some problem - if no warning its probable that the ID matching
4666               // process didn't work
4667               JvOptionPane
4668                       .showMessageDialog(
4669                               Desktop.desktop,
4670                               tcf.getWarningMessage() == null ? MessageManager
4671                                       .getString("label.check_file_matches_sequence_ids_alignment")
4672                                       : tcf.getWarningMessage(),
4673                               MessageManager
4674                                       .getString("label.problem_reading_tcoffee_score_file"),
4675                               JvOptionPane.WARNING_MESSAGE);
4676             }
4677           }
4678           else
4679           {
4680             tcf = null;
4681           }
4682         } catch (Exception x)
4683         {
4684           Cache.log
4685                   .debug("Exception when processing data source as T-COFFEE score file",
4686                           x);
4687           tcf = null;
4688         }
4689         if (tcf == null)
4690         {
4691           // try to see if its a JNet 'concise' style annotation file *before*
4692           // we
4693           // try to parse it as a features file
4694           if (format == null)
4695           {
4696             format = new IdentifyFile().identify(file, sourceType);
4697           }
4698           if (FileFormat.ScoreMatrix == format)
4699           {
4700             ScoreMatrixFile sm = new ScoreMatrixFile(new FileParse(file,
4701                     sourceType));
4702             sm.parse();
4703             // todo: i18n this message
4704             statusBar
4705                     .setText(MessageManager.formatMessage(
4706                             "label.successfully_loaded_matrix",
4707                             sm.getMatrixName()));
4708           }
4709           else if (FileFormat.Jnet.equals(format))
4710           {
4711             JPredFile predictions = new JPredFile(file, sourceType);
4712             new JnetAnnotationMaker();
4713             JnetAnnotationMaker.add_annotation(predictions,
4714                     viewport.getAlignment(), 0, false);
4715             SequenceI repseq = viewport.getAlignment().getSequenceAt(0);
4716             viewport.getAlignment().setSeqrep(repseq);
4717             ColumnSelection cs = new ColumnSelection();
4718             cs.hideInsertionsFor(repseq);
4719             viewport.setColumnSelection(cs);
4720             isAnnotation = true;
4721           }
4722           // else if (IdentifyFile.FeaturesFile.equals(format))
4723           else if (FileFormat.Features.equals(format))
4724           {
4725             if (parseFeaturesFile(file, sourceType))
4726             {
4727               alignPanel.paintAlignment(true);
4728             }
4729           }
4730           else
4731           {
4732             new FileLoader().LoadFile(viewport, file, sourceType, format);
4733           }
4734         }
4735       }
4736       if (isAnnotation)
4737       {
4738
4739         alignPanel.adjustAnnotationHeight();
4740         viewport.updateSequenceIdColours();
4741         buildSortByAnnotationScoresMenu();
4742         alignPanel.paintAlignment(true);
4743       }
4744     } catch (Exception ex)
4745     {
4746       ex.printStackTrace();
4747     } catch (OutOfMemoryError oom)
4748     {
4749       try
4750       {
4751         System.gc();
4752       } catch (Exception x)
4753       {
4754       }
4755       new OOMWarning(
4756               "loading data "
4757                       + (sourceType != null ? (sourceType == DataSourceType.PASTE ? "from clipboard."
4758                               : "using " + sourceType + " from " + file)
4759                               : ".")
4760                       + (format != null ? "(parsing as '" + format
4761                               + "' file)" : ""), oom, Desktop.desktop);
4762     }
4763   }
4764
4765   /**
4766    * Method invoked by the ChangeListener on the tabbed pane, in other words
4767    * when a different tabbed pane is selected by the user or programmatically.
4768    */
4769   @Override
4770   public void tabSelectionChanged(int index)
4771   {
4772     if (index > -1)
4773     {
4774       alignPanel = alignPanels.get(index);
4775       viewport = alignPanel.av;
4776       avc.setViewportAndAlignmentPanel(viewport, alignPanel);
4777       setMenusFromViewport(viewport);
4778     }
4779
4780     /*
4781      * 'focus' any colour slider that is open to the selected viewport
4782      */
4783     if (viewport.getConservationSelected())
4784     {
4785       SliderPanel.setConservationSlider(alignPanel,
4786               viewport.getResidueShading(), alignPanel.getViewName());
4787     }
4788     else
4789     {
4790       SliderPanel.hideConservationSlider();
4791     }
4792     if (viewport.getAbovePIDThreshold())
4793     {
4794       SliderPanel.setPIDSliderSource(alignPanel,
4795               viewport.getResidueShading(), alignPanel.getViewName());
4796     }
4797     else
4798     {
4799       SliderPanel.hidePIDSlider();
4800     }
4801
4802     /*
4803      * If there is a frame linked to this one in a SplitPane, switch it to the
4804      * same view tab index. No infinite recursion of calls should happen, since
4805      * tabSelectionChanged() should not get invoked on setting the selected
4806      * index to an unchanged value. Guard against setting an invalid index
4807      * before the new view peer tab has been created.
4808      */
4809     final AlignViewportI peer = viewport.getCodingComplement();
4810     if (peer != null)
4811     {
4812       AlignFrame linkedAlignFrame = ((AlignViewport) peer).getAlignPanel().alignFrame;
4813       if (linkedAlignFrame.tabbedPane.getTabCount() > index)
4814       {
4815         linkedAlignFrame.tabbedPane.setSelectedIndex(index);
4816       }
4817     }
4818   }
4819
4820   /**
4821    * On right mouse click on view tab, prompt for and set new view name.
4822    */
4823   @Override
4824   public void tabbedPane_mousePressed(MouseEvent e)
4825   {
4826     if (e.isPopupTrigger())
4827     {
4828       String msg = MessageManager.getString("label.enter_view_name");
4829       String reply = JvOptionPane.showInternalInputDialog(this, msg, msg,
4830               JvOptionPane.QUESTION_MESSAGE);
4831
4832       if (reply != null)
4833       {
4834         viewport.viewName = reply;
4835         // TODO warn if reply is in getExistingViewNames()?
4836         tabbedPane.setTitleAt(tabbedPane.getSelectedIndex(), reply);
4837       }
4838     }
4839   }
4840
4841   public AlignViewport getCurrentView()
4842   {
4843     return viewport;
4844   }
4845
4846   /**
4847    * Open the dialog for regex description parsing.
4848    */
4849   @Override
4850   protected void extractScores_actionPerformed(ActionEvent e)
4851   {
4852     ParseProperties pp = new jalview.analysis.ParseProperties(
4853             viewport.getAlignment());
4854     // TODO: verify regex and introduce GUI dialog for version 2.5
4855     // if (pp.getScoresFromDescription("col", "score column ",
4856     // "\\W*([-+]?\\d*\\.?\\d*e?-?\\d*)\\W+([-+]?\\d*\\.?\\d*e?-?\\d*)",
4857     // true)>0)
4858     if (pp.getScoresFromDescription("description column",
4859             "score in description column ", "\\W*([-+eE0-9.]+)", true) > 0)
4860     {
4861       buildSortByAnnotationScoresMenu();
4862     }
4863   }
4864
4865   /*
4866    * (non-Javadoc)
4867    *
4868    * @see
4869    * jalview.jbgui.GAlignFrame#showDbRefs_actionPerformed(java.awt.event.ActionEvent
4870    * )
4871    */
4872   @Override
4873   protected void showDbRefs_actionPerformed(ActionEvent e)
4874   {
4875     viewport.setShowDBRefs(showDbRefsMenuitem.isSelected());
4876   }
4877
4878   /*
4879    * (non-Javadoc)
4880    *
4881    * @seejalview.jbgui.GAlignFrame#showNpFeats_actionPerformed(java.awt.event.
4882    * ActionEvent)
4883    */
4884   @Override
4885   protected void showNpFeats_actionPerformed(ActionEvent e)
4886   {
4887     viewport.setShowNPFeats(showNpFeatsMenuitem.isSelected());
4888   }
4889
4890   /**
4891    * find the viewport amongst the tabs in this alignment frame and close that
4892    * tab
4893    *
4894    * @param av
4895    */
4896   public boolean closeView(AlignViewportI av)
4897   {
4898     if (viewport == av)
4899     {
4900       this.closeMenuItem_actionPerformed(false);
4901       return true;
4902     }
4903     Component[] comp = tabbedPane.getComponents();
4904     for (int i = 0; comp != null && i < comp.length; i++)
4905     {
4906       if (comp[i] instanceof AlignmentPanel)
4907       {
4908         if (((AlignmentPanel) comp[i]).av == av)
4909         {
4910           // close the view.
4911           closeView((AlignmentPanel) comp[i]);
4912           return true;
4913         }
4914       }
4915     }
4916     return false;
4917   }
4918
4919   protected void build_fetchdbmenu(JMenu webService)
4920   {
4921     // Temporary hack - DBRef Fetcher always top level ws entry.
4922     // TODO We probably want to store a sequence database checklist in
4923     // preferences and have checkboxes.. rather than individual sources selected
4924     // here
4925     final JMenu rfetch = new JMenu(
4926             MessageManager.getString("action.fetch_db_references"));
4927     rfetch.setToolTipText(MessageManager
4928             .getString("label.retrieve_parse_sequence_database_records_alignment_or_selected_sequences"));
4929     webService.add(rfetch);
4930
4931     final JCheckBoxMenuItem trimrs = new JCheckBoxMenuItem(
4932             MessageManager.getString("option.trim_retrieved_seqs"));
4933     trimrs.setToolTipText(MessageManager
4934             .getString("label.trim_retrieved_sequences"));
4935     trimrs.setSelected(Cache.getDefault("TRIM_FETCHED_DATASET_SEQS", true));
4936     trimrs.addActionListener(new ActionListener()
4937     {
4938       @Override
4939       public void actionPerformed(ActionEvent e)
4940       {
4941         trimrs.setSelected(trimrs.isSelected());
4942         Cache.setProperty("TRIM_FETCHED_DATASET_SEQS",
4943                 Boolean.valueOf(trimrs.isSelected()).toString());
4944       };
4945     });
4946     rfetch.add(trimrs);
4947     JMenuItem fetchr = new JMenuItem(
4948             MessageManager.getString("label.standard_databases"));
4949     fetchr.setToolTipText(MessageManager
4950             .getString("label.fetch_embl_uniprot"));
4951     fetchr.addActionListener(new ActionListener()
4952     {
4953
4954       @Override
4955       public void actionPerformed(ActionEvent e)
4956       {
4957         new Thread(new Runnable()
4958         {
4959           @Override
4960           public void run()
4961           {
4962             boolean isNucleotide = alignPanel.alignFrame.getViewport()
4963                     .getAlignment().isNucleotide();
4964             DBRefFetcher dbRefFetcher = new DBRefFetcher(alignPanel.av
4965                     .getSequenceSelection(), alignPanel.alignFrame, null,
4966                     alignPanel.alignFrame.featureSettings, isNucleotide);
4967             dbRefFetcher.addListener(new FetchFinishedListenerI()
4968             {
4969               @Override
4970               public void finished()
4971               {
4972                 AlignFrame.this.setMenusForViewport();
4973               }
4974             });
4975             dbRefFetcher.fetchDBRefs(false);
4976           }
4977         }).start();
4978
4979       }
4980
4981     });
4982     rfetch.add(fetchr);
4983     final AlignFrame me = this;
4984     new Thread(new Runnable()
4985     {
4986       @Override
4987       public void run()
4988       {
4989         final jalview.ws.SequenceFetcher sf = jalview.gui.SequenceFetcher
4990                 .getSequenceFetcherSingleton(me);
4991         javax.swing.SwingUtilities.invokeLater(new Runnable()
4992         {
4993           @Override
4994           public void run()
4995           {
4996             String[] dbclasses = sf.getOrderedSupportedSources();
4997             // sf.getDbInstances(jalview.ws.dbsources.DasSequenceSource.class);
4998             // jalview.util.QuickSort.sort(otherdb, otherdb);
4999             List<DbSourceProxy> otherdb;
5000             JMenu dfetch = new JMenu();
5001             JMenu ifetch = new JMenu();
5002             JMenuItem fetchr = null;
5003             int comp = 0, icomp = 0, mcomp = 15;
5004             String mname = null;
5005             int dbi = 0;
5006             for (String dbclass : dbclasses)
5007             {
5008               otherdb = sf.getSourceProxy(dbclass);
5009               // add a single entry for this class, or submenu allowing 'fetch
5010               // all' or pick one
5011               if (otherdb == null || otherdb.size() < 1)
5012               {
5013                 continue;
5014               }
5015               // List<DbSourceProxy> dbs=otherdb;
5016               // otherdb=new ArrayList<DbSourceProxy>();
5017               // for (DbSourceProxy db:dbs)
5018               // {
5019               // if (!db.isA(DBRefSource.ALIGNMENTDB)
5020               // }
5021               if (mname == null)
5022               {
5023                 mname = "From " + dbclass;
5024               }
5025               if (otherdb.size() == 1)
5026               {
5027                 final DbSourceProxy[] dassource = otherdb
5028                         .toArray(new DbSourceProxy[0]);
5029                 DbSourceProxy src = otherdb.get(0);
5030                 fetchr = new JMenuItem(src.getDbSource());
5031                 fetchr.addActionListener(new ActionListener()
5032                 {
5033
5034                   @Override
5035                   public void actionPerformed(ActionEvent e)
5036                   {
5037                     new Thread(new Runnable()
5038                     {
5039
5040                       @Override
5041                       public void run()
5042                       {
5043                         boolean isNucleotide = alignPanel.alignFrame
5044                                 .getViewport().getAlignment()
5045                                 .isNucleotide();
5046                         DBRefFetcher dbRefFetcher = new DBRefFetcher(
5047                                 alignPanel.av.getSequenceSelection(),
5048                                 alignPanel.alignFrame, dassource,
5049                                 alignPanel.alignFrame.featureSettings,
5050                                 isNucleotide);
5051                         dbRefFetcher
5052                                 .addListener(new FetchFinishedListenerI()
5053                                 {
5054                                   @Override
5055                                   public void finished()
5056                                   {
5057                                     AlignFrame.this.setMenusForViewport();
5058                                   }
5059                                 });
5060                         dbRefFetcher.fetchDBRefs(false);
5061                       }
5062                     }).start();
5063                   }
5064
5065                 });
5066                 fetchr.setToolTipText(JvSwingUtils.wrapTooltip(true,
5067                         MessageManager.formatMessage(
5068                                 "label.fetch_retrieve_from",
5069                                 new Object[] { src.getDbName() })));
5070                 dfetch.add(fetchr);
5071                 comp++;
5072               }
5073               else
5074               {
5075                 final DbSourceProxy[] dassource = otherdb
5076                         .toArray(new DbSourceProxy[0]);
5077                 // fetch all entry
5078                 DbSourceProxy src = otherdb.get(0);
5079                 fetchr = new JMenuItem(MessageManager.formatMessage(
5080                         "label.fetch_all_param",
5081                         new Object[] { src.getDbSource() }));
5082                 fetchr.addActionListener(new ActionListener()
5083                 {
5084                   @Override
5085                   public void actionPerformed(ActionEvent e)
5086                   {
5087                     new Thread(new Runnable()
5088                     {
5089
5090                       @Override
5091                       public void run()
5092                       {
5093                         boolean isNucleotide = alignPanel.alignFrame
5094                                 .getViewport().getAlignment()
5095                                 .isNucleotide();
5096                         DBRefFetcher dbRefFetcher = new DBRefFetcher(
5097                                 alignPanel.av.getSequenceSelection(),
5098                                 alignPanel.alignFrame, dassource,
5099                                 alignPanel.alignFrame.featureSettings,
5100                                 isNucleotide);
5101                         dbRefFetcher
5102                                 .addListener(new FetchFinishedListenerI()
5103                                 {
5104                                   @Override
5105                                   public void finished()
5106                                   {
5107                                     AlignFrame.this.setMenusForViewport();
5108                                   }
5109                                 });
5110                         dbRefFetcher.fetchDBRefs(false);
5111                       }
5112                     }).start();
5113                   }
5114                 });
5115
5116                 fetchr.setToolTipText(JvSwingUtils.wrapTooltip(true,
5117                         MessageManager.formatMessage(
5118                                 "label.fetch_retrieve_from_all_sources",
5119                                 new Object[] {
5120                                     Integer.valueOf(otherdb.size())
5121                                             .toString(), src.getDbSource(),
5122                                     src.getDbName() })));
5123                 dfetch.add(fetchr);
5124                 comp++;
5125                 // and then build the rest of the individual menus
5126                 ifetch = new JMenu(MessageManager.formatMessage(
5127                         "label.source_from_db_source",
5128                         new Object[] { src.getDbSource() }));
5129                 icomp = 0;
5130                 String imname = null;
5131                 int i = 0;
5132                 for (DbSourceProxy sproxy : otherdb)
5133                 {
5134                   String dbname = sproxy.getDbName();
5135                   String sname = dbname.length() > 5 ? dbname.substring(0,
5136                           5) + "..." : dbname;
5137                   String msname = dbname.length() > 10 ? dbname.substring(
5138                           0, 10) + "..." : dbname;
5139                   if (imname == null)
5140                   {
5141                     imname = MessageManager.formatMessage(
5142                             "label.from_msname", new Object[] { sname });
5143                   }
5144                   fetchr = new JMenuItem(msname);
5145                   final DbSourceProxy[] dassrc = { sproxy };
5146                   fetchr.addActionListener(new ActionListener()
5147                   {
5148
5149                     @Override
5150                     public void actionPerformed(ActionEvent e)
5151                     {
5152                       new Thread(new Runnable()
5153                       {
5154
5155                         @Override
5156                         public void run()
5157                         {
5158                           boolean isNucleotide = alignPanel.alignFrame
5159                                   .getViewport().getAlignment()
5160                                   .isNucleotide();
5161                           DBRefFetcher dbRefFetcher = new DBRefFetcher(
5162                                   alignPanel.av.getSequenceSelection(),
5163                                   alignPanel.alignFrame, dassrc,
5164                                   alignPanel.alignFrame.featureSettings,
5165                                   isNucleotide);
5166                           dbRefFetcher
5167                                   .addListener(new FetchFinishedListenerI()
5168                                   {
5169                                     @Override
5170                                     public void finished()
5171                                     {
5172                                       AlignFrame.this.setMenusForViewport();
5173                                     }
5174                                   });
5175                           dbRefFetcher.fetchDBRefs(false);
5176                         }
5177                       }).start();
5178                     }
5179
5180                   });
5181                   fetchr.setToolTipText("<html>"
5182                           + MessageManager.formatMessage(
5183                                   "label.fetch_retrieve_from", new Object[]
5184                                   { dbname }));
5185                   ifetch.add(fetchr);
5186                   ++i;
5187                   if (++icomp >= mcomp || i == (otherdb.size()))
5188                   {
5189                     ifetch.setText(MessageManager.formatMessage(
5190                             "label.source_to_target", imname, sname));
5191                     dfetch.add(ifetch);
5192                     ifetch = new JMenu();
5193                     imname = null;
5194                     icomp = 0;
5195                     comp++;
5196                   }
5197                 }
5198               }
5199               ++dbi;
5200               if (comp >= mcomp || dbi >= (dbclasses.length))
5201               {
5202                 dfetch.setText(MessageManager.formatMessage(
5203                         "label.source_to_target", mname, dbclass));
5204                 rfetch.add(dfetch);
5205                 dfetch = new JMenu();
5206                 mname = null;
5207                 comp = 0;
5208               }
5209             }
5210           }
5211         });
5212       }
5213     }).start();
5214
5215   }
5216
5217   /**
5218    * Left justify the whole alignment.
5219    */
5220   @Override
5221   protected void justifyLeftMenuItem_actionPerformed(ActionEvent e)
5222   {
5223     AlignmentI al = viewport.getAlignment();
5224     al.justify(false);
5225     viewport.firePropertyChange("alignment", null, al);
5226   }
5227
5228   /**
5229    * Right justify the whole alignment.
5230    */
5231   @Override
5232   protected void justifyRightMenuItem_actionPerformed(ActionEvent e)
5233   {
5234     AlignmentI al = viewport.getAlignment();
5235     al.justify(true);
5236     viewport.firePropertyChange("alignment", null, al);
5237   }
5238
5239   @Override
5240   public void setShowSeqFeatures(boolean b)
5241   {
5242     showSeqFeatures.setSelected(b);
5243     viewport.setShowSequenceFeatures(b);
5244   }
5245
5246   /*
5247    * (non-Javadoc)
5248    *
5249    * @see
5250    * jalview.jbgui.GAlignFrame#showUnconservedMenuItem_actionPerformed(java.
5251    * awt.event.ActionEvent)
5252    */
5253   @Override
5254   protected void showUnconservedMenuItem_actionPerformed(ActionEvent e)
5255   {
5256     viewport.setShowUnconserved(showNonconservedMenuItem.getState());
5257     alignPanel.paintAlignment(true);
5258   }
5259
5260   /*
5261    * (non-Javadoc)
5262    *
5263    * @see
5264    * jalview.jbgui.GAlignFrame#showGroupConsensus_actionPerformed(java.awt.event
5265    * .ActionEvent)
5266    */
5267   @Override
5268   protected void showGroupConsensus_actionPerformed(ActionEvent e)
5269   {
5270     viewport.setShowGroupConsensus(showGroupConsensus.getState());
5271     alignPanel.updateAnnotation(applyAutoAnnotationSettings.getState());
5272
5273   }
5274
5275   /*
5276    * (non-Javadoc)
5277    *
5278    * @see
5279    * jalview.jbgui.GAlignFrame#showGroupConservation_actionPerformed(java.awt
5280    * .event.ActionEvent)
5281    */
5282   @Override
5283   protected void showGroupConservation_actionPerformed(ActionEvent e)
5284   {
5285     viewport.setShowGroupConservation(showGroupConservation.getState());
5286     alignPanel.updateAnnotation(applyAutoAnnotationSettings.getState());
5287   }
5288
5289   /*
5290    * (non-Javadoc)
5291    *
5292    * @see
5293    * jalview.jbgui.GAlignFrame#showConsensusHistogram_actionPerformed(java.awt
5294    * .event.ActionEvent)
5295    */
5296   @Override
5297   protected void showConsensusHistogram_actionPerformed(ActionEvent e)
5298   {
5299     viewport.setShowConsensusHistogram(showConsensusHistogram.getState());
5300     alignPanel.updateAnnotation(applyAutoAnnotationSettings.getState());
5301   }
5302
5303   /*
5304    * (non-Javadoc)
5305    *
5306    * @see
5307    * jalview.jbgui.GAlignFrame#showConsensusProfile_actionPerformed(java.awt
5308    * .event.ActionEvent)
5309    */
5310   @Override
5311   protected void showSequenceLogo_actionPerformed(ActionEvent e)
5312   {
5313     viewport.setShowSequenceLogo(showSequenceLogo.getState());
5314     alignPanel.updateAnnotation(applyAutoAnnotationSettings.getState());
5315   }
5316
5317   @Override
5318   protected void normaliseSequenceLogo_actionPerformed(ActionEvent e)
5319   {
5320     showSequenceLogo.setState(true);
5321     viewport.setShowSequenceLogo(true);
5322     viewport.setNormaliseSequenceLogo(normaliseSequenceLogo.getState());
5323     alignPanel.updateAnnotation(applyAutoAnnotationSettings.getState());
5324   }
5325
5326   @Override
5327   protected void applyAutoAnnotationSettings_actionPerformed(ActionEvent e)
5328   {
5329     alignPanel.updateAnnotation(applyAutoAnnotationSettings.getState());
5330   }
5331
5332   /*
5333    * (non-Javadoc)
5334    *
5335    * @see
5336    * jalview.jbgui.GAlignFrame#makeGrpsFromSelection_actionPerformed(java.awt
5337    * .event.ActionEvent)
5338    */
5339   @Override
5340   protected void makeGrpsFromSelection_actionPerformed(ActionEvent e)
5341   {
5342     if (avc.makeGroupsFromSelection())
5343     {
5344       PaintRefresher.Refresh(this, viewport.getSequenceSetId());
5345       alignPanel.updateAnnotation();
5346       alignPanel.paintAlignment(true);
5347     }
5348   }
5349
5350   public void clearAlignmentSeqRep()
5351   {
5352     // TODO refactor alignmentseqrep to controller
5353     if (viewport.getAlignment().hasSeqrep())
5354     {
5355       viewport.getAlignment().setSeqrep(null);
5356       PaintRefresher.Refresh(this, viewport.getSequenceSetId());
5357       alignPanel.updateAnnotation();
5358       alignPanel.paintAlignment(true);
5359     }
5360   }
5361
5362   @Override
5363   protected void createGroup_actionPerformed(ActionEvent e)
5364   {
5365     if (avc.createGroup())
5366     {
5367       alignPanel.alignmentChanged();
5368     }
5369   }
5370
5371   @Override
5372   protected void unGroup_actionPerformed(ActionEvent e)
5373   {
5374     if (avc.unGroup())
5375     {
5376       alignPanel.alignmentChanged();
5377     }
5378   }
5379
5380   /**
5381    * make the given alignmentPanel the currently selected tab
5382    *
5383    * @param alignmentPanel
5384    */
5385   public void setDisplayedView(AlignmentPanel alignmentPanel)
5386   {
5387     if (!viewport.getSequenceSetId().equals(
5388             alignmentPanel.av.getSequenceSetId()))
5389     {
5390       throw new Error(
5391               MessageManager
5392                       .getString("error.implementation_error_cannot_show_view_alignment_frame"));
5393     }
5394     if (tabbedPane != null
5395             && tabbedPane.getTabCount() > 0
5396             && alignPanels.indexOf(alignmentPanel) != tabbedPane
5397                     .getSelectedIndex())
5398     {
5399       tabbedPane.setSelectedIndex(alignPanels.indexOf(alignmentPanel));
5400     }
5401   }
5402
5403   /**
5404    * Action on selection of menu options to Show or Hide annotations.
5405    *
5406    * @param visible
5407    * @param forSequences
5408    *          update sequence-related annotations
5409    * @param forAlignment
5410    *          update non-sequence-related annotations
5411    */
5412   @Override
5413   protected void setAnnotationsVisibility(boolean visible,
5414           boolean forSequences, boolean forAlignment)
5415   {
5416     AlignmentAnnotation[] anns = alignPanel.getAlignment()
5417             .getAlignmentAnnotation();
5418     if (anns == null)
5419     {
5420       return;
5421     }
5422     for (AlignmentAnnotation aa : anns)
5423     {
5424       /*
5425        * don't display non-positional annotations on an alignment
5426        */
5427       if (aa.annotations == null)
5428       {
5429         continue;
5430       }
5431       boolean apply = (aa.sequenceRef == null && forAlignment)
5432               || (aa.sequenceRef != null && forSequences);
5433       if (apply)
5434       {
5435         aa.visible = visible;
5436       }
5437     }
5438     alignPanel.validateAnnotationDimensions(true);
5439     alignPanel.alignmentChanged();
5440   }
5441
5442   /**
5443    * Store selected annotation sort order for the view and repaint.
5444    */
5445   @Override
5446   protected void sortAnnotations_actionPerformed()
5447   {
5448     this.alignPanel.av.setSortAnnotationsBy(getAnnotationSortOrder());
5449     this.alignPanel.av
5450             .setShowAutocalculatedAbove(isShowAutoCalculatedAbove());
5451     alignPanel.paintAlignment(true);
5452   }
5453
5454   /**
5455    *
5456    * @return alignment panels in this alignment frame
5457    */
5458   public List<? extends AlignmentViewPanel> getAlignPanels()
5459   {
5460     return alignPanels == null ? Arrays.asList(alignPanel) : alignPanels;
5461   }
5462
5463   /**
5464    * Open a new alignment window, with the cDNA associated with this (protein)
5465    * alignment, aligned as is the protein.
5466    */
5467   protected void viewAsCdna_actionPerformed()
5468   {
5469     // TODO no longer a menu action - refactor as required
5470     final AlignmentI alignment = getViewport().getAlignment();
5471     List<AlignedCodonFrame> mappings = alignment.getCodonFrames();
5472     if (mappings == null)
5473     {
5474       return;
5475     }
5476     List<SequenceI> cdnaSeqs = new ArrayList<SequenceI>();
5477     for (SequenceI aaSeq : alignment.getSequences())
5478     {
5479       for (AlignedCodonFrame acf : mappings)
5480       {
5481         SequenceI dnaSeq = acf.getDnaForAaSeq(aaSeq.getDatasetSequence());
5482         if (dnaSeq != null)
5483         {
5484           /*
5485            * There is a cDNA mapping for this protein sequence - add to new
5486            * alignment. It will share the same dataset sequence as other mapped
5487            * cDNA (no new mappings need to be created).
5488            */
5489           final Sequence newSeq = new Sequence(dnaSeq);
5490           newSeq.setDatasetSequence(dnaSeq);
5491           cdnaSeqs.add(newSeq);
5492         }
5493       }
5494     }
5495     if (cdnaSeqs.size() == 0)
5496     {
5497       // show a warning dialog no mapped cDNA
5498       return;
5499     }
5500     AlignmentI cdna = new Alignment(cdnaSeqs.toArray(new SequenceI[cdnaSeqs
5501             .size()]));
5502     GAlignFrame alignFrame = new AlignFrame(cdna, AlignFrame.DEFAULT_WIDTH,
5503             AlignFrame.DEFAULT_HEIGHT);
5504     cdna.alignAs(alignment);
5505     String newtitle = "cDNA " + MessageManager.getString("label.for") + " "
5506             + this.title;
5507     Desktop.addInternalFrame(alignFrame, newtitle,
5508             AlignFrame.DEFAULT_WIDTH, AlignFrame.DEFAULT_HEIGHT);
5509   }
5510
5511   /**
5512    * Set visibility of dna/protein complement view (available when shown in a
5513    * split frame).
5514    *
5515    * @param show
5516    */
5517   @Override
5518   protected void showComplement_actionPerformed(boolean show)
5519   {
5520     SplitContainerI sf = getSplitViewContainer();
5521     if (sf != null)
5522     {
5523       sf.setComplementVisible(this, show);
5524     }
5525   }
5526
5527   /**
5528    * Generate the reverse (optionally complemented) of the selected sequences,
5529    * and add them to the alignment
5530    */
5531   @Override
5532   protected void showReverse_actionPerformed(boolean complement)
5533   {
5534     AlignmentI al = null;
5535     try
5536     {
5537       Dna dna = new Dna(viewport, viewport.getViewAsVisibleContigs(true));
5538       al = dna.reverseCdna(complement);
5539       viewport.addAlignment(al, "");
5540       addHistoryItem(new EditCommand(
5541               MessageManager.getString("label.add_sequences"),
5542               Action.PASTE, al.getSequencesArray(), 0, al.getWidth(),
5543               viewport.getAlignment()));
5544     } catch (Exception ex)
5545     {
5546       System.err.println(ex.getMessage());
5547       return;
5548     }
5549   }
5550
5551   /**
5552    * Try to run a script in the Groovy console, having first ensured that this
5553    * AlignFrame is set as currentAlignFrame in Desktop, to allow the script to
5554    * be targeted at this alignment.
5555    */
5556   @Override
5557   protected void runGroovy_actionPerformed()
5558   {
5559     Jalview.setCurrentAlignFrame(this);
5560     groovy.ui.Console console = Desktop.getGroovyConsole();
5561     if (console != null)
5562     {
5563       try
5564       {
5565         console.runScript();
5566       } catch (Exception ex)
5567       {
5568         System.err.println((ex.toString()));
5569         JvOptionPane
5570                 .showInternalMessageDialog(Desktop.desktop, MessageManager
5571                         .getString("label.couldnt_run_groovy_script"),
5572                         MessageManager
5573                                 .getString("label.groovy_support_failed"),
5574                         JvOptionPane.ERROR_MESSAGE);
5575       }
5576     }
5577     else
5578     {
5579       System.err.println("Can't run Groovy script as console not found");
5580     }
5581   }
5582
5583   /**
5584    * Hides columns containing (or not containing) a specified feature, provided
5585    * that would not leave all columns hidden
5586    *
5587    * @param featureType
5588    * @param columnsContaining
5589    * @return
5590    */
5591   public boolean hideFeatureColumns(String featureType,
5592           boolean columnsContaining)
5593   {
5594     boolean notForHiding = avc.markColumnsContainingFeatures(
5595             columnsContaining, false, false, featureType);
5596     if (notForHiding)
5597     {
5598       if (avc.markColumnsContainingFeatures(!columnsContaining, false,
5599               false, featureType))
5600       {
5601         getViewport().hideSelectedColumns();
5602         return true;
5603       }
5604     }
5605     return false;
5606   }
5607
5608   @Override
5609   protected void selectHighlightedColumns_actionPerformed(
5610           ActionEvent actionEvent)
5611   {
5612     // include key modifier check in case user selects from menu
5613     avc.markHighlightedColumns(
5614             (actionEvent.getModifiers() & ActionEvent.ALT_MASK) != 0,
5615             true,
5616             (actionEvent.getModifiers() & (ActionEvent.META_MASK | ActionEvent.CTRL_MASK)) != 0);
5617   }
5618
5619   /**
5620    * Rebuilds the Colour menu, including any user-defined colours which have
5621    * been loaded either on startup or during the session
5622    */
5623   public void buildColourMenu()
5624   {
5625     colourMenu.removeAll();
5626
5627     colourMenu.add(applyToAllGroups);
5628     colourMenu.add(textColour);
5629     colourMenu.addSeparator();
5630
5631     ColourMenuHelper.addMenuItems(colourMenu, this,
5632             viewport.getAlignment(), false);
5633
5634     colourMenu.addSeparator();
5635     colourMenu.add(conservationMenuItem);
5636     colourMenu.add(modifyConservation);
5637     colourMenu.add(abovePIDThreshold);
5638     colourMenu.add(modifyPID);
5639     colourMenu.add(annotationColour);
5640
5641     ColourSchemeI colourScheme = viewport.getGlobalColourScheme();
5642     ColourMenuHelper.setColourSelected(colourMenu, colourScheme);
5643   }
5644 }
5645
5646 class PrintThread extends Thread
5647 {
5648   AlignmentPanel ap;
5649
5650   public PrintThread(AlignmentPanel ap)
5651   {
5652     this.ap = ap;
5653   }
5654
5655   static PageFormat pf;
5656
5657   @Override
5658   public void run()
5659   {
5660     PrinterJob printJob = PrinterJob.getPrinterJob();
5661
5662     if (pf != null)
5663     {
5664       printJob.setPrintable(ap, pf);
5665     }
5666     else
5667     {
5668       printJob.setPrintable(ap);
5669     }
5670
5671     if (printJob.printDialog())
5672     {
5673       try
5674       {
5675         printJob.print();
5676       } catch (Exception PrintException)
5677       {
5678         PrintException.printStackTrace();
5679       }
5680     }
5681   }
5682 }