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