src/jalview/gui/AlignFrame.java

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