merge
[jalview.git] / src / jalview / api / SequenceStructureBinding.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;
22
23 /**
24  * methods for interacting with the binding between a structure visualization
25  * and one or more Jalview views.
26  * 
27  * @author JimP prototype class - this may disappear !
28  */
29 public interface SequenceStructureBinding
30 {
31
32   /**
33    * 
34    * @return true if Jalview or the Viewer is still restoring state or loading
35    *         is still going on (see setFinishedLoadingFromArchive)
36    */
37   void setLoadingFromArchive(boolean loadingFromArchive);
38
39   boolean isLoadingFromArchive();
40
41   /**
42    * modify flag which controls if sequence colouring events are honoured by the
43    * binding. Should be true for normal operation
44    * 
45    * @param finishedLoading
46    */
47   void setFinishedLoadingFromArchive(boolean finishedLoading);
48
49   boolean isLoadingFinished();
50
51 }