Class PTNumberFormatter

Object
   |
   +--PTNumberFormatter

class PTNumberFormatter

Utility class for formatting numbers.

Usage:	
 	var nf = new PTNumberFormatter(23.234);
 	nf.setCurrency(true)
 	nf.setCurrencySymbol('¥');
 	return nf.formatValue();
 

Field Detail

INVALID

<final> String INVALID

Constant representing an invalid number

See Also:

Constant Field Values

VERSION

<static> <final> Object VERSION

See Also:

Constant Field Values

PTNumberFormatter

PTNumberFormatter(num)

PTNumberFormatter Object constructor

Parameters:
num - The number to be formatted (number)

formatField

void formatField(field)

Convenience method which can be attached to the onBlur handler of a form field to validate and format the field's value

Parameters:
field - The form field to validate (INPUT type="text" element or TEXTAREA element)

formatValue

String formatValue(num)

Returns the number formatted according to the settings (a string)

Parameters:
num - Number to set before formatting, optional. (number)

Returns:
the formatted number string

setCurrency

void setCurrency(isCurrency)

Sets whether or not to display the number as currency

Parameters:
isCurrency - Whether or not to display the number as currency (boolean)

setCurrencySymbol

void setCurrencySymbol(symbol)

Sets the currency symbol

Parameters:
symbol - The currency symbol to set (string)

setCurrencySymbolBefore

void setCurrencySymbolBefore(showSymbolBefore)

Sets whether or not the currency symbol appears before the number

Parameters:
showSymbolBefore - Whether or not the currency symbol appears before the number (boolean)

setDecimalPlaces

void setDecimalPlaces(numDecimalPlaces)

Sets the precision of decimal places

Parameters:
numDecimalPlaces - The number of decimal places. Any number of places less than or equal to zero is considered zero. (integer)

setDecimalSeparator

void setDecimalSeparator(separator)

Sets the symbol that separates decimals

Parameters:
separator - Decimal separator symbol (string)

setGrouping

void setGrouping(showGroupingSeparator)

Sets whether or not to display the grouping separator

Parameters:
showGroupingSeparator - Whether or not to display the grouping separator (boolean)

setGroupingSeparator

void setGroupingSeparator(separator)

Sets the symbol that separates groupings

Parameters:
separator - Decimal separator symbol (string)

setNegativePrefix

void setNegativePrefix(symbol)

Sets the prefix symbol for negative numbers

Parameters:
symbol - Negative prefix symbol. Default is '-'. (string)

setNegativeSuffix

void setNegativeSuffix(symbol)

Sets the suffix symbol for negative numbers

Parameters:
symbol - Negative suffix symbol. Default is ''. (string)

setNumber

void setNumber(num)

Sets the number used by the formatter

Parameters:
num - The number to be formatted (number)

toFormatted

String toFormatted(number)

Formats a given number. Deprecated, use formatValue() instead

Parameters:
number - The number to format (number)

Returns:
the formatted number string

Deprecated Use formatValue instead

toUnformatted

Number toUnformatted()

Returns the number in its native unformatted form

Returns:
the unformatted number value

validateValue

Boolean validateValue(number)

Validates a number

Parameters:
number - The number to validate

Returns:
true if the value is a valid number that can be formatted