X-Git-Url: http://source.jalview.org/gitweb/?a=blobdiff_plain;f=src%2Fjalview%2Fgui%2FSplitFrame.java;h=73744b37d28758264fa03819cfa93acf6f5be2dc;hb=155a17a423e980849fd4dc5f857da1a72b0010b9;hp=d28bb14a13861824a7de0b58f7067641de29f19a;hpb=fdebbbbada35176910e5d8d1065c038ca1e143b2;p=jalview.git diff --git a/src/jalview/gui/SplitFrame.java b/src/jalview/gui/SplitFrame.java index d28bb14..73744b3 100644 --- a/src/jalview/gui/SplitFrame.java +++ b/src/jalview/gui/SplitFrame.java @@ -20,16 +20,9 @@ */ package jalview.gui; -import jalview.api.SplitContainerI; -import jalview.datamodel.AlignmentI; -import jalview.jbgui.GAlignFrame; -import jalview.jbgui.GSplitFrame; -import jalview.structure.StructureSelectionManager; -import jalview.util.Platform; -import jalview.viewmodel.AlignmentViewport; - +import java.awt.BorderLayout; import java.awt.Component; -import java.awt.Toolkit; +import java.awt.Dimension; import java.awt.event.ActionEvent; import java.awt.event.ActionListener; import java.awt.event.KeyAdapter; @@ -42,12 +35,32 @@ import java.util.Map.Entry; import javax.swing.AbstractAction; import javax.swing.InputMap; +import javax.swing.JButton; import javax.swing.JComponent; +import javax.swing.JDesktopPane; +import javax.swing.JInternalFrame; +import javax.swing.JLayeredPane; import javax.swing.JMenuItem; +import javax.swing.JPanel; +import javax.swing.JTabbedPane; import javax.swing.KeyStroke; +import javax.swing.event.ChangeEvent; +import javax.swing.event.ChangeListener; import javax.swing.event.InternalFrameAdapter; import javax.swing.event.InternalFrameEvent; +import jalview.api.AlignViewControllerGuiI; +import jalview.api.FeatureSettingsControllerI; +import jalview.api.SplitContainerI; +import jalview.controller.FeatureSettingsControllerGuiI; +import jalview.datamodel.AlignmentI; +import jalview.jbgui.GAlignFrame; +import jalview.jbgui.GSplitFrame; +import jalview.structure.StructureSelectionManager; +import jalview.util.MessageManager; +import jalview.util.Platform; +import jalview.viewmodel.AlignmentViewport; + /** * An internal frame on the desktop that hosts a horizontally split view of * linked DNA and Protein alignments. Additional views can be created in linked @@ -74,6 +87,13 @@ public class SplitFrame extends GSplitFrame implements SplitContainerI private static final long serialVersionUID = 1L; + /** + * geometry for Feature Settings Holder + */ + private static final int FS_MIN_WIDTH = 400; + + private static final int FS_MIN_HEIGHT = 400; + public SplitFrame(GAlignFrame top, GAlignFrame bottom) { super(top, bottom); @@ -85,6 +105,7 @@ public class SplitFrame extends GSplitFrame implements SplitContainerI */ protected void init() { + setFrameIcon(null); getTopFrame().setSplitFrame(this); getBottomFrame().setSplitFrame(this); getTopFrame().setVisible(true); @@ -97,9 +118,9 @@ public class SplitFrame extends GSplitFrame implements SplitContainerI * estimate width and height of SplitFrame; this.getInsets() doesn't seem to * give the full additional size (a few pixels short) */ - int widthFudge = Platform.isAMac() ? MAC_INSETS_WIDTH + int widthFudge = Platform.isAMacAndNotJS() ? MAC_INSETS_WIDTH : WINDOWS_INSETS_WIDTH; - int heightFudge = Platform.isAMac() ? MAC_INSETS_HEIGHT + int heightFudge = Platform.isAMacAndNotJS() ? MAC_INSETS_HEIGHT : WINDOWS_INSETS_HEIGHT; int width = ((AlignFrame) getTopFrame()).getWidth() + widthFudge; int height = ((AlignFrame) getTopFrame()).getHeight() @@ -160,26 +181,21 @@ public class SplitFrame extends GSplitFrame implements SplitContainerI */ public void adjustLayout() { + final AlignViewport topViewport = ((AlignFrame) getTopFrame()).viewport; + final AlignViewport bottomViewport = ((AlignFrame) getBottomFrame()).viewport; + /* * Ensure sequence ids are the same width so sequences line up */ - int w1 = ((AlignFrame) getTopFrame()).getViewport().getIdWidth(); - int w2 = ((AlignFrame) getBottomFrame()).getViewport().getIdWidth(); + int w1 = topViewport.getIdWidth(); + int w2 = bottomViewport.getIdWidth(); int w3 = Math.max(w1, w2); - if (w1 != w3) - { - ((AlignFrame) getTopFrame()).getViewport().setIdWidth(w3); - } - if (w2 != w3) - { - ((AlignFrame) getBottomFrame()).getViewport().setIdWidth(w3); - } + topViewport.setIdWidth(w3); + bottomViewport.setIdWidth(w3); /* * Scale protein to either 1 or 3 times character width of dna */ - final AlignViewport topViewport = ((AlignFrame) getTopFrame()).viewport; - final AlignViewport bottomViewport = ((AlignFrame) getBottomFrame()).viewport; final AlignmentI topAlignment = topViewport.getAlignment(); final AlignmentI bottomAlignment = bottomViewport.getAlignment(); AlignmentViewport cdna = topAlignment.isNucleotide() ? topViewport @@ -194,12 +210,16 @@ public class SplitFrame extends GSplitFrame implements SplitContainerI } /** - * Adjust the divider for a sensible split of the real estate (for example, + * Adjusts the divider for a sensible split of the real estate (for example, * when many transcripts are shown with a single protein). This should only be * called after the split pane has been laid out (made visible) so it has a - * height. + * height. The aim is to avoid unnecessary vertical scroll bars, while + * ensuring that at least 2 sequences are visible in each panel. + *
+ * Once laid out, the user may choose to customise as they wish, so this + * method is not called again after the initial layout. */ - protected void adjustDivider() + protected void adjustInitialLayout() { AlignFrame topFrame = (AlignFrame) getTopFrame(); AlignFrame bottomFrame = (AlignFrame) getBottomFrame(); @@ -224,36 +244,32 @@ public class SplitFrame extends GSplitFrame implements SplitContainerI int bottomCharHeight = bottomViewport.getViewStyle().getCharHeight(); /* - * calculate the minimum ratio that leaves at least - * two sequences visible in the top panel + * calculate the minimum ratio that leaves at least the height + * of two sequences (after rounding) visible in the top panel */ int topPanelHeight = topFrame.getHeight(); + int bottomPanelHeight = bottomFrame.getHeight(); int topSequencesHeight = topFrame.alignPanel.getSeqPanel().seqCanvas .getHeight(); int topPanelMinHeight = topPanelHeight - - Math.max(0, - topSequencesHeight - 2 * topViewport.getCharHeight()); - int myHeight = getHeight(); - double minRatio = topPanelMinHeight / (double) myHeight; + - Math.max(0, topSequencesHeight - 3 * topCharHeight); + double totalHeight = (double) topPanelHeight + bottomPanelHeight; + double minRatio = topPanelMinHeight / totalHeight; /* - * calculate the maximum ratio that leaves at least - * two sequences visible in the bottom panel + * calculate the maximum ratio that leaves at least the height + * of two sequences (after rounding) visible in the bottom panel */ - int bottomPanelHeight = bottomFrame.getHeight(); - int bottomSequencesHeight = bottomFrame.alignPanel.getSeqPanel().seqCanvas - .getHeight(); + int bottomSequencesHeight = bottomFrame.alignPanel + .getSeqPanel().seqCanvas.getHeight(); int bottomPanelMinHeight = bottomPanelHeight - - Math.max( - 0, - bottomSequencesHeight - 2 - * bottomViewport.getCharHeight()); - double maxRatio = (myHeight - bottomPanelMinHeight) / (double) myHeight; + - Math.max(0, bottomSequencesHeight - 3 * bottomCharHeight); + double maxRatio = (totalHeight - bottomPanelMinHeight) / totalHeight; /* * estimate ratio of (topFrameContent / bottomFrameContent) */ - int insets = Platform.isAMac() ? MAC_INSETS_HEIGHT + int insets = Platform.isAMacAndNotJS() ? MAC_INSETS_HEIGHT : WINDOWS_INSETS_HEIGHT; // allow 3 'rows' for scale, scrollbar, status bar int topHeight = insets + (3 + topCount) * topCharHeight @@ -268,7 +284,7 @@ public class SplitFrame extends GSplitFrame implements SplitContainerI */ ratio = Math.min(ratio, maxRatio); ratio = Math.max(ratio, minRatio); - // setRelativeDividerLocation(ratio); + setRelativeDividerLocation(ratio); } /** @@ -412,7 +428,9 @@ public class SplitFrame extends GSplitFrame implements SplitContainerI * Ctrl-W / Cmd-W - close view or window */ KeyStroke key_cmdW = KeyStroke.getKeyStroke(KeyEvent.VK_W, - Toolkit.getDefaultToolkit().getMenuShortcutKeyMask(), false); + jalview.util.ShortcutKeyMaskExWrapper + .getMenuShortcutKeyMaskEx(), + false); action = new AbstractAction() { @Override @@ -433,7 +451,9 @@ public class SplitFrame extends GSplitFrame implements SplitContainerI * Ctrl-T / Cmd-T open new view */ KeyStroke key_cmdT = KeyStroke.getKeyStroke(KeyEvent.VK_T, - Toolkit.getDefaultToolkit().getMenuShortcutKeyMask(), false); + jalview.util.ShortcutKeyMaskExWrapper + .getMenuShortcutKeyMaskEx(), + false); AbstractAction action = new AbstractAction() { @Override @@ -539,7 +559,7 @@ public class SplitFrame extends GSplitFrame implements SplitContainerI topFrame.setDisplayedView(newTopPanel); } - newBottomPanel.av.viewName = newTopPanel.av.viewName; + newBottomPanel.av.setViewName(newTopPanel.av.getViewName()); newTopPanel.av.setCodingComplement(newBottomPanel.av); /* @@ -762,6 +782,22 @@ public class SplitFrame extends GSplitFrame implements SplitContainerI { (AlignFrame) getTopFrame(), (AlignFrame) getBottomFrame() }); } + @Override + public AlignFrame getComplementAlignFrame( + AlignViewControllerGuiI alignFrame) + { + if (getTopFrame() == alignFrame) + { + return (AlignFrame) getBottomFrame(); + } + if (getBottomFrame() == alignFrame) + { + return (AlignFrame) getTopFrame(); + } + // we didn't know anything about this frame... + return null; + } + /** * Replace Cmd-F Find action with our version. This is necessary because the * 'default' Finder searches in the first AlignFrame it finds. We need it to @@ -773,7 +809,9 @@ public class SplitFrame extends GSplitFrame implements SplitContainerI * Ctrl-F / Cmd-F open Finder dialog, 'focused' on the right alignment */ KeyStroke key_cmdF = KeyStroke.getKeyStroke(KeyEvent.VK_F, - Toolkit.getDefaultToolkit().getMenuShortcutKeyMask(), false); + jalview.util.ShortcutKeyMaskExWrapper + .getMenuShortcutKeyMaskEx(), + false); AbstractAction action = new AbstractAction() { @Override @@ -783,10 +821,296 @@ public class SplitFrame extends GSplitFrame implements SplitContainerI if (c != null && c instanceof AlignFrame) { AlignFrame af = (AlignFrame) c; - new Finder(af.viewport, af.alignPanel); + boolean dna = af.getViewport().getAlignment().isNucleotide(); + String scope = MessageManager.getString("label.in") + " " + + (dna ? MessageManager.getString("label.nucleotide") + : MessageManager.getString("label.protein")); + new Finder(af.alignPanel, true, scope); } } }; overrideKeyBinding(key_cmdF, action); } -} + + /** + * Override to do nothing if triggered from one of the child frames + */ + @Override + public void setSelected(boolean selected) throws PropertyVetoException + { + JDesktopPane desktopPane = getDesktopPane(); + JInternalFrame fr = desktopPane == null ? null + : desktopPane.getSelectedFrame(); + if (fr == getTopFrame() || fr == getBottomFrame()) + { + /* + * patch for JAL-3288 (deselecting top/bottom frame closes popup menu); + * it may be possible to remove this method in future + * if the underlying Java behaviour changes + */ + if (selected) + { + moveToFront(); + } + return; + } + super.setSelected(selected); + } + + /** + * holds the frame for feature settings, so Protein and DNA tabs can be + * managed + */ + JInternalFrame featureSettingsUI; + + JTabbedPane featureSettingsPanels; + + @Override + public void addFeatureSettingsUI( + FeatureSettingsControllerGuiI featureSettings) + { + boolean showInternalFrame = false; + if (featureSettingsUI == null || featureSettingsPanels == null) + { + showInternalFrame = true; + featureSettingsPanels = new JTabbedPane(); + featureSettingsPanels.addChangeListener(new ChangeListener() + { + + @Override + public void stateChanged(ChangeEvent e) + { + if (e.getSource() != featureSettingsPanels + || featureSettingsUI == null + || featureSettingsUI.isClosed() + || !featureSettingsUI.isVisible()) + { + // not our tabbed pane + return; + } + int tab = featureSettingsPanels.getSelectedIndex(); + if (tab < 0 || featureSettingsPanels + .getSelectedComponent() instanceof FeatureSettingsControllerGuiI) + { + // no tab selected or already showing a feature settings GUI + return; + } + getAlignFrames().get(tab).showFeatureSettingsUI(); + } + }); + featureSettingsUI = new JInternalFrame(MessageManager.getString( + "label.sequence_feature_settings_for_CDS_and_Protein")); + featureSettingsUI.setFrameIcon(null); + featureSettingsPanels.setOpaque(true); + + JPanel dialog = new JPanel(); + dialog.setOpaque(true); + dialog.setLayout(new BorderLayout()); + dialog.add(featureSettingsPanels, BorderLayout.CENTER); + JPanel buttons = new JPanel(); + JButton ok = new JButton(MessageManager.getString("action.ok")); + ok.addActionListener(new ActionListener() + { + + @Override + public void actionPerformed(ActionEvent e) + { + try + { + featureSettingsUI.setClosed(true); + } catch (PropertyVetoException pv) + { + pv.printStackTrace(); + } + } + }); + JButton cancel = new JButton( + MessageManager.getString("action.cancel")); + cancel.addActionListener(new ActionListener() + { + + @Override + public void actionPerformed(ActionEvent e) + { + try + { + for (Component fspanel : featureSettingsPanels.getComponents()) + { + if (fspanel instanceof FeatureSettingsControllerGuiI) + { + ((FeatureSettingsControllerGuiI) fspanel).revert(); + } + } + featureSettingsUI.setClosed(true); + } catch (Exception pv) + { + pv.printStackTrace(); + } + } + }); + buttons.add(ok); + buttons.add(cancel); + dialog.add(buttons, BorderLayout.SOUTH); + featureSettingsUI.setContentPane(dialog); + createDummyTabs(); + } + if (featureSettingsPanels + .indexOfTabComponent((Component) featureSettings) > -1) + { + // just show the feature settings ! + featureSettingsPanels + .setSelectedComponent((Component) featureSettings); + return; + } + // otherwise replace the dummy tab with the given feature settings + int pos = getAlignFrames().indexOf(featureSettings.getAlignframe()); + // if pos==-1 then alignFrame isn't managed by this splitframe + if (pos == 0) + { + featureSettingsPanels.removeTabAt(0); + featureSettingsPanels.insertTab(tabName[0], null, + (Component) featureSettings, + MessageManager.formatMessage( + "label.sequence_feature_settings_for", tabName[0]), + 0); + } + if (pos == 1) + { + featureSettingsPanels.removeTabAt(1); + featureSettingsPanels.insertTab(tabName[1], null, + (Component) featureSettings, + MessageManager.formatMessage( + "label.sequence_feature_settings_for", tabName[1]), + 1); + } + featureSettingsPanels.setSelectedComponent((Component) featureSettings); + + // TODO: JAL-3535 - construct a feature settings title including names of + // currently selected CDS and Protein names + + if (showInternalFrame) + { + if (Platform.isAMacAndNotJS()) + { + Desktop.addInternalFrame(featureSettingsUI, + MessageManager.getString( + "label.sequence_feature_settings_for_CDS_and_Protein"), + 600, 480); + } + else + { + Desktop.addInternalFrame(featureSettingsUI, + MessageManager.getString( + "label.sequence_feature_settings_for_CDS_and_Protein"), + 600, 450); + } + featureSettingsUI + .setMinimumSize(new Dimension(FS_MIN_WIDTH, FS_MIN_HEIGHT)); + + featureSettingsUI.addInternalFrameListener( + new javax.swing.event.InternalFrameAdapter() + { + @Override + public void internalFrameClosed( + javax.swing.event.InternalFrameEvent evt) + { + for (int tab = 0; tab < featureSettingsPanels + .getTabCount();) + { + FeatureSettingsControllerGuiI fsettings = (FeatureSettingsControllerGuiI) featureSettingsPanels + .getTabComponentAt(tab); + if (fsettings != null) + { + featureSettingsPanels.removeTabAt(tab); + fsettings.featureSettings_isClosed(); + } + else + { + tab++; + } + } + featureSettingsPanels = null; + featureSettingsUI = null; + }; + }); + featureSettingsUI.setLayer(JLayeredPane.PALETTE_LAYER); + } + } + + /** + * tab names for feature settings + */ + private String[] tabName = new String[] { + MessageManager.getString("label.CDS"), + MessageManager.getString("label.protein") }; + + /** + * create placeholder tabs which materialise the feature settings for a given + * view. Also reinitialises any tabs containing stale feature settings + */ + private void createDummyTabs() + { + for (int tabIndex = 0; tabIndex < 2; tabIndex++) + { + JPanel dummyTab = new JPanel(); + featureSettingsPanels.addTab(tabName[tabIndex], dummyTab); + } + } + + private void replaceWithDummyTab(FeatureSettingsControllerI toClose) + { + Component dummyTab = null; + for (int tabIndex = 0; tabIndex < 2; tabIndex++) + { + if (featureSettingsPanels.getTabCount() > tabIndex) + { + dummyTab = featureSettingsPanels.getTabComponentAt(tabIndex); + if (dummyTab instanceof FeatureSettingsControllerGuiI + && !dummyTab.isVisible()) + { + featureSettingsPanels.removeTabAt(tabIndex); + // close the feature Settings tab + ((FeatureSettingsControllerGuiI) dummyTab) + .featureSettings_isClosed(); + // create a dummy tab in its place + dummyTab = new JPanel(); + featureSettingsPanels.insertTab(tabName[tabIndex], null, dummyTab, + MessageManager.formatMessage( + "label.sequence_feature_settings_for", + tabName[tabIndex]), + tabIndex); + } + } + } + } + + @Override + public void closeFeatureSettings( + FeatureSettingsControllerI featureSettings, + boolean closeContainingFrame) + { + if (featureSettingsUI != null) + { + if (closeContainingFrame) + { + try + { + featureSettingsUI.setClosed(true); + } catch (Exception x) + { + } + featureSettingsUI = null; + } + else + { + replaceWithDummyTab(featureSettings); + } + } + } + + @Override + public boolean isFeatureSettingsOpen() + { + return featureSettingsUI != null && !featureSettingsUI.isClosed(); + } +} \ No newline at end of file