CurrencyFormatter  - AS3

Имя фактического идентификатора локали, используемого этим объектом CurrencyFormatter.

В зависимости от операционной системы и значения параметра requestedLocaleIDName, передаваемого конструктору CurrencyFormatter(), имя может иметь одно из трех значений.

1. Если запрашиваемая локаль не является LocaleID.DEFAULT и поддерживается операционной системой, тогда возвращаемое имя совпадает со значением свойства requestedLocaleIDName.
2. Если константа LocaleID.DEFAULT использована в качестве значения параметра requestedLocaleIDName конструктора, то используется имя текущей локали, заданной в операционной системе пользователя. Значение LocaleID.DEFAULT сохраняет настройку ОС, заданную пользователем. Передача явного значения в качестве параметра requestedLocaleIDName не обязательно дает тот же результат, что использование LocaleID.DEFAULT, даже если при этом используются одинаковые имена идентификатора локали. Пользователь мог задать в своей системе пользовательские настройки локали, и запрос явного имени идентификатора локали вместо использования константы LocaleID.DEFAULT в программе не позволит извлечь эти пользовательские настройки.
3. Если система не поддерживает имя requestedLocaleIDName, определенное в конструкторе, то используется резервное имя идентификатора локали.

Связанные элементы API

Трехбуквенный код ISO 4217 для фактически использованной локали.

Этот код используется для определения символа ли строки валюты при форматировании денежных сумм с помощью метода format() с параметром withCurrencySymbol, которому задано значение false.

Это свойство инициализируется конструктором, исходя из фактически используемой локали. В случае использования резервной локали это свойство отражает предпочитаемый код валюты по умолчанию для резервной локали.

Значением по умолчанию является dependent on the actual locale and operating system.

Связанные элементы API

Символ или строка валюты для фактически используемой локали.

Это свойство используется для определения символа валюты при форматировании денежных сумм с помощью метода format() с параметром withCurrencySymbol, которому задано значение true.

Это свойство инициализируется конструктором, исходя из фактически используемой локали. В случае использования резервной локали это свойство отражает предпочитаемый символ валюты по умолчанию для резервной локали.

Значением по умолчанию является dependent on the actual locale and operating system.

Связанные элементы API

Символ-разделитель десятичной дроби, используемый для форматирования или анализа денежных сумм с дробной частью.

Это свойство изначально задается на основе локали, выбранной при создании объекта NumberFormatter.

Когда этому свойству задано значение и отсутствуют ошибки или предупреждения, свойству lastOperationStatus задается значение:

• LastOperationStatus.NO_ERROR

В противном случае в качестве значения свойства lastOperationStatus задается одна из констант, определенных в классе LastOperationStatus.

Значением по умолчанию является dependent on the actual locale and operating system.

Связанные элементы API

Определяет набор цифровых символов, используемых при форматировании денежных сумм.

В различных языках и регионах используются разные символы для представления цифр 0—9. Это свойство определяет используемый набор цифр.

Значение этого свойства представляет значение Юникод для обозначения нуля в десятичном наборе цифр. Действительные значения для этого свойства определены в классе NationalDigitsType.

Когда этому свойству задано значение и отсутствуют ошибки или предупреждения, свойству lastOperationStatus задается значение:

• LastOperationStatus.NO_ERROR

В противном случае в качестве значения свойства lastOperationStatus задается одна из констант, определенных в классе LastOperationStatus.

Значением по умолчанию является dependent on the actual locale and operating system.

Связанные элементы API

Максимальное число цифр, которые могут отображаться после десятичного разделителя.

Числа округляются до указанного в этом свойстве количества знаков. Схема округления варьируется в зависимости от операционной системы пользователя.

Когда свойство trailingZeros имеет значение true, дробная часть числа (после запятой) дополняется нулями, чтобы ее длина соответствовала значению данного свойства fractionalDigits.

Когда этому свойству задано значение и отсутствуют ошибки или предупреждения, свойству lastOperationStatus задается значение:

• LastOperationStatus.NO_ERROR

В противном случае в качестве значения свойства lastOperationStatus задается одна из констант, определенных в классе LastOperationStatus.

Значением по умолчанию является 0.

Связанные элементы API

Описывает размещение разделителей группировки в пределах отформатированной строки денежной суммы.

Когда свойство useGrouping имеет значение true, свойство groupingPattern используется для определения местоположения разделителя группировки и используемого шаблона.

Шаблон группировки определяется как строка, содержащая числа, разделенные точкой с запятой и в некоторых случаях может оканчиваться звездочкой. Например: "3;2;*". Каждое число в строке представляет собой количество цифр в группе. Разделитель группировки помещается перед каждой группой цифр. Звездочка в конце строки обозначает, что группы с этим числом цифр должны повторяться до конца отформатированной строки. Если звездочки нет, то в оставшейся части отформатированной строки нет дополнительных групп или символов.

Первое число в строке соответствует первой группе цифр слева от десятичного разделителя. Последующие числа определяют количество цифр в следующих группах слева. Таким образом строка «3;2;*» обозначает, что разделитель группировки ставится после первой группы из 3 цифр, за которой следует группы из 2 цифр. Например: 98,76,54,321

В следующей таблице приводятся примеры форматирования денежной суммы 123456789,12 с различными шаблонами группировки. В качестве символа группировки используется запятая, десятичный разделитель — точка, символ валюты — знак доллара ($).

Можно определить лишь ограниченное число размеров группировки. В одних операционных системах шаблоны группировки могут содержать только два числа и звездочку. Другие операционные системы могут поддерживать до четырех чисел и звездочку. Когда речь идет о шаблонах без звездочки, одни операционные системы поддерживают только одно число, а другие до трех чисел. Если превышено максимальное число элементов группировки, то лишние элементы игнорируются, в свойству lastOperationStatus задается значение, как описано ниже.

Когда этому свойству задано значение и отсутствуют ошибки или предупреждения, свойству lastOperationStatus задается значение:

• LastOperationStatus.NO_ERROR

В противном случае в качестве значения свойства lastOperationStatus задается одна из констант, определенных в классе LastOperationStatus.

Связанные элементы API

Символ или строка, используемые в качестве разделителя группировки.

Значение этого свойства используется в качестве разделителя группировки при форматировании денежных сумм, когда свойство useGrouping имеет значение true. Это свойство изначально задается на основе локали, выбранной при создании объекта NumberFormatter.

Когда этому свойству задано значение и отсутствуют ошибки или предупреждения, свойству lastOperationStatus задается значение:

• LastOperationStatus.NO_ERROR

В противном случае в качестве значения свойства lastOperationStatus задается одна из констант, определенных в классе LastOperationStatus.

Значением по умолчанию является dependent on the actual locale and operating system.

Связанные элементы API

Состояние самой последней операции, выполненной этим объектом CurrencyFormatter. Свойство lastOperationStatus задается каждый раз при вызове конструктора или метода этого класса или при задании значения для другого свойства. Другие возможные значения см. в описании соответствующего метода.

Связанные элементы API

Определяет, включается ли начальный нуль в отформатированную денежную сумму, если слева от десятичного разделителя нет целых чисел.

Когда это свойство имеет значение true начальный нуль добавляется слева от десятичного разделителя при форматировании числовых значений в диапазоне от -1.0 до 1.0. Когда это свойство имеет значение false, начальный нуль не добавляется.

Например, если форматируется денежная сумма 0,321 и это свойство имеет значение true, тогда в отформатированную строку включается начальный нуль. Если свойство имеет значение false, то начальный нуль не включается. В этом случае строка будет содержать только десятичный разделитель и дробную часть: $.321.

В следующей таблице приводятся примеры форматирования денежных сумм на основе значений этого свойства, а также связанных свойств fractionalDigits и trailingZeros.

Когда этому свойству задано значение и отсутствуют ошибки или предупреждения, свойству lastOperationStatus задается значение:

• LastOperationStatus.NO_ERROR

В противном случае в качестве значения свойства lastOperationStatus задается одна из констант, определенных в классе LastOperationStatus.

Значением по умолчанию является dependent on the actual locale and operating system.

Связанные элементы API

Числовое значение, которое обозначает шаблон форматирования для отрицательных денежных сумм. Этот шаблон определяет местоположение символа валюты и отрицательного символа или круглых скобок относительно числовой части денежной суммы.

В качестве значения этого свойства должна использоваться одна из констант, определенная в таблице ниже.

В приведенной ниже таблице перечислены возможные шаблоны форматирования для отрицательных денежных сумм. Когда денежная сумма форматируется с помощью метода format():

• вместо символа «¤» подставляется значение свойства currencyISOCode или currencySymbol в зависимости от значения параметра withCurrencySymbol, переданного методу format();
• вместо символа «-» подставляется значение свойства negativeNumberSymbol;
• вместо символа «n» подставляется денежная сумма, переданная методу format().

Когда этому свойству задано значение и отсутствуют ошибки или предупреждения, свойству lastOperationStatus задается значение:

• LastOperationStatus.NO_ERROR

В противном случае в качестве значения свойства lastOperationStatus задается одна из констант, определенных в классе LastOperationStatus.

Значением по умолчанию является dependent on the actual locale and operating system.

Связанные элементы API

Отрицательный символ, используемый при форматировании отрицательных денежных сумм.

Этот символ используется вместе с форматом отрицательных денежных сумм при форматировании сумм, которые меньше нуля. Он не используется в форматах отрицательных денежных сумм, которые не включают отрицательный символ (например, когда отрицательные суммы заключены в круглые скобки).

Когда этому свойству задано значение и отсутствуют ошибки или предупреждения, свойству lastOperationStatus задается значение:

• LastOperationStatus.NO_ERROR

В противном случае в качестве значения свойства lastOperationStatus задается одна из констант, определенных в классе LastOperationStatus.

Значением по умолчанию является dependent on the actual locale and operating system.

Связанные элементы API

Числовое значение, которое обозначает шаблон форматирования для положительных денежных сумм. Этот формат определяет местоположение символа валюты относительно числовой части денежной суммы.

В качестве значения этого свойства должна использоваться одна из констант, определенная в таблице ниже.

В приведенной ниже таблице перечислены возможные шаблоны форматирования для положительных денежных сумм. Когда денежная сумма форматируется с помощью метода format():

• вместо символа «¤» подставляется значение свойства currencyISOCode или currencySymbol в зависимости от значения параметра withCurrencySymbol, переданного методу format();
• вместо символа «n» подставляется денежная сумма, переданная методу format().

Когда этому свойству задано значение и отсутствуют ошибки или предупреждения, свойству lastOperationStatus задается значение:

• LastOperationStatus.NO_ERROR

В противном случае в качестве значения свойства lastOperationStatus задается одна из констант, определенных в классе LastOperationStatus.

Значением по умолчанию является dependent on the actual locale and operating system.

Связанные элементы API

Имя запрашиваемого идентификатора локали, переданного конструктору этого объекта CurrencyFormatter.

Если использовано значение LocaleID.DEFAULT, возвращается имя i-default. Локаль, использованная на самом деле, может отличаться от запрашиваемой, когда применяется резервная локаль. Имя фактической локали можно получить с помощью свойства actualLocaleIDName.

Связанные элементы API

Определяет, добавляются ли нули в конце форматируемой денежной суммы.

Когда это свойство имеет значение true, в конце дробной части отформатированного числа добавляются нули, чтобы его длина соответствовала ограничению, определенному в свойстве fractionalDigits. Когда это свойство имеет значение false, нули в конце числа не отображаются.

Например, если форматируется денежная сумма 123,4, это свойство имеет значение true, а свойству fractionalDigits задано значение 3, в конце отформатированной строки будут отображаться нули: $123,400. Если же это свойство имеет значение false, нули в конце строки не добавляются, и после десятичного разделителя отображаются только ненулевые цифры: $123,4.

В следующей таблице приводятся примеры форматирования денежных сумм на основе значений этого свойства, а также связанных свойств fractionalDigits и leadingZero.

Когда этому свойству задано значение и отсутствуют ошибки или предупреждения, свойству lastOperationStatus задается значение:

• LastOperationStatus.NO_ERROR

В противном случае в качестве значения свойства lastOperationStatus задается одна из констант, определенных в классе LastOperationStatus.

Значением по умолчанию является dependent on the actual locale and operating system.

Связанные элементы API

Позволяет использовать разделитель группировки при форматировании денежных сумм.

Когда свойство useGrouping имеет значение true, цифры группируются и разделяются с использованием символа-разделителя группировки. Например, $123,456,789

Когда свойство useGrouping имеет значение false, цифры не группируются и не разделяются. Например, ;123456789

Свойство groupingSeparator определяет символ, который должен использоваться в качестве разделителя группировки. Свойство groupingPattern определяет количество цифр между разделителями группировки.

Когда этому свойству задано значение и отсутствуют ошибки или предупреждения, свойству lastOperationStatus задается значение:

• LastOperationStatus.NO_ERROR

В противном случае в качестве значения свойства lastOperationStatus задается одна из констант, определенных в классе LastOperationStatus.

Связанные элементы API

Создает новый объект CurrencyFormatter, чтобы отформатировать числа, представляющие денежные суммы в соответствии с правилами данной локали.

Этот конструктор определяет, поддерживает ли текущая операционная система запрашиваемое имя идентификатора локали. Если она не поддерживается, будет использована резервная локаль. Если использована резервная локаль, свойство lastOperationStatus указывает тип резервного значения, а свойство actualLocaleIDName содержит имя резервного идентификатора локали.

Значения определенных свойств, такие как currencySymbol и currencyISOCode, задаются автоматически, исходя из локали.

ПРИМЕЧАНИЕ. Когда используется резервная локаль, для свойств валюты задаются значения по умолчанию, в результате чего свойство currencySymbol или currencyISOCode может получить неожиданное значение. Рекомендуется проверить значения свойств currencySymbol и currencyISOCode, прежде чем форматировать денежную сумму.

Чтобы задать форматирование в соответствии с текущими пользовательскими настройками операционной системы, необходимо передать значение LocaleID.DEFAULT в параметре requestedLocaleIDName конструктора.

Когда конструктор вызывается и успешно создает объект, свойство lastOperationStatus получает значение:

• LastOperationStatus.NO_ERROR

Когда запрашиваемое имя идентификатора языкового стандарта недоступно, lastOperationStatus получает одно из следующих значений:

• LastOperationStatus.USING_FALLBACK_WARNING
• LastOperationStatus.USING_DEFAULT_WARNING

В противном случае в качестве значения свойства lastOperationStatus задается одна из констант, определенных в классе LastOperationStatus.

Дополнительные сведения о перечисленных выше предупреждениях и других возможных значениях свойства lastOperationStatus см. в описании класса LastOperationStatus.

Связанные элементы API

Создается строка, которая представляет денежную сумму, отформатированную в соответствии с текущими свойствами данного объекта CurrencyFormatter, включая локаль, символ валюты и код валюты ISO.

По умолчанию этот метод использует свойство currencyISOCode для определения символ и другие настройки валюты, используемые при форматировании.

Во многих странах и регионах одинаковые символы валюты используются для обозначения разных денежных единиц. Например, в Соединенных Штатах, Австралии, Новой Зеландии, Канаде и Мексике используется один и тот же знак доллара ($) для обозначения местной валюты. Когда форматируемая валюта отличается от местной валюты пользователя, лучше использовать код ISO для обозначения валюты Можно вызвать метод formattingWithCurrencySymbolIsSafe(), чтобы проверить совпадает ли код ISO форматируемой валюты со свойством currencyISOCode объекта CurrencyFormatter.

Этот метод позволяет форматировать как очень большие, так и очень малые числа. Однако число знаков ограничивается пределами точности, установленными для типа данных объекта Number.

Параметры

Связанные элементы API

 
         var cf:CurrencyFormatter = new CurrencyFormatter("fr-CA");  
         
         trace(cf.actualLocaleIDName);               // "fr-CA"  
         trace(cf.currencyISOCode);                // "CAD"
         trace(cf.currencySymbol);                // "$"
         
         trace(cf.format(1254.56));                // "1 254,56 CAD"
         trace(cf.format(1254.56, true));            // "1 254,56 $"
         

 
         var cf:CurrencyFormatter = new CurrencyFormatter(LocaleID.DEFAULT);  
         
         if (cf.formattingWithCurrencySymbolIsSafe("CAD")) {
           trace(cf.actualLocaleIDName);     // "fr-CA French (Canada)"
           trace(cf.format(1254.56, false)); // "1 254,56 $"
         }
         else {
           trace(cf.actualLocaleIDName);     // "en-US English (USA)"
           cf.setCurrency("CAD", "C$")
           trace(cf.format(1254.56, true));  // "C$ 1,254.56"
         }
         

Определяет, может ли текущий заданный символ валюты использоваться при форматировании денежных сумм.

Во многих регионах и странах используются одинаковые символы валюты. Этот метод помогает предотвратить использование неоднозначного символа валюты либо неожиданного символа или кода ISO валюты в результате использования резервной локали.

Этот метод часто используется для определения того, следует отображать символ местной валюты (если сумма форматируется с использованием пользовательской валюты по умолчанию) или более точный код ISO (если сумма форматируется в валюте, отличной от используемой по умолчанию).

Этот метод сравнивает параметр requestedISOCode с текущим значением свойства currencyISOCode и возвращает true, если строки совпадают, и false, если не совпадают. Когда строки совпадают, использование метода format() с параметром withCurrencySymbol, которому задано значение true, приводит к тому, что отформатированная строка с денежной суммой будет содержать уникальный символ валюты для данной локали. Если этот метод возвращает значение false, то использование метода format() с параметром withCurrencySymbol, которому задано значение true, может привести к использованию неоднозначного или некорректного символа валюты.

Когда этот метод вызывается и успешно выполняется, свойство lastOperationStatus получает значение:

• LastOperationStatus.NO_ERROR

В противном случае в качестве значения свойства lastOperationStatus задается одна из констант, определенных в классе LastOperationStatus.

Параметры

Связанные элементы API

Перечисляет все имена идентификаторов локалей, поддерживаемые этим классом.

Если этот класс не поддерживается текущей операционной системой, данный метод возвращает нулевое значение.

Когда этот метод вызывается и успешно выполняется, свойство lastOperationStatus получает значение:

• LastOperationStatus.NO_ERROR

В противном случае в качестве значения свойства lastOperationStatus задается одна из констант, определенных в классе LastOperationStatus.

Анализирует строку, возвращая денежную сумму и символ валюты.

Алгоритм анализа использует значение свойства decimalSeparator, чтобы определить целую и дробную часть числа. Он использует значения свойств negativeCurrencyFormat и positiveCurrencyFormat, чтобы определить местоположение символа или строки валюты относительно денежной суммы. Для отрицательных сумм свойство negativeCurrencyFormat определяет местоположение отрицательного символа и необходимость использования круглых скобок.

Если порядок символа валюты, символа «-» и числа в введенной строке не соответствует шаблону, определенному свойствами negativeCurrencyFormat и positiveCurrencyFormat, тогда:

1. свойству value возвращенного объекта CurrencyParseResult задается значение NaN;
2. свойству currencyString возвращенного объекта CurrencyParseResult задается значение null;
3. свойству lastOperationStatus задается значение, указывающее на ошибку анализа.

Строка ввода может содержать пробелы, которые игнорируются в ходе анализа.

Анализ может успешно выполняться, даже если не указан символ валюты. Часть строки, соответствующая символу валюты, не проверяется. Если ввод не содержит символа или строки валюты, в качестве значения свойства currencyString возвращенного объекта CurrencyParseResult задается пустая строка.

Когда этот метод вызывается и успешно выполняется, свойство lastOperationStatus получает значение:

• LastOperationStatus.NO_ERROR

В противном случае в качестве значения свойства lastOperationStatus задается одна из констант, определенных в классе LastOperationStatus.

Параметры

Связанные элементы API

Задает свойства currencyISOCode и currencySymbol объекта CurrencyFormatter.

Когда этот метод вызывается и успешно выполняется, свойство lastOperationStatus получает значение:

• LastOperationStatus.NO_ERROR

В противном случае свойства currencyISOCode и currencySymbol не изменяются, а в качестве значения свойства lastOperationStatus задается одна из констант, определенных в классе LastOperationStatus.

Параметры

Связанные элементы API

В данном примере используются следующие локали:

• локаль операционной системы по умолчанию для форматирования денежных сумм (LocaleID.DEFAULT);
• японская (Япония);
• английская (США);
• французская (Франция).

Для каждой локали в списке выполняются следующие действия.

1. Создается объект CurrencyFormatter.
2. Метод formattingWithCurrencySymbolIsSafe() проверяет, является ли валютой локали по умолчанию Евро (EUR), и, если да, строка форматируется с использованием символа валюты. В противном случае строка форматируется с использованием кода ISO.

  
package {
    import flash.display.Sprite;
    import flash.globalization.CurrencyFormatter;
    import flash.globalization.LocaleID;
    
    public class CurrencyFormatterExample1 extends Sprite
    {
        public function CurrencyFormatterExample1():void
        {
            var cf:CurrencyFormatter;
            var amountWithSymbol:String;
            var amountWithISOCode:String
            
            var localeNames:Array = [LocaleID.DEFAULT, "ja-JP", "en-US", "fr-FR"];
            
            for each (var localeName:String in localeNames) 
            {
                cf = new CurrencyFormatter(localeName);
                
                trace('\n' + "LocaleID requested=" + cf.requestedLocaleIDName 
                    + "; actual=" + cf.actualLocaleIDName);
                
                trace("Last Operation Status: " + cf.lastOperationStatus );
                
                trace("Currency ISO Code: " + cf.currencyISOCode);
                
                if (cf.formattingWithCurrencySymbolIsSafe("EUR")) 
                {
                    amountWithSymbol = cf.format(123456789.19, true);
                    trace("Format using Symbol: "+ amountWithSymbol);
                }
                else 
                {
                    amountWithISOCode = cf.format(123456789.19); 
                    trace("Format using ISO Code: " + amountWithISOCode);
                }
            }
        }
    }
}

Выполняются следующие действия.

1. Создается объект CurrencyFormatter для английского языка (США).
2. Строка ввода анализируется с помощью метода parse().
3. Отображается денежная сумма со строкой валюты, полученная из объекта CurrencyParseResult.

 
package {
      import flash.display.Sprite;
      import flash.globalization.CurrencyFormatter;
      import flash.globalization.CurrencyParseResult;
      import flash.globalization.LastOperationStatus;
      import flash.globalization.LocaleID;

      public class CurrencyFormatterParseExample extends Sprite
      {
            public function CurrencyFormatterParseExample()
            {
                var cf:CurrencyFormatter = new CurrencyFormatter( "en_US" );
                
                trace("LocaleID requested=" + cf.requestedLocaleIDName 
                    + "; actual=" + cf.actualLocaleIDName);
                trace("Last Operation Status: " + cf.lastOperationStatus );

                var inputString:String = "Dollar 123,567,89,0.254";
                
                var result:CurrencyParseResult = cf.parse(inputString);
                
                if (cf.lastOperationStatus == LastOperationStatus.NO_ERROR ) {
                    trace("Amount value: " + result.value); 
                    trace("Currency string: " + result.currencyString); 
                }
            }
      }
}