JAL-3949 fixed failing commandlinetests due to more output and line count limit
[jalview.git] / src / 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.controller.FeatureSettingsControllerGuiI;
24 import jalview.datamodel.AlignmentI;
25
26 /**
27  * Describes a visual container that can show two alignments.
28  * 
29  * @author gmcarstairs
30  *
31  */
32 public interface SplitContainerI
33 {
34
35   /**
36    * Set visibility of the specified split view component.
37    * 
38    * @param alignFrame
39    * @param show
40    */
41   // TODO need an interface for AlignFrame?
42   void setComplementVisible(Object alignFrame, boolean show);
43
44   /**
45    * Returns the alignment that is complementary to the one in the given
46    * AlignFrame, or null.
47    */
48   AlignmentI getComplement(Object af);
49
50   /**
51    * Returns the frame title for the alignment that is complementary to the one
52    * in the given AlignFrame, or null.
53    * 
54    * @param af
55    * @return
56    */
57   String getComplementTitle(Object af);
58
59   /**
60    * get the 'other' alignFrame in the SplitFrame
61    * 
62    * @param alignFrame
63    * @return the complement alignFrame - or null if alignFrame wasn't held by this
64    *         frame
65    */
66   AlignViewControllerGuiI getComplementAlignFrame(
67           AlignViewControllerGuiI alignFrame);
68
69   /**
70    * add the given UI to the splitframe's feature settings UI holder
71    * 
72    * @param featureSettings
73    * @return
74    */
75   void addFeatureSettingsUI(
76           FeatureSettingsControllerGuiI featureSettings);
77
78   /**
79    * Request to close all feature settings originating from a particular panel.
80    * 
81    * @param featureSettings
82    * @param closeContainingFrame
83    *                               - if false then the tab containing the feature
84    *                               settings will be 'reset' ready for a new
85    *                               feature settings
86    */
87   void closeFeatureSettings(FeatureSettingsControllerI featureSettings,
88           boolean closeContainingFrame);
89
90   /**
91    * 
92    * @return true if a feature settings panel is currently open
93    */
94   boolean isFeatureSettingsOpen();
95
96 }