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