Package com.inductiveautomation.ignition.common.util

Class ScientificNumberFormat

java.lang.Object

java.text.Format

java.text.NumberFormat

com.inductiveautomation.ignition.common.util.ScientificNumberFormat

All Implemented Interfaces:

Serializable, Cloneable

public class ScientificNumberFormat
extends NumberFormat

A number format that will switch between a "small" and "large" format depending on the magnitude of the value. If the magnitude of the to-be-formatted value is below a settable threshold, then the small format will be used. Otherwise, and if the value is exactly equal to 0.0, the large format will be used.

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class java.text.NumberFormat

NumberFormat.Field, NumberFormat.Style

Field Summary

Fields inherited from class java.text.NumberFormat

FRACTION_FIELD, INTEGER_FIELD

Constructor Summary

Constructors

Constructor	Description
ScientificNumberFormat()	Creates a Scientific number format with 10 significant digits and a threshold of 0.0001
ScientificNumberFormat(int significantDigits, double threshold)	Creates a scientific number format with any number of significant digits and a custom threshold
ScientificNumberFormat(String largeFormat, String smallFormat, double threshold)	Creates a scientific number format with custom large and small formats

Method Summary

Modifier and Type	Method	Description
JFormattedTextField	createEditor()	Creates an editor that uses this formatter as its decimal format
StringBuffer	format(double number, StringBuffer toAppendTo, FieldPosition pos)
StringBuffer	format(long number, StringBuffer toAppendTo, FieldPosition pos)
static ScientificNumberFormat	getShared()
Number	parse(String source, ParsePosition parsePosition)

Methods inherited from class java.text.NumberFormat

clone, equals, format, format, format, getAvailableLocales, getCompactNumberInstance, getCompactNumberInstance, getCurrency, getCurrencyInstance, getCurrencyInstance, getInstance, getInstance, getIntegerInstance, getIntegerInstance, getMaximumFractionDigits, getMaximumIntegerDigits, getMinimumFractionDigits, getMinimumIntegerDigits, getNumberInstance, getNumberInstance, getPercentInstance, getPercentInstance, getRoundingMode, hashCode, isGroupingUsed, isParseIntegerOnly, parse, parseObject, setCurrency, setGroupingUsed, setMaximumFractionDigits, setMaximumIntegerDigits, setMinimumFractionDigits, setMinimumIntegerDigits, setParseIntegerOnly, setRoundingMode

Methods inherited from class java.text.Format

format, formatToCharacterIterator, parseObject

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Details

ScientificNumberFormat

public ScientificNumberFormat()

Creates a Scientific number format with 10 significant digits and a threshold of 0.0001

ScientificNumberFormat

public ScientificNumberFormat(int significantDigits,
 double threshold)

Creates a scientific number format with any number of significant digits and a custom threshold

ScientificNumberFormat

public ScientificNumberFormat(String largeFormat,
 String smallFormat,
 double threshold)

Creates a scientific number format with custom large and small formats

Method Details

getShared

public static ScientificNumberFormat getShared()

format

public StringBuffer format(double number,
 StringBuffer toAppendTo,
 FieldPosition pos)

Specified by:

format in class NumberFormat

format

public StringBuffer format(long number,
 StringBuffer toAppendTo,
 FieldPosition pos)

Specified by:

format in class NumberFormat

parse

public Number parse(String source,
 ParsePosition parsePosition)

Specified by:

parse in class NumberFormat

createEditor

public JFormattedTextField createEditor()

Creates an editor that uses this formatter as its decimal format