org.jdesktop.swingx.text.StrictNumberFormatter Maven / Gradle / Ivy
Show all versions of swingx-all Show documentation
/*
* $Id$
*
* Copyright 2009 Sun Microsystems, Inc., 4150 Network Circle,
* Santa Clara, California 95054, U.S.A. All rights reserved.
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
*
*/
package org.jdesktop.swingx.text;
import java.math.BigDecimal;
import java.text.Format;
import java.text.NumberFormat;
import java.text.ParseException;
import javax.swing.text.NumberFormatter;
/**
* Experiment to work around Issue #1183-swingx: NumberEditorExt throws exception
* on getCellValue. Remaining issue: no visual error feedback if the expected
* number type exceeds its range.
*
* @author Jeanette Winzenburg
*/
public class StrictNumberFormatter extends NumberFormatter {
private BigDecimal maxAsBig;
private BigDecimal minAsBig;
/**
* @param format
*/
public StrictNumberFormatter(NumberFormat format) {
super(format);
}
/**
* {@inheritDoc}
*
* Overridden to automatically set the minimum/maximum to the boundaries of
* the Number type if it corresponds to a raw type, or null if not.
*/
@Override
public void setValueClass(Class valueClass) {
super.setValueClass(valueClass);
updateMinMax();
}
/**
*
*/
@SuppressWarnings({ "unchecked", "rawtypes" })
private void updateMinMax() {
Comparable min = null;
Comparable max = null;
if (getValueClass() == Integer.class) {
max = Integer.MAX_VALUE;
min = Integer.MIN_VALUE;
} else if (getValueClass() == Long.class) {
max = Long.MAX_VALUE;
min = Long.MIN_VALUE;
} else if (getValueClass() == Short.class) {
max = Short.MAX_VALUE;
min = Short.MIN_VALUE;
} else if (getValueClass() == Byte.class) {
max = Byte.MAX_VALUE;
min = Byte.MIN_VALUE;
} else if (getValueClass() == Float.class) {
// Issue #1528-swingx: float doesn't take negative/zero numbers
// was: crude error - Float.MIN_VALUE is the smallest _positive_
max = Float.MAX_VALUE;
min = - Float.MAX_VALUE;
} else if (getValueClass() == Double.class) {
// don*t understand what's happening here, naive compare with bigDecimal
// fails - so don't do anything for now
// JW: revisit!
}
setMaximum(max);
setMinimum(min);
}
@SuppressWarnings({ "unchecked", "rawtypes" })
@Override
public void setMaximum(Comparable max) {
super.setMaximum(max);
this.maxAsBig = max != null ? new BigDecimal(max.toString()) : null;
}
@SuppressWarnings({ "unchecked", "rawtypes" })
@Override
public void setMinimum(Comparable minimum) {
super.setMinimum(minimum);
this.minAsBig = minimum != null ? new BigDecimal(minimum.toString()) : null;
}
/**
* Returns the Object representation of the
* String text, may be null.
*
* @param text String to convert
* @return Object representation of text
* @throws ParseException if there is an error in the conversion
*/
@Override
public Object stringToValue(String text) throws ParseException {
Object value = getParsedValue(text, getFormat());
try {
if (!isValueInRange(value, true)) {
throw new ParseException("Value not within min/max range", 0);
}
} catch (ClassCastException cce) {
throw new ParseException("Class cast exception comparing values: "
+ cce, 0);
}
return convertValueToValueClass(value, getValueClass());
}
/**
* Converts the passed in value to the passed in class. This only
* works if valueClass is one of Integer,
* Long, Float, Double,
* Byte or Short and value
* is an instanceof Number.
*/
private Object convertValueToValueClass(Object value, Class valueClass) {
if (valueClass != null && (value instanceof Number)) {
if (valueClass == Integer.class) {
return new Integer(((Number)value).intValue());
}
else if (valueClass == Long.class) {
return new Long(((Number)value).longValue());
}
else if (valueClass == Float.class) {
return new Float(((Number)value).floatValue());
}
else if (valueClass == Double.class) {
return new Double(((Number)value).doubleValue());
}
else if (valueClass == Byte.class) {
return new Byte(((Number)value).byteValue());
}
else if (valueClass == Short.class) {
return new Short(((Number)value).shortValue());
}
}
return value;
}
/**
* Invokes parseObject on f, returning
* its value.
*/
private Object getParsedValue(String text, Format f) throws ParseException {
if (f == null) {
return text;
}
return f.parseObject(text);
}
/**
* Returns true if value is between the min/max.
*
* @param wantsCCE If false, and a ClassCastException is thrown in
* comparing the values, the exception is consumed and
* false is returned.
*/
private boolean isValueInRange(Object orgValue, boolean wantsCCE) {
if (orgValue == null) return true;
if ((getMinimum() == null) && getMaximum() == null) return true;
BigDecimal value = new BigDecimal(orgValue.toString());
Comparable min = getMinimumAsBig();
try {
if (min != null && min.compareTo(value) > 0) {
return false;
}
} catch (ClassCastException cce) {
if (wantsCCE) {
throw cce;
}
return false;
}
Comparable max = getMaximumAsBig();
try {
if (max != null && max.compareTo(value) < 0) {
return false;
}
} catch (ClassCastException cce) {
if (wantsCCE) {
throw cce;
}
return false;
}
return true;
}
private Comparable getMinimumAsBig() {
return minAsBig;
}
private Comparable getMaximumAsBig() {
return maxAsBig;
}
}