src/jalview/api/structures/JalviewStructureDisplayI.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.api.structures;
  22
  23 import jalview.api.AlignmentViewPanel;
  24 import jalview.datamodel.PDBEntry;
  25 import jalview.datamodel.SequenceI;
  26 import jalview.schemes.ColourSchemeI;
  27 import jalview.structures.models.AAStructureBindingModel;
  28
  29 public interface JalviewStructureDisplayI
  30 {
  31
  32   AAStructureBindingModel getBinding();
  33
  34   /**
  35    * @return true if there is an active GUI handling a structure display
  36    */
  37   boolean isVisible();
  38
  39   /**
  40    * enable or disable the structure display - note this might just hide or show
  41    * a GUI element, but not actually reset the display
  42    *
  43    * @param b
  44    */
  45   void setVisible(boolean b);
  46
  47   /**
  48    * free up any external resources that were used by this display and collect
  49    * garbage
  50    */
  51   void dispose();
  52
  53   /**
  54    * Shutdown any Jalview structure viewing processes started by this display
  55    *
  56    * @param closeExternalViewer
  57    *          if true, force close any linked external viewer process
  58    */
  59   void closeViewer(boolean closeExternalViewer);
  60
  61   /**
  62    * apply a colourscheme to the structures in the viewer
  63    *
  64    * @param colourScheme
  65    */
  66   void setJalviewColourScheme(ColourSchemeI colourScheme);
  67
  68   /**
  69    *
  70    * @return true if all background sequence/structure binding threads have
  71    *         completed for this viewer instance
  72    */
  73   boolean hasMapping();
  74
  75   /**
  76    * Checks if the PDB file is already loaded in this viewer, if so just adds
  77    * mappings as necessary and answers true, else answers false. This supports
  78    * the use case of adding additional chains of the same structure to a viewer.
  79    *
  80    * @param seq
  81    * @param chains
  82    * @param apanel
  83    * @param pdbId
  84    * @return
  85    */
  86   boolean addAlreadyLoadedFile(SequenceI[] seq, String[] chains,
  87           AlignmentViewPanel apanel, String pdbId);
  88
  89   /**
  90    * Adds one or more chains (sequences) of a PDB structure to this structure
  91    * viewer
  92    *
  93    * @param pdbentry
  94    * @param seq
  95    * @param chains
  96    * @param apanel
  97    * @param pdbId
  98    * @return
  99    */
 100   void addToExistingViewer(PDBEntry pdbentry, SequenceI[] seq,
 101           String[] chains, AlignmentViewPanel apanel, String pdbId);
 102
 103   /**
 104    * refresh GUI after reconfiguring structure(s) and alignment panels
 105    */
 106   void updateTitleAndMenus();
 107
 108   /**
 109    * Answers true if the viewer should attempt to align any added structures,
 110    * else false
 111    *
 112    * @return
 113    */
 114   boolean isAlignAddedStructures();
 115
 116   /**
 117    * Sets the flag for whether added structures should be aligned
 118    *
 119    * @param alignAdded
 120    */
 121   void setAlignAddedStructures(boolean alignAdded);
 122
 123 }