src/jalview/gui/AlignFrame.java

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