cbad1483559545da60fb674319273431d1f58e2a
[jalview.git] / SplitFrame.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.appletgui;
22
23 import jalview.api.AlignmentViewPanel;
24 import jalview.api.ViewStyleI;
25 import jalview.bin.JalviewLite;
26 import jalview.datamodel.AlignmentI;
27 import jalview.structure.StructureSelectionManager;
28 import jalview.viewmodel.AlignmentViewport;
29
30 import java.awt.BorderLayout;
31 import java.awt.Dimension;
32 import java.awt.GridLayout;
33 import java.awt.Panel;
34
35 public class SplitFrame extends EmbmenuFrame
36 {
37   private static final long serialVersionUID = 1L;
38
39   private AlignFrame topFrame;
40
41   private AlignFrame bottomFrame;
42
43   private Panel outermost;
44
45   /**
46    * Constructs the split frame placing cdna in the top half. No 'alignment' is
47    * performed here, this should be done by the calling client if wanted.
48    */
49   public SplitFrame(AlignFrame af1, AlignFrame af2)
50   {
51     boolean af1IsNucleotide = af1.viewport.getAlignment().isNucleotide();
52     topFrame = af1IsNucleotide ? af1 : af2;
53     bottomFrame = topFrame == af1 ? af2 : af1;
54     init();
55   }
56
57   /**
58    * Creates a Panel containing two Panels, and adds the first and second
59    * AlignFrame's components to each. At this stage we have not yet committed to
60    * whether the enclosing panel will be added to this frame, for display as a
61    * separate frame, or added to the applet (embedded mode).
62    */
63   public void init()
64   {
65     constructSplit();
66
67     /*
68      * Try to make and add dna/protein sequence mappings
69      */
70     final AlignViewport topViewport = topFrame.viewport;
71     final AlignViewport bottomViewport = bottomFrame.viewport;
72     final AlignmentI topAlignment = topViewport.getAlignment();
73     final AlignmentI bottomAlignment = bottomViewport.getAlignment();
74     AlignmentViewport cdna = topAlignment.isNucleotide() ? topViewport
75             : (bottomAlignment.isNucleotide() ? bottomViewport : null);
76     AlignmentViewport protein = !topAlignment.isNucleotide() ? topViewport
77             : (!bottomAlignment.isNucleotide() ? bottomViewport : null);
78
79     final StructureSelectionManager ssm = StructureSelectionManager
80             .getStructureSelectionManager(topViewport.applet);
81     ssm.registerMappings(protein.getAlignment().getCodonFrames());
82     topViewport.setCodingComplement(bottomViewport);
83     ssm.addCommandListener(cdna);
84     ssm.addCommandListener(protein);
85
86     /*
87      * Compute cDNA consensus on protein alignment
88      */
89     protein.initComplementConsensus();
90     AlignmentViewPanel ap = topAlignment.isNucleotide() ? bottomFrame.alignPanel
91             : topFrame.alignPanel;
92     protein.updateConsensus(ap);
93
94     adjustLayout();
95   }
96
97   /**
98    * 
99    */
100   protected void constructSplit()
101   {
102     setMenuBar(null);
103     outermost = new Panel(new GridLayout(2, 1));
104
105     Panel topPanel = new Panel();
106     Panel bottomPanel = new Panel();
107     outermost.add(topPanel);
108     outermost.add(bottomPanel);
109
110     addAlignFrameComponents(topFrame, topPanel);
111     addAlignFrameComponents(bottomFrame, bottomPanel);
112   }
113
114   /**
115    * Make any adjustments to the layout
116    */
117   protected void adjustLayout()
118   {
119     AlignmentViewport cdna = topFrame.getAlignViewport().getAlignment()
120             .isNucleotide() ? topFrame.viewport : bottomFrame.viewport;
121     AlignmentViewport protein = cdna == topFrame.viewport ? bottomFrame.viewport
122             : topFrame.viewport;
123
124     /*
125      * Ensure sequence ids are the same width for good alignment.
126      */
127     // TODO should do this via av.getViewStyle/setViewStyle
128     // however at present av.viewStyle is not set in IdPanel.fontChanged
129     int w1 = topFrame.alignPanel.idPanel.idCanvas.getWidth();
130     int w2 = bottomFrame.alignPanel.idPanel.idCanvas.getWidth();
131     int w3 = Math.max(w1, w2);
132     if (w1 != w3)
133     {
134       Dimension d = topFrame.alignPanel.idPanel.idCanvas.getSize();
135       topFrame.alignPanel.idPanel.idCanvas.setSize(new Dimension(w3,
136               d.height));
137     }
138     if (w2 != w3)
139     {
140       Dimension d = bottomFrame.alignPanel.idPanel.idCanvas.getSize();
141       bottomFrame.alignPanel.idPanel.idCanvas.setSize(new Dimension(w3,
142               d.height));
143     }
144
145     /*
146      * Scale protein to either 1 or 3 times character width of dna
147      */
148     if (protein != null && cdna != null)
149     {
150       ViewStyleI vs = protein.getViewStyle();
151       int scale = vs.isScaleProteinAsCdna() ? 3 : 1;
152       vs.setCharWidth(scale * cdna.getViewStyle().getCharWidth());
153       protein.setViewStyle(vs);
154     }
155   }
156
157   /**
158    * Add the menu bar, alignment panel and status bar from the AlignFrame to the
159    * panel. The menu bar is a panel 'reconstructed' from the AlignFrame's frame
160    * menu bar. This allows each half of the SplitFrame to have its own menu bar.
161    * 
162    * @param af
163    * @param panel
164    */
165   private void addAlignFrameComponents(AlignFrame af, Panel panel)
166   {
167     panel.setLayout(new BorderLayout());
168     Panel menuPanel = af
169             .makeEmbeddedPopupMenu(af.getMenuBar(), true, false);
170     panel.add(menuPanel, BorderLayout.NORTH);
171     panel.add(af.statusBar, BorderLayout.SOUTH);
172     panel.add(af.alignPanel, BorderLayout.CENTER);
173
174     af.setSplitFrame(this);
175   }
176
177   /**
178    * Display the content panel either as a new frame or embedded in the applet.
179    * 
180    * @param embedded
181    * @param applet
182    */
183   public void addToDisplay(boolean embedded, JalviewLite applet)
184   {
185     createSplitFrameWindow(embedded, applet);
186     validate();
187     topFrame.alignPanel.adjustAnnotationHeight();
188     topFrame.alignPanel.paintAlignment(true);
189     bottomFrame.alignPanel.adjustAnnotationHeight();
190     bottomFrame.alignPanel.paintAlignment(true);
191   }
192
193   /**
194    * Either show the content panel in this frame as a new frame, or (if
195    * embed=true) add it to the applet container instead.
196    * 
197    * @param embed
198    * @param applet
199    */
200   protected void createSplitFrameWindow(boolean embed, JalviewLite applet)
201   {
202     if (embed)
203     {
204       applet.add(outermost);
205       applet.validate();
206     }
207     else
208     {
209       this.add(outermost);
210       int width = Math.max(topFrame.frameWidth, bottomFrame.frameWidth);
211       int height = topFrame.frameHeight + bottomFrame.frameHeight;
212       jalview.bin.JalviewLite
213               .addFrame(this, this.getTitle(), width, height);
214     }
215   }
216
217   /**
218    * Returns the contained AlignFrame complementary to the one given (or null if
219    * no match to top or bottom component).
220    * 
221    * @param af
222    * @return
223    */
224   public AlignFrame getComplement(AlignFrame af)
225   {
226     if (topFrame == af)
227     {
228       return bottomFrame;
229     }
230     else if (bottomFrame == af)
231     {
232       return topFrame;
233     }
234     return null;
235   }
236 }