merge
[jalview.git] / src / jalview / api / SplitContainerI.java
1 package jalview.api;
2
3 import jalview.datamodel.AlignmentI;
4
5 /**
6  * Describes a visual container that can show two alignments.
7  * 
8  * @author gmcarstairs
9  *
10  */
11 public interface SplitContainerI
12 {
13
14   /**
15    * Set visibility of the specified split view component.
16    * 
17    * @param alignFrame
18    * @param show
19    */
20   // TODO need an interface for AlignFrame?
21   void setComplementVisible(Object alignFrame, boolean show);
22
23   /**
24    * Returns the alignment that is complementary to the one in the given
25    * AlignFrame, or null.
26    */
27   AlignmentI getComplement(Object af);
28
29   /**
30    * Returns the frame title for the alignment that is complementary to the one
31    * in the given AlignFrame, or null.
32    * 
33    * @param af
34    * @return
35    */
36   String getComplementTitle(Object af);
37
38 }