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