NumberFormatter  - AS3

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

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

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

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

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

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

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

• LastOperationStatus.NO_ERROR

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

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

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

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

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

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

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

• LastOperationStatus.NO_ERROR

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

Значением по умолчанию является dependent on the 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 locale and operating system..

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

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

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

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

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

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

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

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

• LastOperationStatus.NO_ERROR

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

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

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

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

В следующей таблице сведены все возможные форматы отрицательных чисел. При форматировании отрицательного числа знак «-» в шаблоне заменяется значением свойства negativeSymbol, а символ «n» заменяется отформатированным числовым значением.

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

• LastOperationStatus.NO_ERROR

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

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

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

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

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

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

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

• LastOperationStatus.NO_ERROR

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

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

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

Если использовано значение 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 locale and operating system..

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

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

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

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

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

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

• LastOperationStatus.NO_ERROR

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

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

Создает новый объект NumberFormatter для форматирования чисел в соответствии с правилами данной локали.

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

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

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

• LastOperationStatus.NO_ERROR

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

• LastOperationStatus.USING_FALLBACK_WARNING
• LastOperationStatus.USING_DEFAULT_WARNING

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

• LastOperationStatus.UNSUPPORTED_ERROR

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

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

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

Форматирует значение целого числа. Эта функция эквивалентна методу formatNumber(), но принимает значение int. Если передаваемое значение слишком велико или мало, например больше чем 1,72e308 или меньше чем 1,72e-308, то эта функция возвращает 0.

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

• LastOperationStatus.NO_ERROR

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

Параметры

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

Форматирует числовое значение.

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

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

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

• LastOperationStatus.NO_ERROR

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

Параметры

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

Форматирует значение целого числа без знака. Эта функция эквивалентна методу formatNumber(), но принимает значение uint. Если переданное значение слишком велико, например больше 1,72e308, то эта функция возвращает 0.

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

• LastOperationStatus.NO_ERROR

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

Параметры

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

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

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

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

• LastOperationStatus.NO_ERROR

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

Анализирует строку и возвращает объект NumberParseResult, содержащий проанализированные элементы.

Объект NumberParseResult содержит значение первого числа, найденного в введенной строке, начальный индекс для числа в строке, а также индекс первого символа после числа в строке.

Если строка не содержит числа, свойству NumberParseResult задается значение NaN, а свойствам startIndex и endIndex задается шестнадцатеричное значение 0x7fffffff.

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

В следующей таблице перечислены результаты строк, проанализированных для различных значений NegativeNumberFormat.

Обратите внимание, что допускается использование одного пробела между числом и знаком «минус» или круглой скобкой.

При определении допустимого числа остальные свойства игнорируются. В частности, значение свойства digitsType игнорируется, и знаки могут находиться в любых наборах, перечисленных в классе NationalDigitsType. Значения свойств groupingPattern и useGrouping не влияют на анализ числа.

Если до или после числа в строке следует знак «+», он рассматривается как символ, не входящий в состав числа.

Эта функция не анализирует строки, содержащие числа в экспоненциальном представлении (например, 1,23e40).

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

• LastOperationStatus.NO_ERROR

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

Параметры

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

 
         var nf:NumberFormatter = new NumberFormatter("fr-FR"); 
         var str:String = "1,56 mètre"
         var result:NumberParseResult = nf.parse(str);
         trace(result.value) // 1.56
         trace(str.substr(0,result.startIndex));                // ""
         trace(str.substr(result.startIndex, result.endIndex)); // "1,56"
         trace(str.substr(result.endIndex));                    // " mètre"
         

Анализирует строку, которая содержит только цифры и/или пробелы, и возвращает число. Если строка не начинается с числа или содержит символы, отличные от пробела, которые не входят в состав числа, этот метод возвращает значение NaN. Пробел до или после числовых знаков игнорируется. Разделитель — это символ, который имеет свойство разделителя-пробела (Zs) в Базе данных символов Юникод (см. http://www.unicode.org/ucd/).

Если до или после цифры числа стоит знак «плюс» (+), он рассматривается не как символ пробела. Возвращается значение NaN.

См. описание функции анализа для получения дополнительной информации об анализе чисел и признаках допустимого числа.

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

• LastOperationStatus.NO_ERROR

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

Параметры

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

В этом примере используются следующие локали: локаль по умолчанию ОС для форматирования чисел, японская (Япония), английская (США) и французская (Франция). В примере используется статический элемент LocaleID.DEFAULT для запроса системной локали по умолчанию.

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

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

1. Создается объект NumberFormatter.
2. Одно и тоже значение форматируется как число, целое число и беззнаковое число, затем отображаются результаты.

 
package {
    import flash.globalization.NumberFormatter;
    import flash.globalization.LocaleID;
    
    public class NumberFormatterExample extends Sprite
    {
        public function NumberFormatterExample():void
        {
            var localeNames:Array = [LocaleID.DEFAULT,"ja_JP","en_US","fr_FR"];
            
            for ( var i:int = 0; i < localeNames.length; i++ ) 
            {
                var nf:NumberFormatter = new NumberFormatter( localeNames[i] as String );
                trace('\n\n' + "LocaleID requested: " + nf.requestedLocaleIDName 
                    + "; actual: " + nf.actualLocaleIDName);
                trace( "Last Operation Status:" + nf.lastOperationStatus );   
            
                var numberString:String = nf.formatNumber(123456789.19); 
                trace( "Formatted Number:" + numberString);
                numberString = nf.formatInt(-123456789); 
                trace( "Formatted Int:" + numberString);
                numberString = nf.formatUint(123456789); 
                trace( "Formatted UInt:" + numberString);
            }
        }
    }
}

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

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

1. Создается объект NumberFormatter.
2. Вызывается метод NumberFormatter.parse() для синтаксического анализа строки и получения объекта NumberParseResult.
3. Вызывается метод NumberFormatter.parseNumber() для синтаксического анализа строки и получения объекта Number.

 
package {
      import flash.globalization.NumberFormatter;
      import flash.globalization.NumberParseResult;
      import flash.globalization.LastOperationStatus;
      import flash.globalization.LocaleID;

      public class NumberFormatterParseExample
      {
            public function NumberFormatterParseExample():void
            {
                var nf:NumberFormatter = new NumberFormatter( "en_US" );
                trace("LocaleID requested: " + nf.requestedLocaleIDName 
                    + "; actual: " + nf.actualLocaleIDName);
                trace( "Last Operation Status:" + nf.lastOperationStatus );  

                var inputNumberString:String = "123,567,89,0.254";
                var parseResult:NumberParseResult = nf.parse(inputNumberString);
                if ( nf.lastOperationStatus == LastOperationStatus.NO_ERROR ) {
                    trace("Parsed value:" + parseResult.value);
                }
                inputNumberString = "-123,567,89,0.254";
                var parsedNumber:Number = nf.parseNumber(inputNumberString);
                if ( nf.lastOperationStatus == LastOperationStatus.NO_ERROR ) {
                    trace("Parsed value:" + parsedNumber);
                }
            }
      }
}