X-Git-Url: http://source.jalview.org/gitweb/?a=blobdiff_plain;f=src%2Fjalview%2Fgui%2FCalculationChooser.java;h=f674c7e5289d0e7fdd91bae22c3774667b093c50;hb=9bc0c6be2b195af9fed245e9e7ae27d73196fac8;hp=7f245b1e33442d210b64b32be725d89d7c1587e5;hpb=ff8e1762f6ca309e3695b7e7dbec4e3262b1dd1c;p=jalview.git diff --git a/src/jalview/gui/CalculationChooser.java b/src/jalview/gui/CalculationChooser.java index 7f245b1..f674c7e 100644 --- a/src/jalview/gui/CalculationChooser.java +++ b/src/jalview/gui/CalculationChooser.java @@ -25,6 +25,7 @@ import jalview.analysis.scoremodels.ScoreModels; import jalview.analysis.scoremodels.SimilarityParams; import jalview.api.analysis.ScoreModelI; import jalview.api.analysis.SimilarityParamsI; +import jalview.datamodel.SequenceGroup; import jalview.util.MessageManager; import java.awt.BorderLayout; @@ -47,6 +48,7 @@ import java.util.List; import javax.swing.BorderFactory; import javax.swing.ButtonGroup; +import javax.swing.DefaultComboBoxModel; import javax.swing.JButton; import javax.swing.JCheckBox; import javax.swing.JComboBox; @@ -73,6 +75,10 @@ public class CalculationChooser extends JPanel private static final Font VERDANA_11PT = new Font("Verdana", 0, 11); + private static final int MIN_TREE_SELECTION = 3; + + private static final int MIN_PCA_SELECTION = 4; + AlignFrame af; JRadioButton pca; @@ -83,7 +89,7 @@ public class CalculationChooser extends JPanel JComboBox modelNames; - JButton ok; + JButton calculate; private JInternalFrame frame; @@ -95,6 +101,15 @@ public class CalculationChooser extends JPanel private JCheckBox shorterSequence; + final ComboBoxTooltipRenderer renderer = new ComboBoxTooltipRenderer(); + + List tips = new ArrayList(); + + /* + * the most recently opened PCA results panel + */ + private PCAPanel pcaPanel; + /** * Constructor * @@ -116,7 +131,20 @@ public class CalculationChooser extends JPanel frame = new JInternalFrame(); frame.setContentPane(this); this.setBackground(Color.white); + frame.addFocusListener(new FocusListener() + { + @Override + public void focusLost(FocusEvent e) + { + } + + @Override + public void focusGained(FocusEvent e) + { + validateCalcTypes(); + } + }); /* * Layout consists of 3 or 4 panels: * - first with choice of PCA or tree method NJ or AV @@ -129,6 +157,7 @@ public class CalculationChooser extends JPanel pca.setOpaque(false); neighbourJoining = new JRadioButton( MessageManager.getString("label.tree_calc_nj")); + neighbourJoining.setSelected(true); averageDistance = new JRadioButton( MessageManager.getString("label.tree_calc_av")); neighbourJoining.setOpaque(false); @@ -140,20 +169,19 @@ public class CalculationChooser extends JPanel JPanel treePanel = new JPanel(new FlowLayout(FlowLayout.LEFT)); treePanel.setOpaque(false); - treePanel.setBorder(BorderFactory.createTitledBorder(MessageManager - .getString("label.tree"))); + JvSwingUtils.createTitledBorder(treePanel, + MessageManager.getString("label.tree"), true); // then copy the inset dimensions for the border-less PCA panel JPanel pcaBorderless = new JPanel(new FlowLayout(FlowLayout.LEFT)); Insets b = treePanel.getBorder().getBorderInsets(treePanel); - pcaBorderless.setBorder(BorderFactory.createEmptyBorder(2, b.left, 2, - b.right)); + pcaBorderless.setBorder( + BorderFactory.createEmptyBorder(2, b.left, 2, b.right)); pcaBorderless.setOpaque(false); pcaBorderless.add(pca, FlowLayout.LEFT); calcChoicePanel.add(pcaBorderless, FlowLayout.LEFT); - treePanel.add(neighbourJoining); treePanel.add(averageDistance); @@ -163,14 +191,18 @@ public class CalculationChooser extends JPanel calcTypes.add(pca); calcTypes.add(neighbourJoining); calcTypes.add(averageDistance); + + ActionListener calcChanged = new ActionListener() { @Override - public void itemStateChanged(ItemEvent e) + public void actionPerformed(ActionEvent e) { - neighbourJoining.setEnabled(tree.isSelected()); - averageDistance.setEnabled(tree.isSelected()); + validateCalcTypes(); } }; + pca.addActionListener(calcChanged); + neighbourJoining.addActionListener(calcChanged); + averageDistance.addActionListener(calcChanged); /* * score models drop-down - with added tooltips! @@ -199,30 +231,30 @@ public class CalculationChooser extends JPanel /* * OK / Cancel buttons */ - ok = new JButton(MessageManager.getString("action.calculate")); - ok.setFont(VERDANA_11PT); - ok.addActionListener(new java.awt.event.ActionListener() + calculate = new JButton(MessageManager.getString("action.calculate")); + calculate.setFont(VERDANA_11PT); + calculate.addActionListener(new java.awt.event.ActionListener() { @Override public void actionPerformed(ActionEvent e) { - ok_actionPerformed(); + calculate_actionPerformed(); } }); - JButton cancel = new JButton(MessageManager.getString("action.close")); - cancel.setFont(VERDANA_11PT); - cancel.addActionListener(new java.awt.event.ActionListener() + JButton close = new JButton(MessageManager.getString("action.close")); + close.setFont(VERDANA_11PT); + close.addActionListener(new java.awt.event.ActionListener() { @Override public void actionPerformed(ActionEvent e) { - cancel_actionPerformed(e); + close_actionPerformed(); } }); JPanel actionPanel = new JPanel(); actionPanel.setOpaque(false); - actionPanel.add(ok); - actionPanel.add(cancel); + actionPanel.add(calculate); + actionPanel.add(close); boolean includeParams = false; this.add(calcChoicePanel, BorderLayout.CENTER); @@ -243,9 +275,7 @@ public class CalculationChooser extends JPanel title = title + " (" + af.getViewport().viewName + ")"; } - Desktop.addInternalFrame(frame, - title, width, - height, false); + Desktop.addInternalFrame(frame, title, width, height, false); calcChoicePanel.doLayout(); revalidate(); /* @@ -264,6 +294,80 @@ public class CalculationChooser extends JPanel } /** + * enable calculations applicable for the current alignment or selection. + */ + protected void validateCalcTypes() + { + int size = af.getViewport().getAlignment().getHeight(); + if (af.getViewport().getSelectionGroup() != null) + { + size = af.getViewport().getSelectionGroup().getSize(); + } + + /* + * disable calc options for which there is insufficient input data + * return value of true means enabled and selected + */ + boolean checkPca = checkEnabled(pca, size, MIN_PCA_SELECTION); + boolean checkNeighbourJoining = checkEnabled(neighbourJoining, size, + MIN_TREE_SELECTION); + boolean checkAverageDistance = checkEnabled(averageDistance, size, + MIN_TREE_SELECTION); + + if (checkPca || checkNeighbourJoining || checkAverageDistance) + { + calculate.setToolTipText(null); + calculate.setEnabled(true); + } + else + { + calculate.setEnabled(false); + } + updateScoreModels(modelNames, tips); + } + + /** + * Check the input and disable a calculation's radio button if necessary. A + * tooltip is shown for disabled calculations. + * + * @param calc + * - radio button for the calculation being validated + * @param size + * - size of input to calculation + * @param minsize + * - minimum size for calculation + * @return true if size >= minsize and calc.isSelected + */ + private boolean checkEnabled(JRadioButton calc, int size, int minsize) + { + String ttip = MessageManager + .formatMessage("label.you_need_at_least_n_sequences", minsize); + + calc.setEnabled(size >= minsize); + if (!calc.isEnabled()) + { + calc.setToolTipText(ttip); + } + else + { + calc.setToolTipText(null); + } + if (calc.isSelected()) + { + modelNames.setEnabled(calc.isEnabled()); + if (calc.isEnabled()) + { + return true; + } + else + { + calculate.setToolTipText(ttip); + } + } + return false; + } + + /** * A rather elaborate helper method (blame Swing, not me) that builds a * drop-down list of score models (by name) with descriptions as tooltips. * There is also a tooltip shown for the currently selected item when hovering @@ -271,46 +375,68 @@ public class CalculationChooser extends JPanel */ protected JComboBox buildModelOptionsList() { - final JComboBox comboBox = new JComboBox(); - ComboBoxTooltipRenderer renderer = new ComboBoxTooltipRenderer(); - comboBox.setRenderer(renderer); - final List tips = new ArrayList(); + final JComboBox scoreModelsCombo = new JComboBox(); + scoreModelsCombo.setRenderer(renderer); /* * show tooltip on mouse over the combobox * note the listener has to be on the components that make up * the combobox, doesn't work if just on the combobox */ - MouseAdapter mouseListener = new MouseAdapter() + final MouseAdapter mouseListener = new MouseAdapter() { @Override public void mouseEntered(MouseEvent e) { - comboBox.setToolTipText(tips.get(comboBox.getSelectedIndex())); + scoreModelsCombo.setToolTipText( + tips.get(scoreModelsCombo.getSelectedIndex())); } @Override public void mouseExited(MouseEvent e) { - comboBox.setToolTipText(null); + scoreModelsCombo.setToolTipText(null); } }; - for (Component c : comboBox.getComponents()) + for (Component c : scoreModelsCombo.getComponents()) { c.addMouseListener(mouseListener); } + updateScoreModels(scoreModelsCombo, tips); + + /* + * set the list of tooltips on the combobox's renderer + */ + renderer.setTooltips(tips); + + return scoreModelsCombo; + } + + private void updateScoreModels(JComboBox comboBox, + List toolTips) + { + Object curSel = comboBox.getSelectedItem(); + toolTips.clear(); + DefaultComboBoxModel model = new DefaultComboBoxModel(); + /* * now we can actually add entries to the combobox, * remembering their descriptions for tooltips */ ScoreModels scoreModels = ScoreModels.getInstance(); + boolean selectedIsPresent = false; for (ScoreModelI sm : scoreModels.getModels()) { boolean nucleotide = af.getViewport().getAlignment().isNucleotide(); if (sm.isDNA() && nucleotide || sm.isProtein() && !nucleotide) { - comboBox.addItem(sm.getName()); + if (curSel != null && sm.getName().equals(curSel)) + { + selectedIsPresent = true; + curSel = sm.getName(); + } + model.addElement(sm.getName()); /* * tooltip is description if provided, else text lookup with @@ -322,22 +448,21 @@ public class CalculationChooser extends JPanel tooltip = MessageManager.getStringOrReturn("label.score_model_", sm.getName()); } - tips.add(tooltip); + toolTips.add(tooltip); } - - /* - * set the list of tooltips on the combobox's renderer - */ - renderer.setTooltips(tips); } - - return comboBox; + if (selectedIsPresent) + { + model.setSelectedItem(curSel); + } + // finally, update the model + comboBox.setModel(model); } /** * Open and calculate the selected tree or PCA on 'OK' */ - protected void ok_actionPerformed() + protected void calculate_actionPerformed() { boolean doPCA = pca.isSelected(); String modelName = modelNames.getSelectedItem().toString(); @@ -363,7 +488,25 @@ public class CalculationChooser extends JPanel */ protected void openTreePanel(String modelName, SimilarityParamsI params) { - String treeType = neighbourJoining.isSelected() ? TreeBuilder.NEIGHBOUR_JOINING + /* + * gui validation shouldn't allow insufficient sequences here, but leave + * this check in in case this method gets exposed programmatically in future + */ + AlignViewport viewport = af.getViewport(); + SequenceGroup sg = viewport.getSelectionGroup(); + if (sg != null && sg.getSize() < MIN_TREE_SELECTION) + { + JvOptionPane.showMessageDialog(Desktop.desktop, + MessageManager.formatMessage( + "label.you_need_at_least_n_sequences", + MIN_TREE_SELECTION), + MessageManager.getString("label.not_enough_sequences"), + JvOptionPane.WARNING_MESSAGE); + return; + } + + String treeType = neighbourJoining.isSelected() + ? TreeBuilder.NEIGHBOUR_JOINING : TreeBuilder.AVERAGE_DISTANCE; af.newTreePanel(treeType, modelName, params); } @@ -377,22 +520,26 @@ public class CalculationChooser extends JPanel protected void openPcaPanel(String modelName, SimilarityParamsI params) { AlignViewport viewport = af.getViewport(); + + /* + * gui validation shouldn't allow insufficient sequences here, but leave + * this check in in case this method gets exposed programmatically in future + */ if (((viewport.getSelectionGroup() != null) - && (viewport.getSelectionGroup().getSize() < 4) && (viewport - .getSelectionGroup().getSize() > 0)) - || (viewport.getAlignment().getHeight() < 4)) + && (viewport.getSelectionGroup().getSize() < MIN_PCA_SELECTION) + && (viewport.getSelectionGroup().getSize() > 0)) + || (viewport.getAlignment().getHeight() < MIN_PCA_SELECTION)) { - JvOptionPane - .showInternalMessageDialog( - this, - MessageManager - .getString("label.principal_component_analysis_must_take_least_four_input_sequences"), - MessageManager - .getString("label.sequence_selection_insufficient"), - JvOptionPane.WARNING_MESSAGE); + JvOptionPane.showInternalMessageDialog(this, + MessageManager.formatMessage( + "label.you_need_at_least_n_sequences", + MIN_PCA_SELECTION), + MessageManager + .getString("label.sequence_selection_insufficient"), + JvOptionPane.WARNING_MESSAGE); return; } - new PCAPanel(af.alignPanel, modelName, params); + pcaPanel = new PCAPanel(af.alignPanel, modelName, params); } /** @@ -434,15 +581,14 @@ public class CalculationChooser extends JPanel */ boolean matchGap = doPCA ? false : treeMatchGaps; - return new SimilarityParams(includeGapGap, matchGap, includeGapResidue, matchOnShortestLength); + return new SimilarityParams(includeGapGap, matchGap, includeGapResidue, + matchOnShortestLength); } /** - * Closes dialog on cancel - * - * @param e + * Closes dialog on Close button press */ - protected void cancel_actionPerformed(ActionEvent e) + protected void close_actionPerformed() { try { @@ -451,4 +597,9 @@ public class CalculationChooser extends JPanel { } } + + public PCAPanel getPcaPanel() + { + return pcaPanel; + } }