パッケージmx.validators
クラスpublic class CurrencyValidator
継承CurrencyValidator Inheritance Validator Inheritance EventDispatcher Inheritance Object

CurrencyValidator クラスは、ストリングが有効な通貨の式であることを確認します。 このクラスでは、入力値が特定の範囲（minValue と maxValue で指定）に収まっていること、負の数値ではないこと（allowNegative で指定）、および表示される桁数が指定した precision を超えないことを確認できます。 CurrencyValidator クラスは、"$12,345.00" のように書式設定されている通貨の式でも、また "12345" のように書式設定されていない通貨の式でも、正確に検証します。 currencySymbol、alignSymbol、thousandsSeparator および decimalSeparator の各プロパティは、国際化に対応してカスタマイズできます。

MXML のシンタックスexpandedMXML シンタックスを隠す

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=","
  />

例を表示

関連項目

mx.validators.CurrencyValidatorAlignSymbol

パブリックプロパティ
 プロパティ定義元
  alignSymbol : String
式の残りの部分を基準とした currencySymbol の整列設定を指定します。
CurrencyValidator
  allowNegative : Object
負の数値が使用可能かどうかを指定します。
CurrencyValidator
 Inheritedconstructor : Object
指定されたオブジェクトインスタンスのクラスオブジェクトまたはコンストラクタ関数への参照です。
Object
  currencySymbol : String
"$"、"R$" または "£" など、通貨記号の指定に使用する単一文字ストリングを表します。
CurrencyValidator
  currencySymbolError : String
currencySymbol で定義した通貨記号が誤った場所にある場合に発生するエラーメッセージを表します。
CurrencyValidator
  decimalPointCountError : String
小数点の記号を複数個含む場合に発生するエラーメッセージを表します。
CurrencyValidator
  decimalSeparator : String
小数部を区切る文字を表します。
CurrencyValidator
 Inheritedenabled : Boolean
この値を false に設定すると、バリデータによる検証が行えなくなります。
Validator
  exceedsMaxError : String
値が maxValue を超える場合に発生するエラーメッセージを表します。
CurrencyValidator
  invalidCharError : String
通貨に無効な文字が含まれている場合に発生するエラーメッセージを表します。
CurrencyValidator
  invalidFormatCharsError : String
値に無効な書式文字が含まれる場合に発生するエラーメッセージを表します。
CurrencyValidator
 Inheritedlistener : Object
検証のリスナーを指定します。
Validator
  lowerThanMinError : String
値が minValue 未満の場合に発生するエラーメッセージを表します。
CurrencyValidator
  maxValue : Object
有効な数値の最大値を表します。
CurrencyValidator
  minValue : Object
有効な数値の最小値を表します。
CurrencyValidator
  negativeError : String
負の値で、allowNegative プロパティが false の場合に発生するエラーメッセージを表します。
CurrencyValidator
  precision : Object
小数部の最大桁数を表します。
CurrencyValidator
  precisionError : String
値が、precision プロパティで定義されている桁数を超える場合に発生するエラーメッセージを表します。
CurrencyValidator
 Inheritedproperty : String
検証する値を含む source オブジェクトのプロパティの名前を指定するストリングを表します。
Validator
 Inheritedprototype : Object
[静的] クラスまたは関数オブジェクトのプロトタイプオブジェクトへの参照です。
Object
 Inheritedrequired : Boolean = true
true の場合、検証エラーの原因となる欠損値または空値を指定します。
Validator
 InheritedrequiredFieldError : String
値が欠損し、required プロパティが true の場合に発生するエラーメッセージです。
Validator
  separationError : String
桁区切り記号が誤った場所に配置されている場合に発生するエラーメッセージを表します。
CurrencyValidator
 Inheritedsource : Object
検証するプロパティを含むオブジェクトを指定します。
Validator
  thousandsSeparator : String
桁区切りに使用される文字を表します。
CurrencyValidator
 Inheritedtrigger : IEventDispatcher
バリデータをトリガするイベントの生成を行うコンポーネントを指定します。
Validator
 InheritedtriggerEvent : String
検証をトリガするイベントを指定します。
Validator
プロテクトプロパティ
 プロパティ定義元
 InheritedactualListeners : Array
[読み取り専用] リスナーオブジェクトが存在する場合はリスナーオブジェクトを含みます。そうでない場合は、ソースオブジェクトを含みます。
Validator
 InheritedactualTrigger : IEventDispatcher
[読み取り専用] トリガオブジェクトが存在する場合はトリガオブジェクトを含みます。そうでない場合は、ソースオブジェクトを含みます。
Validator
 InheritedresourceManager : IResourceManager
[読み取り専用] アプリケーションのローカライズされたすべてのリソースを管理するオブジェクトへの参照です。
Validator
 InheritedsubFields : Array
validate() メソッドに渡された value オブジェクトに含まれるプロパティ名を含むストリングの配列です。
Validator
パブリックメソッド
 メソッド定義元
  
CurrencyValidator()
コンストラクタです。
CurrencyValidator
 Inherited
addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
イベントリスナーオブジェクトを EventDispatcher オブジェクトに登録し、リスナーがイベントの通知を受け取るようにします。
EventDispatcher
 Inherited
dispatchEvent(event:Event):Boolean
イベントをイベントフローに送出します。
EventDispatcher
 Inherited
hasEventListener(type:String):Boolean
EventDispatcher オブジェクトに、特定のイベントタイプに対して登録されたリスナーがあるかどうかを確認します。
EventDispatcher
 Inherited
hasOwnProperty(name:String):Boolean
オブジェクトに指定されたプロパティが定義されているかどうかを示します。
Object
 Inherited
initialized(document:Object, id:String):void
MXML タグを使用してバリデータを作成したときに、MXML コンパイラによって自動的に呼び出されます。
Validator
 Inherited
isPrototypeOf(theClass:Object):Boolean
Object クラスのインスタンスが、パラメータとして指定されたオブジェクトのプロトタイプチェーン内にあるかどうかを示します。
Object
 Inherited
propertyIsEnumerable(name:String):Boolean
指定されたプロパティが存在し、列挙できるかどうかを示します。
Object
 Inherited
removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void
EventDispatcher オブジェクトからリスナーを削除します。
EventDispatcher
 Inherited
setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void
ループ処理に対するダイナミックプロパティの可用性を設定します。
Object
 Inherited
toString():String
指定されたオブジェクトのストリング表現を返します。
Object
 Inherited
validate(value:Object = null, suppressEvents:Boolean = false):ValidationResultEvent
検証を実行し、リスナーに任意で結果を通知します。
Validator
 Inherited
validateAll(validators:Array):Array
[静的] validators 配列に含まれるすべてのバリデータを呼び出します。
Validator
  
validateCurrency(validator:CurrencyValidator, value:Object, baseField:String):Array
[静的] バリデータを呼び出す上で便利なメソッドです。
CurrencyValidator
 Inherited
valueOf():Object
指定されたオブジェクトのプリミティブな値を返します。
Object
 Inherited
willTrigger(type:String):Boolean
指定されたイベントタイプについて、この EventDispatcher オブジェクトまたはその祖先にイベントリスナーが登録されているかどうかを確認します。
EventDispatcher
プロテクトメソッド
 メソッド定義元
 Inherited
addListenerHandler():void
バリデータから送出された valid イベントおよび invalid イベントのすべてのリスナーを設定します。
Validator
  
doValidation(value:Object):Array
[override] 通貨の式の妥当性を検証する上で基本クラスの doValidation() メソッドをオーバーライドします。
CurrencyValidator
 Inherited
getValueFromSource():Object
検証するオブジェクトを返します。
Validator
 Inherited
handleResults(errorResults:Array):ValidationResultEvent
エラー結果の配列から ValidationResultEvent を返します。
Validator
 Inherited
isRealValue(value:Object):Boolean
value が null でない場合、true を返します。
Validator
 Inherited
removeListenerHandler():void
バリデータから送出された valid イベントおよび invalid イベントのすべてのリスナーを切断します。
Validator
 Inherited
resourcesChanged():void
このメソッドは、バリデータが作成されたときと、ResourceManager が "change" イベントを送出してローカライズされたリソースが何らかの点で変更されたことを示すときに再び呼び出されます。
Validator
イベント
 イベント 概要 定義元
 Inherited
activate
[ブロードキャスト イベント] Flash Player または AIR アプリケーションがオペレーティングシステムのフォーカスを取得して、アクティブになったときに送出されます。EventDispatcher
 Inherited
deactivate
[ブロードキャスト イベント] Flash Player または AIR アプリケーションがオペレーティングシステムのフォーカスを失って、非アクティブになったときに送出されます。EventDispatcher
 Inherited
invalid
検証が失敗すると送出されます。Validator
 Inherited
valid
検証が正常に完了すると送出されます。Validator
プロテクト定数
 定数定義元
 InheritedDECIMAL_DIGITS : String = "0123456789"
[静的] 0 から 9 の 10 進数字を含むストリングです。
Validator
 InheritedROMAN_LETTERS : String = "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz"
[静的] ローマ字アルファベットの大文字と小文字を含む（"A" から "Z"、および "a" から "z"）ストリングです。
Validator
プロパティの詳細
alignSymbolプロパティ
alignSymbol:String

式の残りの部分を基準とした 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

関連項目

mx.validators.CurrencyValidatorAlignSymbol
allowNegativeプロパティ 
allowNegative:Object

負の数値が使用可能かどうかを指定します。 true または false を指定できます。

デフォルト値 : true.



実装
    public function get allowNegative():Object
    public function set allowNegative(value:Object):void
currencySymbolプロパティ 
currencySymbol:String

"$"、"R$" または "£" など、通貨記号の指定に使用する単一文字ストリングを表します。数字は使用できず、thousandsSeparator および decimalSeparator とは異なるストリングにする必要があります。

デフォルト値 : "$".



実装
    public function get currencySymbol():String
    public function set currencySymbol(value:String):void
currencySymbolErrorプロパティ 
currencySymbolError:String

currencySymbol で定義した通貨記号が誤った場所にある場合に発生するエラーメッセージを表します。

デフォルト値 : "通貨記号が無効な位置にあります。".



実装
    public function get currencySymbolError():String
    public function set currencySymbolError(value:String):void
decimalPointCountErrorプロパティ 
decimalPointCountError:String

小数点の記号を複数個含む場合に発生するエラーメッセージを表します。

デフォルト値 : "小数点は 1 回だけ使用できます。".



実装
    public function get decimalPointCountError():String
    public function set decimalPointCountError(value:String):void
decimalSeparatorプロパティ 
decimalSeparator:String

小数部を区切る文字を表します。 数字は使用できず、currencySymbol および thousandsSeparator とは異なるストリングにする必要があります。

デフォルト値 : ".".



実装
    public function get decimalSeparator():String
    public function set decimalSeparator(value:String):void
exceedsMaxErrorプロパティ 
exceedsMaxError:String

値が maxValue を超える場合に発生するエラーメッセージを表します。

デフォルト値 : "入力した金額が大きすぎます。".



実装
    public function get exceedsMaxError():String
    public function set exceedsMaxError(value:String):void
invalidCharErrorプロパティ 
invalidCharError:String

通貨に無効な文字が含まれている場合に発生するエラーメッセージを表します。

デフォルト値 : "入力値に無効な文字が含まれています。".



実装
    public function get invalidCharError():String
    public function set invalidCharError(value:String):void
invalidFormatCharsErrorプロパティ 
invalidFormatCharsError:String

値に無効な書式文字が含まれる場合に発生するエラーメッセージを表します。

デフォルト値 : "フォーマット用パラメータのいずれかが無効です。".



実装
    public function get invalidFormatCharsError():String
    public function set invalidFormatCharsError(value:String):void
lowerThanMinErrorプロパティ 
lowerThanMinError:String

値が minValue 未満の場合に発生するエラーメッセージを表します。

デフォルト値 : "入力した金額が小さすぎます。".



実装
    public function get lowerThanMinError():String
    public function set lowerThanMinError(value:String):void
maxValueプロパティ 
maxValue:Object

有効な数値の最大値を表します。 値が NaN の場合、値は無視されます。

デフォルト値 : NaN.



実装
    public function get maxValue():Object
    public function set maxValue(value:Object):void
minValueプロパティ 
minValue:Object

有効な数値の最小値を表します。 値が NaN の場合、値は無視されます。

デフォルト値 : NaN.



実装
    public function get minValue():Object
    public function set minValue(value:Object):void
negativeErrorプロパティ 
negativeError:String

負の値で、allowNegative プロパティが false の場合に発生するエラーメッセージを表します。

デフォルト値 : "金額を負の値にすることはできません。".



実装
    public function get negativeError():String
    public function set negativeError(value:String):void
precisionプロパティ 
precision:Object

小数部の最大桁数を表します。 負以外の任意の整数を設定できます。 メモ：0 に設定すると、NumberValidator.domain を int に設定する場合と同じ効果があります。-1 に設定すると、値は無視されます。

デフォルト値 : 2.



実装
    public function get precision():Object
    public function set precision(value:Object):void
precisionErrorプロパティ 
precisionError:String

値が、precisionプロパティで定義されている桁数を超える場合に発生するエラーメッセージを表します。

デフォルト値 : "入力した金額の整数部の桁数が多すぎます。".



実装
    public function get precisionError():String
    public function set precisionError(value:String):void
separationErrorプロパティ 
separationError:String

桁区切り記号が誤った場所に配置されている場合に発生するエラーメッセージを表します。

デフォルト値 : "桁区切り記号は 3 桁ごとに挿入する必要があります。".



実装
    public function get separationError():String
    public function set separationError(value:String):void
thousandsSeparatorプロパティ 
thousandsSeparator:String

桁区切りに使用される文字を表します。 数字は使用できず、currencySymbol および decimalSeparator とは異なるストリングにする必要があります。

デフォルト値 : ",".



実装
    public function get thousandsSeparator():String
    public function set thousandsSeparator(value:String):void
コンストラクタの詳細
CurrencyValidator()コンストラクタ
public function CurrencyValidator()

コンストラクタです。

メソッドの詳細
doValidation()メソッド
override protected function doValidation(value:Object):Array

通貨の式の妥当性を検証する上で基本クラスの doValidation() メソッドをオーバーライドします。

このメソッドはユーザーが直接呼び出すものではなく、妥当性を検証する際に Flex から呼び出されます。 Validator クラスをカスタムで作成する場合は、このメソッドを実装する必要があります。

パラメータ

value:Object — 検証するオブジェクトです。

戻り値
Array — ValidationResult オブジェクトの配列です。このオブジェクトは、検証が行われるフィールドごとに 1 つ含まれます。
validateCurrency()メソッド 
public static function validateCurrency(validator:CurrencyValidator, value:Object, baseField:String):Array

バリデータを呼び出す上で便利なメソッドです。 他の標準 Flex バリデータにもそれぞれ同様の便利なメソッドがあります。

パラメータ

validator:CurrencyValidator — CurrencyValidator インスタンスを表します。
 
value:Object — 検証するオブジェクトです。
 
baseField:String — value パラメータで指定したサブフィールドのテキスト表現です。 例えば、value パラメータで value.currency を指定する場合、baseField の値は "currency" です。

戻り値
Array — ValidationResult オブジェクトの配列です。このオブジェクトは、検証が行われるフィールドごとに 1 つ含まれます。

関連項目

mx.validators.ValidationResult
例 例の使用法
CurrencyValidatorExample.mxml
<?xml version="1.0" encoding="utf-8"?>
<!-- Simple example to demonstrate the CurrencyValidator. -->
<mx:Application xmlns:mx="http://www.adobe.com/2006/mxml">

    <mx:Script>
        import mx.controls.Alert;
    </mx:Script>

    <mx:CurrencyValidator source="{priceUS}" property="text" precision="2" 
        trigger="{myButton}" triggerEvent="click" 
        valid="Alert.show('Validation Succeeded!');"/>

    <mx:Panel title="CurrencyValidator Example" width="75%" height="75%" 
        paddingTop="10" paddingLeft="10" paddingRight="10" paddingBottom="10">
        
        <mx:Form>
            <mx:FormItem label="Enter a U.S. dollar amount: ">
                 <mx:TextInput id="priceUS" width="100%"/>
            </mx:FormItem>

            <mx:FormItem >
                <mx:Button id="myButton" label="Validate"/>
            </mx:FormItem>
        </mx:Form>            
    </mx:Panel>
</mx:Application>



© 2009 Adobe Systems Incorporated. All rights reserved.
Thu Mar 19 2009, 08:51 PM -07:00
 

 

このページに新しいコメントが追加された場合に、電子メールでの通知を希望する。 | コメントレポート

現在のページ: http://livedocs.adobe.com/flex/3_jp/langref/mx/validators/CurrencyValidator.html