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;
74 private static final int DESKTOP_DECORATORS_HEIGHT = 65;
76 private static final long serialVersionUID = 1L;
78 public SplitFrame(GAlignFrame top, GAlignFrame bottom)
85 * Initialise this frame.
89 getTopFrame().setSplitFrame(this);
90 getBottomFrame().setSplitFrame(this);
91 getTopFrame().setVisible(true);
92 getBottomFrame().setVisible(true);
94 ((AlignFrame) getTopFrame()).getViewport().setCodingComplement(
95 ((AlignFrame) getBottomFrame()).getViewport());
98 * estimate width and height of SplitFrame; this.getInsets() doesn't seem to
99 * give the full additional size (a few pixels short)
101 int widthFudge = Platform.isAMac() ? MAC_INSETS_WIDTH
102 : WINDOWS_INSETS_WIDTH;
103 int heightFudge = Platform.isAMac() ? MAC_INSETS_HEIGHT
104 : WINDOWS_INSETS_HEIGHT;
105 int width = ((AlignFrame) getTopFrame()).getWidth() + widthFudge;
106 int height = ((AlignFrame) getTopFrame()).getHeight()
107 + ((AlignFrame) getBottomFrame()).getHeight() + DIVIDER_SIZE
109 height = fitHeightToDesktop(height);
110 setSize(width, height);
114 addCloseFrameListener();
120 addCommandListeners();
124 * Reduce the height if too large to fit in the Desktop. Also adjust the
125 * divider location in proportion.
129 * @return original or reduced height
131 public int fitHeightToDesktop(int height)
133 // allow about 65 pixels for Desktop decorators on Windows
135 int newHeight = Math.min(height, Desktop.instance.getHeight()
136 - DESKTOP_DECORATORS_HEIGHT);
137 if (newHeight != height)
139 int oldDividerLocation = getDividerLocation();
140 setDividerLocation(oldDividerLocation * newHeight / height);
146 * Set the top and bottom frames to listen to each others Commands (e.g. Edit,
149 protected void addCommandListeners()
151 // TODO if CommandListener is only ever 1:1 for complementary views,
152 // may change broadcast pattern to direct messaging (more efficient)
153 final StructureSelectionManager ssm = StructureSelectionManager
154 .getStructureSelectionManager(Desktop.instance);
155 ssm.addCommandListener(((AlignFrame) getTopFrame()).getViewport());
156 ssm.addCommandListener(((AlignFrame) getBottomFrame()).getViewport());
160 * Do any tweaking and twerking of the layout wanted.
162 public void adjustLayout()
165 * Ensure sequence ids are the same width so sequences line up
167 int w1 = ((AlignFrame) getTopFrame()).getViewport().getIdWidth();
168 int w2 = ((AlignFrame) getBottomFrame()).getViewport().getIdWidth();
169 int w3 = Math.max(w1, w2);
172 ((AlignFrame) getTopFrame()).getViewport().setIdWidth(w3);
176 ((AlignFrame) getBottomFrame()).getViewport().setIdWidth(w3);
180 * Scale protein to either 1 or 3 times character width of dna
182 final AlignViewport topViewport = ((AlignFrame) getTopFrame()).viewport;
183 final AlignViewport bottomViewport = ((AlignFrame) getBottomFrame()).viewport;
184 final AlignmentI topAlignment = topViewport.getAlignment();
185 final AlignmentI bottomAlignment = bottomViewport.getAlignment();
186 AlignmentViewport cdna = topAlignment.isNucleotide() ? topViewport
187 : (bottomAlignment.isNucleotide() ? bottomViewport : null);
188 AlignmentViewport protein = !topAlignment.isNucleotide() ? topViewport
189 : (!bottomAlignment.isNucleotide() ? bottomViewport : null);
190 if (protein != null && cdna != null)
192 ViewStyleI vs = protein.getViewStyle();
193 int scale = vs.isScaleProteinAsCdna() ? 3 : 1;
194 vs.setCharWidth(scale * cdna.getViewStyle().getCharWidth());
195 protein.setViewStyle(vs);
200 * Adjust the divider for a sensible split of the real estate (for example,
201 * when many transcripts are shown with a single protein). This should only be
202 * called after the split pane has been laid out (made visible) so it has a
205 protected void adjustDivider()
207 final AlignViewport topViewport = ((AlignFrame) getTopFrame()).viewport;
208 final AlignViewport bottomViewport = ((AlignFrame) getBottomFrame()).viewport;
209 final AlignmentI topAlignment = topViewport.getAlignment();
210 final AlignmentI bottomAlignment = bottomViewport.getAlignment();
211 boolean topAnnotations = topViewport.isShowAnnotation();
212 boolean bottomAnnotations = bottomViewport.isShowAnnotation();
213 // TODO need number of visible sequences here, not #sequences - how?
214 int topCount = topAlignment.getHeight();
215 int bottomCount = bottomAlignment.getHeight();
216 int topCharHeight = topViewport.getViewStyle().getCharHeight();
217 int bottomCharHeight = bottomViewport.getViewStyle().getCharHeight();
220 * estimate ratio of (topFrameContent / bottomFrameContent)
222 int insets = Platform.isAMac() ? MAC_INSETS_HEIGHT
223 : WINDOWS_INSETS_HEIGHT;
224 // allow 3 'rows' for scale, scrollbar, status bar
225 int topHeight = insets + (3 + topCount) * topCharHeight
226 + (topAnnotations ? topViewport.calcPanelHeight() : 0);
227 int bottomHeight = insets + (3 + bottomCount) * bottomCharHeight
228 + (bottomAnnotations ? bottomViewport.calcPanelHeight() : 0);
229 double ratio = ((double) topHeight) / (topHeight + bottomHeight);
232 * limit to 0.2 <= ratio <= 0.8 to avoid concealing all sequences
234 ratio = Math.min(ratio, 0.8d);
235 ratio = Math.max(ratio, 0.2d);
236 setRelativeDividerLocation(ratio);
240 * Add a listener to tidy up when the frame is closed.
242 protected void addCloseFrameListener()
244 addInternalFrameListener(new InternalFrameAdapter()
247 public void internalFrameClosed(InternalFrameEvent evt)
255 * Add a key listener that delegates to whichever split component the mouse is
256 * in (or does nothing if neither).
258 protected void addKeyListener()
260 addKeyListener(new KeyAdapter()
264 public void keyPressed(KeyEvent e)
266 AlignFrame af = (AlignFrame) getFrameAtMouse();
269 * Intercept and override any keys here if wanted.
271 if (!overrideKey(e, af))
275 for (KeyListener kl : af.getKeyListeners())
284 public void keyReleased(KeyEvent e)
286 Component c = getFrameAtMouse();
289 for (KeyListener kl : c.getKeyListeners())
300 * Returns true if the key event is overriden and actioned (or ignored) here,
301 * else returns false, indicating it should be delegated to the AlignFrame's
304 * We can't handle Cmd-Key combinations here, instead this is done by
305 * overriding key bindings.
307 * @see addKeyOverrides
312 protected boolean overrideKey(KeyEvent e, AlignFrame af)
314 boolean actioned = false;
315 int keyCode = e.getKeyCode();
318 case KeyEvent.VK_DOWN:
319 if (e.isAltDown() || !af.viewport.cursorMode)
322 * Key down (or Alt-key-down in cursor mode) - move selected sequences
324 ((AlignFrame) getTopFrame()).moveSelectedSequences(false);
325 ((AlignFrame) getBottomFrame()).moveSelectedSequences(false);
331 if (e.isAltDown() || !af.viewport.cursorMode)
334 * Key up (or Alt-key-up in cursor mode) - move selected sequences
336 ((AlignFrame) getTopFrame()).moveSelectedSequences(true);
337 ((AlignFrame) getBottomFrame()).moveSelectedSequences(true);
348 * Set key bindings (recommended for Swing over key accelerators).
350 private void addKeyBindings()
352 overrideDelegatedKeyBindings();
354 overrideImplementedKeyBindings();
358 * Override key bindings with alternative action methods implemented in this
361 protected void overrideImplementedKeyBindings()
366 overrideExpandViews();
367 overrideGatherViews();
371 * Replace Cmd-W close view action with our version.
373 protected void overrideCloseView()
375 AbstractAction action;
377 * Ctrl-W / Cmd-W - close view or window
379 KeyStroke key_cmdW = KeyStroke.getKeyStroke(KeyEvent.VK_W, Toolkit
380 .getDefaultToolkit().getMenuShortcutKeyMask(), false);
381 action = new AbstractAction()
384 public void actionPerformed(ActionEvent e)
386 closeView_actionPerformed();
389 overrideKeyBinding(key_cmdW, action);
393 * Replace Cmd-T new view action with our version.
395 protected void overrideNewView()
398 * Ctrl-T / Cmd-T open new view
400 KeyStroke key_cmdT = KeyStroke.getKeyStroke(KeyEvent.VK_T, Toolkit
401 .getDefaultToolkit().getMenuShortcutKeyMask(), false);
402 AbstractAction action = new AbstractAction()
405 public void actionPerformed(ActionEvent e)
407 newView_actionPerformed();
410 overrideKeyBinding(key_cmdT, action);
414 * For now, delegates key events to the corresponding key accelerator for the
415 * AlignFrame that the mouse is in. Hopefully can be simplified in future if
416 * AlignFrame is changed to use key bindings rather than accelerators.
418 protected void overrideDelegatedKeyBindings()
420 if (getTopFrame() instanceof AlignFrame)
423 * Get all accelerator keys in the top frame (the bottom should be
424 * identical) and override each one.
426 for (Entry<KeyStroke, JMenuItem> acc : ((AlignFrame) getTopFrame())
427 .getAccelerators().entrySet())
429 overrideKeyBinding(acc);
435 * Overrides an AlignFrame key accelerator with our version which delegates to
436 * the action listener in whichever frame has the mouse (and does nothing if
441 private void overrideKeyBinding(Entry<KeyStroke, JMenuItem> acc)
443 final KeyStroke ks = acc.getKey();
444 InputMap inputMap = this.getInputMap(JComponent.WHEN_FOCUSED);
445 inputMap.put(ks, ks);
446 this.getActionMap().put(ks, new AbstractAction()
449 public void actionPerformed(ActionEvent e)
451 Component c = getFrameAtMouse();
452 if (c != null && c instanceof AlignFrame)
454 for (ActionListener a : ((AlignFrame) c).getAccelerators()
455 .get(ks).getActionListeners())
457 a.actionPerformed(null);
465 * Replace an accelerator key's action with the specified action.
469 protected void overrideKeyBinding(KeyStroke ks, AbstractAction action)
471 this.getActionMap().put(ks, action);
472 overrideMenuItem(ks, action);
476 * Create and link new views (with matching names) in both panes.
478 * Note this is _not_ multiple tabs, each hosting a split pane view, rather it
479 * is a single split pane with each split holding multiple tabs which are
482 * TODO implement instead with a tabbed holder in the SplitView, each tab
483 * holding a single JSplitPane. Would avoid a duplicated tab, at the cost of
484 * some additional coding.
486 protected void newView_actionPerformed()
488 AlignFrame topFrame = (AlignFrame) getTopFrame();
489 AlignFrame bottomFrame = (AlignFrame) getBottomFrame();
490 final boolean scaleProteinAsCdna = topFrame.viewport
491 .isScaleProteinAsCdna();
493 AlignmentPanel newTopPanel = topFrame.newView(null, true);
494 AlignmentPanel newBottomPanel = bottomFrame.newView(null, true);
497 * This currently (for the first new view only) leaves the top pane on tab 0
498 * but the bottom on tab 1. This results from 'setInitialTabVisible' echoing
499 * from the bottom back to the first frame. Next line is a fudge to work
500 * around this. TODO find a better way.
502 if (topFrame.getTabIndex() != bottomFrame.getTabIndex())
504 topFrame.setDisplayedView(newTopPanel);
507 newBottomPanel.av.viewName = newTopPanel.av.viewName;
508 newTopPanel.av.setCodingComplement(newBottomPanel.av);
511 * These lines can be removed once scaleProteinAsCdna is added to element
512 * Viewport in jalview.xsd, as Jalview2XML.copyAlignPanel will then take
515 newTopPanel.av.setScaleProteinAsCdna(scaleProteinAsCdna);
516 newBottomPanel.av.setScaleProteinAsCdna(scaleProteinAsCdna);
519 * Line up id labels etc
523 final StructureSelectionManager ssm = StructureSelectionManager
524 .getStructureSelectionManager(Desktop.instance);
525 ssm.addCommandListener(newTopPanel.av);
526 ssm.addCommandListener(newBottomPanel.av);
530 * Close the currently selected view in both panes. If there is only one view,
531 * close this split frame.
533 protected void closeView_actionPerformed()
535 int viewCount = ((AlignFrame) getTopFrame()).getAlignPanels().size();
542 AlignmentPanel topPanel = ((AlignFrame) getTopFrame()).alignPanel;
543 AlignmentPanel bottomPanel = ((AlignFrame) getBottomFrame()).alignPanel;
545 ((AlignFrame) getTopFrame()).closeView(topPanel);
546 ((AlignFrame) getBottomFrame()).closeView(bottomPanel);
551 * Close child frames and this split frame.
555 ((AlignFrame) getTopFrame()).closeMenuItem_actionPerformed(true);
556 ((AlignFrame) getBottomFrame()).closeMenuItem_actionPerformed(true);
559 this.setClosed(true);
560 } catch (PropertyVetoException e)
567 * Replace AlignFrame 'expand views' action with SplitFrame version.
569 protected void overrideExpandViews()
571 KeyStroke key_X = KeyStroke.getKeyStroke(KeyEvent.VK_X, 0, false);
572 AbstractAction action = new AbstractAction()
575 public void actionPerformed(ActionEvent e)
577 expandViews_actionPerformed();
580 overrideMenuItem(key_X, action);
584 * Replace AlignFrame 'gather views' action with SplitFrame version.
586 protected void overrideGatherViews()
588 KeyStroke key_G = KeyStroke.getKeyStroke(KeyEvent.VK_G, 0, false);
589 AbstractAction action = new AbstractAction()
592 public void actionPerformed(ActionEvent e)
594 gatherViews_actionPerformed();
597 overrideMenuItem(key_G, action);
601 * Override the menu action associated with the keystroke in the child frames,
602 * replacing it with the given action.
607 private void overrideMenuItem(KeyStroke ks, AbstractAction action)
609 overrideMenuItem(ks, action, getTopFrame());
610 overrideMenuItem(ks, action, getBottomFrame());
614 * Override the menu action associated with the keystroke in one child frame,
615 * replacing it with the given action. Mwahahahaha.
621 private void overrideMenuItem(KeyStroke key, final AbstractAction action,
624 if (comp instanceof AlignFrame)
626 JMenuItem mi = ((AlignFrame) comp).getAccelerators().get(key);
629 for (ActionListener al : mi.getActionListeners())
631 mi.removeActionListener(al);
633 mi.addActionListener(new ActionListener()
636 public void actionPerformed(ActionEvent e)
638 action.actionPerformed(e);
646 * Expand any multiple views (which are always in pairs) into separate split
649 protected void expandViews_actionPerformed()
651 Desktop.instance.explodeViews(this);
655 * Gather any other SplitFrame views of this alignment back in as multiple
656 * (pairs of) views in this SplitFrame.
658 protected void gatherViews_actionPerformed()
660 Desktop.instance.gatherViews(this);
664 * Returns the alignment in the complementary frame to the one given.
667 public AlignmentI getComplement(Object alignFrame)
669 if (alignFrame == this.getTopFrame())
671 return ((AlignFrame) getBottomFrame()).viewport.getAlignment();
673 else if (alignFrame == this.getBottomFrame())
675 return ((AlignFrame) getTopFrame()).viewport.getAlignment();
681 * Returns the title of the complementary frame to the one given.
684 public String getComplementTitle(Object alignFrame)
686 if (alignFrame == this.getTopFrame())
688 return ((AlignFrame) getBottomFrame()).getTitle();
690 else if (alignFrame == this.getBottomFrame())
692 return ((AlignFrame) getTopFrame()).getTitle();
698 * Set the 'other half' to hidden / revealed.
701 public void setComplementVisible(Object alignFrame, boolean show)
704 * Hiding the AlignPanel suppresses unnecessary repaints
706 if (alignFrame == getTopFrame())
708 ((AlignFrame) getBottomFrame()).alignPanel.setVisible(show);
710 else if (alignFrame == getBottomFrame())
712 ((AlignFrame) getTopFrame()).alignPanel.setVisible(show);
714 super.setComplementVisible(alignFrame, show);
718 * return the AlignFrames held by this container
720 * @return { Top alignFrame (Usually CDS), Bottom AlignFrame (Usually
723 public List<AlignFrame> getAlignFrames()
725 return Arrays.asList(new AlignFrame[] { (AlignFrame) getTopFrame(),
726 (AlignFrame) getBottomFrame() });
730 * Replace Cmd-F Find action with our version. This is necessary because the
731 * 'default' Finder searches in the first AlignFrame it finds. We need it to
732 * search in the half of the SplitFrame that has the mouse.
734 protected void overrideFind()
737 * Ctrl-F / Cmd-F open Finder dialog, 'focused' on the right alignment
739 KeyStroke key_cmdF = KeyStroke.getKeyStroke(KeyEvent.VK_F, Toolkit
740 .getDefaultToolkit().getMenuShortcutKeyMask(), false);
741 AbstractAction action = new AbstractAction()
744 public void actionPerformed(ActionEvent e)
746 Component c = getFrameAtMouse();
747 if (c != null && c instanceof AlignFrame)
749 AlignFrame af = (AlignFrame) c;
750 new Finder(af.viewport, af.alignPanel);
754 overrideKeyBinding(key_cmdF, action);