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