| パッケージ | mx.validators |
| クラス | public class CurrencyValidator |
| 継承 | CurrencyValidator  Validator EventDispatcher Object |
| 言語バージョン: | ActionScript 3.0 |
| 製品バージョン: | Flex 3 |
| ランタイムバージョン: | Flash Player 9, AIR 1.1 |
 | Flex 4.5 以降では、このクラスの代わりとして spark.validators.CurrencyValidator クラスを使用することをお勧めします。 |
CurrencyValidator クラスは、ストリングが有効な通貨の式であることを確認します。 このクラスでは、入力値が特定の範囲（
minValue と maxValue で指定）に収まっていること、負の数値ではないこと（allowNegative で指定）、および表示される桁数が指定した precision を超えないことを確認できます。 CurrencyValidator クラスは、"$12,345.00" のように書式設定されている通貨の式でも、また "12345" のように書式設定されていない通貨の式でも、正確に検証します。 currencySymbol、alignSymbol、thousandsSeparator、および decimalSeparator の各プロパティは、国際化に対応してカスタマイズできます。
MXML シンタックス
MXML シンタックスを表示
MXML シンタックスを隠すThe <mx:CurrencyValidator> tag
inherits all of the tag properties of its superclass,
and adds the following tag properties:
<mx:CurrencyValidator
alignSymbol="left|right|any"
allowNegative="true|false"
currencySymbol="$"
currencySymbolError="The currency symbol occurs in an invalid location."
decimalPointCountError="The decimal separator can occur only once."
decimalSeparator="."
exceedsMaxError="The amount entered is too large."
invalidCharError="The input contains invalid characters."
invalidFormatCharsError="One of the formatting parameters is invalid."
lowerThanMinError="The amount entered is too small."
maxValue="NaN"
minValue="NaN"
negativeError="The amount may not be negative."
precision="2"
precisionError="The amount entered has too many digits beyond the decimal point."
separationError="The thousands separator must be followed by three digits."
thousandsSeparator=","
/>
関連する API エレメント
パブリックプロパティ
| プロパティ | 定義元 | ||
|---|---|---|---|
| alignSymbol : String
式の残りの部分を基準とした currencySymbol の整列設定を指定します。 | CurrencyValidator | ||
| allowNegative : Object
負の数値が使用可能かどうかを指定します。 | CurrencyValidator | ||
 | constructor : Object
指定されたオブジェクトインスタンスのクラスオブジェクトまたはコンストラクター関数への参照です。 | Object | |
| currencySymbol : String
"$"、"R$" または "£" など、通貨記号の指定に使用する文字ストリングを表します。 | CurrencyValidator | ||
| currencySymbolError : String
currencySymbol で定義した通貨記号が誤った場所にある場合に発生するエラーメッセージを表します。 | CurrencyValidator | ||
| decimalPointCountError : String
小数点の記号を複数個含む場合に発生するエラーメッセージを表します。 | CurrencyValidator | ||
| decimalSeparator : String
小数部を区切る文字を表します。 | CurrencyValidator | ||
| enabled : Boolean
この値を false に設定すると、バリデーターによる検証が行えなくなります。 | Validator | |
| exceedsMaxError : String
値が maxValue を超える場合に発生するエラーメッセージを表します。 | CurrencyValidator | ||
| invalidCharError : String
通貨に無効な文字が含まれている場合に発生するエラーメッセージを表します。 | CurrencyValidator | ||
| invalidFormatCharsError : String
値に無効な書式文字が含まれる場合に発生するエラーメッセージを表します。 | CurrencyValidator | ||
| listener : Object
検証のリスナーを指定します。 | Validator | |
| lowerThanMinError : String
値が minValue 未満の場合に発生するエラーメッセージを表します。 | CurrencyValidator | ||
| maxValue : Object
有効な数値の最大値を表します。 | CurrencyValidator | ||
| minValue : Object
有効な数値の最小値を表します。 | CurrencyValidator | ||
| negativeError : String
負の値で、allowNegative プロパティが false の場合に発生するエラーメッセージを表します。 | CurrencyValidator | ||
| precision : Object
小数部の最大桁数を表します。 | CurrencyValidator | ||
| precisionError : String
値が、precision プロパティで定義されている桁数を超える場合に発生するエラーメッセージを表します。 | CurrencyValidator | ||
| property : String
検証する値を含む source オブジェクトのプロパティの名前を指定するストリングを表します。 | Validator | |
| required : Boolean = true
true の場合、検証エラーの原因となる欠損値または空値を指定します。 | Validator | |
| requiredFieldError : String
値が欠損し、required プロパティが true の場合に発生するエラーメッセージです。 | Validator | |
| separationError : String
桁区切り記号が誤った場所に配置されている場合に発生するエラーメッセージを表します。 | CurrencyValidator | ||
| source : Object
検証するプロパティを含むオブジェクトを指定します。 | Validator | |
| thousandsSeparator : String
桁区切りに使用される文字を表します。 | CurrencyValidator | ||
| trigger : IEventDispatcher
バリデーターをトリガーするイベントの生成を行うコンポーネントを指定します。 | Validator | |
| triggerEvent : String
検証をトリガーするイベントを指定します。 | Validator | |
プロテクトプロパティ
パブリックメソッド
| メソッド | 定義元 | ||
|---|---|---|---|
コンストラクターです。 | CurrencyValidator | ||
| addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
イベントリスナーオブジェクトを EventDispatcher オブジェクトに登録し、リスナーがイベントの通知を受け取るようにします。 | EventDispatcher | |
|
イベントをイベントフローに送出します。 | EventDispatcher | |
|
EventDispatcher オブジェクトに、特定のイベントタイプに対して登録されたリスナーがあるかどうかを確認します。 | EventDispatcher | |
|
オブジェクトに指定されたプロパティが定義されているかどうかを示します。 | Object | |
|
MXML タグを使用してバリデーターを作成したときに、MXML コンパイラーによって自動的に呼び出されます。 | Validator | |
|
Object クラスのインスタンスが、パラメーターとして指定されたオブジェクトのプロトタイプチェーン内にあるかどうかを示します。 | Object | |
|
指定されたプロパティが存在し、列挙できるかどうかを示します。 | Object | |
|
EventDispatcher オブジェクトからリスナーを削除します。 | EventDispatcher | |
|
ループ処理に対するダイナミックプロパティの可用性を設定します。 | Object | |
|
ロケール固有の規則に従って書式設定された、このオブジェクトのストリング表現を返します。 | Object | |
|
指定されたオブジェクトのストリング表現を返します。 | Object | |
|
検証を実行し、リスナーに任意で結果を通知します。 | Validator | |
| [静的]
validators 配列に含まれるすべてのバリデーターを呼び出します。 | Validator | |
[静的]
バリデーターを呼び出す上で便利なメソッドです。 | CurrencyValidator | ||
|
指定されたオブジェクトのプリミティブな値を返します。 | Object | |
|
指定されたイベントタイプについて、この EventDispatcher オブジェクトまたはその祖先にイベントリスナーが登録されているかどうかを確認します。 | EventDispatcher | |
プロテクトメソッド
| メソッド | 定義元 | ||
|---|---|---|---|
|
バリデーターから送出された valid イベントおよび invalid イベントのすべてのリスナーを設定します。 | Validator | |
[オーバーライド]
通貨の式の妥当性を検証する上で基本クラスの doValidation() メソッドをオーバーライドします。 | CurrencyValidator | ||
|
検証するオブジェクトを返します。 | Validator | |
|
エラー結果の配列から ValidationResultEvent を返します。 | Validator | |
|
value が null でない場合、true を返します。 | Validator | |
|
バリデーターから送出された valid イベントおよび invalid イベントのすべてのリスナーを切断します。 | Validator | |
|
このメソッドは、バリデーターが作成されたときと、ResourceManager が "change" イベントを送出してローカライズされたリソースが何らかの点で変更されたことを示すときに再び呼び出されます。 | Validator | |
プロテクト定数
プロパティの詳細
alignSymbol | プロパティ |
alignSymbol:String| 言語バージョン: | ActionScript 3.0 |
| 製品バージョン: | Flex 3 |
| ランタイムバージョン: | Flash Player 9, AIR 1.1 |
式の残りの部分を基準とした currencySymbol の整列設定を指定します。 ActionScript で指定できる値は、CurrencyValidatorAlignSymbol.LEFT、CurrencyValidatorAlignSymbol.RIGHT、および CurrencyValidatorAlignSymbol.ANY です。 MXML で指定できる値は、"left"、"right"、および "any" です。
デフォルト値： CurrencyValidatorAlignSymbol.LEFT。
実装
public function get alignSymbol():String public function set alignSymbol(value:String):void関連する API エレメント
allowNegative | プロパティ |
currencySymbol | プロパティ |
currencySymbol:String| 言語バージョン: | ActionScript 3.0 |
| 製品バージョン: | Flex 3 |
| ランタイムバージョン: | Flash Player 9, AIR 1.1 |
"$"、"R$" または "£" など、通貨記号の指定に使用する単一文字ストリングを表します。数字は使用できず、thousandsSeparator および decimalSeparator とは異なるストリングにする必要があります。
デフォルト値： "$"。
実装
public function get currencySymbol():String public function set currencySymbol(value:String):voidcurrencySymbolError | プロパティ |
currencySymbolError:String| 言語バージョン: | ActionScript 3.0 |
| 製品バージョン: | Flex 3 |
| ランタイムバージョン: | Flash Player 9, AIR 1.1 |
currencySymbol で定義した通貨記号が誤った場所にある場合に発生するエラーメッセージを表します。
デフォルト値： "The currency symbol occurs in an invalid location."。
実装
public function get currencySymbolError():String public function set currencySymbolError(value:String):voiddecimalPointCountError | プロパティ |
decimalPointCountError:String| 言語バージョン: | ActionScript 3.0 |
| 製品バージョン: | Flex 3 |
| ランタイムバージョン: | Flash Player 9, AIR 1.1 |
小数点の記号を複数個含む場合に発生するエラーメッセージを表します。
デフォルト値： "The decimal separator can only occur once."。
実装
public function get decimalPointCountError():String public function set decimalPointCountError(value:String):voiddecimalSeparator | プロパティ |
decimalSeparator:String| 言語バージョン: | ActionScript 3.0 |
| 製品バージョン: | Flex 3 |
| ランタイムバージョン: | Flash Player 9, AIR 1.1 |
小数部を区切る文字を表します。 数字は使用できず、currencySymbol および thousandsSeparator とは異なるストリングにする必要があります。
デフォルト値： "."。
実装
public function get decimalSeparator():String public function set decimalSeparator(value:String):voidexceedsMaxError | プロパティ |
invalidCharError | プロパティ |
invalidFormatCharsError | プロパティ |
invalidFormatCharsError:String| 言語バージョン: | ActionScript 3.0 |
| 製品バージョン: | Flex 3 |
| ランタイムバージョン: | Flash Player 9, AIR 1.1 |
値に無効な書式文字が含まれる場合に発生するエラーメッセージを表します。
デフォルト値： "One of the formatting parameters is invalid."。
実装
public function get invalidFormatCharsError():String public function set invalidFormatCharsError(value:String):voidlowerThanMinError | プロパティ |
maxValue | プロパティ |
minValue | プロパティ |
negativeError | プロパティ |
precision | プロパティ |
precision:Object| 言語バージョン: | ActionScript 3.0 |
| 製品バージョン: | Flex 3 |
| ランタイムバージョン: | Flash Player 9, AIR 1.1 |
小数部の最大桁数を表します。 負以外の任意の整数を設定できます。 メモ：0 に設定すると、NumberValidator.domain を int に設定する場合と同じ効果があります。 -1 に設定すると、値は無視されます。
デフォルト値： 2。
実装
public function get precision():Object public function set precision(value:Object):voidprecisionError | プロパティ |
precisionError:String| 言語バージョン: | ActionScript 3.0 |
| 製品バージョン: | Flex 3 |
| ランタイムバージョン: | Flash Player 9, AIR 1.1 |
値が、precisionプロパティで定義されている桁数を超える場合に発生するエラーメッセージを表します。
デフォルト値： "The amount entered has too many digits beyond the decimal point."。
実装
public function get precisionError():String public function set precisionError(value:String):voidseparationError | プロパティ |
separationError:String| 言語バージョン: | ActionScript 3.0 |
| 製品バージョン: | Flex 3 |
| ランタイムバージョン: | Flash Player 9, AIR 1.1 |
桁区切り記号が誤った場所に配置されている場合に発生するエラーメッセージを表します。
デフォルト値： "The thousands separator must be followed by three digits."。
実装
public function get separationError():String public function set separationError(value:String):voidthousandsSeparator | プロパティ |
thousandsSeparator:String| 言語バージョン: | ActionScript 3.0 |
| 製品バージョン: | Flex 3 |
| ランタイムバージョン: | Flash Player 9, AIR 1.1 |
桁区切りに使用される文字を表します。 数字は使用できず、currencySymbol および decimalSeparator とは異なるストリングにする必要があります。
デフォルト値： ","。
実装
public function get thousandsSeparator():String public function set thousandsSeparator(value:String):voidコンストラクターの詳細
CurrencyValidator | () | コンストラクター |
public function CurrencyValidator()| 言語バージョン: | ActionScript 3.0 |
| 製品バージョン: | Flex 3 |
| ランタイムバージョン: | Flash Player 9, AIR 1.1 |
コンストラクターです。
メソッドの詳細
doValidation | () | メソッド |
override protected function doValidation(value:Object):Array| 言語バージョン: | ActionScript 3.0 |
| 製品バージョン: | Flex 3 |
| ランタイムバージョン: | Flash Player 9, AIR 1.1 |
通貨の式の妥当性を検証する上で基本クラスの doValidation() メソッドをオーバーライドします。
このメソッドはユーザーが直接呼び出すものではなく、妥当性を検証する際に Flex から呼び出されます。 Validator クラスをカスタムで作成する場合は、このメソッドを実装する必要があります。
パラメーター
value:Object — 検証するオブジェクトです。
|
Array — ValidationResult オブジェクトの配列です。このオブジェクトは、検証が行われるフィールドごとに 1 つ含まれます。
|
validateCurrency | () | メソッド |
public static function validateCurrency(validator:CurrencyValidator, value:Object, baseField:String):Array| 言語バージョン: | ActionScript 3.0 |
| 製品バージョン: | Flex 3 |
| ランタイムバージョン: | Flash Player 9, AIR 1.1 |
バリデーターを呼び出す上で便利なメソッドです。 他の標準 Flex バリデーターにもそれぞれ同様の便利なメソッドがあります。
パラメーター
validator:CurrencyValidator — CurrencyValidator インスタンスを表します。
| |
value:Object — 検証するオブジェクトです。
| |
baseField:String — value パラメーターで指定したサブフィールドのテキスト表現です。 例えば、value パラメーターで value.currency を指定する場合、baseField の値は "currency" です。
|
Array — ValidationResult オブジェクトの配列です。このオブジェクトは、検証が行われるフィールドごとに 1 つ含まれます。
|
関連する API エレメント
例 この例の使用方法
CurrencyValidatorExample.mxml
<?xml version="1.0" encoding="utf-8"?>
<!-- Simple example to demonstrate the CurrencyValidator. -->
<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>
import mx.controls.Alert;
</fx:Script>
<fx:Declarations>
<mx:CurrencyValidator source="{priceUS}" property="text" precision="2"
trigger="{myButton}" triggerEvent="click"
valid="Alert.show('Validation Succeeded!');"/>
</fx:Declarations>
<s:Panel title="CurrencyValidator Example"
width="75%" height="75%"
horizontalCenter="0" verticalCenter="0">
<mx:Form left="10" right="10" top="10" bottom="10">
<mx:FormItem label="Enter a U.S. dollar amount: ">
<s:TextInput id="priceUS" width="100%"/>
</mx:FormItem>
<mx:FormItem >
<s:Button id="myButton" label="Validate"/>
</mx:FormItem>
</mx:Form>
</s:Panel>
</s:Application>
Tue Jun 12 2018, 10:34 AM Z