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.structures.models.AAStructureBindingModel;
  27
  28 public interface JalviewStructureDisplayI
  29 {
  30
  31   AAStructureBindingModel getBinding();
  32
  33   /**
  34    * @return true if there is an active GUI handling a structure display
  35    */
  36   boolean isVisible();
  37
  38   /**
  39    * enable or disable the structure display - note this might just hide or show
  40    * a GUI element, but not actually reset the display
  41    *
  42    * @param b
  43    */
  44   void setVisible(boolean b);
  45
  46   /**
  47    * free up any external resources that were used by this display and collect
  48    * garbage
  49    */
  50   void dispose();
  51
  52   /**
  53    * Shutdown any Jalview structure viewing processes started by this display
  54    *
  55    * @param closeExternalViewer
  56    *          if true, force close any linked external viewer process
  57    */
  58   void closeViewer(boolean closeExternalViewer);
  59
  60   /**
  61    *
  62    * @return true if all background sequence/structure binding threads have
  63    *         completed for this viewer instance
  64    */
  65   boolean hasMapping();
  66
  67   /**
  68    * Checks if the PDB file is already loaded in this viewer, if so just adds
  69    * mappings as necessary and answers true, else answers false. This supports
  70    * the use case of adding additional chains of the same structure to a viewer.
  71    *
  72    * @param seq
  73    * @param chains
  74    * @param apanel
  75    * @param pdbId
  76    * @return
  77    */
  78   boolean addAlreadyLoadedFile(SequenceI[] seq, String[] chains,
  79           AlignmentViewPanel apanel, String pdbId);
  80
  81   /**
  82    * Adds one or more chains (sequences) of a PDB structure to this structure
  83    * viewer
  84    *
  85    * @param pdbentry
  86    * @param seq
  87    * @param chains
  88    * @param apanel
  89    * @param pdbId
  90    * @return
  91    */
  92   void addToExistingViewer(PDBEntry pdbentry, SequenceI[] seq,
  93           String[] chains, AlignmentViewPanel apanel, String pdbId);
  94
  95   /**
  96    * refresh GUI after reconfiguring structure(s) and alignment panels
  97    */
  98   void updateTitleAndMenus();
  99
 100   /**
 101    * Answers true if the viewer should attempt to align any added structures,
 102    * else false
 103    *
 104    * @return
 105    */
 106   boolean isAlignAddedStructures();
 107
 108   /**
 109    * Sets the flag for whether added structures should be aligned
 110    *
 111    * @param alignAdded
 112    */
 113   void setAlignAddedStructures(boolean alignAdded);
 114
 115   /**
 116    * Raise the panel to the top of the stack...
 117    */
 118   void raiseViewer();
 119
 120   AlignmentViewPanel getAlignmentPanel();
 121
 122   /**
 123    * Answers true if the given alignment view is used to colour structures by
 124    * sequence, false if not
 125    *
 126    * @param ap
 127    * @return
 128    */
 129   boolean isUsedForColourBy(AlignmentViewPanel ap);
 130
 131   /**
 132    * If implemented, shows a command line console in the structure viewer
 133    *
 134    * @param show
 135    *          true to show, false to hide
 136    */
 137   void showConsole(boolean show);
 138
 139   /**
 140    * Remove references to the given alignment view for this structure viewer
 141    *
 142    * @param avp
 143    */
 144   void removeAlignmentPanel(AlignmentViewPanel avp);
 145
 146   /**
 147    * Updates the progress bar if there is one. Call stopProgressBar with the
 148    * returned handle to remove the message.
 149    *
 150    * @param msg
 151    * @return handle
 152    */
 153   long startProgressBar(String msg);
 154
 155   /**
 156    * Ends the progress bar with the specified handle, leaving a message (if not
 157    * null) on the status bar
 158    *
 159    * @param msg
 160    * @param handle
 161    */
 162   void stopProgressBar(String msg, long handle);
 163
 164   /**
 165    *
 166    * @return true if the actions menu is shown for this viewer
 167    */
 168   boolean hasViewerActionsMenu();
 169
 170 }