| Package | mx.validators |
| Class | public class StringValidator |
| Inheritance | StringValidator  Validator flash.events.EventDispatcher |
| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 3 |
| Runtime Versions : | Flash Player 9, AIR 1.1 |
Hide MXML SyntaxThe <mx:StringValidator> tag
inherits all of the tag attributes of its superclass,
and add the following tag attributes:
Show MXML Syntax
<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."
/>
| Property | Defined By | ||
|---|---|---|---|
 | 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 | |
| Method | Defined By | ||
|---|---|---|---|
Constructor. | StringValidator | ||
| initialized(document:Object, id:String):void
Called automatically by the MXML compiler when the Validator
is created using an MXML tag. | Validator | |
| validate(value:Object = null, suppressEvents:Boolean = false):ValidationResultEvent
Performs validation and optionally notifies
the listeners of the result. | Validator | |
| validateAll(validators:Array):Array [static]
Invokes all the validators in the validators Array. | Validator | |
validateString(validator:StringValidator, value:Object, baseField:String = null):Array [static]
Convenience method for calling a validator. | StringValidator | ||
| Method | Defined By | ||
|---|---|---|---|
| addListenerHandler():void
Sets up all of the listeners for the
valid and invalid
events dispatched from the validator. | Validator | |
doValidation(value:Object):Array [override]
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 | |
| maxLength | property |
maxLength:Object| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 3 |
| Runtime Versions : | Flash Player 9, AIR 1.1 |
Maximum length for a valid String. A value of NaN means this property is ignored.
The default value is NaN.
public function get maxLength():Object public function set maxLength(value:Object):void| minLength | property |
minLength:Object| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 3 |
| Runtime Versions : | Flash Player 9, AIR 1.1 |
Minimum length for a valid String. A value of NaN means this property is ignored.
The default value is NaN.
public function get minLength():Object public function set minLength(value:Object):void| tooLongError | property |
tooLongError:String| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 3 |
| Runtime Versions : | Flash Player 9, AIR 1.1 |
Error message when the String is longer
than the maxLength property.
The default value is "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 | property |
tooShortError:String| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 3 |
| Runtime Versions : | Flash Player 9, AIR 1.1 |
Error message when the string is shorter
than the minLength property.
The default value is "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 | () | Constructor |
public function StringValidator()| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 3 |
| Runtime Versions : | Flash Player 9, AIR 1.1 |
Constructor.
| doValidation | () | method |
override protected function doValidation(value:Object):Array| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 3 |
| Runtime Versions : | 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.
Parameters
value:Object — Object to validate.
|
Array — An Array of ValidationResult objects, with one ValidationResult
object for each field examined by the validator.
|
| validateString | () | method |
public static function validateString(validator:StringValidator, value:Object, baseField:String = null):Array| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 3 |
| Runtime Versions : | Flash Player 9, AIR 1.1 |
Convenience method for calling a validator. Each of the standard Flex validators has a similar convenience method.
Parameters
validator:StringValidator — The StringValidator instance.
| |
value:Object — A field to validate.
| |
baseField:String (default = null)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.
|
See also