Language Version: | ActionScript 3.0 |
Runtime Versions: | Flash Player 9, AIR 1.1 |
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.
public var decimalSeparatorFrom:String
Language Version: | ActionScript 3.0 |
Runtime Versions: | Flash Player 9, AIR 1.1 |
Decimal separator character to use
when parsing an input String.
The default value is ".".
public var decimalSeparatorTo:String
Language Version: | ActionScript 3.0 |
Runtime Versions: | Flash Player 9, AIR 1.1 |
Decimal separator character to use
when outputting formatted decimal numbers.
The default value is ".".
public var isValid:Boolean = false
Language Version: | ActionScript 3.0 |
Runtime Versions: | Flash Player 9, AIR 1.1 |
If true
, the format succeeded,
otherwise it is false
.
public var thousandsSeparatorFrom:String
Language Version: | ActionScript 3.0 |
Runtime Versions: | Flash Player 9, AIR 1.1 |
Character to use as the thousands separator
in the input String.
The default value is ",".
public var thousandsSeparatorTo:String
Language Version: | ActionScript 3.0 |
Runtime Versions: | Flash Player 9, AIR 1.1 |
Character to use as the thousands separator
in the output String.
The default value is ",".
public function NumberBase(decimalSeparatorFrom:String = ".", thousandsSeparatorFrom:String = ",", decimalSeparatorTo:String = ".", thousandsSeparatorTo:String = ",")
Language Version: | ActionScript 3.0 |
Runtime Versions: | Flash Player 9, AIR 1.1 |
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.
|
public function expandExponents(value:String):String
Language Version: | ActionScript 3.0 |
Runtime Versions: | Flash Player 9, AIR 1.1 |
Formats a number in exponent notation, into
a number in decimal notation.
Parameters
| value:String — String to process in exponent notation.
|
Returns public function formatDecimal(value:String):String
Language Version: | ActionScript 3.0 |
Runtime Versions: | Flash Player 9, AIR 1.1 |
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.
|
public function formatNegative(value:String, useSign:Boolean):String
Language Version: | ActionScript 3.0 |
Runtime Versions: | Flash Player 9, AIR 1.1 |
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 public function formatPrecision(value:String, precision:int):String
Language Version: | ActionScript 3.0 |
Runtime Versions: | Flash Player 9, AIR 1.1 |
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 public function formatRounding(value:String, roundType:String):String
Language Version: | ActionScript 3.0 |
Runtime Versions: | Flash Player 9, AIR 1.1 |
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.
|
ReturnsSee also
public function formatRoundingWithPrecision(value:String, roundType:String, precision:int):String
Language Version: | ActionScript 3.0 |
Runtime Versions: | Flash Player 9, AIR 1.1 |
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.
|
ReturnsSee also
public function formatThousands(value:String):String
Language Version: | ActionScript 3.0 |
Runtime Versions: | Flash Player 9, AIR 1.1 |
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 public function parseNumberString(str:String):String
Language Version: | ActionScript 3.0 |
Runtime Versions: | Flash Player 9, AIR 1.1 |
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.
|