Zimlet JavaScript API Reference - AjxNumberFormat

Class AjxNumberFormat




Defined in: AjxText.js.

Class Summary
Constructor Attributes Constructor Name and Description
 
AjxNumberFormat(pattern, skipNegFormat)
Number formatter based on Java's DecimalFormat.
Field Summary
Field Attributes Field Name and Description
<static>  
AjxNumberFormat.getNumberInstance
Get general number formatter.
Method Summary
Method Attributes Method Name and Description
<static>  
AjxNumberFormat.format(pattern, number)
Formats a number based on a given pattern.
 
format(number)
Formats a number.
<static>  
AjxNumberFormat.getCurrencyInstance()
Get currency number formatter.
<static>  
AjxNumberFormat.getInstance()
Get general number formatter.
<static>  
AjxNumberFormat.getIntegerInstance()
Get integer number formatter.
<static>  
AjxNumberFormat.getPercentInstance()
Get percent number formatter.
Class Detail
AjxNumberFormat(pattern, skipNegFormat)
Number formatter based on Java's DecimalFormat.
Parameters:
{string} pattern
The number pattern.
{boolean} skipNegFormat
Specifies whether to skip the generation of this format's negative value formatter.

Note: This parameter is only used by the implementation and should not be passed by application code instantiating a custom number format.

Field Detail
<static> {AjxNumberFormat} AjxNumberFormat.getNumberInstance
Get general number formatter. Note: Same as AjxNumberFormat.getInstance().
Method Detail
<static> {string} AjxNumberFormat.format(pattern, number)
Formats a number based on a given pattern. Equivalent to new AjxNumberFormat(pattern).format(number).
Parameters:
{string} pattern
The format pattern.
{number} number
The number to format.
Returns:
{string} The formatted number string.

{string} format(number)
Formats a number.
Parameters:
{number} number
The number to format.
Returns:
{string} The formatted number string.

<static> {AjxNumberFormat} AjxNumberFormat.getCurrencyInstance()
Get currency number formatter.
Returns:
{AjxNumberFormat} Number formatter.

<static> {AjxNumberFormat} AjxNumberFormat.getInstance()
Get general number formatter.
Returns:
{AjxNumberFormat} Number formatter.

<static> {AjxNumberFormat} AjxNumberFormat.getIntegerInstance()
Get integer number formatter.
Returns:
{AjxNumberFormat} Number formatter.

<static> {AjxNumberFormat} AjxNumberFormat.getPercentInstance()
Get percent number formatter.
Returns:
{AjxNumberFormat} Number formatter.

Documentation generated by JsDoc Toolkit 2.3.0 on Tue Jun 28 2016 21:01:30 GMT-0400 (EDT)