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