Merge branch 'Release_2_9_0b1_Branch'

[jalview.git] / src / jalview / api / structures / JalviewStructureDisplayI.java

diff --git a/src/jalview/api/structures/JalviewStructureDisplayI.java b/src/jalview/api/structures/JalviewStructureDisplayI.java
index e37f467..159ceeb 100644 (file)
--- a/src/jalview/api/structures/JalviewStructureDisplayI.java
+++ b/src/jalview/api/structures/JalviewStructureDisplayI.java
@@ -1,39 +1,65 @@
+/*
+ * Jalview - A Sequence Alignment Editor and Viewer (Version 2.9.0b1)
+ * Copyright (C) 2015 The Jalview Authors
+ * 
+ * This file is part of Jalview.
+ * 
+ * Jalview is free software: you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License 
+ * as published by the Free Software Foundation, either version 3
+ * of the License, or (at your option) any later version.
+ *  
+ * Jalview is distributed in the hope that it will be useful, but 
+ * WITHOUT ANY WARRANTY; without even the implied warranty 
+ * of MERCHANTABILITY or FITNESS FOR A PARTICULAR 
+ * PURPOSE.  See the GNU General Public License for more details.
+ * 
+ * You should have received a copy of the GNU General Public License
+ * along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
+ * The Jalview Authors are detailed in the 'AUTHORS' file.
+ */
 package jalview.api.structures;
 
-import jalview.api.FeatureRenderer;
-import jalview.api.SequenceRenderer;
-import jalview.api.SequenceStructureBinding;
-import jalview.datamodel.AlignmentI;
-import jalview.datamodel.SequenceI;
-import jalview.ext.jmol.JalviewJmolBinding;
-import jalview.structure.StructureMappingcommandSet;
-import jalview.structure.StructureSelectionManager;
+import jalview.schemes.ColourSchemeI;
+import jalview.structures.models.AAStructureBindingModel;
 
 public interface JalviewStructureDisplayI
 {
 
-  SequenceStructureBinding getBinding();
+  AAStructureBindingModel getBinding();
 
   /**
-   * @return true if there is an active GUI handling a structure display 
+   * @return true if there is an active GUI handling a structure display
    */
   boolean isVisible();
 
   /**
-   * enable or disable the structure display - note this might just hide or show a GUI element, but not actually reset the display
+   * enable or disable the structure display - note this might just hide or show
+   * a GUI element, but not actually reset the display
+   * 
    * @param b
    */
   void setVisible(boolean b);
 
   /**
-   * free up any external resources that were used by this display and collect garbage
+   * free up any external resources that were used by this display and collect
+   * garbage
    */
   void dispose();
 
   /**
-   * shutdown any structure viewing processes started by this display
+   * Shutdown any Jalview structure viewing processes started by this display
+   * 
+   * @param closeExternalViewer
+   *          if true, force close any linked external viewer process
    */
-  void closeViewer();
+  void closeViewer(boolean closeExternalViewer);
 
+  /**
+   * apply a colourscheme to the structures in the viewer
+   * 
+   * @param colourScheme
+   */
+  void setJalviewColourScheme(ColourSchemeI colourScheme);
 
 }