StringValidator

套件	mx.validators
類別	public class StringValidator
繼承	StringValidator Validator EventDispatcher Object

語言版本:

ActionScript 3.0

產品版本:

Flex 3

執行階段版本:

Flash Player 9, AIR 1.1

The StringValidator class validates that the length of a String is within a specified range.

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 Setting this value to false will stop the validator from performing validation.	Validator
		listener : Object Specifies the validation listener.	Validator
		maxLength : Object Maximum length for a valid String.	StringValidator
		minLength : Object Minimum length for a valid String.	StringValidator
		property : String A String specifying the name of the property of the source object that contains the value to validate.	Validator
		required : Boolean = true If true, specifies that a missing or empty value causes a validation error.	Validator
		requiredFieldError : String Error message when a value is missing and the required property is true.	Validator
		source : Object Specifies the object containing the property to validate.	Validator
		tooLongError : String Error message when the String is longer than the maxLength property.	StringValidator
		tooShortError : String Error message when the string is shorter than the minLength property.	StringValidator
		trigger : IEventDispatcher Specifies the component generating the event that triggers the validator.	Validator
		triggerEvent : String Specifies the event that triggers the validation.	Validator

保護屬性

隱藏繼承保護屬性

顯示繼承保護屬性

	屬性		定義自
		actualListeners : Array [唯讀] Contains an Array of listener objects, if any, or the source object.	Validator
		actualTrigger : IEventDispatcher [唯讀] Contains the trigger object, if any, or the source object.	Validator
		resourceManager : IResourceManager [唯讀] A reference to the object which manages all of the application's localized resources.	Validator
		subFields : Array An Array of Strings containing the names for the properties contained in the value Object passed to the validate() method.	Validator

公用方法

隱藏繼承公用方法

顯示繼承公用方法

	方法		定義自
		StringValidator() Constructor.	StringValidator
		addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void 會在 EventDispatcher 物件註冊事件偵聽程式，以便讓偵聽程式收到事件的通知。	EventDispatcher
		dispatchEvent(event:Event):Boolean 會將事件傳送到事件流程。	EventDispatcher
		hasEventListener(type:String):Boolean 會檢查 EventDispatcher 物件是否有對特定的事件類型註冊偵聽程式。	EventDispatcher
		hasOwnProperty(name:String):Boolean 指出物件是否有已定義的指定屬性。	Object
		initialized(document:Object, id:String):void Called automatically by the MXML compiler when the Validator is created using an MXML tag.	Validator
		isPrototypeOf(theClass:Object):Boolean 指出 Object 類別的實體是否位於指定為參數的物件原型鏈中。	Object
		propertyIsEnumerable(name:String):Boolean 指出指定的屬性是否存在，以及是否可列舉。	Object
		removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void 會從 EventDispatcher 物件移除偵聽程式。	EventDispatcher
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void 為迴圈作業設定動態屬性的可用性。	Object
		toLocaleString():String 傳回代表此物件的字串，根據地區特定慣例進行格式化。	Object
		toString():String 會傳回指定之物件的字串形式。	Object
		validate(value:Object = null, suppressEvents:Boolean = false):ValidationResultEvent Performs validation and optionally notifies the listeners of the result.	Validator
		validateAll(validators:Array):Array [靜態] Invokes all the validators in the validators Array.	Validator
		validateString(validator:StringValidator, value:Object, baseField:String = null):Array [靜態] Convenience method for calling a validator.	StringValidator
		valueOf():Object 會傳回指定之物件的基本值。	Object
		willTrigger(type:String):Boolean 檢查此 EventDispatcher 物件是否已註冊事件偵聽程式，或者此物件的任何祖系已為特定事件類型註冊事件偵聽程式。	EventDispatcher

保護方法

隱藏繼承保護方法

顯示繼承保護方法

	方法		定義自
		addListenerHandler():void Sets up all of the listeners for the valid and invalid events dispatched from the validator.	Validator
		doValidation(value:Object):Array [覆寫] Override of the base class doValidation() method to validate a String.	StringValidator
		getValueFromSource():Object Returns the Object to validate.	Validator
		handleResults(errorResults:Array):ValidationResultEvent Returns a ValidationResultEvent from the Array of error results.	Validator
		isRealValue(value:Object):Boolean Returns true if value is not null.	Validator
		removeListenerHandler():void Disconnects all of the listeners for the valid and invalid events dispatched from the validator.	Validator
		resourcesChanged():void This method is called when a Validator is constructed, and again whenever the ResourceManager dispatches a "change" Event to indicate that the localized resources have changed in some way.	Validator

事件

按一下以瞭解事件的詳細資訊

隱藏繼承事件

顯示繼承事件

	摘要	定義自
activate	[廣播事件] 當 Flash Player 或 AIR 應用程式取得作業系統焦點並成為作用中時傳送。	EventDispatcher
deactivate	[廣播事件] 當 Flash Player 或 AIR 應用程式失去作業系統焦點並成為非作用中時傳送。	EventDispatcher
invalid	Dispatched when validation fails.	Validator
valid	Dispatched when validation succeeds.	Validator

保護常數

隱藏繼承保護常數

顯示繼承保護常數

	常數		定義自

屬性詳細資訊

maxLength

屬性

maxLength:Object

語言版本:

ActionScript 3.0

產品版本:

Flex 3

執行階段版本:

Flash Player 9, AIR 1.1

Maximum length for a valid String. A value of NaN means this property is ignored.

預設值為 NaN。

實作
public function get maxLength():Object
public function set maxLength(value:Object):void

minLength

屬性

minLength:Object

語言版本:

ActionScript 3.0

產品版本:

Flex 3

執行階段版本:

Flash Player 9, AIR 1.1

Minimum length for a valid String. A value of NaN means this property is ignored.

預設值為 NaN。

實作
public function get minLength():Object
public function set minLength(value:Object):void

tooLongError

屬性

tooLongError:String

語言版本:

ActionScript 3.0

產品版本:

Flex 3

執行階段版本:

Flash Player 9, AIR 1.1

Error message when the String is longer than the maxLength property.

預設值為 "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):void

tooShortError

屬性

tooShortError:String

語言版本:

ActionScript 3.0

產品版本:

Flex 3

執行階段版本:

Flash Player 9, AIR 1.1

Error message when the string is shorter than the minLength property.

預設值為 "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

建構函式詳細資料

()

建構函式

public function StringValidator()

語言版本:

ActionScript 3.0

產品版本:

Flex 3

執行階段版本:

Flash Player 9, AIR 1.1

Constructor.

方法詳細資訊

doValidation

()

方法

override protected function doValidation(value:Object):Array

語言版本:

ActionScript 3.0

產品版本:

Flex 3

執行階段版本:

Flash Player 9, AIR 1.1

Override of the base class doValidation() method to validate a String.

You do not call this method directly; Flex calls it as part of performing a validation. If you create a custom Validator class, you must implement this method.

參數

value:Object — Object to validate.

傳回值

Array — An Array of ValidationResult objects, with one ValidationResult object for each field examined by the validator.

validateString

()

方法

public static function validateString(validator:StringValidator, value:Object, baseField:String = null):Array

語言版本:

ActionScript 3.0

產品版本:

Flex 3

執行階段版本:

Flash Player 9, AIR 1.1

Convenience method for calling a validator. Each of the standard Flex validators has a similar convenience method.

參數

	`validator:StringValidator` — The StringValidator instance.

	`value:Object` — A field to validate.

	`baseField:String` (default = `null`) — Text representation of the subfield specified in the `value` parameter. For example, if the `value` parameter specifies value.mystring, the `baseField` value is `"mystring"`.

傳回值

Array — An Array of ValidationResult objects, with one ValidationResult object for each field examined by the validator.

相關 API 元素

mx.validators.ValidationResult

範例如何使用本範例

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>

法律聲明 | 線上隱私權政策

StringValidator - AS3 Flex

類別 x

maxLength

minLength

tooLongError

tooShortError