| Package | mx.validators |
| Class | public class StringValidator |
| Inheritance | StringValidator  Validator EventDispatcher Object |
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 | ||
|---|---|---|---|
 | constructor : Object
A reference to the class object or constructor function for a given object instance. | 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 | |
| prototype : Object [static]
A reference to the prototype object of a class or function object. | Object | |
| 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 | ||
| addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
Registers an event listener object with an EventDispatcher object so that the listener
receives notification of an event. | EventDispatcher | |
|
Dispatches an event into the event flow. | EventDispatcher | |
|
Checks whether the EventDispatcher object has any listeners registered for a specific type
of event. | EventDispatcher | |
|
Indicates whether an object has a specified property defined. | Object | |
|
Called automatically by the MXML compiler when the Validator
is created using an MXML tag. | Validator | |
|
Indicates whether an instance of the Object class is in the prototype chain of the object specified
as the parameter. | Object | |
|
Indicates whether the specified property exists and is enumerable. | Object | |
|
Removes a listener from the EventDispatcher object. | EventDispatcher | |
|
Sets the availability of a dynamic property for loop operations. | Object | |
|
Returns the string representation of this object, formatted according to locale-specific conventions. | Object | |
|
Returns the string representation of the specified object. | Object | |
|
Performs validation and optionally notifies
the listeners of the result. | Validator | |
| [static]
Invokes all the validators in the validators Array. | Validator | |
[static]
Convenience method for calling a validator. | StringValidator | ||
|
Returns the primitive value of the specified object. | Object | |
|
Checks whether an event listener is registered with this EventDispatcher object or any of
its ancestors for the specified event type. | EventDispatcher | |
| Method | Defined By | ||
|---|---|---|---|
|
Sets up all of the listeners for the
valid and invalid
events dispatched from the validator. | Validator | |
[override]
Override of the base class doValidation() method
to validate a String. | StringValidator | ||
|
Returns the Object to validate. | Validator | |
|
Returns a ValidationResultEvent from the Array of error results. | Validator | |
|
Returns true if value is not null. | Validator | |
|
Disconnects all of the listeners for the
valid and invalid
events dispatched from the validator. | Validator | |
|
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:ObjectMaximum 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:ObjectMinimum 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
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
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()Constructor.
| doValidation | () | method |
override protected function doValidation(value:Object):Array
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):ArrayConvenience 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
<?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>
