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