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