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