ASDoc

mx.validators
Validator クラス

直接の既知のサブクラス
mx.validators.CreditCardValidator, mx.validators.CurrencyValidator, mx.validators.DateValidator, mx.validators.EmailValidator, mx.validators.NumberValidator, mx.validators.PhoneNumberValidator, mx.validators.SocialSecurityValidator, mx.validators.StringValidator, mx.validators.ZipCodeValidator

Validator クラス

Validator クラスは他のあらゆる検証クラスの基本クラスです。タグを宣言することによって、カスタマイズした検証関数向けに Validator クラスを使用することもできます。

MXML シンタックス

<mx:Validator> タグには、次のプロパティを使用できます。

 <mx:Validator
   field="required field name - no default"
   required="optional field boolean - default is "true""
   requiredFieldError="Message displayed when user doesn't complete a required field - default is "This field is required."
   listener="validation listener - no default"
   validate="event handler that performs validation - no default" 
 />

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

メソッド
`static`	`disable( doc:Object, objName:String) : Void`指定したオブジェクトの検証を無効にします。
	`doValidation( value) : Void`この検証のすべてのインスタンスに共通する検証ロジックを実行します。
`static`	`enable( doc:Object, objName:String) : Void`指定したオブジェクトの検証を有効にします。
	`hasErrors( ) : Boolean`現時点で検証にエラーがあるかどうかを返します。
`static`	`isStructureValid( doc:Object, structure:String) : Boolean`配下の構造が有効かどうかを調べます。
`static`	`isValid( doc:Object, objName:String) : Boolean`オブジェクトが有効かどうかを調べます。
`static`	`validateRequired( validator:mx.validators.Validator, value:Object, paramObj:Object, baseField:String) : Void`オブジェクトが自身の必須プロパティに基づいて有効かどうかを調べます。
	`validationError( errorCode:String, defaultMessage:String, subfield:String) : Void`この検証に対するエラーを追加します。

プロパティ
	`field:String`必須フィールド名を表します。メモ : このプロパティは MXML でのみ使用します。ActionScript では設定できません。
	`listener:String` 検証リスナーを表します。
	`required:Boolean` オプションの Boolean フィールドを表します。
	`requiredFieldError:String`エラーメッセージを表します。
	`validate:String`指定したフィールドを検証するために呼び出されるイベントハンドラを表します。

メソッドの詳細

disable

static  disable( doc:Object, objName:String)
										
													 :  Void

指定したオブジェクトの検証を無効にします。過去に設定された可能性のあるエラーをすべてクリアします。そのオブジェクトに対するバリデータがない場合は、なにも実行されません。

パラメータ
doc:Object - オブジェクトがある MXML ドキュメントを表します。
objName:String - オブジェクトを返すドキュメントに関連するストリングを表します。

doValidation

doValidation( value)
										
													 :  Void

この検証のすべてのインスタンスに共通する検証ロジックを実行します。必須プロパティを検証します。エラーを報告するには validationError() メソッドを呼び出す必要があります。

パラメータ
value - 検証する値を表します。

enable

static  enable( doc:Object, objName:String)
										
													 :  Void

指定したオブジェクトの検証を有効にします。そのオブジェクトに対するバリデータがない場合は、なにも実行されません。

パラメータ
doc:Object - このオブジェクトを含む MXML ドキュメントを表します。
objName:String - オブジェクトを返すドキュメントに関連するストリングを表します。

hasErrors

hasErrors( )
										
													 :  Boolean

現時点で検証にエラーがあるかどうかを返します。検証をさらに詳しく行う必要があるかどうかを判断するのに便利です。

isStructureValid

static  isStructureValid( doc:Object, structure:String)
										
													 :  Boolean

配下の構造が有効かどうかを調べます。これにより、渡されたストリングに "." を加えたストリングで始まるすべての検証をひととおり実行します。メモ : フィールド自体は検証されません。このため、自分自身から isStructureValid() を呼び出して子を検証することが可能な検証を記述できます。

パラメータ
doc:Object - 構造を含む MXML ドキュメントを表します。
structure:String - 実行するすべての検証の親であるドキュメントに関連するストリングを表します。

戻り値
見つかったすべてのバリデータが有効な場合、またはバリデータが 1 つも見つからない場合は、true を返します。無効な場合には、false を返します。

isValid

static  isValid( doc:Object, objName:String)
										
													 :  Boolean

オブジェクトが有効かどうかを調べます。

パラメータ
doc:Object - プロパティを含む MXML ドキュメントを表します。
objName:String - オブジェクトを返すドキュメントに関連するストリングを表します。

戻り値
オブジェクトが有効かどうかを返します。オブジェクトに対する検証がない場合、または検証が無効にされている場合は、true を返します。

validateRequired

static  validateRequired( validator:mx.validators.Validator, value:Object, paramObj:Object, baseField:String)
										
													 :  Void

オブジェクトが自身の必須プロパティに基づいて有効かどうかを調べます。

パラメータ
    validator:mx.validators.Validator -
    value:Object - 検証する値を表します。
    paramObj:Object -
    baseField:String -

validationError

validationError( errorCode:String, defaultMessage:String, subfield:String)
										
													 :  Void

この検証に対するエラーを追加します。

パラメータ
    errorCode:String - エラー条件を示すストリングを表します。ローカライズ目的や条件付きロジックに使用されることがあります。
    defaultMessage:String - このエラーケース用に使用するメッセージを表します。たとえば、MXML の中でこのパラメータに対してオーバーライドできる変数を使用することが考えられます。
    subfield:String - このエラーの原因となった検証対象のオブジェクトに関連するフィールドを表します。

プロパティの詳細

field

field:String

必須フィールド名を表します。
メモ : このプロパティは MXML でのみ使用します。ActionScript では設定できません。

listener

listener:String

検証リスナーを表します。リスナーを指定しない場合、各 Validator はデフォルトのリスナーを使用します。
メモ : このプロパティは MXML でのみ使用します。ActionScript では設定できません。

required

required:Boolean

オプションの Boolean フィールドを表します。必須かどうかを指定しない場合、各 Validator は "true" をデフォルトとして使用します。

requiredFieldError

requiredFieldError:String

エラーメッセージを表します。デフォルト値は "This field is required." です。

validate

validate:String

指定したフィールドを検証するために呼び出されるイベントハンドラを表します。

例

SimpleValidator.mxml

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

<mx:Script>
<![CDATA[
import mx.controls.Alert;

function checkValidity()
          {
var temp;
temp= mx.validators.Validator.isStructureValid(this,'CheckModel');

if (temp == true)
mx.controls.Alert.show(" The Information Entered is Valid!!", "Validity Check Box",
Alert.OK);
          }

    ]]>
</mx:Script>

<mx:Model id="CheckModel">
<FirstName>{fname.text}</FirstName>
<DOB>{dob.text}</DOB>
<Email>{email.text}</Email>
<Age>{age.text}</Age>
<SSN>{ssn.text}</SSN>
<Zip>{zip.text}</Zip>
<Phone>{phone.text}</Phone>
</mx:Model>

<mx:Panel title="Validation Check Panel" backgroundColor="#0C8BF3" width="100%" height="100%">

<mx:HBox width="100%" height="100%">

<mx:Form color="#FFFFFF">

<mx:FormItem label="Name(required):" required="true" direction="horizontal">
<mx:TextInput id="fname" width="200" color="#000000"/>
</mx:FormItem>

<mx:FormItem label="Date of birth (dd/mm/yyyy):" required="true">
<mx:TextInput id="dob" width="200" color="#000000"/>
</mx:FormItem>

<mx:FormItem label="E-mail address:" required="true">
<mx:TextInput id="email" width="200" color="#000000"/>
</mx:FormItem>

<mx:FormItem label="Age between 18 and 50:" required="true">
<mx:TextInput id="age" width="200" color="#000000"/>
</mx:FormItem>

<mx:FormItem label="Social security no:" required="true">
<mx:TextInput id="ssn" width="200" color="#000000"/>
</mx:FormItem>

<mx:FormItem label="Zip:" required="true">
<mx:TextInput id="zip" width="200" color="#000000"/>
</mx:FormItem>

<mx:FormItem label="Enter 10-digit phone no:" required="true">
<mx:TextInput id="phone" width="200" color="#000000" maxChars="10"/>
</mx:FormItem>

<mx:FormItem>
<mx:Button label="Check Model validity" click="checkValidity()" color="#000000"/>
</mx:FormItem>

</mx:Form>

</mx:HBox>

</mx:Panel>

<mx:StringValidator field="CheckModel.FirstName" minLength="4" maxLength="12"/>
<mx:PhoneNumberValidator field="CheckModel.Phone"/>
<mx:DateValidator field="CheckModel.DOB"/>
<mx:EmailValidator field="CheckModel.Email"/>
<mx:NumberValidator field="CheckModel.Age" integerError="Enter Integer value"
minValue="18" maxValue="50" domain="int"/>
<mx:SocialSecurityValidator field="CheckModel.SSN"/>
<mx:ZipCodeValidator field="CheckModel.Zip"/>

</mx:Application>

mx.validators Validator クラス