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