2 * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
3 * Copyright (C) $$Year-Rel$$ The Jalview Authors
5 * This file is part of Jalview.
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.
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.
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.
23 import jalview.api.SplitContainerI;
24 import jalview.api.ViewStyleI;
25 import jalview.datamodel.AlignmentI;
26 import jalview.jbgui.GAlignFrame;
27 import jalview.jbgui.GSplitFrame;
28 import jalview.structure.StructureSelectionManager;
29 import jalview.util.Platform;
30 import jalview.viewmodel.AlignmentViewport;
32 import java.awt.Component;
33 import java.awt.Toolkit;
34 import java.awt.event.ActionEvent;
35 import java.awt.event.ActionListener;
36 import java.awt.event.KeyAdapter;
37 import java.awt.event.KeyEvent;
38 import java.awt.event.KeyListener;
39 import java.beans.PropertyVetoException;
40 import java.util.Arrays;
41 import java.util.List;
42 import java.util.Map.Entry;
44 import javax.swing.AbstractAction;
45 import javax.swing.InputMap;
46 import javax.swing.JComponent;
47 import javax.swing.JMenuItem;
48 import javax.swing.KeyStroke;
49 import javax.swing.event.InternalFrameAdapter;
50 import javax.swing.event.InternalFrameEvent;
53 * An internal frame on the desktop that hosts a horizontally split view of
54 * linked DNA and Protein alignments. Additional views can be created in linked
55 * pairs, expanded to separate split frames, or regathered into a single frame.
57 * (Some) operations on each alignment are automatically mirrored on the other.
58 * These include mouseover (highlighting), sequence and column selection,
59 * sequence ordering and sorting, and grouping, colouring and sorting by tree.
64 public class SplitFrame extends GSplitFrame implements SplitContainerI
66 private static final int WINDOWS_INSETS_WIDTH = 28; // tbc
68 private static final int MAC_INSETS_WIDTH = 28;
70 private static final int WINDOWS_INSETS_HEIGHT = 50; // tbc
72 private static final int MAC_INSETS_HEIGHT = 50;
73 private static final int DESKTOP_DECORATORS_HEIGHT = 65;
74 private static final long serialVersionUID = 1L;
76 public SplitFrame(GAlignFrame top, GAlignFrame bottom)
83 * Initialise this frame.
87 getTopFrame().setSplitFrame(this);
88 getBottomFrame().setSplitFrame(this);
89 getTopFrame().setVisible(true);
90 getBottomFrame().setVisible(true);
92 ((AlignFrame) getTopFrame()).getViewport().setCodingComplement(
93 ((AlignFrame) getBottomFrame()).getViewport());
96 * estimate width and height of SplitFrame; this.getInsets() doesn't seem to
97 * give the full additional size (a few pixels short)
99 int widthFudge = Platform.isAMac() ? MAC_INSETS_WIDTH
100 : WINDOWS_INSETS_WIDTH;
101 int heightFudge = Platform.isAMac() ? MAC_INSETS_HEIGHT
102 : WINDOWS_INSETS_HEIGHT;
103 int width = ((AlignFrame) getTopFrame()).getWidth() + widthFudge;
104 int height = ((AlignFrame) getTopFrame()).getHeight()
105 + ((AlignFrame) getBottomFrame()).getHeight() + DIVIDER_SIZE
107 height = fitHeightToDesktop(height);
108 setSize(width, height);
112 addCloseFrameListener();
118 addCommandListeners();
122 * Reduce the height if too large to fit in the Desktop. Also adjust the
123 * divider location in proportion.
127 * @return original or reduced height
129 public int fitHeightToDesktop(int height)
131 // allow about 65 pixels for Desktop decorators on Windows
133 int newHeight = Math.min(height, Desktop.instance.getHeight()
134 - DESKTOP_DECORATORS_HEIGHT);
135 if (newHeight != height)
137 int oldDividerLocation = getDividerLocation();
138 setDividerLocation(oldDividerLocation * newHeight / height);
144 * Set the top and bottom frames to listen to each others Commands (e.g. Edit,
147 protected void addCommandListeners()
149 // TODO if CommandListener is only ever 1:1 for complementary views,
150 // may change broadcast pattern to direct messaging (more efficient)
151 final StructureSelectionManager ssm = StructureSelectionManager
152 .getStructureSelectionManager(Desktop.instance);
153 ssm.addCommandListener(((AlignFrame) getTopFrame()).getViewport());
154 ssm.addCommandListener(((AlignFrame) getBottomFrame()).getViewport());
158 * Do any tweaking and twerking of the layout wanted.
160 public void adjustLayout()
163 * Ensure sequence ids are the same width so sequences line up
165 int w1 = ((AlignFrame) getTopFrame()).getViewport().getIdWidth();
166 int w2 = ((AlignFrame) getBottomFrame()).getViewport().getIdWidth();
167 int w3 = Math.max(w1, w2);
170 ((AlignFrame) getTopFrame()).getViewport().setIdWidth(w3);
174 ((AlignFrame) getBottomFrame()).getViewport().setIdWidth(w3);
178 * Scale protein to either 1 or 3 times character width of dna
180 final AlignViewport topViewport = ((AlignFrame) getTopFrame()).viewport;
181 final AlignViewport bottomViewport = ((AlignFrame) getBottomFrame()).viewport;
182 final AlignmentI topAlignment = topViewport.getAlignment();
183 final AlignmentI bottomAlignment = bottomViewport.getAlignment();
184 AlignmentViewport cdna = topAlignment.isNucleotide() ? topViewport
185 : (bottomAlignment.isNucleotide() ? bottomViewport : null);
186 AlignmentViewport protein = !topAlignment.isNucleotide() ? topViewport
187 : (!bottomAlignment.isNucleotide() ? bottomViewport : null);
188 if (protein != null && cdna != null)
190 ViewStyleI vs = protein.getViewStyle();
191 int scale = vs.isScaleProteinAsCdna() ? 3 : 1;
192 vs.setCharWidth(scale * cdna.getViewStyle().getCharWidth());
193 protein.setViewStyle(vs);
198 * Adjust the divider for a sensible split of the real estate (for example,
199 * when many transcripts are shown with a single protein). This should only be
200 * called after the split pane has been laid out (made visible) so it has a
203 protected void adjustDivider()
205 final AlignViewport topViewport = ((AlignFrame) getTopFrame()).viewport;
206 final AlignViewport bottomViewport = ((AlignFrame) getBottomFrame()).viewport;
207 final AlignmentI topAlignment = topViewport.getAlignment();
208 final AlignmentI bottomAlignment = bottomViewport.getAlignment();
209 boolean topAnnotations = topViewport.isShowAnnotation();
210 boolean bottomAnnotations = bottomViewport.isShowAnnotation();
211 // TODO need number of visible sequences here, not #sequences - how?
212 int topCount = topAlignment.getHeight();
213 int bottomCount = bottomAlignment.getHeight();
214 int topCharHeight = topViewport.getViewStyle().getCharHeight();
215 int bottomCharHeight = bottomViewport.getViewStyle().getCharHeight();
218 * estimate ratio of (topFrameContent / bottomFrameContent)
220 int insets = Platform.isAMac() ? MAC_INSETS_HEIGHT
221 : WINDOWS_INSETS_HEIGHT;
222 // allow 3 'rows' for scale, scrollbar, status bar
223 int topHeight = insets + (3 + topCount) * topCharHeight
224 + (topAnnotations ? topViewport.calcPanelHeight() : 0);
225 int bottomHeight = insets + (3 + bottomCount) * bottomCharHeight
226 + (bottomAnnotations ? bottomViewport.calcPanelHeight() : 0);
227 double ratio = ((double) topHeight) / (topHeight + bottomHeight);
230 * limit to 0.2 <= ratio <= 0.8 to avoid concealing all sequences
232 ratio = Math.min(ratio, 0.8d);
233 ratio = Math.max(ratio, 0.2d);
234 setRelativeDividerLocation(ratio);
238 * Add a listener to tidy up when the frame is closed.
240 protected void addCloseFrameListener()
242 addInternalFrameListener(new InternalFrameAdapter()
245 public void internalFrameClosed(InternalFrameEvent evt)
253 * Add a key listener that delegates to whichever split component the mouse is
254 * in (or does nothing if neither).
256 protected void addKeyListener()
258 addKeyListener(new KeyAdapter()
262 public void keyPressed(KeyEvent e)
264 AlignFrame af = (AlignFrame) getFrameAtMouse();
267 * Intercept and override any keys here if wanted.
269 if (!overrideKey(e, af))
273 for (KeyListener kl : af.getKeyListeners())
282 public void keyReleased(KeyEvent e)
284 Component c = getFrameAtMouse();
287 for (KeyListener kl : c.getKeyListeners())
298 * Returns true if the key event is overriden and actioned (or ignored) here,
299 * else returns false, indicating it should be delegated to the AlignFrame's
302 * We can't handle Cmd-Key combinations here, instead this is done by
303 * overriding key bindings.
305 * @see addKeyOverrides
310 protected boolean overrideKey(KeyEvent e, AlignFrame af)
312 boolean actioned = false;
313 int keyCode = e.getKeyCode();
316 case KeyEvent.VK_DOWN:
317 if (e.isAltDown() || !af.viewport.cursorMode)
320 * Key down (or Alt-key-down in cursor mode) - move selected sequences
322 ((AlignFrame) getTopFrame()).moveSelectedSequences(false);
323 ((AlignFrame) getBottomFrame()).moveSelectedSequences(false);
329 if (e.isAltDown() || !af.viewport.cursorMode)
332 * Key up (or Alt-key-up in cursor mode) - move selected sequences
334 ((AlignFrame) getTopFrame()).moveSelectedSequences(true);
335 ((AlignFrame) getBottomFrame()).moveSelectedSequences(true);
346 * Set key bindings (recommended for Swing over key accelerators).
348 private void addKeyBindings()
350 overrideDelegatedKeyBindings();
352 overrideImplementedKeyBindings();
356 * Override key bindings with alternative action methods implemented in this
359 protected void overrideImplementedKeyBindings()
364 overrideExpandViews();
365 overrideGatherViews();
369 * Replace Cmd-W close view action with our version.
371 protected void overrideCloseView()
373 AbstractAction action;
375 * Ctrl-W / Cmd-W - close view or window
377 KeyStroke key_cmdW = KeyStroke.getKeyStroke(KeyEvent.VK_W, Toolkit
378 .getDefaultToolkit().getMenuShortcutKeyMask(), false);
379 action = new AbstractAction()
382 public void actionPerformed(ActionEvent e)
384 closeView_actionPerformed();
387 overrideKeyBinding(key_cmdW, action);
391 * Replace Cmd-T new view action with our version.
393 protected void overrideNewView()
396 * Ctrl-T / Cmd-T open new view
398 KeyStroke key_cmdT = KeyStroke.getKeyStroke(KeyEvent.VK_T, Toolkit
399 .getDefaultToolkit().getMenuShortcutKeyMask(), false);
400 AbstractAction action = new AbstractAction()
403 public void actionPerformed(ActionEvent e)
405 newView_actionPerformed();
408 overrideKeyBinding(key_cmdT, action);
412 * For now, delegates key events to the corresponding key accelerator for the
413 * AlignFrame that the mouse is in. Hopefully can be simplified in future if
414 * AlignFrame is changed to use key bindings rather than accelerators.
416 protected void overrideDelegatedKeyBindings()
418 if (getTopFrame() instanceof AlignFrame)
421 * Get all accelerator keys in the top frame (the bottom should be
422 * identical) and override each one.
424 for (Entry<KeyStroke, JMenuItem> acc : ((AlignFrame) getTopFrame())
425 .getAccelerators().entrySet())
427 overrideKeyBinding(acc);
433 * Overrides an AlignFrame key accelerator with our version which delegates to
434 * the action listener in whichever frame has the mouse (and does nothing if
439 private void overrideKeyBinding(Entry<KeyStroke, JMenuItem> acc)
441 final KeyStroke ks = acc.getKey();
442 InputMap inputMap = this.getInputMap(JComponent.WHEN_FOCUSED);
443 inputMap.put(ks, ks);
444 this.getActionMap().put(ks, new AbstractAction()
447 public void actionPerformed(ActionEvent e)
449 Component c = getFrameAtMouse();
450 if (c != null && c instanceof AlignFrame)
452 for (ActionListener a : ((AlignFrame) c).getAccelerators()
453 .get(ks).getActionListeners())
455 a.actionPerformed(null);
463 * Replace an accelerator key's action with the specified action.
467 protected void overrideKeyBinding(KeyStroke ks, AbstractAction action)
469 this.getActionMap().put(ks, action);
470 overrideMenuItem(ks, action);
474 * Create and link new views (with matching names) in both panes.
476 * Note this is _not_ multiple tabs, each hosting a split pane view, rather it
477 * is a single split pane with each split holding multiple tabs which are
480 * TODO implement instead with a tabbed holder in the SplitView, each tab
481 * holding a single JSplitPane. Would avoid a duplicated tab, at the cost of
482 * some additional coding.
484 protected void newView_actionPerformed()
486 AlignFrame topFrame = (AlignFrame) getTopFrame();
487 AlignFrame bottomFrame = (AlignFrame) getBottomFrame();
488 final boolean scaleProteinAsCdna = topFrame.viewport
489 .isScaleProteinAsCdna();
491 AlignmentPanel newTopPanel = topFrame.newView(null, true);
492 AlignmentPanel newBottomPanel = bottomFrame.newView(null, true);
495 * This currently (for the first new view only) leaves the top pane on tab 0
496 * but the bottom on tab 1. This results from 'setInitialTabVisible' echoing
497 * from the bottom back to the first frame. Next line is a fudge to work
498 * around this. TODO find a better way.
500 if (topFrame.getTabIndex() != bottomFrame.getTabIndex())
502 topFrame.setDisplayedView(newTopPanel);
505 newBottomPanel.av.viewName = newTopPanel.av.viewName;
506 newTopPanel.av.setCodingComplement(newBottomPanel.av);
509 * These lines can be removed once scaleProteinAsCdna is added to element
510 * Viewport in jalview.xsd, as Jalview2XML.copyAlignPanel will then take
513 newTopPanel.av.setScaleProteinAsCdna(scaleProteinAsCdna);
514 newBottomPanel.av.setScaleProteinAsCdna(scaleProteinAsCdna);
517 * Line up id labels etc
521 final StructureSelectionManager ssm = StructureSelectionManager
522 .getStructureSelectionManager(Desktop.instance);
523 ssm.addCommandListener(newTopPanel.av);
524 ssm.addCommandListener(newBottomPanel.av);
528 * Close the currently selected view in both panes. If there is only one view,
529 * close this split frame.
531 protected void closeView_actionPerformed()
533 int viewCount = ((AlignFrame) getTopFrame()).getAlignPanels().size();
540 AlignmentPanel topPanel = ((AlignFrame) getTopFrame()).alignPanel;
541 AlignmentPanel bottomPanel = ((AlignFrame) getBottomFrame()).alignPanel;
543 ((AlignFrame) getTopFrame()).closeView(topPanel);
544 ((AlignFrame) getBottomFrame()).closeView(bottomPanel);
549 * Close child frames and this split frame.
553 ((AlignFrame) getTopFrame()).closeMenuItem_actionPerformed(true);
554 ((AlignFrame) getBottomFrame()).closeMenuItem_actionPerformed(true);
557 this.setClosed(true);
558 } catch (PropertyVetoException e)
565 * Replace AlignFrame 'expand views' action with SplitFrame version.
567 protected void overrideExpandViews()
569 KeyStroke key_X = KeyStroke.getKeyStroke(KeyEvent.VK_X, 0, false);
570 AbstractAction action = new AbstractAction()
573 public void actionPerformed(ActionEvent e)
575 expandViews_actionPerformed();
578 overrideMenuItem(key_X, action);
582 * Replace AlignFrame 'gather views' action with SplitFrame version.
584 protected void overrideGatherViews()
586 KeyStroke key_G = KeyStroke.getKeyStroke(KeyEvent.VK_G, 0, false);
587 AbstractAction action = new AbstractAction()
590 public void actionPerformed(ActionEvent e)
592 gatherViews_actionPerformed();
595 overrideMenuItem(key_G, action);
599 * Override the menu action associated with the keystroke in the child frames,
600 * replacing it with the given action.
605 private void overrideMenuItem(KeyStroke ks, AbstractAction action)
607 overrideMenuItem(ks, action, getTopFrame());
608 overrideMenuItem(ks, action, getBottomFrame());
612 * Override the menu action associated with the keystroke in one child frame,
613 * replacing it with the given action. Mwahahahaha.
619 private void overrideMenuItem(KeyStroke key, final AbstractAction action,
622 if (comp instanceof AlignFrame)
624 JMenuItem mi = ((AlignFrame) comp).getAccelerators().get(key);
627 for (ActionListener al : mi.getActionListeners())
629 mi.removeActionListener(al);
631 mi.addActionListener(new ActionListener()
634 public void actionPerformed(ActionEvent e)
636 action.actionPerformed(e);
644 * Expand any multiple views (which are always in pairs) into separate split
647 protected void expandViews_actionPerformed()
649 Desktop.instance.explodeViews(this);
653 * Gather any other SplitFrame views of this alignment back in as multiple
654 * (pairs of) views in this SplitFrame.
656 protected void gatherViews_actionPerformed()
658 Desktop.instance.gatherViews(this);
662 * Returns the alignment in the complementary frame to the one given.
665 public AlignmentI getComplement(Object alignFrame)
667 if (alignFrame == this.getTopFrame())
669 return ((AlignFrame) getBottomFrame()).viewport.getAlignment();
671 else if (alignFrame == this.getBottomFrame())
673 return ((AlignFrame) getTopFrame()).viewport.getAlignment();
679 * Returns the title of the complementary frame to the one given.
682 public String getComplementTitle(Object alignFrame)
684 if (alignFrame == this.getTopFrame())
686 return ((AlignFrame) getBottomFrame()).getTitle();
688 else if (alignFrame == this.getBottomFrame())
690 return ((AlignFrame) getTopFrame()).getTitle();
696 * Set the 'other half' to hidden / revealed.
699 public void setComplementVisible(Object alignFrame, boolean show)
702 * Hiding the AlignPanel suppresses unnecessary repaints
704 if (alignFrame == getTopFrame())
706 ((AlignFrame) getBottomFrame()).alignPanel.setVisible(show);
708 else if (alignFrame == getBottomFrame())
710 ((AlignFrame) getTopFrame()).alignPanel.setVisible(show);
712 super.setComplementVisible(alignFrame, show);
716 * return the AlignFrames held by this container
718 * @return { Top alignFrame (Usually CDS), Bottom AlignFrame (Usually
721 public List<AlignFrame> getAlignFrames()
723 return Arrays.asList(new AlignFrame[] { (AlignFrame) getTopFrame(),
724 (AlignFrame) getBottomFrame() });
727 * Replace Cmd-F Find action with our version. This is necessary because the
728 * 'default' Finder searches in the first AlignFrame it finds. We need it to
729 * search in the half of the SplitFrame that has the mouse.
731 protected void overrideFind()
734 * Ctrl-F / Cmd-F open Finder dialog, 'focused' on the right alignment
736 KeyStroke key_cmdF = KeyStroke.getKeyStroke(KeyEvent.VK_F, Toolkit
737 .getDefaultToolkit().getMenuShortcutKeyMask(), false);
738 AbstractAction action = new AbstractAction()
741 public void actionPerformed(ActionEvent e)
743 Component c = getFrameAtMouse();
744 if (c != null && c instanceof AlignFrame)
746 AlignFrame af = (AlignFrame) c;
747 new Finder(af.viewport, af.alignPanel);
751 overrideKeyBinding(key_cmdF, action);