| Пакет | mx.formatters |
| Класс | public class CurrencyFormatter |
| Наследование | CurrencyFormatter  Formatter Object |
| Язык версии: | ActionScript 3.0 |
| Версия продукта: | Flex 3 |
| Версии среды выполнения: | Flash Player 9, AIR 1.1 |
 | Начиная с Flex 4.5, Adobe рекомендует вместо этого класса использовать класс spark.formatters.CurrencyFormatter. |
Класс CurrencyFormatter форматирует допустимое число в качестве значения валюты. Он регулирует округление десятичных чисел и его точность, тысячный разделитель и знак минуса для отрицательных чисел; кроме того, он добавляет символ валюты. Символ валюты размещается слева или справа от значения с помощью свойства
alignSymbol. Символ валюты может включать несколько символов, в том числе пробелы.
В случае ошибки возвращается пустая строка, а строка с описанием ошибки сохраняется в свойстве error. Свойство error может иметь одно из следующих значений:
-
Invalid valueозначает, что методуformat()было передано недопустимое числовое значение. Значение должно являться допустимым числом в виде номера или строки. -
Invalid formatозначает, что один из параметров содержит недопустимое значение.
Показать синтаксис MXML
Скрыть синтаксис MXMLThe <mx:CurrencyFormatter> tag
inherits all of the tag attributes of its superclass,
and adds the following tag attributes:
<mx:CurrencyFormatter
alignSymbol="left|right"
currencySymbol="$"
decimalSeparatorFrom="."
decimalSeparatorTo="."
precision="-1"
rounding="none|up|down|nearest"
thousandsSeparatorFrom=","
thousandsSeparatorTo=","
useNegativeSign="true|false"
useThousandsSeparator="true|false"
/>
Связанные элементы API
| Свойство | Определено | ||
|---|---|---|---|
| alignSymbol : String
Помещает символ валюты слева или справа от отформатированного значения. | CurrencyFormatter | ||
 | constructor : Object
Ссылка на объект класса или функцию конструктора для данного экземпляра объекта. | Object | |
| currencySymbol : String
Символ, который будет использоваться в качестве символа валюты для отформатированного числа. | CurrencyFormatter | ||
| decimalSeparatorFrom : String
Символ десятичного разделителя, который будет использоваться при анализе входной строки. | CurrencyFormatter | ||
| decimalSeparatorTo : String
Символ десятичного разделителя, который будет использоваться при выводе отформатированных десятичных чисел. | CurrencyFormatter | ||
| error : String
Описание, сохраняемое средством форматирования при появлении ошибки. | Formatter | |
| precision : Object
Количество десятичных разрядов для включения в выводимую строку. | CurrencyFormatter | ||
| rounding : String
Способ округления числа. | CurrencyFormatter | ||
| thousandsSeparatorFrom : String
Символ для использования в качестве тысячного разделителя во входной строке. | CurrencyFormatter | ||
| thousandsSeparatorTo : String
Символ для использования в качестве тысячного разделителя в выводимой строке. | CurrencyFormatter | ||
| useNegativeSign : Object
Если значение true, отрицательное число форматируется путем прибавления перед ним знака минуса «-». | CurrencyFormatter | ||
| useThousandsSeparator : Object
Если значение true, число разбивается на тысячи с помощью символа разделителя. | CurrencyFormatter | ||
| Метод | Определено | ||
|---|---|---|---|
Конструктор. | CurrencyFormatter | ||
[переопределить]
Форматирует значение value в качестве валюты. | CurrencyFormatter | ||
|
Показывает, определено ли заданное свойство для объекта. | Object | |
|
Показывает, есть ли экземпляр класса Object в цепи прототипов объекта, заданного в качестве параметра. | Object | |
|
Показывает наличие заданного свойства и его перечисляемость. | Object | |
|
Задает доступность динамического свойства для операций цикла. | Object | |
|
Возвращает строковое представление этого объекта, отформатированного в соответствии со стандартами, принятыми для данной локали. | Object | |
|
Возвращает строковое представление заданного объекта. | Object | |
|
Возвращает элементарное значение заданного объекта. | Object | |
alignSymbol | свойство |
alignSymbol:String| Язык версии: | ActionScript 3.0 |
| Версия продукта: | Flex 3 |
| Версии среды выполнения: | Flash Player 9, AIR 1.1 |
Помещает символ валюты слева или справа от отформатированного значения. Допустимыми являются значения left и right.
Значением по умолчанию является "left".
Реализация
public function get alignSymbol():String public function set alignSymbol(value:String):voidcurrencySymbol | свойство |
currencySymbol:String| Язык версии: | ActionScript 3.0 |
| Версия продукта: | Flex 3 |
| Версии среды выполнения: | Flash Player 9, AIR 1.1 |
Символ, который будет использоваться в качестве символа валюты для отформатированного числа. В качестве символа валюты можно использовать один или несколько символов, например «$» или «YEN». Можно также использовать пробелы между символом валюты и отформатированным числом. Если число является отрицательным, символ валюты отображается между этим числом и знаком «минус» или между круглыми скобками.
Значением по умолчанию является "$".
Реализация
public function get currencySymbol():String public function set currencySymbol(value:String):voiddecimalSeparatorFrom | свойство |
decimalSeparatorFrom:String| Язык версии: | ActionScript 3.0 |
| Версия продукта: | Flex 3 |
| Версии среды выполнения: | Flash Player 9, AIR 1.1 |
Символ десятичного разделителя, который будет использоваться при анализе входной строки.
Значением по умолчанию является ".".
Реализация
public function get decimalSeparatorFrom():String public function set decimalSeparatorFrom(value:String):voiddecimalSeparatorTo | свойство |
decimalSeparatorTo:String| Язык версии: | ActionScript 3.0 |
| Версия продукта: | Flex 3 |
| Версии среды выполнения: | Flash Player 9, AIR 1.1 |
Символ десятичного разделителя, который будет использоваться при выводе отформатированных десятичных чисел.
Значением по умолчанию является ".".
Реализация
public function get decimalSeparatorTo():String public function set decimalSeparatorTo(value:String):voidprecision | свойство |
precision:Object| Язык версии: | ActionScript 3.0 |
| Версия продукта: | Flex 3 |
| Версии среды выполнения: | Flash Player 9, AIR 1.1 |
Количество десятичных разрядов для включения в выводимую строку. Корректировку точности можно деактивировать путем установки значения -1. Если установлено значение -1, точность не изменяется. Так, при вводе значения 1,453 и установке значения для rounding на NumberBaseRoundType.NONE, программа возвращает значение 1,453. Если для свойства precision установлено значение -1 и указан определенный тип округления, программа возвращает значение, исходя из этого типа округления.
Значением по умолчанию является -1.
Реализация
public function get precision():Object public function set precision(value:Object):voidrounding | свойство |
rounding:String| Язык версии: | ActionScript 3.0 |
| Версия продукта: | Flex 3 |
| Версии среды выполнения: | Flash Player 9, AIR 1.1 |
Способ округления числа. В ActionScript возможными значениями являются NumberBaseRoundType.NONE, NumberBaseRoundType.UP, NumberBaseRoundType.DOWN или NumberBaseRoundType.NEAREST. В MXML возможными значениями являются none, up, down или nearest.
Значением по умолчанию является NumberBaseRoundType.NONE.
Реализация
public function get rounding():String public function set rounding(value:String):voidСвязанные элементы API
thousandsSeparatorFrom | свойство |
thousandsSeparatorFrom:String| Язык версии: | ActionScript 3.0 |
| Версия продукта: | Flex 3 |
| Версии среды выполнения: | Flash Player 9, AIR 1.1 |
Символ для использования в качестве тысячного разделителя во входной строке.
Значением по умолчанию является ",".
Реализация
public function get thousandsSeparatorFrom():String public function set thousandsSeparatorFrom(value:String):voidthousandsSeparatorTo | свойство |
thousandsSeparatorTo:String| Язык версии: | ActionScript 3.0 |
| Версия продукта: | Flex 3 |
| Версии среды выполнения: | Flash Player 9, AIR 1.1 |
Символ для использования в качестве тысячного разделителя в выводимой строке.
Значением по умолчанию является ",".
Реализация
public function get thousandsSeparatorTo():String public function set thousandsSeparatorTo(value:String):voiduseNegativeSign | свойство |
useNegativeSign:Object| Язык версии: | ActionScript 3.0 |
| Версия продукта: | Flex 3 |
| Версии среды выполнения: | Flash Player 9, AIR 1.1 |
Если значение true, отрицательное число форматируется путем добавления перед ним знака минуса «-». Если значение false, число форматируется путем заключения в круглые скобки, например (400).
Значением по умолчанию является true.
Реализация
public function get useNegativeSign():Object public function set useNegativeSign(value:Object):voiduseThousandsSeparator | свойство |
useThousandsSeparator:Object| Язык версии: | ActionScript 3.0 |
| Версия продукта: | Flex 3 |
| Версии среды выполнения: | Flash Player 9, AIR 1.1 |
Если значение true, число разбивается на тысячи с помощью символа разделителя.
Значением по умолчанию является true.
Реализация
public function get useThousandsSeparator():Object public function set useThousandsSeparator(value:Object):voidCurrencyFormatter | () | Конструктор |
public function CurrencyFormatter()| Язык версии: | ActionScript 3.0 |
| Версия продукта: | Flex 3 |
| Версии среды выполнения: | Flash Player 9, AIR 1.1 |
Конструктор.
format | () | метод |
override public function format(value:Object):String| Язык версии: | ActionScript 3.0 |
| Версия продукта: | Flex 3 |
| Версии среды выполнения: | Flash Player 9, AIR 1.1 |
Форматирует значение value в качестве валюты. Если отформатировать значение value невозможно, возвращает пустую строку и записывает описание ошибки в свойство error.
Параметры
value:Object — Значение для форматирования.
|
String — Отформатированная строка. В случае ошибки эта строка будет пустой.
|
<?xml version="1.0" encoding="utf-8"?>
<!-- Simple example to demonstrate the CurrencyFormatter. -->
<s:Application xmlns:fx="http://ns.adobe.com/mxml/2009"
xmlns:s="library://ns.adobe.com/flex/spark"
xmlns:mx="library://ns.adobe.com/flex/mx">
<fx:Script>
<![CDATA[
import mx.events.ValidationResultEvent;
private var vResult:ValidationResultEvent;
// Event handler to validate and format input.
private function Format():void {
vResult = numVal.validate();
if (vResult.type==ValidationResultEvent.VALID) {
var temp:Number = Number(priceUS.text);
formattedUSPrice.text = usdFormatter.format(temp);
} else {
formattedUSPrice.text = "";
}
}
]]>
</fx:Script>
<fx:Declarations>
<mx:CurrencyFormatter id="usdFormatter" precision="2"
currencySymbol="$" decimalSeparatorFrom="."
decimalSeparatorTo="." useNegativeSign="true"
useThousandsSeparator="true" alignSymbol="left"/>
<mx:NumberValidator id="numVal" source="{priceUS}" property="text"
allowNegative="true" domain="real"/>
</fx:Declarations>
<s:Panel title="CurrencyFormatter Example"
width="75%" height="75%"
horizontalCenter="0" verticalCenter="0">
<mx:Form left="10" right="10" top="10" bottom="10">
<mx:FormItem label="Enter U.S. dollar amount:">
<s:TextInput id="priceUS" text="" width="50%"/>
</mx:FormItem>
<mx:FormItem label="Formatted amount: ">
<s:TextInput id="formattedUSPrice" text="" width="50%" editable="false"/>
</mx:FormItem>
<mx:FormItem>
<s:Button label="Validate and Format" click="Format();"/>
</mx:FormItem>
</mx:Form>
</s:Panel>
</s:Application>
Tue Jun 12 2018, 11:34 AM Z