Merge branch 'releases/Release_2_11_4_Branch'
[jalview.git] / jalview / api / SplitContainerI.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 import jalview.datamodel.AlignmentI;
24
25 /**
26  * Describes a visual container that can show two alignments.
27  * 
28  * @author gmcarstairs
29  *
30  */
31 public interface SplitContainerI
32 {
33
34   /**
35    * Set visibility of the specified split view component.
36    * 
37    * @param alignFrame
38    * @param show
39    */
40   // TODO need an interface for AlignFrame?
41   void setComplementVisible(Object alignFrame, boolean show);
42
43   /**
44    * Returns the alignment that is complementary to the one in the given
45    * AlignFrame, or null.
46    */
47   AlignmentI getComplement(Object af);
48
49   /**
50    * Returns the frame title for the alignment that is complementary to the one
51    * in the given AlignFrame, or null.
52    * 
53    * @param af
54    * @return
55    */
56   String getComplementTitle(Object af);
57
58 }