Merge branch 'features/JAL-1333' into Release_2_8_2_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
new file mode 100644 (file)
index 0000000..efb60dd
--- /dev/null
+++ b/src/jalview/api/structures/JalviewStructureDisplayI.java
@@ -0,0 +1,68 @@
+/*
+ * Jalview - A Sequence Alignment Editor and Viewer (Version 2.8.2)
+ * Copyright (C) 2014 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.schemes.ColourSchemeI;
+import jalview.schemes.UserColourScheme;
+import jalview.structure.StructureMappingcommandSet;
+import jalview.structure.StructureSelectionManager;
+
+public interface JalviewStructureDisplayI
+{
+
+  SequenceStructureBinding getBinding();
+
+  /**
+   * @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
+   * 
+   * @param b
+   */
+  void setVisible(boolean b);
+
+  /**
+   * 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
+   */
+  void closeViewer();
+  /**
+   * apply a colourscheme to the structures in the viewer
+   * @param colourScheme
+   */
+  void setJalviewColourScheme(ColourSchemeI colourScheme);
+
+}