パッケージ | spark.validators |
クラス | public class CurrencyValidator |
継承 | CurrencyValidator NumberValidatorBase GlobalizationValidatorBase GlobalizationBase AdvancedStyleClient EventDispatcher Object |
言語バージョン: | ActionScript 3.0 |
製品バージョン: | Flex 4.5 |
ランタイムバージョン: | Flash Player 10.1, AIR 2.5 |
CurrencyValidator
クラスは、ストリングがロケールの規則に基づいた有効な通貨額であるかどうかを確認します。このクラスでは、ロケール ID を指定するために locale
スタイルを使用します。
このバリデーターでは、通貨ストリングが(minValue
プロパティと maxValue
プロパティで)指定した範囲に収まっていること、整数であること(domain
プロパティで指定)、負でないこと(allowNegative
プロパティで指定)、負と正の数を正しく指定していること、正しい通貨 ISO コードまたは通貨記号が使用されていること、fractionalDigits
の指定数を超えていないことを検証できます。デフォルトのプロパティ値の設定には、flash.globalization.CurrencyFormatter
クラスが使用されるため、ロケール固有の値がオペレーティングシステムによって提供されます。
flash.globalization.CurrencyFormatter
クラスでは、ロケール固有データの提供用に、基盤となるオペレーティングシステムを使用します。オペレーティングシステムで通貨フォーマットを提供しない場合、このクラスが代替機能を提供します。
The <s:CurrencyValidator>
tag
inherits all of the tag attributes of its superclass,
and adds the following tag attributes:
<s:CurrencyValidator Properties currencyISOCode="locale specified string or customized by user." currencyStringError="Currency name is repeated or not correct." currencySymbol="locale specified string or customized by user." negativeCurrencyFormat="locale specified string or customized by user." negativeCurrencyFormatError="The negative format of the input currency is incorrect." positiveCurrencyFormat="locale specified string or customized by user." positiveCurrencyFormatError="The positive format of the input currency is incorrect." />
関連する API エレメント
プロパティ | 定義元 | ||
---|---|---|---|
actualLocaleIDName : String [読み取り専用]
このクラスオブジェクトで使用される実際のロケール ID の名前。 | GlobalizationBase | ||
allowNegative : Boolean
負の数値が使用可能かどうかを指定します。 | NumberValidatorBase | ||
className : String [読み取り専用]
コンポーネントクラスの名前です。 | AdvancedStyleClient | ||
constructor : Object
指定されたオブジェクトインスタンスのクラスオブジェクトまたはコンストラクター関数への参照です。 | Object | ||
currencyISOCode : String
使用されているロケールの 3 文字の ISO 4217 通貨コードです。 | CurrencyValidator | ||
currencyStringError : String
通貨記号または通貨の ISO コードが繰り返されているか間違った場所にある場合に発生するエラーメッセージを表します。 | CurrencyValidator | ||
currencySymbol : String
使用されるロケールの通貨記号または文字列です。 | CurrencyValidator | ||
decimalPointCountError : String
小数点の記号を複数個含む場合に発生するエラーメッセージを表します。 | NumberValidatorBase | ||
decimalSeparator : String
小数部分がある数字の検証に使用される小数点区切り文字です。 | NumberValidatorBase | ||
digitsType : uint
数字を検証するときに使用される数字のセットを定義します。 | NumberValidatorBase | ||
domain : String
検証する数値の型を表します。 | NumberValidatorBase | ||
enabled : Boolean
この値を false に設定すると、バリデーターによる検証が行えなくなります。 | GlobalizationValidatorBase | ||
fractionalDigits : int
小数点記号の後に表示できる最大桁数。 | NumberValidatorBase | ||
fractionalDigitsError : String
fractionalDigits プロパティによって指定された値を小数桁が超えたときのエラーメッセージを表します。 | NumberValidatorBase | ||
greaterThanMaxError : String
値が maxValue プロパティの値を超過する場合に発生するエラーメッセージを表します。 | NumberValidatorBase | ||
groupingSeparator : String
グループ化区切りに使用される文字または文字列。 | NumberValidatorBase | ||
id : String
コンポーネントの ID です。 | AdvancedStyleClient | ||
inheritingStyles : Object
このビジュアルでないスタイルクライアントのインスタンスの継承可能なスタイルを含むオブジェクトです。 | AdvancedStyleClient | ||
invalidCharError : String
値に無効な文字が含まれている場合に発生するエラーメッセージを表します。 | NumberValidatorBase | ||
invalidFormatCharsError : String
値に無効な形式の文字が含まれる場合に発生するエラーメッセージを表します。具体的には、区切り文字に数字またはマイナス記号(-)が使用されている場合や区切り文字が複数個連続して使用されている場合がそれに該当します。 | NumberValidatorBase | ||
lastOperationStatus : String [オーバーライド] [読み取り専用]
このクラスオブジェクトが実行した最新の操作のステータス。 | NumberValidatorBase | ||
lessThanMinError : String
値が minValue 未満の場合に発生するエラーメッセージを表します。 | NumberValidatorBase | ||
listener : Object
検証のリスナーを指定します。 | GlobalizationValidatorBase | ||
localeUndefinedError : String
ロケールが未定義であるか使用できない場合に発生するエラーメッセージを表します。 | NumberValidatorBase | ||
maxValue : Number
有効な数値の最大値を表します。 | NumberValidatorBase | ||
minValue : Number
有効な数値の最小値を表します。 | NumberValidatorBase | ||
moduleFactory : IFlexModuleFactory
モジュールファクトリは、このビジュアルでないスタイルクライアントのインスタンスのスタイルを制御するスタイルマネージャーを検索するためのコンテキストとして使用されます。 | AdvancedStyleClient | ||
negativeCurrencyFormat : uint
負の通貨額の検証パターンを示す数値です。 | CurrencyValidator | ||
negativeCurrencyFormatError : String
入力通貨ストリングの負の数のフォーマットが正しくないときに発生するエラーメッセージを表します。 | CurrencyValidator | ||
negativeError : String
負の値で、allowNegative プロパティが false の場合に発生するエラーメッセージを表します。 | NumberValidatorBase | ||
negativeSymbol : String [読み取り専用]
負の値を検証するときに使用されるマイナス記号です。 | NumberValidatorBase | ||
negativeSymbolError : String
マイナス記号が繰り返されているか、または間違った場所にある場合に発生するエラーメッセージを表します。 | NumberValidatorBase | ||
nonInheritingStyles : Object
このコンポーネントの非継承スタイルのチェーンの始まりです。 | AdvancedStyleClient | ||
notAnIntegerError : String
domain プロパティで数値型に整数を指定する必要がある場合に発生するエラーメッセージを表します。 | NumberValidatorBase | ||
parseError : String
数字を解析できなかった場合に発生するエラーメッセージを表します。 | NumberValidatorBase | ||
positiveCurrencyFormat : uint
正の通貨額の検証パターンを示す数値です。 | CurrencyValidator | ||
positiveCurrencyFormatError : String
正の数の通貨フォーマットが正しくないときに発生するエラーメッセージを表します。 | CurrencyValidator | ||
property : String
検証する値を含む source オブジェクトのプロパティの名前を指定するストリングを表します。 | GlobalizationValidatorBase | ||
required : Boolean = true
true の場合、検証エラーの原因となる欠損値または空値を指定します。 | GlobalizationValidatorBase | ||
requiredFieldError : String
値が欠損し、required プロパティが true の場合に発生するエラーメッセージです。 | GlobalizationValidatorBase | ||
source : Object
検証するプロパティを含むオブジェクトを指定します。 | GlobalizationValidatorBase | ||
styleDeclaration : CSSStyleDeclaration
このオブジェクトで宣言されたインラインスタイルを保持するスタイル宣言です。 | AdvancedStyleClient | ||
styleManager : IStyleManager2 [読み取り専用]
このコンポーネントで使用する StyleManager インスタンスを返します。 | AdvancedStyleClient | ||
styleName : Object
オブジェクトのスタイル値のソースです。 | AdvancedStyleClient | ||
styleParent : IAdvancedStyleClient
コンポーネントの親は、下位要素のセレクターを評価するために使用されます。 | AdvancedStyleClient | ||
trigger : IEventDispatcher
バリデーターをトリガーするイベントの生成を行うコンポーネントを指定します。 | GlobalizationValidatorBase | ||
triggerEvent : String
検証をトリガーするイベントを指定します。 | GlobalizationValidatorBase |
メソッド | 定義元 | ||
---|---|---|---|
所定のロケールの規則に従って通貨額を表す数字を検証するために、新しい CurrencyValidator オブジェクトを構築します。 | CurrencyValidator | ||
addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
イベントリスナーオブジェクトを EventDispatcher オブジェクトに登録し、リスナーがイベントの通知を受け取るようにします。 | EventDispatcher | ||
このコンポーネントインスタンスからスタイルプロパティを削除します。 | AdvancedStyleClient | ||
イベントをイベントフローに送出します。 | EventDispatcher | ||
このコンポーネントに適用されるタイプセレクターの CSSStyleDeclaration オブジェクトの配列を返します。何も存在しない場合は null を返します。 | AdvancedStyleClient | ||
[オーバーライド]
このコンポーネントのスタイル参照チェーンのいずれかの場所に設定されたスタイルプロパティを取得します。 | GlobalizationBase | ||
currentCSSState が null でない場合、true を返します。 | AdvancedStyleClient | ||
EventDispatcher オブジェクトに、特定のイベントタイプに対して登録されたリスナーがあるかどうかを確認します。 | EventDispatcher | ||
オブジェクトに指定されたプロパティが定義されているかどうかを示します。 | Object | ||
initialized メソッドは、このクラスまたはこのクラスを拡張するクラスが MXML 宣言で使用されると呼び出されます。 | AdvancedStyleClient | ||
Object クラスのインスタンスが、パラメーターとして指定されたオブジェクトのプロトタイプチェーン内にあるかどうかを示します。 | Object | ||
cssState が currentCSSState に一致した場合は、true を返します。 | AdvancedStyleClient | ||
このインスタンスが、指定されたタイプと同じであるのか、それともそのサブクラスであるのかを判別します。 | AdvancedStyleClient | ||
スタイルの変更を、このスタイルクライアントのインスタンスの子に通知します。 | AdvancedStyleClient | ||
指定されたプロパティが存在し、列挙できるかどうかを示します。 | Object | ||
getStyle() メソッドが機能するように、内部のスタイルキャッシュ値を設定します。 | AdvancedStyleClient | ||
各エフェクトイベントのイベントリスナーの 1 つとして、EffectManager を登録します。 | AdvancedStyleClient | ||
EventDispatcher オブジェクトからリスナーを削除します。 | EventDispatcher | ||
ループ処理に対するダイナミックプロパティの可用性を設定します。 | Object | ||
このコンポーネントインスタンスのスタイルプロパティを設定します。 | AdvancedStyleClient | ||
スタイルプロパティの変更を検出します。 | AdvancedStyleClient | ||
コンポーネントのスタイルを初めて初期化するとき、Flex は stylesInitialized() メソッドを呼び出します。 | AdvancedStyleClient | ||
ロケール固有の規則に従って書式設定された、このオブジェクトのストリング表現を返します。 | Object | ||
指定されたオブジェクトのストリング表現を返します。 | Object | ||
検証を実行し、リスナーに任意で結果を通知します。 | GlobalizationValidatorBase | ||
[静的]
validators 配列に含まれるすべてのバリデーターを呼び出します。 | GlobalizationValidatorBase | ||
カスタム検証関数からバリデーターを呼び出す便利なメソッドです。 | CurrencyValidator | ||
指定されたオブジェクトのプリミティブな値を返します。 | Object | ||
指定されたイベントタイプについて、この EventDispatcher オブジェクトまたはその祖先にイベントリスナーが登録されているかどうかを確認します。 | EventDispatcher |
スタイルには共通スタイルと特定のテーマに関連するスタイルがあります。共通スタイルは、任意のテーマと共に使用できます。特定のテーマに関連するスタイルは、アプリケーションがそのテーマを使用する場合にのみ使用できます。
currencyISOCode | プロパティ |
currencyISOCode:String
言語バージョン: | ActionScript 3.0 |
製品バージョン: | Flex 4.5 |
ランタイムバージョン: | Flash Player 10.1, AIR 2.5 |
使用されているロケールの 3 文字の ISO 4217 通貨コードです。
このプロパティは、validate()
メソッドを使用して、入力通貨額内の通貨ストリングつまり通貨記号を検証するときに使用します。
このプロパティは、使用される実際のロケールに基づいて、コンストラクターによって初期化されます。代替のロケールが使用される場合、このプロパティは、代替のロケールで優先されるデフォルトの通貨コードを反映します。
デフォルト値は実際のロケールおよびオペレーティングシステムによって異なります。
このプロパティはデータバインディングのソースとして使用できます。 このプロパティを変更すると、 change
イベントが送出されます。
実装
public function get currencyISOCode():String
public function set currencyISOCode(value:String):void
関連する API エレメント
currencyStringError | プロパティ |
currencyStringError:String
言語バージョン: | ActionScript 3.0 |
製品バージョン: | Flex 4.5 |
ランタイムバージョン: | Flash Player 10.1, AIR 2.5 |
通貨記号または通貨の ISO コードが繰り返されているか間違った場所にある場合に発生するエラーメッセージを表します。
デフォルト値: "Currency name is repeated or not correct."。
このプロパティはデータバインディングのソースとして使用できます。 このプロパティを変更すると、 change
イベントが送出されます。
実装
public function get currencyStringError():String
public function set currencyStringError(value:String):void
currencySymbol | プロパティ |
currencySymbol:String
言語バージョン: | ActionScript 3.0 |
製品バージョン: | Flex 4.5 |
ランタイムバージョン: | Flash Player 10.1, AIR 2.5 |
使用されるロケールの通貨記号または文字列です。
このプロパティは、validate()
メソッドで通貨額を検証するときに、通貨記号として使用されます。検証ストリング内の通貨記号または通貨名は、currencySymbol
プロパティの値または currencyISOCode
プロパティの値と一致している必要があります。
このプロパティは、使用される実際のロケールに基づいて、コンストラクターによって初期化されます。代替のロケールが使用される場合、このプロパティは、代替のロケールで優先されるデフォルトの通貨記号を反映します。
デフォルト値は実際のロケールおよびオペレーティングシステムによって異なります。
このプロパティはデータバインディングのソースとして使用できます。 このプロパティを変更すると、 change
イベントが送出されます。
実装
public function get currencySymbol():String
public function set currencySymbol(value:String):void
関連する API エレメント
negativeCurrencyFormat | プロパティ |
negativeCurrencyFormat:uint
言語バージョン: | ActionScript 3.0 |
製品バージョン: | Flex 4.5 |
ランタイムバージョン: | Flash Player 10.1, AIR 2.5 |
負の通貨額の検証パターンを示す数値です。このプロパティは、通貨額の数値部分に関連する通貨記号とマイナス記号または括弧の位置を定義します。 このプロパティは、入力通貨ストリングが負の金額についてこのパターンに従っているかどうかを検証するために使用します。
このプロパティの値は、下の表で定義された定数のいずれかになります。
- 「¤」記号は通貨ストリング内での currencyISOCode または currencySymbol の場所を表します。
- 「-」文字は negativeNumberSymbol の場所を表します。
- 「n」文字は通貨金額を表します。
負の金額のフォーマットの種類 | フォーマットパターン |
0 | (¤n) |
1 | -¤n |
2 | ¤-n |
3 | ¤n- |
4 | (n¤) |
5 | -n¤ |
6 | n-¤ |
7 | n¤- |
8 | -n ¤ |
9 | -¤ n |
10 | n ¤- |
11 | ¤ n- |
12 | ¤ -n |
13 | n- ¤ |
14 | (¤ n) |
15 | (n ¤) |
デフォルト値は実際のロケールおよびオペレーティングシステムによって異なります。
このプロパティはデータバインディングのソースとして使用できます。 このプロパティを変更すると、 change
イベントが送出されます。
実装
public function get negativeCurrencyFormat():uint
public function set negativeCurrencyFormat(value:uint):void
例外
ArgumentError — 割り当てられた値が 0~15 の場合。
|
関連する API エレメント
negativeCurrencyFormatError | プロパティ |
negativeCurrencyFormatError:String
言語バージョン: | ActionScript 3.0 |
製品バージョン: | Flex 4.5 |
ランタイムバージョン: | Flash Player 10.1, AIR 2.5 |
入力通貨ストリングの負の数のフォーマットが正しくないときに発生するエラーメッセージを表します。
デフォルト値: "The negative format of the input currency is incorrect."。
このプロパティはデータバインディングのソースとして使用できます。 このプロパティを変更すると、 change
イベントが送出されます。
実装
public function get negativeCurrencyFormatError():String
public function set negativeCurrencyFormatError(value:String):void
positiveCurrencyFormat | プロパティ |
positiveCurrencyFormat:uint
言語バージョン: | ActionScript 3.0 |
製品バージョン: | Flex 4.5 |
ランタイムバージョン: | Flash Player 10.1, AIR 2.5 |
正の通貨額の検証パターンを示す数値です。このプロパティは、通貨額の数値部分に関連する通貨記号の位置を定義します。 このプロパティは、入力通貨ストリングが正の金額についてこのパターンに従っているかどうかを検証するために使用します。
このプロパティの値は、下の表で定義された定数のいずれかになります。
- 「¤」記号は通貨ストリング内での
currencyISOCode
またはcurrencySymbol
の場所を表します。 - 「n」文字は通貨ストリング内での
currencyISOCode
またはcurrencySymbol
の場所を表します。
正の金額のフォーマットの種類 | フォーマットパターン |
0 | ¤n |
1 | n¤ |
2 | ¤ n |
3 | n ¤ |
デフォルト値は実際のロケールおよびオペレーティングシステムによって異なります。
このプロパティはデータバインディングのソースとして使用できます。 このプロパティを変更すると、 change
イベントが送出されます。
実装
public function get positiveCurrencyFormat():uint
public function set positiveCurrencyFormat(value:uint):void
例外
ArgumentError — 割り当てられた値が 0~3 の場合。
|
関連する API エレメント
positiveCurrencyFormatError | プロパティ |
positiveCurrencyFormatError:String
言語バージョン: | ActionScript 3.0 |
製品バージョン: | Flex 4.5 |
ランタイムバージョン: | Flash Player 10.1, AIR 2.5 |
正の数の通貨フォーマットが正しくないときに発生するエラーメッセージを表します。
デフォルト値: "The positive format of the input currency is incorrect."。
このプロパティはデータバインディングのソースとして使用できます。 このプロパティを変更すると、 change
イベントが送出されます。
実装
public function get positiveCurrencyFormatError():String
public function set positiveCurrencyFormatError(value:String):void
CurrencyValidator | () | コンストラクター |
public function CurrencyValidator()
言語バージョン: | ActionScript 3.0 |
製品バージョン: | Flex 4.5 |
ランタイムバージョン: | Flash Player 10.1, AIR 2.5 |
所定のロケールの規則に従って通貨額を表す数字を検証するために、新しい CurrencyValidator
オブジェクトを構築します。
このクラスのロケールは locale
スタイルプロパティによって提供されます。locale
スタイルは、次のいくつかの方法で設定できます。
-
UIComponent
のaddStyleClient
メソッドを呼び出すことによってUIComponent
からスタイルを継承する。 - MXML 宣言内でクラスを使用し、宣言を格納するドキュメントからロケールを継承する。
<fx:Declarations> <s:CurrencyValidator id="cv" /> </fx:Declarations>
<fx:Declarations> <s:CurrencyValidator id="cv_turkish" locale="tr-TR" /> </fx:Declarations>
cv.setStyle("locale", "tr-TR")
)を呼び出す。
locale
スタイルが上記のいずれかの手法で設定されていない場合は、このクラスのインスタンスが StyleClient
として topLevelApplication
に追加されるため、locale
依存のプロパティ getter または locale
依存のメソッドが呼び出されるときに、topLevelApplication
オブジェクトから locale
が継承されます。
通貨ストリングフォーマットに関連するプロパティは、ロケールに基づくデフォルト値に設定されます。
注意:代替のロケールが使用されると、通貨プロパティが en_US のデフォルトの値に設定されます。そのため、検証で意図する通貨と一致しない場合があります。 通貨額を検証する前に、currencySymbol
および currencyISOCode
プロパティの値を調べることをお勧めします。
関連する API エレメント
validateCurrency | () | メソッド |
public function validateCurrency(value:Object, baseField:String):Array
言語バージョン: | ActionScript 3.0 |
製品バージョン: | Flex 4.5 |
ランタイムバージョン: | Flash Player 10.1, AIR 2.5 |
カスタム検証関数からバリデーターを呼び出す便利なメソッドです。 他の標準 Flex バリデーターにもそれぞれ同様の便利なメソッドがあります。 呼び出し元は返された配列の ValidationResult
オブジェクトで検証ステータスをチェックする必要があります。
パラメーター
value:Object — 検証する通貨の数字文字列です。数字文字列では、unicode のマイナス記号 0x2212、0xFE63、0xFF0D と、ascii のマイナスを使用できます。
| |
baseField:String — value パラメーターで指定したサブフィールドのテキスト表現です。 例えば、value パラメーターで value.number を指定する場合、baseField の値は "number" です。
|
Array — ValidationResult オブジェクトの配列です。このオブジェクトは、検証が行われるフィールドごとに 1 つ含まれます。
|
関連する API エレメント
<?xml version="1.0" encoding="utf-8"?> <!-- Sample program for spark.formatters.NumberValidator --> <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:Declarations> <s:CurrencyValidator id="currencyValidator" source='{inputNumber}' property="text" trigger='{validateBtn}' triggerEvent="click" /> <s:CurrencyFormatter id="currencyFormatter" useCurrencySymbol="true" useGrouping="true"/> </fx:Declarations> <fx:Script> <![CDATA[ [Bindable] private var number:Number = 123456789.12; ]]> </fx:Script> <mx:Form> <mx:FormItem label="Input Locale ID Name"> <mx:HBox> <s:TextInput id="inputLocaleIDName" text="en-US"/> <!-- Upon button click, sets the locale style on the document UI component. The formatter will inherit this style. --> <s:Button click="setStyle('locale', inputLocaleIDName.text);" label="Apply"/> </mx:HBox> <mx:Text text="Example: 'en-US', 'fr-FR', 'ja-JP', 'ar-SA'"/> </mx:FormItem> <mx:FormItem label="Allow Negative"> <mx:CheckBox id="alowNegative" selected="true" change="currencyValidator.allowNegative = alowNegative.selected"/> </mx:FormItem> <mx:FormItem label="Fractional Digits"> <mx:TextInput id="fractionalDigits" text='{currencyValidator.fractionalDigits}' change="currencyFormatter.fractionalDigits = currencyValidator.fractionalDigits = Number(fractionalDigits.text)"/> </mx:FormItem> <mx:FormItem label="Currency Symbol"> <mx:TextInput id="currencySymbol" text='{currencyValidator.currencySymbol}' change="currencyFormatter.currencySymbol = currencyValidator.currencySymbol = currencySymbol.text"/> </mx:FormItem> <mx:FormItem label="Actual Locale ID Name"> <mx:Text text="{currencyValidator.actualLocaleIDName}"/> </mx:FormItem> <mx:FormItem label="Enter currency amount" > <mx:HBox> <mx:TextInput id="inputNumber" /> <mx:Button id="validateBtn" label="Validate" /> </mx:HBox> </mx:FormItem> <mx:FormItem label="Example currency"> <mx:Text text="{currencyFormatter.format(123456789.12)}"/> </mx:FormItem> </mx:Form> </s:Application>
Tue Jun 12 2018, 10:34 AM Z