Merge branch 'patch/JAL-4345_pae_epas1_doubleclick' into develop
[jalview.git] / src / jalview / gui / 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.gui;
22
23 import java.awt.BorderLayout;
24 import java.awt.Component;
25 import java.awt.Dimension;
26 import java.awt.event.ActionEvent;
27 import java.awt.event.ActionListener;
28 import java.awt.event.KeyAdapter;
29 import java.awt.event.KeyEvent;
30 import java.awt.event.KeyListener;
31 import java.beans.PropertyVetoException;
32 import java.util.Arrays;
33 import java.util.List;
34 import java.util.Map.Entry;
35
36 import javax.swing.AbstractAction;
37 import javax.swing.InputMap;
38 import javax.swing.JButton;
39 import javax.swing.JComponent;
40 import javax.swing.JDesktopPane;
41 import javax.swing.JInternalFrame;
42 import javax.swing.JLayeredPane;
43 import javax.swing.JMenuItem;
44 import javax.swing.JPanel;
45 import javax.swing.JTabbedPane;
46 import javax.swing.KeyStroke;
47 import javax.swing.event.ChangeEvent;
48 import javax.swing.event.ChangeListener;
49 import javax.swing.event.InternalFrameAdapter;
50 import javax.swing.event.InternalFrameEvent;
51
52 import jalview.api.AlignViewControllerGuiI;
53 import jalview.api.FeatureSettingsControllerI;
54 import jalview.api.SplitContainerI;
55 import jalview.controller.FeatureSettingsControllerGuiI;
56 import jalview.datamodel.AlignmentI;
57 import jalview.jbgui.GAlignFrame;
58 import jalview.jbgui.GSplitFrame;
59 import jalview.structure.StructureSelectionManager;
60 import jalview.util.MessageManager;
61 import jalview.util.Platform;
62 import jalview.viewmodel.AlignmentViewport;
63
64 /**
65  * An internal frame on the desktop that hosts a horizontally split view of
66  * linked DNA and Protein alignments. Additional views can be created in linked
67  * pairs, expanded to separate split frames, or regathered into a single frame.
68  * <p>
69  * (Some) operations on each alignment are automatically mirrored on the other.
70  * These include mouseover (highlighting), sequence and column selection,
71  * sequence ordering and sorting, and grouping, colouring and sorting by tree.
72  * 
73  * @author gmcarstairs
74  *
75  */
76 public class SplitFrame extends GSplitFrame implements SplitContainerI
77 {
78   private static final int WINDOWS_INSETS_WIDTH = 28; // tbc
79
80   private static final int MAC_INSETS_WIDTH = 28;
81
82   private static final int WINDOWS_INSETS_HEIGHT = 50; // tbc
83
84   private static final int MAC_INSETS_HEIGHT = 50;
85
86   private static final int DESKTOP_DECORATORS_HEIGHT = 65;
87
88   private static final long serialVersionUID = 1L;
89
90   /**
91    * geometry for Feature Settings Holder
92    */
93   private static final int FS_MIN_WIDTH = 400;
94
95   private static final int FS_MIN_HEIGHT = 400;
96
97   public SplitFrame(GAlignFrame top, GAlignFrame bottom)
98   {
99     super(top, bottom);
100     init();
101   }
102
103   /**
104    * Initialise this frame.
105    */
106   protected void init()
107   {
108     setFrameIcon(null);
109     getTopFrame().setSplitFrame(this);
110     getBottomFrame().setSplitFrame(this);
111     getTopFrame().setVisible(true);
112     getBottomFrame().setVisible(true);
113
114     ((AlignFrame) getTopFrame()).getViewport().setCodingComplement(
115             ((AlignFrame) getBottomFrame()).getViewport());
116
117     /*
118      * estimate width and height of SplitFrame; this.getInsets() doesn't seem to
119      * give the full additional size (a few pixels short)
120      */
121     int widthFudge = Platform.isAMacAndNotJS() ? MAC_INSETS_WIDTH
122             : WINDOWS_INSETS_WIDTH;
123     int heightFudge = Platform.isAMacAndNotJS() ? MAC_INSETS_HEIGHT
124             : WINDOWS_INSETS_HEIGHT;
125     int width = ((AlignFrame) getTopFrame()).getWidth() + widthFudge;
126     int height = ((AlignFrame) getTopFrame()).getHeight()
127             + ((AlignFrame) getBottomFrame()).getHeight() + DIVIDER_SIZE
128             + heightFudge;
129     height = fitHeightToDesktop(height);
130     setSize(width, height);
131
132     adjustLayout();
133
134     addCloseFrameListener();
135
136     addKeyListener();
137
138     addKeyBindings();
139
140     addCommandListeners();
141   }
142
143   /**
144    * Reduce the height if too large to fit in the Desktop. Also adjust the
145    * divider location in proportion.
146    * 
147    * @param height
148    *          in pixels
149    * @return original or reduced height
150    */
151   public int fitHeightToDesktop(int height)
152   {
153     // allow about 65 pixels for Desktop decorators on Windows
154
155     int newHeight = Math.min(height,
156             Desktop.instance.getHeight() - DESKTOP_DECORATORS_HEIGHT);
157     if (newHeight != height)
158     {
159       int oldDividerLocation = getDividerLocation();
160       setDividerLocation(oldDividerLocation * newHeight / height);
161     }
162     return newHeight;
163   }
164
165   /**
166    * Set the top and bottom frames to listen to each others Commands (e.g. Edit,
167    * Order).
168    */
169   protected void addCommandListeners()
170   {
171     // TODO if CommandListener is only ever 1:1 for complementary views,
172     // may change broadcast pattern to direct messaging (more efficient)
173     final StructureSelectionManager ssm = StructureSelectionManager
174             .getStructureSelectionManager(Desktop.instance);
175     ssm.addCommandListener(((AlignFrame) getTopFrame()).getViewport());
176     ssm.addCommandListener(((AlignFrame) getBottomFrame()).getViewport());
177   }
178
179   /**
180    * Do any tweaking and twerking of the layout wanted.
181    */
182   public void adjustLayout()
183   {
184     final AlignViewport topViewport = ((AlignFrame) getTopFrame()).viewport;
185     final AlignViewport bottomViewport = ((AlignFrame) getBottomFrame()).viewport;
186
187     /*
188      * Ensure sequence ids are the same width so sequences line up
189      */
190     int w1 = topViewport.getIdWidth();
191     int w2 = bottomViewport.getIdWidth();
192     int w3 = Math.max(w1, w2);
193     topViewport.setIdWidth(w3);
194     bottomViewport.setIdWidth(w3);
195
196     /*
197      * Scale protein to either 1 or 3 times character width of dna
198      */
199     final AlignmentI topAlignment = topViewport.getAlignment();
200     final AlignmentI bottomAlignment = bottomViewport.getAlignment();
201     AlignmentViewport cdna = topAlignment.isNucleotide() ? topViewport
202             : (bottomAlignment.isNucleotide() ? bottomViewport : null);
203     AlignmentViewport protein = !topAlignment.isNucleotide() ? topViewport
204             : (!bottomAlignment.isNucleotide() ? bottomViewport : null);
205     if (protein != null && cdna != null)
206     {
207       int scale = protein.isScaleProteinAsCdna() ? 3 : 1;
208       protein.setCharWidth(scale * cdna.getViewStyle().getCharWidth());
209     }
210   }
211
212   /**
213    * Adjusts the divider for a sensible split of the real estate (for example,
214    * when many transcripts are shown with a single protein). This should only be
215    * called after the split pane has been laid out (made visible) so it has a
216    * height. The aim is to avoid unnecessary vertical scroll bars, while
217    * ensuring that at least 2 sequences are visible in each panel.
218    * <p>
219    * Once laid out, the user may choose to customise as they wish, so this
220    * method is not called again after the initial layout.
221    */
222   protected void adjustInitialLayout()
223   {
224     AlignFrame topFrame = (AlignFrame) getTopFrame();
225     AlignFrame bottomFrame = (AlignFrame) getBottomFrame();
226
227     /*
228      * recompute layout of top and bottom panels to reflect their
229      * actual (rather than requested) height
230      */
231     topFrame.alignPanel.adjustAnnotationHeight();
232     bottomFrame.alignPanel.adjustAnnotationHeight();
233
234     final AlignViewport topViewport = topFrame.viewport;
235     final AlignViewport bottomViewport = bottomFrame.viewport;
236     final AlignmentI topAlignment = topViewport.getAlignment();
237     final AlignmentI bottomAlignment = bottomViewport.getAlignment();
238     boolean topAnnotations = topViewport.isShowAnnotation();
239     boolean bottomAnnotations = bottomViewport.isShowAnnotation();
240     // TODO need number of visible sequences here, not #sequences - how?
241     int topCount = topAlignment.getHeight();
242     int bottomCount = bottomAlignment.getHeight();
243     int topCharHeight = topViewport.getViewStyle().getCharHeight();
244     int bottomCharHeight = bottomViewport.getViewStyle().getCharHeight();
245
246     /*
247      * calculate the minimum ratio that leaves at least the height 
248      * of two sequences (after rounding) visible in the top panel
249      */
250     int topPanelHeight = topFrame.getHeight();
251     int bottomPanelHeight = bottomFrame.getHeight();
252     int topSequencesHeight = topFrame.alignPanel.getSeqPanel().seqCanvas
253             .getHeight();
254     int topPanelMinHeight = topPanelHeight
255             - Math.max(0, topSequencesHeight - 3 * topCharHeight);
256     double totalHeight = (double) topPanelHeight + bottomPanelHeight;
257     double minRatio = topPanelMinHeight / totalHeight;
258
259     /*
260      * calculate the maximum ratio that leaves at least the height 
261      * of two sequences (after rounding) visible in the bottom panel
262      */
263     int bottomSequencesHeight = bottomFrame.alignPanel
264             .getSeqPanel().seqCanvas.getHeight();
265     int bottomPanelMinHeight = bottomPanelHeight
266             - Math.max(0, bottomSequencesHeight - 3 * bottomCharHeight);
267     double maxRatio = (totalHeight - bottomPanelMinHeight) / totalHeight;
268
269     /*
270      * estimate ratio of (topFrameContent / bottomFrameContent)
271      */
272     int insets = Platform.isAMacAndNotJS() ? MAC_INSETS_HEIGHT
273             : WINDOWS_INSETS_HEIGHT;
274     // allow 3 'rows' for scale, scrollbar, status bar
275     int topHeight = insets + (3 + topCount) * topCharHeight
276             + (topAnnotations ? topViewport.calcPanelHeight() : 0);
277     int bottomHeight = insets + (3 + bottomCount) * bottomCharHeight
278             + (bottomAnnotations ? bottomViewport.calcPanelHeight() : 0);
279     double ratio = ((double) topHeight)
280             / (double) (topHeight + bottomHeight);
281
282     /*
283      * limit ratio to avoid concealing all sequences
284      */
285     ratio = Math.min(ratio, maxRatio);
286     ratio = Math.max(ratio, minRatio);
287     setRelativeDividerLocation(ratio);
288   }
289
290   /**
291    * Add a listener to tidy up when the frame is closed.
292    */
293   protected void addCloseFrameListener()
294   {
295     addInternalFrameListener(new InternalFrameAdapter()
296     {
297       @Override
298       public void internalFrameClosed(InternalFrameEvent evt)
299       {
300         close();
301       };
302     });
303   }
304
305   /**
306    * Add a key listener that delegates to whichever split component the mouse is
307    * in (or does nothing if neither).
308    */
309   protected void addKeyListener()
310   {
311     addKeyListener(new KeyAdapter()
312     {
313
314       @Override
315       public void keyPressed(KeyEvent e)
316       {
317         AlignFrame af = (AlignFrame) getFrameAtMouse();
318
319         /*
320          * Intercept and override any keys here if wanted.
321          */
322         if (!overrideKey(e, af))
323         {
324           if (af != null)
325           {
326             for (KeyListener kl : af.getKeyListeners())
327             {
328               kl.keyPressed(e);
329             }
330           }
331         }
332       }
333
334       @Override
335       public void keyReleased(KeyEvent e)
336       {
337         Component c = getFrameAtMouse();
338         if (c != null)
339         {
340           for (KeyListener kl : c.getKeyListeners())
341           {
342             kl.keyReleased(e);
343           }
344         }
345       }
346
347     });
348   }
349
350   /**
351    * Returns true if the key event is overriden and actioned (or ignored) here,
352    * else returns false, indicating it should be delegated to the AlignFrame's
353    * usual handler.
354    * <p>
355    * We can't handle Cmd-Key combinations here, instead this is done by
356    * overriding key bindings.
357    * 
358    * @see addKeyOverrides
359    * @param e
360    * @param af
361    * @return
362    */
363   protected boolean overrideKey(KeyEvent e, AlignFrame af)
364   {
365     boolean actioned = false;
366     int keyCode = e.getKeyCode();
367     switch (keyCode)
368     {
369     case KeyEvent.VK_DOWN:
370       if (e.isAltDown() || !af.viewport.cursorMode)
371       {
372         /*
373          * Key down (or Alt-key-down in cursor mode) - move selected sequences
374          */
375         ((AlignFrame) getTopFrame()).moveSelectedSequences(false);
376         ((AlignFrame) getBottomFrame()).moveSelectedSequences(false);
377         actioned = true;
378         e.consume();
379       }
380       break;
381     case KeyEvent.VK_UP:
382       if (e.isAltDown() || !af.viewport.cursorMode)
383       {
384         /*
385          * Key up (or Alt-key-up in cursor mode) - move selected sequences
386          */
387         ((AlignFrame) getTopFrame()).moveSelectedSequences(true);
388         ((AlignFrame) getBottomFrame()).moveSelectedSequences(true);
389         actioned = true;
390         e.consume();
391       }
392       break;
393     default:
394     }
395     return actioned;
396   }
397
398   /**
399    * Set key bindings (recommended for Swing over key accelerators).
400    */
401   private void addKeyBindings()
402   {
403     overrideDelegatedKeyBindings();
404
405     overrideImplementedKeyBindings();
406   }
407
408   /**
409    * Override key bindings with alternative action methods implemented in this
410    * class.
411    */
412   protected void overrideImplementedKeyBindings()
413   {
414     overrideFind();
415     overrideNewView();
416     overrideCloseView();
417     overrideExpandViews();
418     overrideGatherViews();
419   }
420
421   /**
422    * Replace Cmd-W close view action with our version.
423    */
424   protected void overrideCloseView()
425   {
426     AbstractAction action;
427     /*
428      * Ctrl-W / Cmd-W - close view or window
429      */
430     KeyStroke key_cmdW = KeyStroke.getKeyStroke(KeyEvent.VK_W,
431             jalview.util.ShortcutKeyMaskExWrapper
432                     .getMenuShortcutKeyMaskEx(),
433             false);
434     action = new AbstractAction()
435     {
436       @Override
437       public void actionPerformed(ActionEvent e)
438       {
439         closeView_actionPerformed();
440       }
441     };
442     overrideKeyBinding(key_cmdW, action);
443   }
444
445   /**
446    * Replace Cmd-T new view action with our version.
447    */
448   protected void overrideNewView()
449   {
450     /*
451      * Ctrl-T / Cmd-T open new view
452      */
453     KeyStroke key_cmdT = KeyStroke.getKeyStroke(KeyEvent.VK_T,
454             jalview.util.ShortcutKeyMaskExWrapper
455                     .getMenuShortcutKeyMaskEx(),
456             false);
457     AbstractAction action = new AbstractAction()
458     {
459       @Override
460       public void actionPerformed(ActionEvent e)
461       {
462         newView_actionPerformed();
463       }
464     };
465     overrideKeyBinding(key_cmdT, action);
466   }
467
468   /**
469    * For now, delegates key events to the corresponding key accelerator for the
470    * AlignFrame that the mouse is in. Hopefully can be simplified in future if
471    * AlignFrame is changed to use key bindings rather than accelerators.
472    */
473   protected void overrideDelegatedKeyBindings()
474   {
475     if (getTopFrame() instanceof AlignFrame)
476     {
477       /*
478        * Get all accelerator keys in the top frame (the bottom should be
479        * identical) and override each one.
480        */
481       for (Entry<KeyStroke, JMenuItem> acc : ((AlignFrame) getTopFrame())
482               .getAccelerators().entrySet())
483       {
484         overrideKeyBinding(acc);
485       }
486     }
487   }
488
489   /**
490    * Overrides an AlignFrame key accelerator with our version which delegates to
491    * the action listener in whichever frame has the mouse (and does nothing if
492    * neither has).
493    * 
494    * @param acc
495    */
496   private void overrideKeyBinding(Entry<KeyStroke, JMenuItem> acc)
497   {
498     final KeyStroke ks = acc.getKey();
499     InputMap inputMap = this.getInputMap(JComponent.WHEN_FOCUSED);
500     inputMap.put(ks, ks);
501     this.getActionMap().put(ks, new AbstractAction()
502     {
503       @Override
504       public void actionPerformed(ActionEvent e)
505       {
506         Component c = getFrameAtMouse();
507         if (c != null && c instanceof AlignFrame)
508         {
509           for (ActionListener a : ((AlignFrame) c).getAccelerators().get(ks)
510                   .getActionListeners())
511           {
512             a.actionPerformed(null);
513           }
514         }
515       }
516     });
517   }
518
519   /**
520    * Replace an accelerator key's action with the specified action.
521    * 
522    * @param ks
523    */
524   protected void overrideKeyBinding(KeyStroke ks, AbstractAction action)
525   {
526     this.getActionMap().put(ks, action);
527     overrideMenuItem(ks, action);
528   }
529
530   /**
531    * Create and link new views (with matching names) in both panes.
532    * <p>
533    * Note this is _not_ multiple tabs, each hosting a split pane view, rather it
534    * is a single split pane with each split holding multiple tabs which are
535    * linked in pairs.
536    * <p>
537    * TODO implement instead with a tabbed holder in the SplitView, each tab
538    * holding a single JSplitPane. Would avoid a duplicated tab, at the cost of
539    * some additional coding.
540    */
541   protected void newView_actionPerformed()
542   {
543     AlignFrame topFrame = (AlignFrame) getTopFrame();
544     AlignFrame bottomFrame = (AlignFrame) getBottomFrame();
545     final boolean scaleProteinAsCdna = topFrame.viewport
546             .isScaleProteinAsCdna();
547
548     AlignmentPanel newTopPanel = topFrame.newView(null, true);
549     AlignmentPanel newBottomPanel = bottomFrame.newView(null, true);
550
551     /*
552      * This currently (for the first new view only) leaves the top pane on tab 0
553      * but the bottom on tab 1. This results from 'setInitialTabVisible' echoing
554      * from the bottom back to the first frame. Next line is a fudge to work
555      * around this. TODO find a better way.
556      */
557     if (topFrame.getTabIndex() != bottomFrame.getTabIndex())
558     {
559       topFrame.setDisplayedView(newTopPanel);
560     }
561
562     newBottomPanel.av.setViewName(newTopPanel.av.getViewName());
563     newTopPanel.av.setCodingComplement(newBottomPanel.av);
564
565     /*
566      * These lines can be removed once scaleProteinAsCdna is added to element
567      * Viewport in jalview.xsd, as Jalview2XML.copyAlignPanel will then take
568      * care of it
569      */
570     newTopPanel.av.setScaleProteinAsCdna(scaleProteinAsCdna);
571     newBottomPanel.av.setScaleProteinAsCdna(scaleProteinAsCdna);
572
573     /*
574      * Line up id labels etc
575      */
576     adjustLayout();
577
578     final StructureSelectionManager ssm = StructureSelectionManager
579             .getStructureSelectionManager(Desktop.instance);
580     ssm.addCommandListener(newTopPanel.av);
581     ssm.addCommandListener(newBottomPanel.av);
582   }
583
584   /**
585    * Close the currently selected view in both panes. If there is only one view,
586    * close this split frame.
587    */
588   protected void closeView_actionPerformed()
589   {
590     int viewCount = ((AlignFrame) getTopFrame()).getAlignPanels().size();
591     if (viewCount < 2)
592     {
593       close();
594       return;
595     }
596
597     AlignmentPanel topPanel = ((AlignFrame) getTopFrame()).alignPanel;
598     AlignmentPanel bottomPanel = ((AlignFrame) getBottomFrame()).alignPanel;
599
600     ((AlignFrame) getTopFrame()).closeView(topPanel);
601     ((AlignFrame) getBottomFrame()).closeView(bottomPanel);
602
603   }
604
605   /**
606    * Close child frames and this split frame.
607    */
608   public void close()
609   {
610     ((AlignFrame) getTopFrame()).closeMenuItem_actionPerformed(true);
611     ((AlignFrame) getBottomFrame()).closeMenuItem_actionPerformed(true);
612     try
613     {
614       this.setClosed(true);
615     } catch (PropertyVetoException e)
616     {
617       // ignore
618     }
619   }
620
621   /**
622    * Replace AlignFrame 'expand views' action with SplitFrame version.
623    */
624   protected void overrideExpandViews()
625   {
626     KeyStroke key_X = KeyStroke.getKeyStroke(KeyEvent.VK_X, 0, false);
627     AbstractAction action = new AbstractAction()
628     {
629       @Override
630       public void actionPerformed(ActionEvent e)
631       {
632         expandViews_actionPerformed();
633       }
634     };
635     overrideMenuItem(key_X, action);
636   }
637
638   /**
639    * Replace AlignFrame 'gather views' action with SplitFrame version.
640    */
641   protected void overrideGatherViews()
642   {
643     KeyStroke key_G = KeyStroke.getKeyStroke(KeyEvent.VK_G, 0, false);
644     AbstractAction action = new AbstractAction()
645     {
646       @Override
647       public void actionPerformed(ActionEvent e)
648       {
649         gatherViews_actionPerformed();
650       }
651     };
652     overrideMenuItem(key_G, action);
653   }
654
655   /**
656    * Override the menu action associated with the keystroke in the child frames,
657    * replacing it with the given action.
658    * 
659    * @param ks
660    * @param action
661    */
662   private void overrideMenuItem(KeyStroke ks, AbstractAction action)
663   {
664     overrideMenuItem(ks, action, getTopFrame());
665     overrideMenuItem(ks, action, getBottomFrame());
666   }
667
668   /**
669    * Override the menu action associated with the keystroke in one child frame,
670    * replacing it with the given action. Mwahahahaha.
671    * 
672    * @param key
673    * @param action
674    * @param comp
675    */
676   private void overrideMenuItem(KeyStroke key, final AbstractAction action,
677           JComponent comp)
678   {
679     if (comp instanceof AlignFrame)
680     {
681       JMenuItem mi = ((AlignFrame) comp).getAccelerators().get(key);
682       if (mi != null)
683       {
684         for (ActionListener al : mi.getActionListeners())
685         {
686           mi.removeActionListener(al);
687         }
688         mi.addActionListener(new ActionListener()
689         {
690           @Override
691           public void actionPerformed(ActionEvent e)
692           {
693             action.actionPerformed(e);
694           }
695         });
696       }
697     }
698   }
699
700   /**
701    * Expand any multiple views (which are always in pairs) into separate split
702    * frames.
703    */
704   protected void expandViews_actionPerformed()
705   {
706     Desktop.instance.explodeViews(this);
707   }
708
709   /**
710    * Gather any other SplitFrame views of this alignment back in as multiple
711    * (pairs of) views in this SplitFrame.
712    */
713   protected void gatherViews_actionPerformed()
714   {
715     Desktop.instance.gatherViews(this);
716   }
717
718   /**
719    * Returns the alignment in the complementary frame to the one given.
720    */
721   @Override
722   public AlignmentI getComplement(Object alignFrame)
723   {
724     if (alignFrame == this.getTopFrame())
725     {
726       return ((AlignFrame) getBottomFrame()).viewport.getAlignment();
727     }
728     else if (alignFrame == this.getBottomFrame())
729     {
730       return ((AlignFrame) getTopFrame()).viewport.getAlignment();
731     }
732     return null;
733   }
734
735   /**
736    * Returns the title of the complementary frame to the one given.
737    */
738   @Override
739   public String getComplementTitle(Object alignFrame)
740   {
741     if (alignFrame == this.getTopFrame())
742     {
743       return ((AlignFrame) getBottomFrame()).getTitle();
744     }
745     else if (alignFrame == this.getBottomFrame())
746     {
747       return ((AlignFrame) getTopFrame()).getTitle();
748     }
749     return null;
750   }
751
752   /**
753    * Set the 'other half' to hidden / revealed.
754    */
755   @Override
756   public void setComplementVisible(Object alignFrame, boolean show)
757   {
758     /*
759      * Hiding the AlignPanel suppresses unnecessary repaints
760      */
761     if (alignFrame == getTopFrame())
762     {
763       ((AlignFrame) getBottomFrame()).alignPanel.setVisible(show);
764     }
765     else if (alignFrame == getBottomFrame())
766     {
767       ((AlignFrame) getTopFrame()).alignPanel.setVisible(show);
768     }
769     super.setComplementVisible(alignFrame, show);
770   }
771
772   /**
773    * return the AlignFrames held by this container
774    * 
775    * @return { Top alignFrame (Usually CDS), Bottom AlignFrame (Usually
776    *         Protein)}
777    */
778   public List<AlignFrame> getAlignFrames()
779   {
780     return Arrays
781             .asList(new AlignFrame[]
782             { (AlignFrame) getTopFrame(), (AlignFrame) getBottomFrame() });
783   }
784
785   @Override
786   public AlignFrame getComplementAlignFrame(
787           AlignViewControllerGuiI alignFrame)
788   {
789     if (getTopFrame() == alignFrame)
790     {
791       return (AlignFrame) getBottomFrame();
792     }
793     if (getBottomFrame() == alignFrame)
794     {
795       return (AlignFrame) getTopFrame();
796     }
797     // we didn't know anything about this frame...
798     return null;
799   }
800
801   /**
802    * Replace Cmd-F Find action with our version. This is necessary because the
803    * 'default' Finder searches in the first AlignFrame it finds. We need it to
804    * search in the half of the SplitFrame that has the mouse.
805    */
806   protected void overrideFind()
807   {
808     /*
809      * Ctrl-F / Cmd-F open Finder dialog, 'focused' on the right alignment
810      */
811     KeyStroke key_cmdF = KeyStroke.getKeyStroke(KeyEvent.VK_F,
812             jalview.util.ShortcutKeyMaskExWrapper
813                     .getMenuShortcutKeyMaskEx(),
814             false);
815     AbstractAction action = new AbstractAction()
816     {
817       @Override
818       public void actionPerformed(ActionEvent e)
819       {
820         Component c = getFrameAtMouse();
821         if (c != null && c instanceof AlignFrame)
822         {
823           AlignFrame af = (AlignFrame) c;
824           boolean dna = af.getViewport().getAlignment().isNucleotide();
825           String scope = MessageManager.getString("label.in") + " "
826                   + (dna ? MessageManager.getString("label.nucleotide")
827                           : MessageManager.getString("label.protein"));
828           new Finder(af.alignPanel, true, scope);
829         }
830       }
831     };
832     overrideKeyBinding(key_cmdF, action);
833   }
834
835   /**
836    * Override to do nothing if triggered from one of the child frames
837    */
838   @Override
839   public void setSelected(boolean selected) throws PropertyVetoException
840   {
841     JDesktopPane desktopPane = getDesktopPane();
842     JInternalFrame fr = desktopPane == null ? null
843             : desktopPane.getSelectedFrame();
844     if (fr == getTopFrame() || fr == getBottomFrame())
845     {
846       /* 
847        * patch for JAL-3288 (deselecting top/bottom frame closes popup menu); 
848        * it may be possible to remove this method in future
849        * if the underlying Java behaviour changes
850        */
851       if (selected)
852       {
853         moveToFront();
854       }
855       return;
856     }
857     super.setSelected(selected);
858   }
859
860   /**
861    * holds the frame for feature settings, so Protein and DNA tabs can be
862    * managed
863    */
864   JInternalFrame featureSettingsUI;
865
866   JTabbedPane featureSettingsPanels;
867
868   @Override
869   public void addFeatureSettingsUI(
870           FeatureSettingsControllerGuiI featureSettings)
871   {
872     boolean showInternalFrame = false;
873     if (featureSettingsUI == null || featureSettingsPanels == null)
874     {
875       showInternalFrame = true;
876       featureSettingsPanels = new JTabbedPane();
877       featureSettingsPanels.addChangeListener(new ChangeListener()
878       {
879
880         @Override
881         public void stateChanged(ChangeEvent e)
882         {
883           if (e.getSource() != featureSettingsPanels
884                   || featureSettingsUI == null
885                   || featureSettingsUI.isClosed()
886                   || !featureSettingsUI.isVisible())
887           {
888             // not our tabbed pane
889             return;
890           }
891           int tab = featureSettingsPanels.getSelectedIndex();
892           if (tab < 0 || featureSettingsPanels
893                   .getSelectedComponent() instanceof FeatureSettingsControllerGuiI)
894           {
895             // no tab selected or already showing a feature settings GUI
896             return;
897           }
898           getAlignFrames().get(tab).showFeatureSettingsUI();
899         }
900       });
901       featureSettingsUI = new JInternalFrame(MessageManager.getString(
902               "label.sequence_feature_settings_for_CDS_and_Protein"));
903       featureSettingsUI.setFrameIcon(null);
904       featureSettingsPanels.setOpaque(true);
905
906       JPanel dialog = new JPanel();
907       dialog.setOpaque(true);
908       dialog.setLayout(new BorderLayout());
909       dialog.add(featureSettingsPanels, BorderLayout.CENTER);
910       JPanel buttons = new JPanel();
911       JButton ok = new JButton(MessageManager.getString("action.ok"));
912       ok.addActionListener(new ActionListener()
913       {
914
915         @Override
916         public void actionPerformed(ActionEvent e)
917         {
918           try
919           {
920             featureSettingsUI.setClosed(true);
921           } catch (PropertyVetoException pv)
922           {
923             pv.printStackTrace();
924           }
925         }
926       });
927       JButton cancel = new JButton(
928               MessageManager.getString("action.cancel"));
929       cancel.addActionListener(new ActionListener()
930       {
931
932         @Override
933         public void actionPerformed(ActionEvent e)
934         {
935           try
936           {
937             for (Component fspanel : featureSettingsPanels.getComponents())
938             {
939               if (fspanel instanceof FeatureSettingsControllerGuiI)
940               {
941                 ((FeatureSettingsControllerGuiI) fspanel).revert();
942               }
943             }
944             featureSettingsUI.setClosed(true);
945           } catch (Exception pv)
946           {
947             pv.printStackTrace();
948           }
949         }
950       });
951       buttons.add(ok);
952       buttons.add(cancel);
953       dialog.add(buttons, BorderLayout.SOUTH);
954       featureSettingsUI.setContentPane(dialog);
955       createDummyTabs();
956     }
957     if (featureSettingsPanels
958             .indexOfTabComponent((Component) featureSettings) > -1)
959     {
960       // just show the feature settings !
961       featureSettingsPanels
962               .setSelectedComponent((Component) featureSettings);
963       return;
964     }
965     // otherwise replace the dummy tab with the given feature settings
966     int pos = getAlignFrames().indexOf(featureSettings.getAlignframe());
967     // if pos==-1 then alignFrame isn't managed by this splitframe
968     if (pos == 0)
969     {
970       featureSettingsPanels.removeTabAt(0);
971       featureSettingsPanels.insertTab(tabName[0], null,
972               (Component) featureSettings,
973               MessageManager.formatMessage(
974                       "label.sequence_feature_settings_for", tabName[0]),
975               0);
976     }
977     if (pos == 1)
978     {
979       featureSettingsPanels.removeTabAt(1);
980       featureSettingsPanels.insertTab(tabName[1], null,
981               (Component) featureSettings,
982               MessageManager.formatMessage(
983                       "label.sequence_feature_settings_for", tabName[1]),
984               1);
985     }
986     featureSettingsPanels.setSelectedComponent((Component) featureSettings);
987
988     // TODO: JAL-3535 - construct a feature settings title including names of
989     // currently selected CDS and Protein names
990
991     if (showInternalFrame)
992     {
993       if (Platform.isAMacAndNotJS())
994       {
995         Desktop.addInternalFrame(featureSettingsUI,
996                 MessageManager.getString(
997                         "label.sequence_feature_settings_for_CDS_and_Protein"),
998                 600, 480);
999       }
1000       else
1001       {
1002         Desktop.addInternalFrame(featureSettingsUI,
1003                 MessageManager.getString(
1004                         "label.sequence_feature_settings_for_CDS_and_Protein"),
1005                 600, 450);
1006       }
1007       featureSettingsUI
1008               .setMinimumSize(new Dimension(FS_MIN_WIDTH, FS_MIN_HEIGHT));
1009
1010       featureSettingsUI.addInternalFrameListener(
1011               new javax.swing.event.InternalFrameAdapter()
1012               {
1013                 @Override
1014                 public void internalFrameClosed(
1015                         javax.swing.event.InternalFrameEvent evt)
1016                 {
1017                   for (int tab = 0; tab < featureSettingsPanels
1018                           .getTabCount();)
1019                   {
1020                     FeatureSettingsControllerGuiI fsettings = (FeatureSettingsControllerGuiI) featureSettingsPanels
1021                             .getTabComponentAt(tab);
1022                     if (fsettings != null)
1023                     {
1024                       featureSettingsPanels.removeTabAt(tab);
1025                       fsettings.featureSettings_isClosed();
1026                     }
1027                     else
1028                     {
1029                       tab++;
1030                     }
1031                   }
1032                   featureSettingsPanels = null;
1033                   featureSettingsUI = null;
1034                 };
1035               });
1036       featureSettingsUI.setLayer(JLayeredPane.PALETTE_LAYER);
1037     }
1038   }
1039
1040   /**
1041    * tab names for feature settings
1042    */
1043   private String[] tabName = new String[] {
1044       MessageManager.getString("label.CDS"),
1045       MessageManager.getString("label.protein") };
1046
1047   /**
1048    * create placeholder tabs which materialise the feature settings for a given
1049    * view. Also reinitialises any tabs containing stale feature settings
1050    */
1051   private void createDummyTabs()
1052   {
1053     for (int tabIndex = 0; tabIndex < 2; tabIndex++)
1054     {
1055       JPanel dummyTab = new JPanel();
1056       featureSettingsPanels.addTab(tabName[tabIndex], dummyTab);
1057     }
1058   }
1059
1060   private void replaceWithDummyTab(FeatureSettingsControllerI toClose)
1061   {
1062     Component dummyTab = null;
1063     for (int tabIndex = 0; tabIndex < 2; tabIndex++)
1064     {
1065       if (featureSettingsPanels.getTabCount() > tabIndex)
1066       {
1067         dummyTab = featureSettingsPanels.getTabComponentAt(tabIndex);
1068         if (dummyTab instanceof FeatureSettingsControllerGuiI
1069                 && !dummyTab.isVisible())
1070         {
1071           featureSettingsPanels.removeTabAt(tabIndex);
1072           // close the feature Settings tab
1073           ((FeatureSettingsControllerGuiI) dummyTab)
1074                   .featureSettings_isClosed();
1075           // create a dummy tab in its place
1076           dummyTab = new JPanel();
1077           featureSettingsPanels.insertTab(tabName[tabIndex], null, dummyTab,
1078                   MessageManager.formatMessage(
1079                           "label.sequence_feature_settings_for",
1080                           tabName[tabIndex]),
1081                   tabIndex);
1082         }
1083       }
1084     }
1085   }
1086
1087   @Override
1088   public void closeFeatureSettings(
1089           FeatureSettingsControllerI featureSettings,
1090           boolean closeContainingFrame)
1091   {
1092     if (featureSettingsUI != null)
1093     {
1094       if (closeContainingFrame)
1095       {
1096         try
1097         {
1098           featureSettingsUI.setClosed(true);
1099         } catch (Exception x)
1100         {
1101         }
1102         featureSettingsUI = null;
1103       }
1104       else
1105       {
1106         replaceWithDummyTab(featureSettings);
1107       }
1108     }
1109   }
1110
1111   @Override
1112   public boolean isFeatureSettingsOpen()
1113   {
1114     return featureSettingsUI != null && !featureSettingsUI.isClosed();
1115   }
1116 }