Packagemx.formatters
Classpublic class NumberBase

The NumberBase class is a utility class that contains general number formatting capabilities, including rounding, precision, thousands formatting, and negative sign formatting. The implementation of the formatter classes use this class.

See also

mx.formatters.NumberFormatter
mx.formatters.NumberBaseRoundType


Public Properties
 PropertyDefined by
  decimalSeparatorFrom : String
Decimal separator character to use when parsing an input String.
NumberBase
  decimalSeparatorTo : String
Decimal separator character to use when outputting formatted decimal numbers.
NumberBase
  isValid : Boolean = false
If true, the format succeeded, otherwise it is false.
NumberBase
  thousandsSeparatorFrom : String
Character to use as the thousands separator in the input String.
NumberBase
  thousandsSeparatorTo : String
Character to use as the thousands separator in the output String.
NumberBase
Public Methods
 MethodDefined by
  
NumberBase(decimalSeparatorFrom:String = ".", thousandsSeparatorFrom:String = ",", decimalSeparatorTo:String = ".", thousandsSeparatorTo:String = ",")
Constructor.
NumberBase
  
formatDecimal(value:String):String
Formats a number by replacing the default decimal separator, ".", with the decimal separator specified by decimalSeparatorTo.
NumberBase
  
formatNegative(value:String, useSign:Boolean):String
Formats a negative number with either a minus sign (-) or parentheses ().
NumberBase
  
formatPrecision(value:String, precision:int):String
Formats a number by setting its decimal precision by using the decimalSeparatorTo property as the decimal separator.
NumberBase
  
formatRounding(value:String, roundType:String):String
Formats a number by rounding it.
NumberBase
  
formatRoundingWithPrecision(value:String, roundType:String, precision:int):String
Formats a number by rounding it and setting the decimal precision.
NumberBase
  
formatThousands(value:String):String
Formats a number by using the thousandsSeparatorTo property as the thousands separator and the decimalSeparatorTo property as the decimal separator.
NumberBase
  
parseNumberString(str:String):String
Extracts a number from a formatted String.
NumberBase
Property detail
decimalSeparatorFromproperty
public var decimalSeparatorFrom:String

Decimal separator character to use when parsing an input String.

The default value is ".".

decimalSeparatorToproperty 
public var decimalSeparatorTo:String

Decimal separator character to use when outputting formatted decimal numbers.

The default value is ".".

isValidproperty 
public var isValid:Boolean = false

If true, the format succeeded, otherwise it is false.

thousandsSeparatorFromproperty 
public var thousandsSeparatorFrom:String

Character to use as the thousands separator in the input String.

The default value is ",".

thousandsSeparatorToproperty 
public var thousandsSeparatorTo:String

Character to use as the thousands separator in the output String.

The default value is ",".

Constructor detail
NumberBase()constructor
public function NumberBase(decimalSeparatorFrom:String = ".", thousandsSeparatorFrom:String = ",", decimalSeparatorTo:String = ".", thousandsSeparatorTo:String = ",")

Constructor.

Parameters
decimalSeparatorFrom:String (default = ".") — Decimal separator to use when parsing an input String.
 
thousandsSeparatorFrom:String (default = ",") — Character to use as the thousands separator in the input String.
 
decimalSeparatorTo:String (default = ".") — Decimal separator character to use when outputting formatted decimal numbers.
 
thousandsSeparatorTo:String (default = ",") — Character to use as the thousands separator in the output String.
Method detail
formatDecimal()method
public function formatDecimal(value:String):String

Formats a number by replacing the default decimal separator, ".", with the decimal separator specified by decimalSeparatorTo.

Parameters
value:String — The String value of the Number (formatted American style ####.##).

Returns
String — String representation of the input where "." is replaced with the decimal formatting character.
formatNegative()method 
public function formatNegative(value:String, useSign:Boolean):String

Formats a negative number with either a minus sign (-) or parentheses ().

Parameters
value:String — Value to be formatted.
 
useSign:Boolean — If true, use a minus sign (-). If false, use parentheses ().

Returns
String — Formatted number.
formatPrecision()method 
public function formatPrecision(value:String, precision:int):String

Formats a number by setting its decimal precision by using the decimalSeparatorTo property as the decimal separator.

Parameters
value:String — Value to be formatted.
 
precision:int — Number of decimal points to use.

Returns
String — Formatted number.
formatRounding()method 
public function formatRounding(value:String, roundType:String):String

Formats a number by rounding it. The possible rounding types are defined by mx.formatters.NumberBaseRoundType.

Parameters
value:String — Value to be rounded.
 
roundType:String — The type of rounding to perform: NumberBaseRoundType.NONE, NumberBaseRoundType.UP, NumberBaseRoundType.DOWN, or NumberBaseRoundType.NEAREST.

Returns
String — Formatted number.

See also

formatRoundingWithPrecision()method 
public function formatRoundingWithPrecision(value:String, roundType:String, precision:int):String

Formats a number by rounding it and setting the decimal precision. The possible rounding types are defined by mx.formatters.NumberBaseRoundType.

Parameters
value:String — Value to be rounded.
 
roundType:String — The type of rounding to perform: NumberBaseRoundType.NONE, NumberBaseRoundType.UP, NumberBaseRoundType.DOWN, or NumberBaseRoundType.NEAREST.
 
precision:int — int of decimal places to use.

Returns
String — Formatted number.

See also

formatThousands()method 
public function formatThousands(value:String):String

Formats a number by using the thousandsSeparatorTo property as the thousands separator and the decimalSeparatorTo property as the decimal separator.

Parameters
value:String — Value to be formatted.

Returns
String — Formatted number.
parseNumberString()method 
public function parseNumberString(str:String):String

Extracts a number from a formatted String. Examines the String from left to right and returns the first number sequence. Ignores thousands separators and includes the decimal and numbers trailing the decimal.

Parameters
str:String — String to parse for the numeric value.

Returns
String — Value, which can be a decimal.