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