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