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