| Paquete | mx.validators |
| Clase | public class Validator |
| Herencia | Validator  EventDispatcher Object |
| Implementa | IMXMLObject, IValidator |
| Subclases | CreditCardValidator, CurrencyValidator, DateValidator, EmailValidator, MultiTriggerValidator, MultiTriggerValidator, NumberValidator, PhoneNumberValidator, RegExpValidator, SocialSecurityValidator, StringValidator, StyleValidator, ZipCodeValidator |
| Versión del lenguaje: | ActionScript 3.0 |
| Versión de producto: | Flex 3 |
| Versiones de motor de ejecución: | Flash Player 9, AIR 1.1 |
Mostrar sintaxis MXML
Ocultar sintaxis MXMLThe Validator class defines the following tag attributes, which all of its subclasses inherit:
<mx:Validator
enabled="true|false"
listener="Value of the source property"
property="No default"
required="true|false"
requiredFieldError="This field is required."
source="No default"
trigger="Value of the source property"
triggerEvent="valueCommit"
/>
Más ejemplos
Elementos de API relacionados
| Propiedad | Definido por | ||
|---|---|---|---|
 | constructor : Object
Una referencia a la clase de objeto o función constructora para una instancia de objeto determinada. | Object | |
| enabled : Boolean
Setting this value to false will stop the validator
from performing validation. | Validator | ||
| listener : Object
Specifies the validation listener. | Validator | ||
| 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 | ||
| trigger : IEventDispatcher
Specifies the component generating the event that triggers the validator. | Validator | ||
| triggerEvent : String
Specifies the event that triggers the validation. | Validator | ||
| Propiedad | Definido por | ||
|---|---|---|---|
| actualListeners : Array [solo lectura]
Contains an Array of listener objects, if any,
or the source object. | Validator | ||
| actualTrigger : IEventDispatcher [solo lectura]
Contains the trigger object, if any,
or the source object. | Validator | ||
| resourceManager : IResourceManager [solo lectura]
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 | ||
| Método | Definido por | ||
|---|---|---|---|
Constructor. | Validator | ||
| addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
Registra un objeto de detector de eventos con un objeto EventDispatcher, de modo que el detector reciba la notificación de un evento. | EventDispatcher | |
|
Distribuye un evento en el flujo del evento. | EventDispatcher | |
|
Comprueba si el objeto EventDispatcher tiene detectores registrados para un tipo concreto de evento. | EventDispatcher | |
|
Indica si un objeto tiene definida una propiedad especificada. | Object | |
Called automatically by the MXML compiler when the Validator
is created using an MXML tag. | Validator | ||
|
Indica si hay una instancia de la clase Object en la cadena de prototipo del objeto especificado como parámetro. | Object | |
|
Indica si existe la propiedad especificada y si es enumerable. | Object | |
|
Elimina un detector del objeto EventDispatcher. | EventDispatcher | |
|
Establece la disponibilidad de una propiedad dinámica para operaciones de bucle. | Object | |
|
Devuelve la representación de cadena de este objeto, con formato según las convenciones específicas de configuración regional. | Object | |
|
Devuelve la representación de cadena del objeto especificado. | Object | |
Performs validation and optionally notifies
the listeners of the result. | Validator | ||
[estática]
Invokes all the validators in the validators Array. | Validator | ||
|
Devuelve el valor simple del objeto especificado. | Object | |
|
Comprueba si hay registrado un detector de eventos con este objeto EventDispatcher o con cualquiera de sus ascendientes para el tipo de evento concreto. | EventDispatcher | |
| Método | Definido por | ||
|---|---|---|---|
Sets up all of the listeners for the
valid and invalid
events dispatched from the validator. | Validator | ||
Executes the validation logic of this validator,
including validating that a missing or empty value
causes a validation error as defined by
the value of the required property. | Validator | ||
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 | ||
| Evento | Resumen | Definido por | ||
|---|---|---|---|---|
| [evento broadcast] Se distribuye cuando Flash Player o AIR pasan a estar activos. | EventDispatcher | ||
| [evento broadcast] Se distribuye cuando Flash Player o de AIR pasan a estar inactivos. | EventDispatcher | ||
| Dispatched when validation fails. | Validator | |||
| Dispatched when validation succeeds. | Validator | |||
| Constante | Definido por | ||
|---|---|---|---|
| DECIMAL_DIGITS : String = "0123456789" [estática]
A String containing the decimal digits 0 through 9. | Validator | ||
| ROMAN_LETTERS : String = "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz" [estática]
A string containing the upper- and lower-case letters
of the Roman alphabet ("A" through "Z" and "a" through "z"). | Validator | ||
actualListeners | propiedad |
actualListeners:Array [solo lectura] | Versión del lenguaje: | ActionScript 3.0 |
| Versión de producto: | Flex 3 |
| Versiones de motor de ejecución: | Flash Player 9, AIR 1.1 |
Contains an Array of listener objects, if any, or the source object. Used to determine which object to notify about the validation result.
Implementación
protected function get actualListeners():ArrayactualTrigger | propiedad |
actualTrigger:IEventDispatcher [solo lectura] | Versión del lenguaje: | ActionScript 3.0 |
| Versión de producto: | Flex 3 |
| Versiones de motor de ejecución: | Flash Player 9, AIR 1.1 |
Contains the trigger object, if any,
or the source object. Used to determine the listener object
for the triggerEvent.
Implementación
protected function get actualTrigger():IEventDispatcherenabled | propiedad |
enabled:Boolean| Versión del lenguaje: | ActionScript 3.0 |
| Versión de producto: | Flex 3 |
| Versiones de motor de ejecución: | Flash Player 9, AIR 1.1 |
Setting this value to false will stop the validator
from performing validation.
When a validator is disabled, it dispatch no events,
and the validate() method returns null.
El valor predeterminado es true.
Implementación
public function get enabled():Boolean public function set enabled(value:Boolean):voidlistener | propiedad |
listener:Object| Versión del lenguaje: | ActionScript 3.0 |
| Versión de producto: | Flex 3 |
| Versiones de motor de ejecución: | Flash Player 9, AIR 1.1 |
Specifies the validation listener.
If you do not specify a listener,
Flex uses the value of the source property.
After Flex determines the source component,
it changes the border color of the component,
displays an error message for a failure,
or hides any existing error message for a successful validation.
Implementación
public function get listener():Object public function set listener(value:Object):voidproperty | propiedad |
property:String| Versión del lenguaje: | ActionScript 3.0 |
| Versión de producto: | Flex 3 |
| Versiones de motor de ejecución: | Flash Player 9, AIR 1.1 |
A String specifying the name of the property
of the source object that contains
the value to validate.
The property is optional, but if you specify source,
you should set a value for this property as well.
El valor predeterminado es null.
Implementación
public function get property():String public function set property(value:String):voidrequired | propiedad |
public var required:Boolean = true| Versión del lenguaje: | ActionScript 3.0 |
| Versión de producto: | Flex 3 |
| Versiones de motor de ejecución: | Flash Player 9, AIR 1.1 |
If true, specifies that a missing or empty
value causes a validation error.
El valor predeterminado es true.
requiredFieldError | propiedad |
requiredFieldError:String| Versión del lenguaje: | ActionScript 3.0 |
| Versión de producto: | Flex 3 |
| Versiones de motor de ejecución: | Flash Player 9, AIR 1.1 |
Error message when a value is missing and the
required property is true.
El valor predeterminado es "This field is required.".
Implementación
public function get requiredFieldError():String public function set requiredFieldError(value:String):voidresourceManager | propiedad |
resourceManager:IResourceManager [solo lectura] | Versión del lenguaje: | ActionScript 3.0 |
| Versión de producto: | Flex 3 |
| Versiones de motor de ejecución: | Flash Player 9, AIR 1.1 |
A reference to the object which manages all of the application's localized resources. This is a singleton instance which implements the IResourceManager interface.
Esta propiedad se puede utilizar como origen para la vinculación de datos. Cuando se modifica esta propiedad, distribuye el evento unused .
Implementación
protected function get resourceManager():IResourceManagersource | propiedad |
source:Object| Versión del lenguaje: | ActionScript 3.0 |
| Versión de producto: | Flex 3 |
| Versiones de motor de ejecución: | Flash Player 9, AIR 1.1 |
Specifies the object containing the property to validate.
Set this to an instance of a component or a data model.
You use data binding syntax in MXML to specify the value.
This property supports dot-delimited Strings
for specifying nested properties.
If you specify a value to the source property,
then you should specify a value to the property
property as well.
The source property is optional.
El valor predeterminado es null.
Implementación
public function get source():Object public function set source(value:Object):voidsubFields | propiedad |
protected var subFields:Array| Versión del lenguaje: | ActionScript 3.0 |
| Versión de producto: | Flex 3 |
| Versiones de motor de ejecución: | Flash Player 9, AIR 1.1 |
An Array of Strings containing the names for the properties contained
in the value Object passed to the validate() method.
For example, CreditCardValidator sets this property to
[ "cardNumber", "cardType" ].
This value means that the value Object
passed to the validate() method
should contain a cardNumber and a cardType property.
Subclasses of the Validator class that validate multiple data fields (like CreditCardValidator and DateValidator) should assign this property in their constructor.
trigger | propiedad |
trigger:IEventDispatcher| Versión del lenguaje: | ActionScript 3.0 |
| Versión de producto: | Flex 3 |
| Versiones de motor de ejecución: | Flash Player 9, AIR 1.1 |
Specifies the component generating the event that triggers the validator.
If omitted, by default Flex uses the value of the source property.
When the trigger dispatches a triggerEvent,
validation executes.
Implementación
public function get trigger():IEventDispatcher public function set trigger(value:IEventDispatcher):voidtriggerEvent | propiedad |
triggerEvent:String| Versión del lenguaje: | ActionScript 3.0 |
| Versión de producto: | Flex 3 |
| Versiones de motor de ejecución: | Flash Player 9, AIR 1.1 |
Specifies the event that triggers the validation.
If omitted, Flex uses the valueCommit event.
Flex dispatches the valueCommit event
when a user completes data entry into a control.
Usually this is when the user removes focus from the component,
or when a property value is changed programmatically.
If you want a validator to ignore all events,
set triggerEvent to the empty string ("").
Implementación
public function get triggerEvent():String public function set triggerEvent(value:String):voidValidator | () | Información sobre |
public function Validator()| Versión del lenguaje: | ActionScript 3.0 |
| Versión de producto: | Flex 3 |
| Versiones de motor de ejecución: | Flash Player 9, AIR 1.1 |
Constructor.
addListenerHandler | () | método |
protected function addListenerHandler():void| Versión del lenguaje: | ActionScript 3.0 |
| Versión de producto: | Flex 3 |
| Versiones de motor de ejecución: | Flash Player 9, AIR 1.1 |
Sets up all of the listeners for the
valid and invalid
events dispatched from the validator. Subclasses of the Validator class
should first call the removeListenerHandler() method,
and then the addListenerHandler() method if
the value of one of their listeners or sources changes.
The CreditCardValidator and DateValidator classes use this function internally.
doValidation | () | método |
protected function doValidation(value:Object):Array| Versión del lenguaje: | ActionScript 3.0 |
| Versión de producto: | Flex 3 |
| Versiones de motor de ejecución: | Flash Player 9, AIR 1.1 |
Executes the validation logic of this validator,
including validating that a missing or empty value
causes a validation error as defined by
the value of the required property.
If you create a subclass of a validator class, you must override this method.
Parámetros
value:Object — Value to validate.
|
Array — For an invalid result, an Array of ValidationResult objects,
with one ValidationResult object for each field examined
by the validator that failed validation.
|
Más ejemplos
Elementos de API relacionados
getValueFromSource | () | método |
protected function getValueFromSource():Object| Versión del lenguaje: | ActionScript 3.0 |
| Versión de producto: | Flex 3 |
| Versiones de motor de ejecución: | Flash Player 9, AIR 1.1 |
Returns the Object to validate. Subclasses, such as the CreditCardValidator and DateValidator classes, override this method because they need to access the values from multiple subfields.
Valor devueltoObject — The Object to validate.
|
handleResults | () | método |
protected function handleResults(errorResults:Array):ValidationResultEvent| Versión del lenguaje: | ActionScript 3.0 |
| Versión de producto: | Flex 3 |
| Versiones de motor de ejecución: | Flash Player 9, AIR 1.1 |
Returns a ValidationResultEvent from the Array of error results.
Internally, this function takes the results from the
doValidation() method and puts it into a ValidationResultEvent object.
Subclasses, such as the RegExpValidator class,
should override this function if they output a subclass
of ValidationResultEvent objects, such as the RegExpValidationResult objects, and
needs to populate the object with additional information. You never
call this function directly, and you should rarely override it.
Parámetros
errorResults:Array — Array of ValidationResult objects.
|
ValidationResultEvent — The ValidationResultEvent returned by the validate() method.
|
initialized | () | método |
public function initialized(document:Object, id:String):void| Versión del lenguaje: | ActionScript 3.0 |
| Versión de producto: | Flex 3 |
| Versiones de motor de ejecución: | Flash Player 9, AIR 1.1 |
Called automatically by the MXML compiler when the Validator is created using an MXML tag.
Parámetros
document:Object — The MXML document containing this Validator.
| |
id:String — Ignored.
|
isRealValue | () | método |
protected function isRealValue(value:Object):Boolean| Versión del lenguaje: | ActionScript 3.0 |
| Versión de producto: | Flex 3 |
| Versiones de motor de ejecución: | Flash Player 9, AIR 1.1 |
Returns true if value is not null.
Parámetros
value:Object — The value to test.
|
Boolean — true if value is not null.
|
removeListenerHandler | () | método |
protected function removeListenerHandler():void| Versión del lenguaje: | ActionScript 3.0 |
| Versión de producto: | Flex 3 |
| Versiones de motor de ejecución: | Flash Player 9, AIR 1.1 |
Disconnects all of the listeners for the
valid and invalid
events dispatched from the validator. Subclasses should first call the
removeListenerHandler() method and then the
addListenerHandler method if
the value of one of their listeners or sources changes.
The CreditCardValidator and DateValidator classes use this function internally.
resourcesChanged | () | método |
protected function resourcesChanged():void| Versión del lenguaje: | ActionScript 3.0 |
| Versión de producto: | Flex 3 |
| Versiones de motor de ejecución: | Flash Player 9, AIR 1.1 |
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.
This event will be dispatched when you set the ResourceManager's
localeChain property, when a resource module
has finished loading, and when you call the ResourceManager's
update() method.
Subclasses should override this method and, after calling
super.resourcesChanged(), do whatever is appropriate
in response to having new resource values.
validate | () | método |
public function validate(value:Object = null, suppressEvents:Boolean = false):ValidationResultEvent| Versión del lenguaje: | ActionScript 3.0 |
| Versión de producto: | Flex 3 |
| Versiones de motor de ejecución: | Flash Player 9, AIR 1.1 |
Performs validation and optionally notifies the listeners of the result.
Parámetros
value:Object (default = null)source and
property properties to determine the value.
If you specify this argument, you should also set the
listener property to specify the target component
for any validation error messages.
| |
suppressEvents:Boolean (default = false)false, then after validation,
the validator will notify the listener of the result.
|
ValidationResultEvent — A ValidationResultEvent object
containing the results of the validation.
For a successful validation, the
ValidationResultEvent.results Array property is empty.
For a validation failure, the
ValidationResultEvent.results Array property contains
one ValidationResult object for each field checked by the validator,
both for fields that failed the validation and for fields that passed.
Examine the ValidationResult.isError
property to determine if the field passed or failed the validation.
|
Elementos de API relacionados
validateAll | () | método |
public static function validateAll(validators:Array):Array| Versión del lenguaje: | ActionScript 3.0 |
| Versión de producto: | Flex 3 |
| Versiones de motor de ejecución: | Flash Player 9, AIR 1.1 |
Invokes all the validators in the validators Array.
Returns an Array containing one ValidationResultEvent object
for each validator that failed.
Returns an empty Array if all validators succeed.
Parámetros
validators:Array — An Array containing the Validator objects to execute.
|
Array — Array of ValidationResultEvent objects, where the Array
contains one ValidationResultEvent object for each validator
that failed.
The Array is empty if all validators succeed.
|
invalid | Evento |
mx.events.ValidationResultEventpropiedad ValidationResultEvent.type =
mx.events.ValidationResultEvent.INVALID| Versión del lenguaje: | ActionScript 3.0 |
| Versión de producto: | Flex 3 |
| Versiones de motor de ejecución: | Flash Player 9, AIR 1.1 |
Dispatched when validation fails.
TheValidationResultEvent.INVALID constant defines the value of the
type property of the event object for an invalid event.
The value of this constant is "invalid".
The properties of the event object have the following values:
| Property | Value |
|---|---|
bubbles | false |
cancelable | false |
currentTarget | The Object that defines the
event listener that handles the event. For example, if you use
myButton.addEventListener() to register an event listener,
myButton is the value of the currentTarget. |
field | The name of the field that failed validation. |
message | A single string that contains every error message from all of the ValidationResult objects in the results Array. |
results | An array of ValidationResult objects, one per validated field. |
target | The Object that dispatched the event;
it is not always the Object listening for the event.
Use the currentTarget property to always access the
Object listening for the event. |
valid | Evento |
mx.events.ValidationResultEventpropiedad ValidationResultEvent.type =
mx.events.ValidationResultEvent.VALID| Versión del lenguaje: | ActionScript 3.0 |
| Versión de producto: | Flex 3 |
| Versiones de motor de ejecución: | Flash Player 9, AIR 1.1 |
Dispatched when validation succeeds.
TheValidationResultEvent.VALID constant defines the value of the
type property of the event object for a validevent.
The value of this constant is "valid".
The properties of the event object have the following values:
| Property | Value |
|---|---|
bubbles | false |
cancelable | false |
currentTarget | The Object that defines the
event listener that handles the event. For example, if you use
myButton.addEventListener() to register an event listener,
myButton is the value of the currentTarget. |
field | An empty String. |
message | An empty String. |
results | An empty Array. |
target | The Object that dispatched the event;
it is not always the Object listening for the event.
Use the currentTarget property to always access the
Object listening for the event. |
DECIMAL_DIGITS | Constante |
protected static const DECIMAL_DIGITS:String = "0123456789"| Versión del lenguaje: | ActionScript 3.0 |
| Versión de producto: | Flex 3 |
| Versiones de motor de ejecución: | Flash Player 9, AIR 1.1 |
A String containing the decimal digits 0 through 9.
ROMAN_LETTERS | Constante |
protected static const ROMAN_LETTERS:String = "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz"| Versión del lenguaje: | ActionScript 3.0 |
| Versión de producto: | Flex 3 |
| Versiones de motor de ejecución: | Flash Player 9, AIR 1.1 |
A string containing the upper- and lower-case letters of the Roman alphabet ("A" through "Z" and "a" through "z").
<?xml version="1.0" encoding="utf-8"?>
<!-- Simple example to demonstrate the Validator class. -->
<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>
<![CDATA[
// Import necessary classes.
import mx.controls.Alert;
import mx.events.ValidationResultEvent;
// Event listener for the valid and invalid events.
private function handleValid(evt:ValidationResultEvent):void {
if (evt.type == ValidationResultEvent.VALID) {
// Enable Submit button.
submitButton.enabled = true;
} else {
submitButton.enabled = false;
}
}
// Submit form is everything is valid.
private function submitForm():void {
Alert.show("Form Submitted!");
}
]]>
</fx:Script>
<fx:Declarations>
<!-- The Validator class defines the required property and the validator events
used by all validator subclasses. -->
<mx:Validator id="reqValid" required="true"
source="{fname}" property="text"
valid="handleValid(event)"
invalid="handleValid(event);" />
</fx:Declarations>
<s:Panel title="Validator Example"
width="75%" height="75%"
horizontalCenter="0" verticalCenter="0">
<mx:Form left="10" right="10" top="10" bottom="10">
<mx:FormItem>
<mx:Text width="100%" color="blue"
text="Enter a value in the Name field before you can submit. The E-mail field is optional."/>
</mx:FormItem>
<mx:FormItem label="Name: " required="true">
<mx:TextInput id="fname" width="100%"/>
</mx:FormItem>
<mx:FormItem label="E-mail address: " required="false">
<mx:TextInput id="email" width="100%"/>
</mx:FormItem>
<mx:FormItem>
<mx:Button id="submitButton" enabled="false"
label="Submit" click="submitForm();"/>
</mx:FormItem>
</mx:Form>
</s:Panel>
</s:Application>
Tue Jun 12 2018, 02:12 PM Z