7152152c1958d98df6cab45eee1ecb4c6ece0151
[jalview.git] / src / jalview / api / structures / JalviewStructureDisplayI.java
1 /*
2  * Jalview - A Sequence Alignment Editor and Viewer (Version 2.9.0b2)
3  * Copyright (C) 2015 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.schemes.ColourSchemeI;
24 import jalview.structures.models.AAStructureBindingModel;
25
26 public interface JalviewStructureDisplayI
27 {
28
29   AAStructureBindingModel getBinding();
30
31   /**
32    * @return true if there is an active GUI handling a structure display
33    */
34   boolean isVisible();
35
36   /**
37    * enable or disable the structure display - note this might just hide or show
38    * a GUI element, but not actually reset the display
39    * 
40    * @param b
41    */
42   void setVisible(boolean b);
43
44   /**
45    * free up any external resources that were used by this display and collect
46    * garbage
47    */
48   void dispose();
49
50   /**
51    * Shutdown any Jalview structure viewing processes started by this display
52    * 
53    * @param closeExternalViewer
54    *          if true, force close any linked external viewer process
55    */
56   void closeViewer(boolean closeExternalViewer);
57
58   /**
59    * apply a colourscheme to the structures in the viewer
60    * 
61    * @param colourScheme
62    */
63   void setJalviewColourScheme(ColourSchemeI colourScheme);
64
65 }