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