src/jalview/gui/AlignViewport.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.AlignmentUtils;
  24 import jalview.analysis.AnnotationSorter.SequenceAnnotationOrder;
  25 import jalview.api.AlignViewportI;
  26 import jalview.api.AlignmentViewPanel;
  27 import jalview.api.FeatureColourI;
  28 import jalview.api.FeatureSettingsModelI;
  29 import jalview.api.FeaturesDisplayedI;
  30 import jalview.api.ViewStyleI;
  31 import jalview.bin.Cache;
  32 import jalview.bin.Console;
  33 import jalview.commands.CommandI;
  34 import jalview.datamodel.AlignedCodonFrame;
  35 import jalview.datamodel.Alignment;
  36 import jalview.datamodel.AlignmentI;
  37 import jalview.datamodel.ColumnSelection;
  38 import jalview.datamodel.HiddenColumns;
  39 import jalview.datamodel.SearchResults;
  40 import jalview.datamodel.SearchResultsI;
  41 import jalview.datamodel.SequenceGroup;
  42 import jalview.datamodel.SequenceI;
  43 import jalview.renderer.ResidueShader;
  44 import jalview.schemes.ColourSchemeI;
  45 import jalview.schemes.ColourSchemeProperty;
  46 import jalview.schemes.ResidueColourScheme;
  47 import jalview.schemes.UserColourScheme;
  48 import jalview.structure.SelectionSource;
  49 import jalview.structure.StructureSelectionManager;
  50 import jalview.structure.VamsasSource;
  51 import jalview.util.ColorUtils;
  52 import jalview.util.MessageManager;
  53 import jalview.viewmodel.AlignmentViewport;
  54 import jalview.ws.params.AutoCalcSetting;
  55
  56 import java.awt.Container;
  57 import java.awt.Dimension;
  58 import java.awt.Font;
  59 import java.awt.FontMetrics;
  60 import java.awt.Rectangle;
  61 import java.util.ArrayList;
  62 import java.util.Hashtable;
  63 import java.util.List;
  64
  65 import javax.swing.JInternalFrame;
  66
  67 /**
  68  * DOCUMENT ME!
  69  *
  70  * @author $author$
  71  * @version $Revision: 1.141 $
  72  */
  73 public class AlignViewport extends AlignmentViewport
  74         implements SelectionSource
  75 {
  76   Font font;
  77
  78   boolean cursorMode = false;
  79
  80   boolean antiAlias = false;
  81
  82   private Rectangle explodedGeometry = null;
  83
  84   private String viewName = null;
  85
  86   /*
  87    * Flag set true on the view that should 'gather' multiple views of the same
  88    * sequence set id when a project is reloaded. Set false on all views when
  89    * they are 'exploded' into separate windows. Set true on the current view
  90    * when 'Gather' is performed, and also on the first tab when the first new
  91    * view is created.
  92    */
  93   private boolean gatherViewsHere = false;
  94
  95   private AnnotationColumnChooser annotationColumnSelectionState;
  96
  97   /**
  98    * Creates a new AlignViewport object.
  99    *
 100    * @param al
 101    *          alignment to view
 102    */
 103   public AlignViewport(AlignmentI al)
 104   {
 105     super(al);
 106     init();
 107   }
 108
 109   /**
 110    * Create a new AlignViewport object with a specific sequence set ID
 111    *
 112    * @param al
 113    * @param seqsetid
 114    *          (may be null - but potential for ambiguous constructor exception)
 115    */
 116   public AlignViewport(AlignmentI al, String seqsetid)
 117   {
 118     this(al, seqsetid, null);
 119   }
 120
 121   public AlignViewport(AlignmentI al, String seqsetid, String viewid)
 122   {
 123     super(al);
 124     sequenceSetID = seqsetid;
 125     viewId = viewid;
 126     // TODO remove these once 2.4.VAMSAS release finished
 127     if (seqsetid != null)
 128     {
 129       Console.debug(
 130               "Setting viewport's sequence set id : " + sequenceSetID);
 131     }
 132     if (viewId != null)
 133     {
 134       Console.debug("Setting viewport's view id : " + viewId);
 135     }
 136     init();
 137
 138   }
 139
 140   /**
 141    * Create a new AlignViewport with hidden regions
 142    *
 143    * @param al
 144    *          AlignmentI
 145    * @param hiddenColumns
 146    *          ColumnSelection
 147    */
 148   public AlignViewport(AlignmentI al, HiddenColumns hiddenColumns)
 149   {
 150     super(al);
 151     if (hiddenColumns != null)
 152     {
 153       al.setHiddenColumns(hiddenColumns);
 154     }
 155     init();
 156   }
 157
 158   /**
 159    * New viewport with hidden columns and an existing sequence set id
 160    *
 161    * @param al
 162    * @param hiddenColumns
 163    * @param seqsetid
 164    *          (may be null)
 165    */
 166   public AlignViewport(AlignmentI al, HiddenColumns hiddenColumns,
 167           String seqsetid)
 168   {
 169     this(al, hiddenColumns, seqsetid, null);
 170   }
 171
 172   /**
 173    * New viewport with hidden columns and an existing sequence set id and viewid
 174    *
 175    * @param al
 176    * @param hiddenColumns
 177    * @param seqsetid
 178    *          (may be null)
 179    * @param viewid
 180    *          (may be null)
 181    */
 182   public AlignViewport(AlignmentI al, HiddenColumns hiddenColumns,
 183           String seqsetid, String viewid)
 184   {
 185     super(al);
 186     sequenceSetID = seqsetid;
 187     viewId = viewid;
 188     // TODO remove these once 2.4.VAMSAS release finished
 189     if (seqsetid != null)
 190     {
 191       Console.debug(
 192               "Setting viewport's sequence set id : " + sequenceSetID);
 193     }
 194     if (viewId != null)
 195     {
 196       Console.debug("Setting viewport's view id : " + viewId);
 197     }
 198
 199     if (hiddenColumns != null)
 200     {
 201       al.setHiddenColumns(hiddenColumns);
 202     }
 203     init();
 204   }
 205
 206   /**
 207    * Apply any settings saved in user preferences
 208    */
 209   private void applyViewProperties()
 210   {
 211     antiAlias = Cache.getDefault("ANTI_ALIAS", true);
 212
 213     viewStyle.setShowJVSuffix(Cache.getDefault("SHOW_JVSUFFIX", true));
 214     setShowAnnotation(Cache.getDefault("SHOW_ANNOTATIONS", true));
 215
 216     setRightAlignIds(Cache.getDefault("RIGHT_ALIGN_IDS", false));
 217     setCentreColumnLabels(Cache.getDefault("CENTRE_COLUMN_LABELS", false));
 218     autoCalculateConsensus = Cache.getDefault("AUTO_CALC_CONSENSUS", true);
 219
 220     setPadGaps(Cache.getDefault("PAD_GAPS", true));
 221     setShowNPFeats(Cache.getDefault("SHOW_NPFEATS_TOOLTIP", true));
 222     setShowDBRefs(Cache.getDefault("SHOW_DBREFS_TOOLTIP", true));
 223     viewStyle.setSeqNameItalics(Cache.getDefault("ID_ITALICS", true));
 224     viewStyle.setWrapAlignment(Cache.getDefault("WRAP_ALIGNMENT", false));
 225     viewStyle.setShowUnconserved(
 226             Cache.getDefault("SHOW_UNCONSERVED", false));
 227     sortByTree = Cache.getDefault("SORT_BY_TREE", false);
 228     followSelection = Cache.getDefault("FOLLOW_SELECTIONS", true);
 229     sortAnnotationsBy = SequenceAnnotationOrder
 230             .valueOf(Cache.getDefault(Preferences.SORT_ANNOTATIONS,
 231                     SequenceAnnotationOrder.NONE.name()));
 232     showAutocalculatedAbove = Cache
 233             .getDefault(Preferences.SHOW_AUTOCALC_ABOVE, false);
 234     viewStyle.setScaleProteinAsCdna(
 235             Cache.getDefault(Preferences.SCALE_PROTEIN_TO_CDNA, true));
 236   }
 237
 238   void init()
 239   {
 240     applyViewProperties();
 241
 242     String fontName = Cache.getDefault("FONT_NAME", "SansSerif");
 243     String fontStyle = Cache.getDefault("FONT_STYLE", Font.PLAIN + "");
 244     String fontSize = Cache.getDefault("FONT_SIZE", "10");
 245
 246     int style = 0;
 247
 248     if (fontStyle.equals("bold"))
 249     {
 250       style = 1;
 251     }
 252     else if (fontStyle.equals("italic"))
 253     {
 254       style = 2;
 255     }
 256
 257     setFont(new Font(fontName, style, Integer.parseInt(fontSize)), true);
 258
 259     alignment
 260             .setGapCharacter(Cache.getDefault("GAP_SYMBOL", "-").charAt(0));
 261
 262     // We must set conservation and consensus before setting colour,
 263     // as Blosum and Clustal require this to be done
 264     if (hconsensus == null && !isDataset)
 265     {
 266       if (!alignment.isNucleotide())
 267       {
 268         showConservation = Cache.getDefault("SHOW_CONSERVATION", true);
 269         showQuality = Cache.getDefault("SHOW_QUALITY", true);
 270         showGroupConservation = Cache.getDefault("SHOW_GROUP_CONSERVATION",
 271                 false);
 272       }
 273       showConsensusHistogram = Cache.getDefault("SHOW_CONSENSUS_HISTOGRAM",
 274               true);
 275       showSequenceLogo = Cache.getDefault("SHOW_CONSENSUS_LOGO", false);
 276       normaliseSequenceLogo = Cache.getDefault("NORMALISE_CONSENSUS_LOGO",
 277               false);
 278       showGroupConsensus = Cache.getDefault("SHOW_GROUP_CONSENSUS", false);
 279       showConsensus = Cache.getDefault("SHOW_IDENTITY", true);
 280
 281       showOccupancy = Cache.getDefault(Preferences.SHOW_OCCUPANCY, true);
 282     }
 283     initAutoAnnotation();
 284     String colourProperty = alignment.isNucleotide()
 285             ? Preferences.DEFAULT_COLOUR_NUC
 286             : Preferences.DEFAULT_COLOUR_PROT;
 287     String schemeName = Cache.getProperty(colourProperty);
 288     if (schemeName == null)
 289     {
 290       // only DEFAULT_COLOUR available in Jalview before 2.9
 291       schemeName = Cache.getDefault(Preferences.DEFAULT_COLOUR,
 292               ResidueColourScheme.NONE);
 293     }
 294     ColourSchemeI colourScheme = ColourSchemeProperty.getColourScheme(this,
 295             alignment, schemeName);
 296     residueShading = new ResidueShader(colourScheme);
 297
 298     if (colourScheme instanceof UserColourScheme)
 299     {
 300       residueShading = new ResidueShader(
 301               UserDefinedColours.loadDefaultColours());
 302       residueShading.setThreshold(0, isIgnoreGapsConsensus());
 303     }
 304
 305     if (residueShading != null)
 306     {
 307       residueShading.setConsensus(hconsensus);
 308     }
 309     setColourAppliesToAllGroups(true);
 310   }
 311
 312   boolean validCharWidth;
 313
 314   /**
 315    * {@inheritDoc}
 316    */
 317   @Override
 318   public void setFont(Font f, boolean setGrid)
 319   {
 320     font = f;
 321
 322     Container c = new Container();
 323
 324     if (setGrid)
 325     {
 326       FontMetrics fm = c.getFontMetrics(font);
 327       int ww = fm.charWidth('M');
 328       setCharHeight(fm.getHeight());
 329       setCharWidth(ww);
 330     }
 331     viewStyle.setFontName(font.getName());
 332     viewStyle.setFontStyle(font.getStyle());
 333     viewStyle.setFontSize(font.getSize());
 334
 335     validCharWidth = true;
 336   }
 337
 338   @Override
 339   public void setViewStyle(ViewStyleI settingsForView)
 340   {
 341     super.setViewStyle(settingsForView);
 342     setFont(new Font(viewStyle.getFontName(), viewStyle.getFontStyle(),
 343             viewStyle.getFontSize()), false);
 344   }
 345
 346   /**
 347    * DOCUMENT ME!
 348    *
 349    * @return DOCUMENT ME!
 350    */
 351   public Font getFont()
 352   {
 353     return font;
 354   }
 355
 356   /**
 357    * DOCUMENT ME!
 358    *
 359    * @param align
 360    *          DOCUMENT ME!
 361    */
 362   @Override
 363   public void setAlignment(AlignmentI align)
 364   {
 365     replaceMappings(align);
 366     super.setAlignment(align);
 367   }
 368
 369   /**
 370    * Replace any codon mappings for this viewport with those for the given
 371    * viewport
 372    *
 373    * @param align
 374    */
 375   public void replaceMappings(AlignmentI align)
 376   {
 377
 378     /*
 379      * Deregister current mappings (if any)
 380      */
 381     deregisterMappings();
 382
 383     /*
 384      * Register new mappings (if any)
 385      */
 386     if (align != null)
 387     {
 388       StructureSelectionManager ssm = StructureSelectionManager
 389               .getStructureSelectionManager(Desktop.instance);
 390       ssm.registerMappings(align.getCodonFrames());
 391     }
 392
 393     /*
 394      * replace mappings on our alignment
 395      */
 396     if (alignment != null && align != null)
 397     {
 398       alignment.setCodonFrames(align.getCodonFrames());
 399     }
 400   }
 401
 402   protected void deregisterMappings()
 403   {
 404     AlignmentI al = getAlignment();
 405     if (al != null)
 406     {
 407       List<AlignedCodonFrame> mappings = al.getCodonFrames();
 408       if (mappings != null)
 409       {
 410         StructureSelectionManager ssm = StructureSelectionManager
 411                 .getStructureSelectionManager(Desktop.instance);
 412         for (AlignedCodonFrame acf : mappings)
 413         {
 414           if (noReferencesTo(acf))
 415           {
 416             ssm.deregisterMapping(acf);
 417           }
 418         }
 419       }
 420     }
 421   }
 422
 423   /**
 424    * DOCUMENT ME!
 425    *
 426    * @return DOCUMENT ME!
 427    */
 428   @Override
 429   public char getGapCharacter()
 430   {
 431     return getAlignment().getGapCharacter();
 432   }
 433
 434   /**
 435    * DOCUMENT ME!
 436    *
 437    * @param gap
 438    *          DOCUMENT ME!
 439    */
 440   public void setGapCharacter(char gap)
 441   {
 442     if (getAlignment() != null)
 443     {
 444       getAlignment().setGapCharacter(gap);
 445     }
 446   }
 447
 448   /**
 449    * get hash of undo and redo list for the alignment
 450    *
 451    * @return long[] { historyList.hashCode, redoList.hashCode };
 452    */
 453   public long[] getUndoRedoHash()
 454   {
 455     // TODO: JAL-1126
 456     if (historyList == null || redoList == null)
 457     {
 458       return new long[] { -1, -1 };
 459     }
 460     return new long[] { historyList.hashCode(), this.redoList.hashCode() };
 461   }
 462
 463   /**
 464    * test if a particular set of hashcodes are different to the hashcodes for
 465    * the undo and redo list.
 466    *
 467    * @param undoredo
 468    *          the stored set of hashcodes as returned by getUndoRedoHash
 469    * @return true if the hashcodes differ (ie the alignment has been edited) or
 470    *         the stored hashcode array differs in size
 471    */
 472   public boolean isUndoRedoHashModified(long[] undoredo)
 473   {
 474     if (undoredo == null)
 475     {
 476       return true;
 477     }
 478     long[] cstate = getUndoRedoHash();
 479     if (cstate.length != undoredo.length)
 480     {
 481       return true;
 482     }
 483
 484     for (int i = 0; i < cstate.length; i++)
 485     {
 486       if (cstate[i] != undoredo[i])
 487       {
 488         return true;
 489       }
 490     }
 491     return false;
 492   }
 493
 494   public boolean followSelection = true;
 495
 496   /**
 497    * @return true if view selection should always follow the selections
 498    *         broadcast by other selection sources
 499    */
 500   public boolean getFollowSelection()
 501   {
 502     return followSelection;
 503   }
 504
 505   /**
 506    * Send the current selection to be broadcast to any selection listeners.
 507    */
 508   @Override
 509   public void sendSelection()
 510   {
 511     jalview.structure.StructureSelectionManager
 512             .getStructureSelectionManager(Desktop.instance)
 513             .sendSelection(new SequenceGroup(getSelectionGroup()),
 514                     new ColumnSelection(getColumnSelection()),
 515                     new HiddenColumns(getAlignment().getHiddenColumns()),
 516                     this);
 517   }
 518
 519   /**
 520    * return the alignPanel containing the given viewport. Use this to get the
 521    * components currently handling the given viewport.
 522    *
 523    * @param av
 524    * @return null or an alignPanel guaranteed to have non-null alignFrame
 525    *         reference
 526    */
 527   public AlignmentPanel getAlignPanel()
 528   {
 529     AlignmentPanel[] aps = PaintRefresher
 530             .getAssociatedPanels(this.getSequenceSetId());
 531     for (int p = 0; aps != null && p < aps.length; p++)
 532     {
 533       if (aps[p].av == this)
 534       {
 535         return aps[p];
 536       }
 537     }
 538     return null;
 539   }
 540
 541   public boolean getSortByTree()
 542   {
 543     return sortByTree;
 544   }
 545
 546   public void setSortByTree(boolean sort)
 547   {
 548     sortByTree = sort;
 549   }
 550
 551   /**
 552    * Returns the (Desktop) instance of the StructureSelectionManager
 553    */
 554   @Override
 555   public StructureSelectionManager getStructureSelectionManager()
 556   {
 557     return StructureSelectionManager
 558             .getStructureSelectionManager(Desktop.instance);
 559   }
 560
 561   @Override
 562   public boolean isNormaliseSequenceLogo()
 563   {
 564     return normaliseSequenceLogo;
 565   }
 566
 567   public void setNormaliseSequenceLogo(boolean state)
 568   {
 569     normaliseSequenceLogo = state;
 570   }
 571
 572   /**
 573    *
 574    * @return true if alignment characters should be displayed
 575    */
 576   @Override
 577   public boolean isValidCharWidth()
 578   {
 579     return validCharWidth;
 580   }
 581
 582   private Hashtable<String, AutoCalcSetting> calcIdParams = new Hashtable<>();
 583
 584   public AutoCalcSetting getCalcIdSettingsFor(String calcId)
 585   {
 586     return calcIdParams.get(calcId);
 587   }
 588
 589   public void setCalcIdSettingsFor(String calcId, AutoCalcSetting settings,
 590           boolean needsUpdate)
 591   {
 592     calcIdParams.put(calcId, settings);
 593     // TODO: create a restart list to trigger any calculations that need to be
 594     // restarted after load
 595     // calculator.getRegisteredWorkersOfClass(settings.getWorkerClass())
 596     if (needsUpdate)
 597     {
 598       Console.debug("trigger update for " + calcId);
 599     }
 600   }
 601
 602   /**
 603    * Method called when another alignment's edit (or possibly other) command is
 604    * broadcast to here.
 605    *
 606    * To allow for sequence mappings (e.g. protein to cDNA), we have to first
 607    * 'unwind' the command on the source sequences (in simulation, not in fact),
 608    * and then for each edit in turn:
 609    * <ul>
 610    * <li>compute the equivalent edit on the mapped sequences</li>
 611    * <li>apply the mapped edit</li>
 612    * <li>'apply' the source edit to the working copy of the source
 613    * sequences</li>
 614    * </ul>
 615    *
 616    * @param command
 617    * @param undo
 618    * @param ssm
 619    */
 620   @Override
 621   public void mirrorCommand(CommandI command, boolean undo,
 622           StructureSelectionManager ssm, VamsasSource source)
 623   {
 624     /*
 625      * Do nothing unless we are a 'complement' of the source. May replace this
 626      * with direct calls not via SSM.
 627      */
 628     if (source instanceof AlignViewportI
 629             && ((AlignViewportI) source).getCodingComplement() == this)
 630     {
 631       // ok to continue;
 632     }
 633     else
 634     {
 635       return;
 636     }
 637
 638     CommandI mappedCommand = ssm.mapCommand(command, undo, getAlignment(),
 639             getGapCharacter());
 640     if (mappedCommand != null)
 641     {
 642       AlignmentI[] views = getAlignPanel().alignFrame.getViewAlignments();
 643       mappedCommand.doCommand(views);
 644       getAlignPanel().alignmentChanged();
 645     }
 646   }
 647
 648   /**
 649    * Add the sequences from the given alignment to this viewport. Optionally,
 650    * may give the user the option to open a new frame, or split panel, with cDNA
 651    * and protein linked.
 652    *
 653    * @param toAdd
 654    * @param title
 655    */
 656   public void addAlignment(AlignmentI toAdd, String title)
 657   {
 658     // TODO: promote to AlignViewportI? applet CutAndPasteTransfer is different
 659
 660     // JBPComment: title is a largely redundant parameter at the moment
 661     // JBPComment: this really should be an 'insert/pre/append' controller
 662     // JBPComment: but the DNA/Protein check makes it a bit more complex
 663
 664     // refactored from FileLoader / CutAndPasteTransfer / SequenceFetcher with
 665     // this comment:
 666     // TODO: create undo object for this JAL-1101
 667
 668     /*
 669      * Ensure datasets are created for the new alignment as
 670      * mappings operate on dataset sequences
 671      */
 672     toAdd.setDataset(null);
 673
 674     /*
 675      * Check if any added sequence could be the object of a mapping or
 676      * cross-reference; if so, make the mapping explicit
 677      */
 678     getAlignment().realiseMappings(toAdd.getSequences());
 679
 680     /*
 681      * If any cDNA/protein mappings exist or can be made between the alignments,
 682      * offer to open a split frame with linked alignments
 683      */
 684     if (Cache.getDefault(Preferences.ENABLE_SPLIT_FRAME, true))
 685     {
 686       if (AlignmentUtils.isMappable(toAdd, getAlignment()))
 687       {
 688         openLinkedAlignment(toAdd, title);
 689         return;
 690       }
 691     }
 692     addDataToAlignment(toAdd);
 693   }
 694
 695   /**
 696    * adds sequences to this alignment
 697    *
 698    * @param toAdd
 699    */
 700   void addDataToAlignment(AlignmentI toAdd)
 701   {
 702     // TODO: JAL-407 regardless of above - identical sequences (based on ID and
 703     // provenance) should share the same dataset sequence
 704
 705     AlignmentI al = getAlignment();
 706     String gap = String.valueOf(al.getGapCharacter());
 707     for (int i = 0; i < toAdd.getHeight(); i++)
 708     {
 709       SequenceI seq = toAdd.getSequenceAt(i);
 710       /*
 711        * experimental!
 712        * - 'align' any mapped sequences as per existing
 713        *    e.g. cdna to genome, domain hit to protein sequence
 714        * very experimental! (need a separate menu option for this)
 715        * - only add mapped sequences ('select targets from a dataset')
 716        */
 717       if (true /*AlignmentUtils.alignSequenceAs(seq, al, gap, true, true)*/)
 718       {
 719         al.addSequence(seq);
 720       }
 721     }
 722
 723     ranges.setEndSeq(getAlignment().getHeight() - 1); // BH 2019.04.18
 724     firePropertyChange("alignment", null, getAlignment().getSequences());
 725   }
 726
 727   /**
 728    * Show a dialog with the option to open and link (cDNA <-> protein) as a new
 729    * alignment, either as a standalone alignment or in a split frame. Returns
 730    * true if the new alignment was opened, false if not, because the user
 731    * declined the offer.
 732    *
 733    * @param al
 734    * @param title
 735    */
 736   protected void openLinkedAlignment(AlignmentI al, String title)
 737   {
 738     String[] options = new String[] { MessageManager.getString("action.no"),
 739         MessageManager.getString("label.split_window"),
 740         MessageManager.getString("label.new_window"), };
 741     final String question = JvSwingUtils.wrapTooltip(true,
 742             MessageManager.getString("label.open_split_window?"));
 743     final AlignViewport us = this;
 744
 745     /*
 746      * options No, Split Window, New Window correspond to
 747      * dialog responses 0, 1, 2 (even though JOptionPane shows them
 748      * in reverse order)
 749      */
 750     JvOptionPane dialog = JvOptionPane.newOptionDialog(Desktop.desktop)
 751             .setResponseHandler(0, new Runnable()
 752             {
 753               @Override
 754               public void run()
 755               {
 756                 addDataToAlignment(al);
 757               }
 758             }).setResponseHandler(1, new Runnable()
 759             {
 760               @Override
 761               public void run()
 762               {
 763                 us.openLinkedAlignmentAs(al, title, true);
 764               }
 765             }).setResponseHandler(2, new Runnable()
 766             {
 767               @Override
 768               public void run()
 769               {
 770                 us.openLinkedAlignmentAs(al, title, false);
 771               }
 772             });
 773     dialog.showDialog(question,
 774             MessageManager.getString("label.open_split_window"),
 775             JvOptionPane.DEFAULT_OPTION, JvOptionPane.PLAIN_MESSAGE, null,
 776             options, options[0]);
 777   }
 778
 779   protected void openLinkedAlignmentAs(AlignmentI al, String title,
 780           boolean newWindowOrSplitPane)
 781   {
 782     /*
 783      * Identify protein and dna alignments. Make a copy of this one if opening
 784      * in a new split pane.
 785      */
 786     AlignmentI thisAlignment = newWindowOrSplitPane
 787             ? new Alignment(getAlignment())
 788             : getAlignment();
 789     AlignmentI protein = al.isNucleotide() ? thisAlignment : al;
 790     final AlignmentI cdna = al.isNucleotide() ? al : thisAlignment;
 791
 792     /*
 793      * Map sequences. At least one should get mapped as we have already passed
 794      * the test for 'mappability'. Any mappings made will be added to the
 795      * protein alignment. Note creating dataset sequences on the new alignment
 796      * is a pre-requisite for building mappings.
 797      */
 798     al.setDataset(null);
 799     AlignmentUtils.mapProteinAlignmentToCdna(protein, cdna);
 800
 801     /*
 802      * Create the AlignFrame for the added alignment. If it is protein, mappings
 803      * are registered with StructureSelectionManager as a side-effect.
 804      */
 805     AlignFrame newAlignFrame = new AlignFrame(al, AlignFrame.DEFAULT_WIDTH,
 806             AlignFrame.DEFAULT_HEIGHT);
 807     newAlignFrame.setTitle(title);
 808     newAlignFrame.setStatus(MessageManager
 809             .formatMessage("label.successfully_loaded_file", new Object[]
 810             { title }));
 811
 812     // TODO if we want this (e.g. to enable reload of the alignment from file),
 813     // we will need to add parameters to the stack.
 814     // if (!protocol.equals(DataSourceType.PASTE))
 815     // {
 816     // alignFrame.setFileName(file, format);
 817     // }
 818
 819     if (!newWindowOrSplitPane)
 820     {
 821       Desktop.addInternalFrame(newAlignFrame, title,
 822               AlignFrame.DEFAULT_WIDTH, AlignFrame.DEFAULT_HEIGHT);
 823     }
 824
 825     try
 826     {
 827       newAlignFrame.setMaximum(Cache.getDefault("SHOW_FULLSCREEN", false));
 828     } catch (java.beans.PropertyVetoException ex)
 829     {
 830     }
 831
 832     if (newWindowOrSplitPane)
 833     {
 834       al.alignAs(thisAlignment);
 835       protein = openSplitFrame(newAlignFrame, thisAlignment);
 836     }
 837   }
 838
 839   /**
 840    * Helper method to open a new SplitFrame holding linked dna and protein
 841    * alignments.
 842    *
 843    * @param newAlignFrame
 844    *          containing a new alignment to be shown
 845    * @param complement
 846    *          cdna/protein complement alignment to show in the other split half
 847    * @return the protein alignment in the split frame
 848    */
 849   protected AlignmentI openSplitFrame(AlignFrame newAlignFrame,
 850           AlignmentI complement)
 851   {
 852     /*
 853      * Make a new frame with a copy of the alignment we are adding to. If this
 854      * is protein, the mappings to cDNA will be registered with
 855      * StructureSelectionManager as a side-effect.
 856      */
 857     AlignFrame copyMe = new AlignFrame(complement, AlignFrame.DEFAULT_WIDTH,
 858             AlignFrame.DEFAULT_HEIGHT);
 859     copyMe.setTitle(getAlignPanel().alignFrame.getTitle());
 860
 861     AlignmentI al = newAlignFrame.viewport.getAlignment();
 862     final AlignFrame proteinFrame = al.isNucleotide() ? copyMe
 863             : newAlignFrame;
 864     final AlignFrame cdnaFrame = al.isNucleotide() ? newAlignFrame : copyMe;
 865     cdnaFrame.setVisible(true);
 866     proteinFrame.setVisible(true);
 867     String linkedTitle = MessageManager
 868             .getString("label.linked_view_title");
 869
 870     /*
 871      * Open in split pane. DNA sequence above, protein below.
 872      */
 873     JInternalFrame splitFrame = new SplitFrame(cdnaFrame, proteinFrame);
 874     Desktop.addInternalFrame(splitFrame, linkedTitle, -1, -1);
 875
 876     return proteinFrame.viewport.getAlignment();
 877   }
 878
 879   public AnnotationColumnChooser getAnnotationColumnSelectionState()
 880   {
 881     return annotationColumnSelectionState;
 882   }
 883
 884   public void setAnnotationColumnSelectionState(
 885           AnnotationColumnChooser currentAnnotationColumnSelectionState)
 886   {
 887     this.annotationColumnSelectionState = currentAnnotationColumnSelectionState;
 888   }
 889
 890   @Override
 891   public void setIdWidth(int i)
 892   {
 893     super.setIdWidth(i);
 894     AlignmentPanel ap = getAlignPanel();
 895     if (ap != null)
 896     {
 897       // modify GUI elements to reflect geometry change
 898       Dimension idw = ap.getIdPanel().getIdCanvas().getPreferredSize();
 899       idw.width = i;
 900       ap.getIdPanel().getIdCanvas().setPreferredSize(idw);
 901     }
 902   }
 903
 904   public Rectangle getExplodedGeometry()
 905   {
 906     return explodedGeometry;
 907   }
 908
 909   public void setExplodedGeometry(Rectangle explodedPosition)
 910   {
 911     this.explodedGeometry = explodedPosition;
 912   }
 913
 914   public boolean isGatherViewsHere()
 915   {
 916     return gatherViewsHere;
 917   }
 918
 919   public void setGatherViewsHere(boolean gatherViewsHere)
 920   {
 921     this.gatherViewsHere = gatherViewsHere;
 922   }
 923
 924   /**
 925    * If this viewport has a (Protein/cDNA) complement, then scroll the
 926    * complementary alignment to match this one.
 927    */
 928   public void scrollComplementaryAlignment()
 929   {
 930     /*
 931      * Populate a SearchResults object with the mapped location to scroll to. If
 932      * there is no complement, or it is not following highlights, or no mapping
 933      * is found, the result will be empty.
 934      */
 935     SearchResultsI sr = new SearchResults();
 936     int verticalOffset = findComplementScrollTarget(sr);
 937     if (!sr.isEmpty())
 938     {
 939       // TODO would like next line without cast but needs more refactoring...
 940       final AlignmentPanel complementPanel = ((AlignViewport) getCodingComplement())
 941               .getAlignPanel();
 942       complementPanel.setToScrollComplementPanel(false);
 943       complementPanel.scrollToCentre(sr, verticalOffset);
 944       complementPanel.setToScrollComplementPanel(true);
 945     }
 946   }
 947
 948   /**
 949    * Answers true if no alignment holds a reference to the given mapping
 950    *
 951    * @param acf
 952    * @return
 953    */
 954   protected boolean noReferencesTo(AlignedCodonFrame acf)
 955   {
 956     AlignFrame[] frames = Desktop.getAlignFrames();
 957     if (frames == null)
 958     {
 959       return true;
 960     }
 961     for (AlignFrame af : frames)
 962     {
 963       if (!af.isClosed())
 964       {
 965         for (AlignmentViewPanel ap : af.getAlignPanels())
 966         {
 967           AlignmentI al = ap.getAlignment();
 968           if (al != null && al.getCodonFrames().contains(acf))
 969           {
 970             return false;
 971           }
 972         }
 973       }
 974     }
 975     return true;
 976   }
 977
 978   /**
 979    * Applies the supplied feature settings descriptor to currently known
 980    * features. This supports an 'initial configuration' of feature colouring
 981    * based on a preset or user favourite. This may then be modified in the usual
 982    * way using the Feature Settings dialogue.
 983    *
 984    * @param featureSettings
 985    */
 986   @Override
 987   public void applyFeaturesStyle(FeatureSettingsModelI featureSettings)
 988   {
 989     transferFeaturesStyles(featureSettings, false);
 990   }
 991
 992   /**
 993    * Applies the supplied feature settings descriptor to currently known
 994    * features. This supports an 'initial configuration' of feature colouring
 995    * based on a preset or user favourite. This may then be modified in the usual
 996    * way using the Feature Settings dialogue.
 997    *
 998    * @param featureSettings
 999    */
1000   @Override
1001   public void mergeFeaturesStyle(FeatureSettingsModelI featureSettings)
1002   {
1003     transferFeaturesStyles(featureSettings, true);
1004   }
1005
1006   /**
1007    * when mergeOnly is set, then group and feature visibility or feature colours
1008    * are not modified for features and groups already known to the feature
1009    * renderer. Feature ordering is always adjusted, and transparency is always
1010    * set regardless.
1011    *
1012    * @param featureSettings
1013    * @param mergeOnly
1014    */
1015   private void transferFeaturesStyles(FeatureSettingsModelI featureSettings,
1016           boolean mergeOnly)
1017   {
1018     if (featureSettings == null)
1019     {
1020       return;
1021     }
1022
1023     FeatureRenderer fr = getAlignPanel().getSeqPanel().seqCanvas
1024             .getFeatureRenderer();
1025     List<String> origRenderOrder = new ArrayList<>();
1026     List<String> origGroups = new ArrayList<>();
1027     // preserve original render order - allows differentiation between user
1028     // configured colours and autogenerated ones
1029     origRenderOrder.addAll(fr.getRenderOrder());
1030     origGroups.addAll(fr.getFeatureGroups());
1031
1032     fr.findAllFeatures(true);
1033     List<String> renderOrder = fr.getRenderOrder();
1034     FeaturesDisplayedI displayed = fr.getFeaturesDisplayed();
1035     if (!mergeOnly)
1036     {
1037       // only clear displayed features if we are mergeing
1038       // displayed.clear();
1039     }
1040     // TODO this clears displayed.featuresRegistered - do we care?
1041     //
1042     // JAL-3330 - JBP - yes we do - calling applyFeatureStyle to a view where
1043     // feature visibility has already been configured is not very friendly
1044     /*
1045      * set feature colour if specified by feature settings
1046      * set visibility of all features
1047      */
1048     for (String type : renderOrder)
1049     {
1050       FeatureColourI preferredColour = featureSettings
1051               .getFeatureColour(type);
1052       FeatureColourI origColour = fr.getFeatureStyle(type);
1053       if (!mergeOnly || (!origRenderOrder.contains(type)
1054               || origColour == null
1055               || (!origColour.isGraduatedColour()
1056                       && origColour.getColour() != null
1057                       && origColour.getColour().equals(
1058                               ColorUtils.createColourFromName(type)))))
1059       {
1060         // if we are merging, only update if there wasn't already a colour
1061         // defined for
1062         // this type
1063         if (preferredColour != null)
1064         {
1065           fr.setColour(type, preferredColour);
1066         }
1067         if (featureSettings.isFeatureDisplayed(type))
1068         {
1069           displayed.setVisible(type);
1070         }
1071         else if (featureSettings.isFeatureHidden(type))
1072         {
1073           displayed.setHidden(type);
1074         }
1075       }
1076     }
1077
1078     /*
1079      * set visibility of feature groups
1080      */
1081     for (String group : fr.getFeatureGroups())
1082     {
1083       if (!mergeOnly || !origGroups.contains(group))
1084       {
1085         // when merging, display groups only if the aren't already marked as not
1086         // visible
1087         fr.setGroupVisibility(group,
1088                 featureSettings.isGroupDisplayed(group));
1089       }
1090     }
1091
1092     /*
1093      * order the features
1094      */
1095     if (featureSettings.optimiseOrder())
1096     {
1097       // TODO not supported (yet?)
1098     }
1099     else
1100     {
1101       fr.orderFeatures(featureSettings);
1102     }
1103     fr.setTransparency(featureSettings.getTransparency());
1104
1105     fr.notifyFeaturesChanged();
1106   }
1107
1108   public String getViewName()
1109   {
1110     return viewName;
1111   }
1112
1113   public void setViewName(String viewName)
1114   {
1115     this.viewName = viewName;
1116   }
1117 }