メソッド | プロパティ | フレームあり | フレームなし

mx.validators
CurrencyValidator クラス

継承を示す線


CurrencyValidator クラス
mx.validators.Validator の拡張

CurrencyValidator クラスは、ストリングが有効な通貨の式であることを表します。このクラスでは、入力値が特定の範囲 (minValue と maxValue で指定) に収まっていること、負の数値ではないこと (allowNegative で指定)、および表示される桁数が指定した数を超えないことを確認できます。NumberValidator は、"$12,345" のようにフォーマットが適用されている通貨でも、また "12345" のように形式が適用されていない通貨でも、正確に検証します。currencySymbol、alignSymbol、thousandSeparator、および decimalSeparator の属性は、国際化に対応してカスタマイズできます。

MXML シンタックス

<mx:CurrencyValidator> タグは、親クラスのプロパティと、次のプロパティを受け取ります。

 <mx:CurrencyValidator
minValue="min value - no default"
maxValue="max value - no default"
currencySymbol="String used to indicate the currency, e.g. '$' or 'YEN' - default is '$'"
alignSymbol="left|right|any - default is left"
decimalSeparator="character used to separate the whole part from the fractional part of the amount - default is '.'"
thousandsSeparator="character allowed to separate every three digits in the whole part of the amount - default is ','"
precision="how many digits to allow beyond the decimal point, can be any nonnegative integer - default is undefined"
allowNegative="true|false"
exceedsMaxError="The amount entered is too large."
lowerThanMinError="The amount entered is too small."
negativeError="The amount may not be negative."
precisionError="The amount entered has too many digits beyond the decimal point."
separationError="The thousands separator must be followed by three digits."
decimalPointCountError="The decimal separator can only occur once."
invalidCharError="The input contains invalid characters."
invalidFormatCharsError="One of the formatting parameters is invalid."
currencySymbolError="The currency symbol occurs in an invalid location."
/>

を参照するにはここをクリックしてください

メソッド
       doValidation( value:Object) :  Void
通貨の式を検証します。
staticvalidateCurrency( validator:mx.validators.Validator, value:Object, paramObj:Object, baseField:String) :  Boolean
<mx:Validator> タグを使用する場合に、カスタム検証関数からバリデータを呼び出す便利なメソッドです。

mx.validators.Validator クラスから継承されるメソッド
disable   doValidation   enable   hasErrors   isStructureValid   isValid   validateRequired   validationError  



プロパティ
       alignSymbol:String
式の残りの部分を基準とした currencySymbol の整列設定を指定します。
       allowNegative:Boolean
負の数値が使用可能かどうかを指定します。
       currencySymbol:String
"$" や "YEN" など、通貨を示すのに使用するストリングを表します。
       currencySymbolError:String
エラーメッセージを表します。
       decimalPointCountError:String
エラーメッセージを表します。
       decimalSeparator:String
小数部を区切る文字を表します。
       exceedsMaxError:String
エラーメッセージを表します。
       invalidCharError:String
エラーメッセージを表します。
       invalidFormatCharsError:String
エラーメッセージを表します。
       lowerThanMinError:String
エラーメッセージを表します。
       maxValue:Number
有効な数値の最大値を表します。
       minValue:Number
有効な数値の最小値を表します。
       negativeError:String
エラーメッセージを表します。
       precision:Number
小数部の最大桁数を表します。
       precisionError:String
エラーメッセージを表します。
       separationError:String
エラーメッセージを表します。
       thousandsSeparator:String
小数部を区切る文字を表します。

mx.validators.Validator クラスから継承されるプロパティ
field   listener   required   requiredFieldError   validate  



メソッドの詳細

doValidation

doValidation( value:Object) :  Void

通貨の式を検証します。

パラメータ
    value:Object - 検証するストリングです。


validateCurrency

static  validateCurrency( validator:mx.validators.Validator, value:Object, paramObj:Object, baseField:String) :  Boolean

<mx:Validator> タグを使用する場合に、カスタム検証関数からバリデータを呼び出す便利なメソッドです。他の標準バリデータにもそれぞれ同様の便利なメソッドがあります。

パラメータ
    validator:mx.validators.Validator - Validator インスタンスです。
    value:Object - value.subfield。タグの field プロパティで指定された値のサブフィールドを subfield として指定します。
    paramObj:Object - パラメータ情報 (エラーメッセージ、最小値と最大値など) を含んだオブジェクトを指定します。このパラメータはオプションですが、baseField を指定する場合には、null を指定します。
    baseField:String - value パラメータで指定した subfield のテキスト表現を指定します。たとえば、value パラメータで value.currency を指定する場合、baseField の値は "currency" です。



プロパティの詳細

alignSymbol

alignSymbol:String  

式の残りの部分を基準とした currencySymbol の整列設定を指定します。有効な値は、"left"、"right"、あるいは左揃えまたは右揃えを可能にする "any" です。デフォルト値は "left" です。


allowNegative

allowNegative:Boolean  

負の数値が使用可能かどうかを指定します。true または false を表します。デフォルト値は true です。


currencySymbol

currencySymbol:String  

"$" や "YEN" など、通貨を示すのに使用するストリングを表します。数字は使用できず、thousandsSeparatordecimalSeparator とは異なるストリングにする必要があります。デフォルト値は "$" です。


currencySymbolError

currencySymbolError:String  

エラーメッセージを表します。デフォルト値は "The currency symbol occurs in an invalid location." です。


decimalPointCountError

decimalPointCountError:String  

エラーメッセージを表します。デフォルト値は "The decimal separator can only occur once." です。


decimalSeparator

decimalSeparator:String  

小数部を区切る文字を表します。数字は使用できず、currencySymbolthousandsSeparator とは異なるストリングにする必要があります。デフォルト値は "." です。


exceedsMaxError

exceedsMaxError:String  

エラーメッセージを表します。デフォルト値は "The amount entered is too large." です。


invalidCharError

invalidCharError:String  

エラーメッセージを表します。デフォルト値は "The input contains invalid characters." です。


invalidFormatCharsError

invalidFormatCharsError:String  

エラーメッセージを表します。デフォルト値は、"One of the formatting parameters is invalid." です。


lowerThanMinError

lowerThanMinError:String  

エラーメッセージを表します。デフォルト値は "The amount entered is too small." です。


maxValue

maxValue:Number  

有効な数値の最大値を表します。デフォルトでは使用されません。


minValue

minValue:Number  

有効な数値の最小値を表します。デフォルトでは使用されません。


negativeError

negativeError:String  

エラーメッセージを表します。デフォルト値は "The amount may not be negative." です。


precision

precision:Number  

小数部の最大桁数を表します。負以外の任意の整数を設定できます。メモ : 0 を設定した場合は、domainint に設定した場合と同じ結果になります。デフォルトでは使用されません。


precisionError

precisionError:String  

エラーメッセージを表します。デフォルト値は "The amount entered has too many digits beyond the decimal point." です。


separationError

separationError:String  

エラーメッセージを表します。デフォルト値は "The thousands separator must be followed by three digits." です。


thousandsSeparator

thousandsSeparator:String  

小数部を区切る文字を表します。数字は使用できず、currencySymboldecimalSeparator とは異なるストリングにする必要があります。デフォルト値は "," です。


CurrencyValidator.mxml
<?xml version="1.0" encoding="utf-8"?>
<!-- 通貨バリデータの使用方法を示す簡単な例 -->
<mx:Application xmlns:mx="http://www.macromedia.com/2003/mxml" backgroundColor="#FFFFFF">

<!-- 例 : 米国通貨の場合 -->
<mx:Model id="US">
<currency>{priceUS.text}</currency>
</mx:Model>

<mx:CurrencyValidator field="US.currency" precision="3"/>

<mx:Panel title="Currency Validator Panel" backgroundColor="#0C8BF3">

<mx:Label text="Enter a US-formatted price:"color="#FFFFFF"/>
<mx:TextInput id="priceUS"/>
<mx:Label text="*press enter to check validation." color="#FFCCCC"/>

</mx:Panel>
</mx:Application>