JSpinner Percentage editor as JTabel CellEditor

[Kim Mirtens]

I want use a JSpinner to edit percentage values in my JTable. I wrote the following code:

private class SpinnerEditor extends AbstractCellEditor implements TableCellEditor {
 
private JSpinner spinner;
private JSpinner.NumberEditor editor;
 
// Initializes the spinner.
public SpinnerEditor() {
spinner = new JSpinner(new SpinnerNumberModel(0, 0, 1, .001));
editor = new JSpinner.NumberEditor(spinner, "0.00%");
spinner.setEditor(editor);
spinner.setBorder(null);
 
}

public Component getTableCellEditorComponent(JTable table,
Object value, boolean isSelected, int row, int column) {
spinner.setValue(value);
return spinner;
}
 
public Object getCellEditorValue() {
return spinner.getValue();
}

public boolean stopCellEditing(){
JFormattedTextField t = ((JSpinner.DefaultEditor) spinner
.getEditor()).getTextField();
String s = t.getText();
if (s.indexOf("%") == -1) {
t.setText(s + "%");
}
try { 
editor.commitEdit();
spinner.commitEdit();
} catch (java.text.ParseException exc) { 
JOptionPane.showMessageDialog(null,"Invalid value.");
}
return super.stopCellEditing();
}
}

The problem is when users hit enter. When they manually typed the "%" sign and hit enter twice it works. When they didn't enter the "%" sign it doesn't work. I tried a keylistener on both the editor and the spinner and also an inputMap, but none of these things seem to be noticing events.
I had the same problem when the user exited the cell, which I tried to fix in the stopCellEditing() by adding a "%" sign. This does work but only in the case where the user has entered less then 2 fraction digits (otherwise it doesn't follow the pattern "0.00%").
How can I get around these problems? I really want the users to be able to commit when they hit enter.

[Brian Cole]

Originally posted by Kim Mirtens:
I want use a JSpinner to edit percentage values in my JTable.

The problem is when users hit enter. When they manually typed the "%" sign and hit enter twice it works. When they didn't enter the "%" sign it doesn't work.

They don't make it easy to get at the JSpinner internals, do they.

Here's some code that I came up with that seems to work. Let me know what you think.

import java.awt.*;
import java.text.*;
import javax.swing.*;
import javax.swing.table.*;
import javax.swing.text.*;
 
/**
 * @author Brian Cole
 */
class OptionalPercentSpinnerEditor extends AbstractCellEditor implements TableCellEditor {
 
private JSpinner spinner;
 
// Initializes the spinner.
public OptionalPercentSpinnerEditor() {
spinner = new JSpinner(new SpinnerNumberModel(0, 0, 1, .001));
spinner.setEditor(new OptionalPercentSpinEditor(spinner));
spinner.setBorder(null);
}
 
public Component getTableCellEditorComponent(JTable table,
Object value, boolean isSelected, int row, int column) {
spinner.setValue(value);
return spinner;
}
 
public Object getCellEditorValue() {
return spinner.getValue();
}
 
// -------- begin static nested classes --------
 
public static class OptionalPercentFormat extends DecimalFormat {
public OptionalPercentFormat() {
super("0.00%");
setMultiplier(100);
}
public Object parseObject( String source ) throws ParseException {
if (! source.endsWith("%")) source += "%";
return super.parseObject(source);
}
}
 
public static class OptionalPercentSpinEditor extends JSpinner.DefaultEditor {
public OptionalPercentSpinEditor(JSpinner spinner) {
super(spinner);
NumberFormatter formatter = new NumberFormatter(new OptionalPercentFormat());
// could call formatter.setValueClass(Double.class);
JFormattedTextField ftf = getTextField();
ftf.setFormatterFactory(new DefaultFormatterFactory(formatter));
ftf.setEditable(true);
// could call ftf.setColumns(n);
ftf.setHorizontalAlignment(JTextField.RIGHT);
}
}
 
}

[ April 15, 2008: Message edited by: Brian Cole ]

[Kim Mirtens]

First of all I want to thank you for all your trouble. This code works better then mine. Your code always commits when enter/return is pressed twice (whith or without percentage sign). When the user only presses once the numberformat is corrected; when he then presses again the value is actually commited to the table. Do you have any ideas on how to get the value commited to the table after a single keypress?