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

StringValidator クラスでは、ストリングの長さが指定の範囲内かどうかを検証します。

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

The <mx:StringValidator> tag inherits all of the tag attributes of its superclass, and add the following tag attributes:

  <mx:StringValidator
    maxLength="NaN" 
    minLength="NaN" 
    tooLongError="This string is longer than the maximum allowed length. This must be less than {0} characters long." 
    tooShortError="This string is shorter than the minimum allowed length. This must be at least {0} characters long." 
  />

例を表示


パブリックプロパティ
 プロパティ定義元
 Inheritedconstructor : Object
指定されたオブジェクトインスタンスのクラスオブジェクトまたはコンストラクタ関数への参照です。
Object
 Inheritedenabled : Boolean
この値を false に設定すると、バリデータによる検証が行えなくなります。
Validator
 Inheritedlistener : Object
検証のリスナーを指定します。
Validator
  maxLength : Object
有効なストリングの最大の長さを表します。
StringValidator
  minLength : Object
有効なストリングの最小の長さを表します。
StringValidator
 Inheritedproperty : String
検証する値を含む source オブジェクトのプロパティの名前を指定するストリングを表します。
Validator
 Inheritedprototype : Object
[静的] クラスまたは関数オブジェクトのプロトタイプオブジェクトへの参照です。
Object
 Inheritedrequired : Boolean = true
true の場合、検証エラーの原因となる欠損値または空値を指定します。
Validator
 InheritedrequiredFieldError : String
値が欠損し、required プロパティが true の場合に発生するエラーメッセージです。
Validator
 Inheritedsource : Object
検証するプロパティを含むオブジェクトを指定します。
Validator
  tooLongError : String
ストリングの長さが maxLength プロパティの値より大きい場合に発生するエラーメッセージを表します。
StringValidator
  tooShortError : String
ストリングの長さが minLength プロパティの値より小さい場合に発生するエラーメッセージを表します。
StringValidator
 Inheritedtrigger : IEventDispatcher
バリデータをトリガするイベントの生成を行うコンポーネントを指定します。
Validator
 InheritedtriggerEvent : String
検証をトリガするイベントを指定します。
Validator
プロテクトプロパティ
 プロパティ定義元
 InheritedactualListeners : Array
[読み取り専用] リスナーオブジェクトが存在する場合はリスナーオブジェクトを含みます。そうでない場合は、ソースオブジェクトを含みます。
Validator
 InheritedactualTrigger : IEventDispatcher
[読み取り専用] トリガオブジェクトが存在する場合はトリガオブジェクトを含みます。そうでない場合は、ソースオブジェクトを含みます。
Validator
 InheritedresourceManager : IResourceManager
[読み取り専用] アプリケーションのローカライズされたすべてのリソースを管理するオブジェクトへの参照です。
Validator
 InheritedsubFields : Array
validate() メソッドに渡された value オブジェクトに含まれるプロパティ名を含むストリングの配列です。
Validator
パブリックメソッド
 メソッド定義元
  
StringValidator()
コンストラクタです。
StringValidator
 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
  
validateString(validator:StringValidator, value:Object, baseField:String = null):Array
[静的] バリデータを呼び出す上で便利なメソッドです。
StringValidator
 Inherited
valueOf():Object
指定されたオブジェクトのプリミティブな値を返します。
Object
 Inherited
willTrigger(type:String):Boolean
指定されたイベントタイプについて、この EventDispatcher オブジェクトまたはその祖先にイベントリスナーが登録されているかどうかを確認します。
EventDispatcher
プロテクトメソッド
 メソッド定義元
 Inherited
addListenerHandler():void
バリデータから送出された valid イベントおよび invalid イベントのすべてのリスナーを設定します。
Validator
  
doValidation(value:Object):Array
[override] ストリングを検証する上で基本クラスの doValidation() メソッドをオーバーライドします。
StringValidator
 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
プロパティの詳細
maxLengthプロパティ
maxLength:Object

有効なストリングの最大の長さを表します。 値が NaN の場合、このプロパティは無視されます。

デフォルト値 : NaN.



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

有効なストリングの最小の長さを表します。 値が NaN の場合、このプロパティは無視されます。

デフォルト値 : NaN.



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

ストリングの長さが maxLength プロパティの値より大きい場合に発生するエラーメッセージを表します。

デフォルト値 : 「このストリングは最大値よりも長いストリングです。」「このストリングは {0} 文字未満である必要があります。」.



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

ストリングの長さが minLength プロパティの値より小さい場合に発生するエラーメッセージを表します。

デフォルト値 : 「このストリングは最小値よりも短いストリングです。」「このストリングは最低 {0} 文字である必要があります。」.



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

コンストラクタです。

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

ストリングを検証する上で基本クラスの doValidation() メソッドをオーバーライドします。

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

パラメータ

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

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

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

パラメータ

validator:StringValidator — StringValidator インスタンスを表します。
 
value:Object — 検証するフィールドを表します。
 
baseField:String (default = null) — value パラメータで指定したサブフィールドのテキスト表現です。 例えば、value パラメータで value.mystring を指定する場合、baseField の値は "mystring" です。

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

関連項目

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

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

    <mx:StringValidator source="{fname}" property="text" 
        tooShortError="This string is shorter than the minimum allowed length of 4. " 
        tooLongError="This string is longer than the maximum allowed length of 20." 
        minLength="4" maxLength="20"  
        trigger="{myButton}" triggerEvent="click" 
        valid="Alert.show('Validation Succeeded!');"/>

    <mx:Panel title="StringValidator Example" width="75%" height="75%" 
        paddingTop="10" paddingLeft="10" paddingRight="10" paddingBottom="10">

            <mx:Form>               
                <mx:FormItem label="Enter a name between 4 and 20 characters: ">
                    <mx:TextInput id="fname" 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/StringValidator.html