src/jalview/api/structures/JalviewStructureDisplayI.java

   1 /*
   2  * Jalview - A Sequence Alignment Editor and Viewer (Version 2.8.2)
   3  * Copyright (C) 2014 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.FeatureRenderer;
  24 import jalview.api.SequenceRenderer;
  25 import jalview.api.SequenceStructureBinding;
  26 import jalview.datamodel.AlignmentI;
  27 import jalview.datamodel.SequenceI;
  28 import jalview.ext.jmol.JalviewJmolBinding;
  29 import jalview.schemes.ColourSchemeI;
  30 import jalview.schemes.UserColourScheme;
  31 import jalview.structure.StructureMappingcommandSet;
  32 import jalview.structure.StructureSelectionManager;
  33
  34 public interface JalviewStructureDisplayI
  35 {
  36
  37   SequenceStructureBinding getBinding();
  38
  39   /**
  40    * @return true if there is an active GUI handling a structure display
  41    */
  42   boolean isVisible();
  43
  44   /**
  45    * enable or disable the structure display - note this might just hide or show
  46    * a GUI element, but not actually reset the display
  47    *
  48    * @param b
  49    */
  50   void setVisible(boolean b);
  51
  52   /**
  53    * free up any external resources that were used by this display and collect
  54    * garbage
  55    */
  56   void dispose();
  57
  58   /**
  59    * shutdown any structure viewing processes started by this display
  60    */
  61   void closeViewer();
  62   /**
  63    * apply a colourscheme to the structures in the viewer
  64    * @param colourScheme
  65    */
  66   void setJalviewColourScheme(ColourSchemeI colourScheme);
  67
  68 }