FULL PRODUCT VERSION :
java version "1.5.0_06"
Java(TM) 2 Runtime Environment, Standard Edition (build 1.5.0_06-b05)
Java HotSpot(TM) Client VM (build 1.5.0_06-b05, mixed mode, sharing)


ADDITIONAL OS VERSION INFORMATION :
Linux 2.6.15-26-686 #1 SMP PREEMPT Thu Aug 3 03:13:28 UTC 2006 i686 GNU/Linux

Ubuntu 6.06

A DESCRIPTION OF THE PROBLEM :
When a JSpinner is edited using the keyboard in the text field of the JSpinner, and then a JMenu is selected using the mouse, the edits are not committed. By contrast, clicking any other (focusable) component (e.g. JButton) commits the edit. This is very inconvenient, for example if the user edits a JSpinner in an application, then uses a JMenu to File->Save. At this point, the old JSpinner value will be saved, not the edited value. This would seem to be quite a common case.

STEPS TO FOLLOW TO REPRODUCE THE PROBLEM :
Create a frame with a number JSpinner and a menu with a menu item which prints the spinner's value to System.out.
Editing the number JSpinner using the keyboard in the text field (use a valid number), then use the mouse to select the menu item to print the spinner's value.


EXPECTED VERSUS ACTUAL BEHAVIOR :
EXPECTED -
The edited value of the spinner should be printed, since it should have been committed when focus left the JSpinner (or its editor)
ACTUAL -
The unedited, original value of the JSpinner is printed - the edit is not committed when the user leaves the JSpinner by clicking the menu.

ERROR MESSAGES/STACK TRACES THAT OCCUR :
No error message, just incorrect behaviour.

REPRODUCIBILITY :
This bug can be reproduced always.

---------- BEGIN SOURCE ----------
import java.awt.FlowLayout;
import java.awt.event.ActionEvent;
import java.awt.event.ActionListener;

import javax.swing.JButton;
import javax.swing.JFrame;
import javax.swing.JLabel;
import javax.swing.JMenu;
import javax.swing.JMenuBar;
import javax.swing.JMenuItem;
import javax.swing.JSpinner;
import javax.swing.SpinnerListModel;
import javax.swing.SpinnerNumberModel;
import javax.swing.SwingUtilities;

public class JSpinnerBugTestCase {

public static void main(String[] args) {
final JFrame frame = new JFrame();
frame.getContentPane().setLayout(new FlowLayout());

final JSpinner spinner = new JSpinner(new SpinnerNumberModel(1, 1, 100, 1));
frame.getContentPane().add(spinner);

final JSpinner listSpinner = new JSpinner(new SpinnerListModel(new String[]{
"First",
"Second"}));
frame.getContentPane().add(listSpinner);

frame.getContentPane().add(new JLabel("Test Label"));
frame.getContentPane().add(new JButton("No operation button"));

JMenuBar menuBar = new JMenuBar();
JMenu menu = new JMenu("Print");
JMenuItem numberMenuItem = new JMenuItem("Print Number JSpinner Value");
numberMenuItem.addActionListener(new ActionListener() {
public void actionPerformed(ActionEvent e) {
System.out.println("Number Spinner value: " + spinner.getValue());
}
});
JMenuItem listMenuItem = new JMenuItem("Print List JSpinner Value");
listMenuItem.addActionListener(new ActionListener() {
public void actionPerformed(ActionEvent e) {
System.out.println("ListSpinner value: " + listSpinner.getValue());
}
});
menuBar.add(menu);
menu.add(numberMenuItem);
menu.add(listMenuItem);
frame.setJMenuBar(menuBar);

frame.pack();

SwingUtilities.invokeLater(new Runnable() {
public void run() {
frame.setVisible(true);
}
});
}

}

---------- END SOURCE ----------

CUSTOMER SUBMITTED WORKAROUND :
Listen to focus on the textField of the JSpinner DefaultEditor, and commit/revert changes when it loses focus. This could be extended to work with other editors, but is a very untidy way of doing things. Why is it necessary to interact with JSpinner using intimate knowledge of the JSpinner editor? This is even given as an example in the JSpinner javadocs, apparently in response to a previous bug report.

The code below is a factory to provide JSpinners with this workaround applied. Try replacing "new JSpinner" with "JSpinnerImproved.create" in the test case, you should see that behaviour is then as expected.




import java.awt.event.FocusEvent;
import java.awt.event.FocusListener;
import java.text.ParseException;

import javax.swing.JComponent;
import javax.swing.JSpinner;
import javax.swing.SpinnerModel;
import javax.swing.JSpinner.DefaultEditor;

/**
 * Provides a factory producing JSpinners which have
 * a workaround applied to prevent failure to commit
 * edits under certain circumstances.
 */
public class JSpinnerImproved {

/**
* Create a spinner, as by new JSpinner(model), but
* with a workaround applied
* @param model
* The model to use in the spinner
* @return
* A new JSpinner
*/
public static JSpinner create(SpinnerModel model) {
final JSpinner spinner = new JSpinner(model);

final JComponent editor = spinner.getEditor();

//If the editor is a default editor, we can work around
//failure to commit when selecting a menu (and possibly other
//problems) by monitoring the editor, and committing its edits when it loses
//focus. This should happen automatically, and sometimes does by some
//means I have not yet located, but fails when immediately selecting a menu
//after editing, etc.
if (editor instanceof DefaultEditor) {
((DefaultEditor)editor).getTextField().addFocusListener(new FocusListener() {

//On focus lost, try to commit any pending edit.
//If this fails, then revert editor to the actual
//current value to avoid confusion
public void focusLost(FocusEvent e) {
try {
spinner.commitEdit();
} catch (ParseException e1) {
((DefaultEditor)editor).getTextField().setValue(spinner.getValue());
}
}

//Do nothing on focus gained
public void focusGained(FocusEvent e) {
}
});
}

return spinner;
}

}