FloatFormatter.java

package org.eclipse.nebula.widgets.formattedtext;

import java.util.Locale;

/**
 * This class provides formatting of <code>Float</code> values in a
 * <code>FormattedText</code>.<p>
 * 
 * NumberFormatter returns different numeric types based on the current
 * value in the Text field. FloatFormatter is an override of NumberFormatter
 * allowing to guaranty to always return Float values (Number.floatValue()).
 */
public class FloatFormatter extends NumberFormatter {
  public FloatFormatter() {
		super();
	}

	public FloatFormatter(Locale loc) {
		super(loc);
	}

	public FloatFormatter(String editPattern, Locale loc) {
		super(editPattern, loc);
	}

	public FloatFormatter(String editPattern, String displayPattern, Locale loc) {
		super(editPattern, displayPattern, loc);
	}

	public FloatFormatter(String editPattern, String displayPattern) {
		super(editPattern, displayPattern);
	}

	public FloatFormatter(String editPattern) {
		super(editPattern);
	}

	/**
   * Returns the current value of the text control if it is a valid <code>Float</code>.
   * If the buffer is flagged as modified, the value is recalculated by parsing
   * with the <code>nfEdit</code> initialized with the edit pattern. If the
   * number is not valid, returns <code>null</code>.
   * 
   * @return current number value if valid, <code>null</code> else
   * @see ITextFormatter#getValue()
   */
	public Object getValue() {
		Object value = super.getValue();
		if ( value instanceof Number ) {
			return new Float(((Number) value).floatValue());
		}
		return super.getValue();
	}

	/**
   * Returns the type of value this {@link ITextFormatter} handles,
   * i.e. returns in {@link #getValue()}.<br>
   * A FloatFormatter always returns a Float value.
   * 
   * @return The value type.
   */
	public Class getValueType() {
		return Float.class;
	}
}