Apache Flex (FlexJS) 0.7.0 API Reference | All Packages | All Classes | Index | Frames No Frames |
CurrencyFormatter

Package | org.apache.flex.html.accessories
Class | public class CurrencyFormatter
Inheritance | CurrencyFormatter EventDispatcher flash.events.EventDispatcher
Implements | IFormatBead

Language Version : | ActionScript 3.0

Product Version : | FlexJS 0.0

Runtime Versions : | Flash Player 10.2, AIR 2.6

The CurrencyFormatter class formats a value in separated groups. The formatter listens to a property on a model and when the property changes, formats it and dispatches a formatChanged event.

Public Properties

| Property | Defined By
--- | --- | ---
|  | currencySymbol : String The currency symbol, such as "$" | CurrencyFormatter
|  | eventName : String The event dispatched by the model when the property changes. | CurrencyFormatter
|  | formattedString : String [read-only] The formatted string. | CurrencyFormatter
|  | fractionalDigits : int Number of digits after the decimal separator | CurrencyFormatter
|  | propertyName : String The name of the property on the model to format. | CurrencyFormatter
|  | strand : IStrand [write-only] The host component for this bead. | CurrencyFormatter

Public Methods

| Method | Defined By
--- | --- | ---
|  | CurrencyFormatter() constructor | CurrencyFormatter
|  | format(value:Object):String Computes the formatted string. | CurrencyFormatter

Property Detail

currencySymbol | property

`currencySymbol:String`

Language Version : | ActionScript 3.0

Product Version : | FlexJS 0.0

Runtime Versions : | Flash Player 10.2, AIR 2.6

The currency symbol, such as "$"

Implementation
`public function get currencySymbol():String`
`public function set currencySymbol(value:String):void`

eventName | property |

`eventName:String`

Language Version : | ActionScript 3.0

Product Version : | FlexJS 0.0

Runtime Versions : | Flash Player 10.2, AIR 2.6

The event dispatched by the model when the property changes. The default is propertyName+"Changed".

Implementation
`public function get eventName():String`
`public function set eventName(value:String):void`

formattedString | property |

`formattedString:String` [read-only]

Language Version : | ActionScript 3.0

Product Version : | FlexJS 0.0

Runtime Versions : | Flash Player 10.2, AIR 2.6

The formatted string.

Implementation
`public function get formattedString():String`

fractionalDigits | property |

`fractionalDigits:int`

Language Version : | ActionScript 3.0

Product Version : | FlexJS 0.0

Runtime Versions : | Flash Player 10.2, AIR 2.6

Number of digits after the decimal separator

Implementation
`public function get fractionalDigits():int`
`public function set fractionalDigits(value:int):void`

propertyName | property |

`propertyName:String`

Language Version : | ActionScript 3.0

Product Version : | FlexJS 0.0

Runtime Versions : | Flash Player 10.2, AIR 2.6

The name of the property on the model to format.

Implementation
`public function get propertyName():String`
`public function set propertyName(value:String):void`

strand | property |

`strand:IStrand` [write-only]

Language Version : | ActionScript 3.0

Product Version : | FlexJS 0.0

Runtime Versions : | Flash Player 10.2, AIR 2.6

The host component for this bead.

Implementation
`public function set strand(value:IStrand):void`
Constructor Detail

CurrencyFormatter | () | Constructor

`public function CurrencyFormatter()`

Language Version : | ActionScript 3.0

Product Version : | FlexJS 0.0

Runtime Versions : | Flash Player 10.2, AIR 2.6

constructor

Method Detail

format | () | method

`public function format(value:Object):String`

Language Version : | ActionScript 3.0

Product Version : | FlexJS 0.0

Runtime Versions : | Flash Player 10.2, AIR 2.6

Computes the formatted string.

Parameters

| `value:Object`

Returns

| `String`

Mon Sep 5 2016, 07:19 AM -07:00