| パッケージ | mx.validators |
| クラス | public class StringValidator |
| 継承 | StringValidator  Validator EventDispatcher Object |
| 言語バージョン: | ActionScript 3.0 |
| 製品バージョン: | Flex 3 |
| ランタイムバージョン: | Flash Player 9, AIR 1.1 |
MXML シンタックスを表示
MXML シンタックスを隠す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."
/>
パブリックプロパティ
| プロパティ | 定義元 | ||
|---|---|---|---|
 | constructor : Object
指定されたオブジェクトインスタンスのクラスオブジェクトまたはコンストラクター関数への参照です。 | Object | |
| enabled : Boolean
この値を false に設定すると、バリデーターによる検証が行えなくなります。 | Validator | |
| listener : Object
検証のリスナーを指定します。 | Validator | |
| maxLength : Object
有効なストリングの最大の長さを表します。 | StringValidator | ||
| minLength : Object
有効なストリングの最小の長さを表します。 | StringValidator | ||
| property : String
検証する値を含む source オブジェクトのプロパティの名前を指定するストリングを表します。 | Validator | |
| required : Boolean = true
true の場合、検証エラーの原因となる欠損値または空値を指定します。 | Validator | |
| requiredFieldError : String
値が欠損し、required プロパティが true の場合に発生するエラーメッセージです。 | Validator | |
| source : Object
検証するプロパティを含むオブジェクトを指定します。 | Validator | |
| tooLongError : String
ストリングの長さが maxLength プロパティの値より大きい場合に発生するエラーメッセージを表します。 | StringValidator | ||
| tooShortError : String
ストリングの長さが minLength プロパティの値より小さい場合に発生するエラーメッセージを表します。 | StringValidator | ||
| trigger : IEventDispatcher
バリデーターをトリガーするイベントの生成を行うコンポーネントを指定します。 | Validator | |
| triggerEvent : String
検証をトリガーするイベントを指定します。 | Validator | |
プロテクトプロパティ
パブリックメソッド
| メソッド | 定義元 | ||
|---|---|---|---|
コンストラクターです。 | StringValidator | ||
| 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 | |
[静的]
バリデーターを呼び出す上で便利なメソッドです。 | StringValidator | ||
|
指定されたオブジェクトのプリミティブな値を返します。 | Object | |
|
指定されたイベントタイプについて、この EventDispatcher オブジェクトまたはその祖先にイベントリスナーが登録されているかどうかを確認します。 | EventDispatcher | |
プロテクトメソッド
| メソッド | 定義元 | ||
|---|---|---|---|
|
バリデーターから送出された valid イベントおよび invalid イベントのすべてのリスナーを設定します。 | Validator | |
[オーバーライド]
ストリングを検証する上で基本クラスの doValidation() メソッドをオーバーライドします。 | StringValidator | ||
|
検証するオブジェクトを返します。 | Validator | |
|
エラー結果の配列から ValidationResultEvent を返します。 | Validator | |
|
value が null でない場合、true を返します。 | Validator | |
|
バリデーターから送出された valid イベントおよび invalid イベントのすべてのリスナーを切断します。 | Validator | |
|
このメソッドは、バリデーターが作成されたときと、ResourceManager が "change" イベントを送出してローカライズされたリソースが何らかの点で変更されたことを示すときに再び呼び出されます。 | Validator | |
プロテクト定数
プロパティの詳細
maxLength | プロパティ |
minLength | プロパティ |
tooLongError | プロパティ |
tooLongError:String| 言語バージョン: | ActionScript 3.0 |
| 製品バージョン: | Flex 3 |
| ランタイムバージョン: | Flash Player 9, AIR 1.1 |
ストリングの長さが maxLength プロパティの値より大きい場合に発生するエラーメッセージを表します。
デフォルト値： "This string is longer than the maximum allowed length. This must be less than {0} characters long."。
実装
public function get tooLongError():String public function set tooLongError(value:String):voidtooShortError | プロパティ |
tooShortError:String| 言語バージョン: | ActionScript 3.0 |
| 製品バージョン: | Flex 3 |
| ランタイムバージョン: | Flash Player 9, AIR 1.1 |
ストリングの長さが minLength プロパティの値より小さい場合に発生するエラーメッセージを表します。
デフォルト値： "This string is shorter than the minimum allowed length. This must be at least {0} characters long."。
実装
public function get tooShortError():String public function set tooShortError(value:String):voidコンストラクターの詳細
StringValidator | () | コンストラクター |
public function StringValidator()| 言語バージョン: | 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 つ含まれます。
|
validateString | () | メソッド |
public static function validateString(validator:StringValidator, value:Object, baseField:String = null):Array| 言語バージョン: | ActionScript 3.0 |
| 製品バージョン: | Flex 3 |
| ランタイムバージョン: | Flash Player 9, AIR 1.1 |
バリデーターを呼び出す上で便利なメソッドです。 他の標準 Flex バリデーターにもそれぞれ同様の便利なメソッドがあります。
パラメーター
validator:StringValidator — StringValidator インスタンスを表します。
| |
value:Object — 検証するフィールドを表します。
| |
baseField:String (default = null)value パラメーターで指定したサブフィールドのテキスト表現です。 例えば、value パラメーターで value.mystring を指定する場合、baseField の値は "mystring" です。
|
Array — ValidationResult オブジェクトの配列です。このオブジェクトは、検証が行われるフィールドごとに 1 つ含まれます。
|
関連する API エレメント
例 この例の使用方法
StringValidatorExample.mxml
<?xml version="1.0" encoding="utf-8"?>
<!-- Simple example to demonstrate StringValidator. -->
<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: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!');"
invalid="Alert.show('Validation Failed!');"/>
</fx:Declarations>
<s:Panel title="StringValidator Example"
width="75%" height="75%"
horizontalCenter="0" verticalCenter="0">
<mx:Form left="10" right="10" top="10" bottom="10">
<mx:FormItem label="Enter a name between 4 and 20 characters: ">
<s:TextInput id="fname" 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