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