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    * @return null or an alignPanel guaranteed to have non-null alignFrame
 524    *         reference
 525    */
 526   public AlignmentPanel getAlignPanel()
 527   {
 528     AlignmentPanel[] aps = PaintRefresher
 529             .getAssociatedPanels(this.getSequenceSetId());
 530     for (int p = 0; aps != null && p < aps.length; p++)
 531     {
 532       if (aps[p].av == this)
 533       {
 534         return aps[p];
 535       }
 536     }
 537     return null;
 538   }
 539
 540   public boolean getSortByTree()
 541   {
 542     return sortByTree;
 543   }
 544
 545   public void setSortByTree(boolean sort)
 546   {
 547     sortByTree = sort;
 548   }
 549
 550   /**
 551    * Returns the (Desktop) instance of the StructureSelectionManager
 552    */
 553   @Override
 554   public StructureSelectionManager getStructureSelectionManager()
 555   {
 556     return StructureSelectionManager
 557             .getStructureSelectionManager(Desktop.instance);
 558   }
 559
 560   @Override
 561   public boolean isNormaliseSequenceLogo()
 562   {
 563     return normaliseSequenceLogo;
 564   }
 565
 566   public void setNormaliseSequenceLogo(boolean state)
 567   {
 568     normaliseSequenceLogo = state;
 569   }
 570
 571   /**
 572    *
 573    * @return true if alignment characters should be displayed
 574    */
 575   @Override
 576   public boolean isValidCharWidth()
 577   {
 578     return validCharWidth;
 579   }
 580
 581   private Hashtable<String, AutoCalcSetting> calcIdParams = new Hashtable<>();
 582
 583   public AutoCalcSetting getCalcIdSettingsFor(String calcId)
 584   {
 585     return calcIdParams.get(calcId);
 586   }
 587
 588   public void setCalcIdSettingsFor(String calcId, AutoCalcSetting settings,
 589           boolean needsUpdate)
 590   {
 591     calcIdParams.put(calcId, settings);
 592     // TODO: create a restart list to trigger any calculations that need to be
 593     // restarted after load
 594     // calculator.getRegisteredWorkersOfClass(settings.getWorkerClass())
 595     if (needsUpdate)
 596     {
 597       Console.debug("trigger update for " + calcId);
 598     }
 599   }
 600
 601   /**
 602    * Method called when another alignment's edit (or possibly other) command is
 603    * broadcast to here.
 604    *
 605    * To allow for sequence mappings (e.g. protein to cDNA), we have to first
 606    * 'unwind' the command on the source sequences (in simulation, not in fact),
 607    * and then for each edit in turn:
 608    * <ul>
 609    * <li>compute the equivalent edit on the mapped sequences</li>
 610    * <li>apply the mapped edit</li>
 611    * <li>'apply' the source edit to the working copy of the source
 612    * sequences</li>
 613    * </ul>
 614    *
 615    * @param command
 616    * @param undo
 617    * @param ssm
 618    */
 619   @Override
 620   public void mirrorCommand(CommandI command, boolean undo,
 621           StructureSelectionManager ssm, VamsasSource source)
 622   {
 623     /*
 624      * Do nothing unless we are a 'complement' of the source. May replace this
 625      * with direct calls not via SSM.
 626      */
 627     if (source instanceof AlignViewportI
 628             && ((AlignViewportI) source).getCodingComplement() == this)
 629     {
 630       // ok to continue;
 631     }
 632     else
 633     {
 634       return;
 635     }
 636
 637     CommandI mappedCommand = ssm.mapCommand(command, undo, getAlignment(),
 638             getGapCharacter());
 639     if (mappedCommand != null)
 640     {
 641       AlignmentI[] views = getAlignPanel().alignFrame.getViewAlignments();
 642       mappedCommand.doCommand(views);
 643       getAlignPanel().alignmentChanged();
 644     }
 645   }
 646
 647   /**
 648    * Add the sequences from the given alignment to this viewport. Optionally,
 649    * may give the user the option to open a new frame, or split panel, with cDNA
 650    * and protein linked.
 651    *
 652    * @param toAdd
 653    * @param title
 654    */
 655   public void addAlignment(AlignmentI toAdd, String title)
 656   {
 657     // TODO: promote to AlignViewportI? applet CutAndPasteTransfer is different
 658
 659     // JBPComment: title is a largely redundant parameter at the moment
 660     // JBPComment: this really should be an 'insert/pre/append' controller
 661     // JBPComment: but the DNA/Protein check makes it a bit more complex
 662
 663     // refactored from FileLoader / CutAndPasteTransfer / SequenceFetcher with
 664     // this comment:
 665     // TODO: create undo object for this JAL-1101
 666
 667     /*
 668      * Ensure datasets are created for the new alignment as
 669      * mappings operate on dataset sequences
 670      */
 671     toAdd.setDataset(null);
 672
 673     /*
 674      * Check if any added sequence could be the object of a mapping or
 675      * cross-reference; if so, make the mapping explicit
 676      */
 677     getAlignment().realiseMappings(toAdd.getSequences());
 678
 679     /*
 680      * If any cDNA/protein mappings exist or can be made between the alignments,
 681      * offer to open a split frame with linked alignments
 682      */
 683     if (Cache.getDefault(Preferences.ENABLE_SPLIT_FRAME, true))
 684     {
 685       if (AlignmentUtils.isMappable(toAdd, getAlignment()))
 686       {
 687         openLinkedAlignment(toAdd, title);
 688         return;
 689       }
 690     }
 691     addDataToAlignment(toAdd);
 692   }
 693
 694   /**
 695    * adds sequences to this alignment
 696    *
 697    * @param toAdd
 698    */
 699   void addDataToAlignment(AlignmentI toAdd)
 700   {
 701     // TODO: JAL-407 regardless of above - identical sequences (based on ID and
 702     // provenance) should share the same dataset sequence
 703
 704     AlignmentI al = getAlignment();
 705     String gap = String.valueOf(al.getGapCharacter());
 706     for (int i = 0; i < toAdd.getHeight(); i++)
 707     {
 708       SequenceI seq = toAdd.getSequenceAt(i);
 709       /*
 710        * experimental!
 711        * - 'align' any mapped sequences as per existing
 712        *    e.g. cdna to genome, domain hit to protein sequence
 713        * very experimental! (need a separate menu option for this)
 714        * - only add mapped sequences ('select targets from a dataset')
 715        */
 716       if (true /*AlignmentUtils.alignSequenceAs(seq, al, gap, true, true)*/)
 717       {
 718         al.addSequence(seq);
 719       }
 720     }
 721
 722     ranges.setEndSeq(getAlignment().getHeight() - 1); // BH 2019.04.18
 723     firePropertyChange("alignment", null, getAlignment().getSequences());
 724   }
 725
 726   /**
 727    * Show a dialog with the option to open and link (cDNA <-> protein) as a new
 728    * alignment, either as a standalone alignment or in a split frame. Returns
 729    * true if the new alignment was opened, false if not, because the user
 730    * declined the offer.
 731    *
 732    * @param al
 733    * @param title
 734    */
 735   protected void openLinkedAlignment(AlignmentI al, String title)
 736   {
 737     String[] options = new String[] { MessageManager.getString("action.no"),
 738         MessageManager.getString("label.split_window"),
 739         MessageManager.getString("label.new_window"), };
 740     final String question = JvSwingUtils.wrapTooltip(true,
 741             MessageManager.getString("label.open_split_window?"));
 742     final AlignViewport us = this;
 743
 744     /*
 745      * options No, Split Window, New Window correspond to
 746      * dialog responses 0, 1, 2 (even though JOptionPane shows them
 747      * in reverse order)
 748      */
 749     JvOptionPane dialog = JvOptionPane.newOptionDialog(Desktop.desktop)
 750             .setResponseHandler(0, new Runnable()
 751             {
 752               @Override
 753               public void run()
 754               {
 755                 addDataToAlignment(al);
 756               }
 757             }).setResponseHandler(1, new Runnable()
 758             {
 759               @Override
 760               public void run()
 761               {
 762                 us.openLinkedAlignmentAs(al, title, true);
 763               }
 764             }).setResponseHandler(2, new Runnable()
 765             {
 766               @Override
 767               public void run()
 768               {
 769                 us.openLinkedAlignmentAs(al, title, false);
 770               }
 771             });
 772     dialog.showDialog(question,
 773             MessageManager.getString("label.open_split_window"),
 774             JvOptionPane.DEFAULT_OPTION, JvOptionPane.PLAIN_MESSAGE, null,
 775             options, options[0]);
 776   }
 777
 778   protected void openLinkedAlignmentAs(AlignmentI al, String title,
 779           boolean newWindowOrSplitPane)
 780   {
 781     /*
 782      * Identify protein and dna alignments. Make a copy of this one if opening
 783      * in a new split pane.
 784      */
 785     AlignmentI thisAlignment = newWindowOrSplitPane
 786             ? new Alignment(getAlignment())
 787             : getAlignment();
 788     AlignmentI protein = al.isNucleotide() ? thisAlignment : al;
 789     final AlignmentI cdna = al.isNucleotide() ? al : thisAlignment;
 790
 791     /*
 792      * Map sequences. At least one should get mapped as we have already passed
 793      * the test for 'mappability'. Any mappings made will be added to the
 794      * protein alignment. Note creating dataset sequences on the new alignment
 795      * is a pre-requisite for building mappings.
 796      */
 797     al.setDataset(null);
 798     AlignmentUtils.mapProteinAlignmentToCdna(protein, cdna);
 799
 800     /*
 801      * Create the AlignFrame for the added alignment. If it is protein, mappings
 802      * are registered with StructureSelectionManager as a side-effect.
 803      */
 804     AlignFrame newAlignFrame = new AlignFrame(al, AlignFrame.DEFAULT_WIDTH,
 805             AlignFrame.DEFAULT_HEIGHT);
 806     newAlignFrame.setTitle(title);
 807     newAlignFrame.setStatus(MessageManager
 808             .formatMessage("label.successfully_loaded_file", new Object[]
 809             { title }));
 810
 811     // TODO if we want this (e.g. to enable reload of the alignment from file),
 812     // we will need to add parameters to the stack.
 813     // if (!protocol.equals(DataSourceType.PASTE))
 814     // {
 815     // alignFrame.setFileName(file, format);
 816     // }
 817
 818     if (!newWindowOrSplitPane)
 819     {
 820       Desktop.addInternalFrame(newAlignFrame, title,
 821               AlignFrame.DEFAULT_WIDTH, AlignFrame.DEFAULT_HEIGHT);
 822     }
 823
 824     try
 825     {
 826       newAlignFrame.setMaximum(Cache.getDefault("SHOW_FULLSCREEN", false));
 827     } catch (java.beans.PropertyVetoException ex)
 828     {
 829     }
 830
 831     if (newWindowOrSplitPane)
 832     {
 833       al.alignAs(thisAlignment);
 834       protein = openSplitFrame(newAlignFrame, thisAlignment);
 835     }
 836   }
 837
 838   /**
 839    * Helper method to open a new SplitFrame holding linked dna and protein
 840    * alignments.
 841    *
 842    * @param newAlignFrame
 843    *          containing a new alignment to be shown
 844    * @param complement
 845    *          cdna/protein complement alignment to show in the other split half
 846    * @return the protein alignment in the split frame
 847    */
 848   protected AlignmentI openSplitFrame(AlignFrame newAlignFrame,
 849           AlignmentI complement)
 850   {
 851     /*
 852      * Make a new frame with a copy of the alignment we are adding to. If this
 853      * is protein, the mappings to cDNA will be registered with
 854      * StructureSelectionManager as a side-effect.
 855      */
 856     AlignFrame copyMe = new AlignFrame(complement, AlignFrame.DEFAULT_WIDTH,
 857             AlignFrame.DEFAULT_HEIGHT);
 858     copyMe.setTitle(getAlignPanel().alignFrame.getTitle());
 859
 860     AlignmentI al = newAlignFrame.viewport.getAlignment();
 861     final AlignFrame proteinFrame = al.isNucleotide() ? copyMe
 862             : newAlignFrame;
 863     final AlignFrame cdnaFrame = al.isNucleotide() ? newAlignFrame : copyMe;
 864     cdnaFrame.setVisible(true);
 865     proteinFrame.setVisible(true);
 866     String linkedTitle = MessageManager
 867             .getString("label.linked_view_title");
 868
 869     /*
 870      * Open in split pane. DNA sequence above, protein below.
 871      */
 872     JInternalFrame splitFrame = new SplitFrame(cdnaFrame, proteinFrame);
 873     Desktop.addInternalFrame(splitFrame, linkedTitle, -1, -1);
 874
 875     return proteinFrame.viewport.getAlignment();
 876   }
 877
 878   public AnnotationColumnChooser getAnnotationColumnSelectionState()
 879   {
 880     return annotationColumnSelectionState;
 881   }
 882
 883   public void setAnnotationColumnSelectionState(
 884           AnnotationColumnChooser currentAnnotationColumnSelectionState)
 885   {
 886     this.annotationColumnSelectionState = currentAnnotationColumnSelectionState;
 887   }
 888
 889   @Override
 890   public void setIdWidth(int i)
 891   {
 892     super.setIdWidth(i);
 893     AlignmentPanel ap = getAlignPanel();
 894     if (ap != null)
 895     {
 896       // modify GUI elements to reflect geometry change
 897       Dimension idw = ap.getIdPanel().getIdCanvas().getPreferredSize();
 898       idw.width = i;
 899       ap.getIdPanel().getIdCanvas().setPreferredSize(idw);
 900     }
 901   }
 902
 903   public Rectangle getExplodedGeometry()
 904   {
 905     return explodedGeometry;
 906   }
 907
 908   public void setExplodedGeometry(Rectangle explodedPosition)
 909   {
 910     this.explodedGeometry = explodedPosition;
 911   }
 912
 913   public boolean isGatherViewsHere()
 914   {
 915     return gatherViewsHere;
 916   }
 917
 918   public void setGatherViewsHere(boolean gatherViewsHere)
 919   {
 920     this.gatherViewsHere = gatherViewsHere;
 921   }
 922
 923   /**
 924    * If this viewport has a (Protein/cDNA) complement, then scroll the
 925    * complementary alignment to match this one.
 926    */
 927   public void scrollComplementaryAlignment()
 928   {
 929     /*
 930      * Populate a SearchResults object with the mapped location to scroll to. If
 931      * there is no complement, or it is not following highlights, or no mapping
 932      * is found, the result will be empty.
 933      */
 934     SearchResultsI sr = new SearchResults();
 935     int verticalOffset = findComplementScrollTarget(sr);
 936     if (!sr.isEmpty())
 937     {
 938       // TODO would like next line without cast but needs more refactoring...
 939       final AlignmentPanel complementPanel = ((AlignViewport) getCodingComplement())
 940               .getAlignPanel();
 941       complementPanel.setToScrollComplementPanel(false);
 942       complementPanel.scrollToCentre(sr, verticalOffset);
 943       complementPanel.setToScrollComplementPanel(true);
 944     }
 945   }
 946
 947   /**
 948    * Answers true if no alignment holds a reference to the given mapping
 949    *
 950    * @param acf
 951    * @return
 952    */
 953   protected boolean noReferencesTo(AlignedCodonFrame acf)
 954   {
 955     AlignFrame[] frames = Desktop.getAlignFrames();
 956     if (frames == null)
 957     {
 958       return true;
 959     }
 960     for (AlignFrame af : frames)
 961     {
 962       if (!af.isClosed())
 963       {
 964         for (AlignmentViewPanel ap : af.getAlignPanels())
 965         {
 966           AlignmentI al = ap.getAlignment();
 967           if (al != null && al.getCodonFrames().contains(acf))
 968           {
 969             return false;
 970           }
 971         }
 972       }
 973     }
 974     return true;
 975   }
 976
 977   /**
 978    * Applies the supplied feature settings descriptor to currently known
 979    * features. This supports an 'initial configuration' of feature colouring
 980    * based on a preset or user favourite. This may then be modified in the usual
 981    * way using the Feature Settings dialogue.
 982    *
 983    * @param featureSettings
 984    */
 985   @Override
 986   public void applyFeaturesStyle(FeatureSettingsModelI featureSettings)
 987   {
 988     transferFeaturesStyles(featureSettings, false);
 989   }
 990
 991   /**
 992    * Applies the supplied feature settings descriptor to currently known
 993    * features. This supports an 'initial configuration' of feature colouring
 994    * based on a preset or user favourite. This may then be modified in the usual
 995    * way using the Feature Settings dialogue.
 996    *
 997    * @param featureSettings
 998    */
 999   @Override
1000   public void mergeFeaturesStyle(FeatureSettingsModelI featureSettings)
1001   {
1002     transferFeaturesStyles(featureSettings, true);
1003   }
1004
1005   /**
1006    * when mergeOnly is set, then group and feature visibility or feature colours
1007    * are not modified for features and groups already known to the feature
1008    * renderer. Feature ordering is always adjusted, and transparency is always
1009    * set regardless.
1010    *
1011    * @param featureSettings
1012    * @param mergeOnly
1013    */
1014   private void transferFeaturesStyles(FeatureSettingsModelI featureSettings,
1015           boolean mergeOnly)
1016   {
1017     if (featureSettings == null)
1018     {
1019       return;
1020     }
1021
1022     FeatureRenderer fr = getAlignPanel().getSeqPanel().seqCanvas
1023             .getFeatureRenderer();
1024     List<String> origRenderOrder = new ArrayList<>();
1025     List<String> origGroups = new ArrayList<>();
1026     // preserve original render order - allows differentiation between user
1027     // configured colours and autogenerated ones
1028     origRenderOrder.addAll(fr.getRenderOrder());
1029     origGroups.addAll(fr.getFeatureGroups());
1030
1031     fr.findAllFeatures(true);
1032     List<String> renderOrder = fr.getRenderOrder();
1033     FeaturesDisplayedI displayed = fr.getFeaturesDisplayed();
1034     if (!mergeOnly)
1035     {
1036       // only clear displayed features if we are mergeing
1037       // displayed.clear();
1038     }
1039     // TODO this clears displayed.featuresRegistered - do we care?
1040     //
1041     // JAL-3330 - JBP - yes we do - calling applyFeatureStyle to a view where
1042     // feature visibility has already been configured is not very friendly
1043     /*
1044      * set feature colour if specified by feature settings
1045      * set visibility of all features
1046      */
1047     for (String type : renderOrder)
1048     {
1049       FeatureColourI preferredColour = featureSettings
1050               .getFeatureColour(type);
1051       FeatureColourI origColour = fr.getFeatureStyle(type);
1052       if (!mergeOnly || (!origRenderOrder.contains(type)
1053               || origColour == null
1054               || (!origColour.isGraduatedColour()
1055                       && origColour.getColour() != null
1056                       && origColour.getColour().equals(
1057                               ColorUtils.createColourFromName(type)))))
1058       {
1059         // if we are merging, only update if there wasn't already a colour
1060         // defined for
1061         // this type
1062         if (preferredColour != null)
1063         {
1064           fr.setColour(type, preferredColour);
1065         }
1066         if (featureSettings.isFeatureDisplayed(type))
1067         {
1068           displayed.setVisible(type);
1069         }
1070         else if (featureSettings.isFeatureHidden(type))
1071         {
1072           displayed.setHidden(type);
1073         }
1074       }
1075     }
1076
1077     /*
1078      * set visibility of feature groups
1079      */
1080     for (String group : fr.getFeatureGroups())
1081     {
1082       if (!mergeOnly || !origGroups.contains(group))
1083       {
1084         // when merging, display groups only if the aren't already marked as not
1085         // visible
1086         fr.setGroupVisibility(group,
1087                 featureSettings.isGroupDisplayed(group));
1088       }
1089     }
1090
1091     /*
1092      * order the features
1093      */
1094     if (featureSettings.optimiseOrder())
1095     {
1096       // TODO not supported (yet?)
1097     }
1098     else
1099     {
1100       fr.orderFeatures(featureSettings);
1101     }
1102     fr.setTransparency(featureSettings.getTransparency());
1103
1104     fr.notifyFeaturesChanged();
1105   }
1106
1107   public String getViewName()
1108   {
1109     return viewName;
1110   }
1111
1112   public void setViewName(String viewName)
1113   {
1114     this.viewName = viewName;
1115   }
1116 }