Package | mx.validators |
Classe | public class Validator |
Héritage | Validator EventDispatcher Object |
Implémente | IMXMLObject, IValidator |
Sous-classes | CreditCardValidator, CurrencyValidator, DateValidator, EmailValidator, MultiTriggerValidator, MultiTriggerValidator, NumberValidator, PhoneNumberValidator, RegExpValidator, SocialSecurityValidator, StringValidator, StyleValidator, ZipCodeValidator |
Version du langage: | ActionScript 3.0 |
Version du produit: | Flex 3 |
Versions du moteur d’exécution: | Flash Player 9, AIR 1.1 |
The 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" />
Eléments de l’API associés
Propriété | Défini par | ||
---|---|---|---|
constructor : Object
Référence à l’objet de classe ou à la fonction constructeur d’une occurrence donnée d’un objet. | Object | ||
enabled : Boolean
Si cette valeur est définie sur false, le programme de validation arrête la validation. | Validator | ||
listener : Object
Spécifie l’écouteur de validation. | Validator | ||
property : String
Chaîne spécifiant le nom de la propriété de l’objet source qui contient la valeur à valider. | Validator | ||
required : Boolean = true
Si true, indique qu’une valeur manquante ou vide provoque une erreur de validation. | Validator | ||
requiredFieldError : String
Message d’erreur lorsqu’une valeur est manquante et que la propriété requise est true. | Validator | ||
source : Object
Spécifie l’objet contenant la propriété à valider. | Validator | ||
trigger : IEventDispatcher
Spécifie le composant qui génère l’événement déclenchant le programme de validation. | Validator | ||
triggerEvent : String
Spécifie l’événement qui déclenche la validation. | Validator |
Propriété | Défini par | ||
---|---|---|---|
actualListeners : Array [lecture seule]
Contient un tableau d’objets d’écouteurs, le cas échéant, ou l’objet source. | Validator | ||
actualTrigger : IEventDispatcher [lecture seule]
Contient l’objet déclencheur, le cas échéant, ou l’objet source. | Validator | ||
resourceManager : IResourceManager [lecture seule]
Référence à l’objet qui gère toutes les ressources localisées de l’application. | Validator | ||
subFields : Array
Tableau de chaînes contenant les noms des propriétés contenues dans l’objet value transmis à la méthode validate(). | Validator |
Méthode | Défini par | ||
---|---|---|---|
Constructeur. | Validator | ||
addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
Enregistre un objet écouteur d’événement auprès d’un objet EventDispatcher afin que l’écouteur soit averti d’un événement. | EventDispatcher | ||
Distribue un événement dans le flux d’événements. | EventDispatcher | ||
Vérifie si des écouteurs sont enregistrés auprès de l’objet EventDispatcher pour un type spécifique d’événement. | EventDispatcher | ||
Indique si la propriété spécifiée d’un objet est définie. | Object | ||
Appelé automatiquement par le compilateur MXML lorsque la classe Validator est créée à l’aide d’une balise MXML. | Validator | ||
Indique si une occurrence de la classe Object figure dans la chaîne de prototype de l’objet spécifié en tant que paramètre. | Object | ||
Indique si la propriété spécifiée existe et est énumérable. | Object | ||
Supprime un écouteur de l’objet EventDispatcher. | EventDispatcher | ||
Définit la disponibilité d’une propriété dynamique pour les opérations en boucle. | Object | ||
Renvoie la représentation de chaîne de cet objet, formatée selon les paramètres régionaux en vigueur. | Object | ||
Renvoie la représentation sous forme de chaîne de l’objet spécifié. | Object | ||
Procède à la validation et, le cas échéant, informe les écouteurs du résultat. | Validator | ||
[statique]
Invoque tous les objets Validator dans le tableau d’objets Validator. | Validator | ||
Renvoie la valeur primitive de l’objet spécifié. | Object | ||
Vérifie si un écouteur d’événement est enregistré auprès de cet objet EventDispatcher ou de ses ancêtres pour le type d’événement spécifié. | EventDispatcher |
Méthode | Défini par | ||
---|---|---|---|
Définit tous les écouteurs pour les événements valid et invalid distribués à partir du programme de validation. | Validator | ||
Exécute la logique de validation de ce programme de validation, y compris la validation du fait qu’une classe manquante ou vide provoque une erreur de validation tel que défini par la valeur de la propriété requise. | Validator | ||
Renvoie l’objet à valider. | Validator | ||
Renvoie une classe ValidationResultEvent depuis le tableau des résultats d’erreurs. | Validator | ||
Renvoie true si la valeur n’est pas nulle. | Validator | ||
Déconnecte tous les écouteurs pour les événements valid et invalid distribués à partir du programme de validation. | Validator | ||
Cette méthode est appelée lorsqu’une classe Validator est construite et chaque fois que la classe ResourceManager distribue un événement « change » pour indiquer que les ressources localisées ont changé d’une manière ou d’une autre. | Validator |
Evénement | Synthèse | Défini par | ||
---|---|---|---|---|
[Evénement de diffusion] Distribué lorsque l’application Flash Player obtient le focus du système d’exploitation et devient active. | EventDispatcher | |||
[Evénement de diffusion] Distribué lorsque l’application Flash Player ou AIR perd le focus du système d’exploitation et devient inactive. | EventDispatcher | |||
Distribué si la validation échoue. | Validator | |||
Distribué si la validation réussit. | Validator |
Constante | Défini par | ||
---|---|---|---|
DECIMAL_DIGITS : String = "0123456789" [statique]
Chaîne contenant les chiffres décimaux de 0 à 9. | Validator | ||
ROMAN_LETTERS : String = "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz" [statique]
Chaîne contenant les lettres majuscules et minuscules de l’alphabet romain (« A » à « Z » et « a » à « z »). | Validator |
actualListeners | propriété |
actualListeners:Array
[lecture seule] Version du langage: | ActionScript 3.0 |
Version du produit: | Flex 3 |
Versions du moteur d’exécution: | Flash Player 9, AIR 1.1 |
Contient un tableau d’objets d’écouteurs, le cas échéant, ou l’objet source. Permet de déterminer quel objet informer du résultat de validation.
Implémentation
protected function get actualListeners():Array
actualTrigger | propriété |
actualTrigger:IEventDispatcher
[lecture seule] Version du langage: | ActionScript 3.0 |
Version du produit: | Flex 3 |
Versions du moteur d’exécution: | Flash Player 9, AIR 1.1 |
Contient l’objet déclencheur, le cas échéant, ou l’objet source. Permet de déterminer l’objet d’écouteur de l’événement triggerEvent
.
Implémentation
protected function get actualTrigger():IEventDispatcher
enabled | propriété |
enabled:Boolean
Version du langage: | ActionScript 3.0 |
Version du produit: | Flex 3 |
Versions du moteur d’exécution: | Flash Player 9, AIR 1.1 |
Si cette valeur est définie sur false
, le programme de validation arrête la validation. Lorsqu’un programme de validation est désactivé, il ne distribue aucun événement et la méthode validate()
renvoie null.
La valeur par défaut est true.
Implémentation
public function get enabled():Boolean
public function set enabled(value:Boolean):void
listener | propriété |
listener:Object
Version du langage: | ActionScript 3.0 |
Version du produit: | Flex 3 |
Versions du moteur d’exécution: | Flash Player 9, AIR 1.1 |
Spécifie l’écouteur de validation.
Si vous ne spécifiez aucun écouteur, Flex utilise la valeur de la propriété source
. Une fois que Flex a déterminé le composant source, il en change la couleur de bordure, affiche un message d’erreur pour un échec ou masque tout message d’erreur existant pour une validation réussie.
Implémentation
public function get listener():Object
public function set listener(value:Object):void
property | propriété |
property:String
Version du langage: | ActionScript 3.0 |
Version du produit: | Flex 3 |
Versions du moteur d’exécution: | Flash Player 9, AIR 1.1 |
Chaîne spécifiant le nom de la propriété de l’objet source
qui contient la valeur à valider. Cette propriété est facultative, mais si vous spécifiez la propriété source
, définissez également une valeur pour cette propriété.
La valeur par défaut est null.
Implémentation
public function get property():String
public function set property(value:String):void
required | propriété |
public var required:Boolean = true
Version du langage: | ActionScript 3.0 |
Version du produit: | Flex 3 |
Versions du moteur d’exécution: | Flash Player 9, AIR 1.1 |
Si true
, indique qu’une valeur manquante ou vide provoque une erreur de validation.
La valeur par défaut est true.
requiredFieldError | propriété |
requiredFieldError:String
Version du langage: | ActionScript 3.0 |
Version du produit: | Flex 3 |
Versions du moteur d’exécution: | Flash Player 9, AIR 1.1 |
Message d’erreur lorsqu’une valeur est manquante et que la propriété requise
est true
.
La valeur par défaut est "This field is required.".
Implémentation
public function get requiredFieldError():String
public function set requiredFieldError(value:String):void
resourceManager | propriété |
resourceManager:IResourceManager
[lecture seule] Version du langage: | ActionScript 3.0 |
Version du produit: | Flex 3 |
Versions du moteur d’exécution: | Flash Player 9, AIR 1.1 |
Référence à l’objet qui gère toutes les ressources localisées de l’application. Il s’agit d’une instance Singleton qui implémente l’interface IResourceManager.
Cette propriété peut être utilisée comme source de la liaison de données. Lorsque cette propriété est modifiée, elle distribue l’événement unused
.
Implémentation
protected function get resourceManager():IResourceManager
source | propriété |
source:Object
Version du langage: | ActionScript 3.0 |
Version du produit: | Flex 3 |
Versions du moteur d’exécution: | Flash Player 9, AIR 1.1 |
Spécifie l’objet contenant la propriété à valider. Définissez ceci sur une instance d’un composant ou d’un modèle de données. Utilisez la syntaxe de liaison de données dans MXML pour spécifier la valeur. Cette propriété prend en charge les chaînes séparées par des points pour spécifier des propriétés imbriquées. Si vous spécifiez une valeur pour la propriété source
, vous devez aussi en spécifier une pour la propriété property
. La propriété source
est facultative.
La valeur par défaut est null.
Implémentation
public function get source():Object
public function set source(value:Object):void
subFields | propriété |
protected var subFields:Array
Version du langage: | ActionScript 3.0 |
Version du produit: | Flex 3 |
Versions du moteur d’exécution: | Flash Player 9, AIR 1.1 |
Tableau de chaînes contenant les noms des propriétés contenues dans l’objet value
transmis à la méthode validate()
. Par exemple, CreditCardValidator définit cette propriété sur [ "cardNumber", "cardType" ]
. Cette valeur signifie que l’objet value
transmis à la méthode validate()
doit contenir une propriété cardNumber
et cardType
.
Les sous-classes de la classe Validator qui valident plusieurs champs de données (par exemple, CreditCardValidator et DateValidator) doivent assigner cette propriété dans leur constructeur.
trigger | propriété |
trigger:IEventDispatcher
Version du langage: | ActionScript 3.0 |
Version du produit: | Flex 3 |
Versions du moteur d’exécution: | Flash Player 9, AIR 1.1 |
Spécifie le composant qui génère l’événement déclenchant le programme de validation. Si omis, Flex utilise par défaut la valeur de la propriété source
. Lorsque le déclencheur
distribue un événement triggerEvent
, la validation s’exécute.
Implémentation
public function get trigger():IEventDispatcher
public function set trigger(value:IEventDispatcher):void
triggerEvent | propriété |
triggerEvent:String
Version du langage: | ActionScript 3.0 |
Version du produit: | Flex 3 |
Versions du moteur d’exécution: | Flash Player 9, AIR 1.1 |
Spécifie l’événement qui déclenche la validation. Si omis, Flex utilise l’événement valueCommit
. Flex distribue l’événement valueCommit
lorsqu’un utilisateur entre des données dans un contrôle. Cela se produit généralement lorsque l’utilisateur supprime le focus du composant ou lorsqu’une valeur de propriété est changée par programmation. Si vous voulez qu’un programme de validation ignore tous les événements, définissez triggerEvent
sur la chaîne vide ("").
Implémentation
public function get triggerEvent():String
public function set triggerEvent(value:String):void
Validator | () | Constructeur |
public function Validator()
Version du langage: | ActionScript 3.0 |
Version du produit: | Flex 3 |
Versions du moteur d’exécution: | Flash Player 9, AIR 1.1 |
Constructeur.
addListenerHandler | () | méthode |
protected function addListenerHandler():void
Version du langage: | ActionScript 3.0 |
Version du produit: | Flex 3 |
Versions du moteur d’exécution: | Flash Player 9, AIR 1.1 |
Définit tous les écouteurs pour les événements valid
et invalid
distribués à partir du programme de validation. Les sous-classes de la classe Validator doivent d’abord appeler la méthode removeListenerHandler()
, puis la méthode addListenerHandler()
si la valeur de l’un de leurs écouteurs ou de l’une de leurs sources change. Les classes CreditCardValidator et DateValidator utilisent cette fonction de manière interne.
doValidation | () | méthode |
protected function doValidation(value:Object):Array
Version du langage: | ActionScript 3.0 |
Version du produit: | Flex 3 |
Versions du moteur d’exécution: | Flash Player 9, AIR 1.1 |
Exécute la logique de validation de ce programme de validation, y compris la validation du fait qu’une classe manquante ou vide provoque une erreur de validation tel que défini par la valeur de la propriété requise
.
Si vous créez une sous-classe d’une classe Validator, vous devez remplacer cette méthode.
Paramètres
value:Object — Valeur à valider.
|
Array — Pour un résultat non valide, tableau d’objets ValidationResult, avec un objet ValidationResult pour chaque champ examiné par le programme de validation ayant échoué à la validation.
|
Eléments de l’API associés
getValueFromSource | () | méthode |
protected function getValueFromSource():Object
Version du langage: | ActionScript 3.0 |
Version du produit: | Flex 3 |
Versions du moteur d’exécution: | Flash Player 9, AIR 1.1 |
Renvoie l’objet à valider. Les sous-classes (par exemple, CreditCardValidator et DateValidator) remplacent cette méthode car elles doivent accéder aux valeurs de plusieurs sous-champs.
Valeur renvoyéeObject — Objet à valider.
|
handleResults | () | méthode |
protected function handleResults(errorResults:Array):ValidationResultEvent
Version du langage: | ActionScript 3.0 |
Version du produit: | Flex 3 |
Versions du moteur d’exécution: | Flash Player 9, AIR 1.1 |
Renvoie une classe ValidationResultEvent depuis le tableau des résultats d’erreurs. En interne, cette fonction extrait les résultats de la méthode doValidation()
pour les insérer dans un objet ValidationResultEvent. Les sous-classes (par exemple, la classe RegExpValidator) doivent remplacer cette fonction si elles produisent une sous-classe d’objets ValidationResultEvent (par exemple, les objets RegExpValidationResult) et doivent remplir l’objet avec des informations supplémentaires. Vous n’appelez jamais cette fonction directement et ne devez la remplacez que rarement.
Paramètres
errorResults:Array — Tableau des objets ValidationResult.
|
ValidationResultEvent — Classe ValidationResultEvent renvoyée par la méthode validate() .
|
initialized | () | méthode |
public function initialized(document:Object, id:String):void
Version du langage: | ActionScript 3.0 |
Version du produit: | Flex 3 |
Versions du moteur d’exécution: | Flash Player 9, AIR 1.1 |
Appelé automatiquement par le compilateur MXML lorsque la classe Validator est créée à l’aide d’une balise MXML.
Paramètres
document:Object — Document MXML contenant cette classe Validator.
| |
id:String — Ignoré.
|
isRealValue | () | méthode |
protected function isRealValue(value:Object):Boolean
Version du langage: | ActionScript 3.0 |
Version du produit: | Flex 3 |
Versions du moteur d’exécution: | Flash Player 9, AIR 1.1 |
Renvoie true
si la valeur value
n’est pas nulle.
Paramètres
value:Object — Valeur à tester.
|
Boolean — Renvoie true si la valeur value n’est pas nulle.
|
removeListenerHandler | () | méthode |
protected function removeListenerHandler():void
Version du langage: | ActionScript 3.0 |
Version du produit: | Flex 3 |
Versions du moteur d’exécution: | Flash Player 9, AIR 1.1 |
Déconnecte tous les écouteurs pour les événements valid
et invalid
distribués à partir du programme de validation. Les sous-classes doivent d’abord appeler la méthode removeListenerHandler()
, puis la méthode addListenerHandler
si la valeur de l’un de leurs écouteurs ou de l’une de leurs sources change. Les classes CreditCardValidator et DateValidator utilisent cette fonction de manière interne.
resourcesChanged | () | méthode |
protected function resourcesChanged():void
Version du langage: | ActionScript 3.0 |
Version du produit: | Flex 3 |
Versions du moteur d’exécution: | Flash Player 9, AIR 1.1 |
Cette méthode est appelée lorsqu’une classe Validator est construite et chaque fois que la classe ResourceManager distribue un événement "change"
pour indiquer que les ressources localisées ont changé d’une manière ou d’une autre.
Cet événement est distribué lorsque vous définissez la propriété localeChain
de la classe ResourceManager, lorsqu’un module de ressource termine de se charger et lorsque vous appelez la méthode update()
de la classe ResourceManager.
Les sous-classes doivent remplacer cette méthode et, après avoir appelé la méthode super.resourcesChanged()
, effectuer les tâches appropriées en réponse aux nouvelles valeurs de ressources.
validate | () | méthode |
public function validate(value:Object = null, suppressEvents:Boolean = false):ValidationResultEvent
Version du langage: | ActionScript 3.0 |
Version du produit: | Flex 3 |
Versions du moteur d’exécution: | Flash Player 9, AIR 1.1 |
Procède à la validation et, le cas échéant, informe les écouteurs du résultat.
Paramètres
value:Object (default = null ) — Valeur facultative à valider. Si nul, le programme de validation utilise les propriétés source et property pour déterminer la valeur. Si vous spécifiez cet argument, vous devez aussi définir la propriété listener afin de spécifier le composant cible pour les messages d’erreur de validation.
| |
suppressEvents:Boolean (default = false ) — Si false , après la validation, le programme de validation informe l’écouteur du résultat.
|
ValidationResultEvent — Objet ValidationResultEvent contenant les résultats de la validation. Pour une validation réussie, la propriété de tableau ValidationResultEvent.results est vide. Pour un échec de validation, la propriété de tableau ValidationResultEvent.results contient un objet ValidationResult pour chaque champ vérifié par le programme de validation, à la fois pour les champs ayant réussi à la validation et pour ceux ayant échoué. Examine la propriété ValidationResult.isError pour déterminer si le champ a réussi ou échoué à la validation.
|
Eléments de l’API associés
validateAll | () | méthode |
public static function validateAll(validators:Array):Array
Version du langage: | ActionScript 3.0 |
Version du produit: | Flex 3 |
Versions du moteur d’exécution: | Flash Player 9, AIR 1.1 |
Invoque tous les objets Validator dans le tableau d’objets Validator
. Renvoie un tableau contenant un objet ValidationResultEvent pour chaque objet Validator ayant échoué. Renvoie un tableau vide si tous les objets Validator ont réussi.
Paramètres
validators:Array — Tableau contenant les objets Validator à exécuter.
|
Array — Tableau d’objets ValidationResultEvent, qui contient un objet ValidationResultEvent pour chaque objet Validator ayant échoué. Le tableau est vide si tous les objets Validator ont réussi.
|
invalid | Evénement |
mx.events.ValidationResultEvent
propriété ValidationResultEvent.type =
mx.events.ValidationResultEvent.INVALID
Version du langage: | ActionScript 3.0 |
Version du produit: | Flex 3 |
Versions du moteur d’exécution: | Flash Player 9, AIR 1.1 |
Distribué si la validation échoue.
La constanteValidationResultEvent.INVALID
définit la valeur de la propriété type
de l’objet d’événement d’un événement invalid
. La valeur de cette constante est « invalid ».
Les valeurs des propriétés de l’objet d’événement sont les suivantes :
Propriété | Valeur |
---|---|
bubbles | false |
cancelable | false |
currentTarget | Objet définissant l’écouteur d’événement qui traite l’événement. Par exemple, si vous utilisez myButton.addEventListener() pour enregistrer un écouteur d’événement, myButton est la valeur de currentTarget . |
field | Nom du champ dont la validation a échoué. |
message | Chaîne unique contenant tous les messages d’erreur issus de tous les objets ValidationResult du tableau de résultats. |
results | Tableau d’objets ValidationResult (un par champ validé). |
target | Objet qui a distribué l’événement (il ne s’agit pas toujours de l’objet qui écoute l’événement). Pour accéder systématiquement à l’objet qui écoute l’événement, utilisez la propriété currentTarget . |
valid | Evénement |
mx.events.ValidationResultEvent
propriété ValidationResultEvent.type =
mx.events.ValidationResultEvent.VALID
Version du langage: | ActionScript 3.0 |
Version du produit: | Flex 3 |
Versions du moteur d’exécution: | Flash Player 9, AIR 1.1 |
Distribué si la validation réussit.
La constanteValidationResultEvent.VALID
définit la valeur de la propriété type
de l’objet d’événement d’un événement valid
. La valeur de cette constante est « valid ».
Les valeurs des propriétés de l’objet d’événement sont les suivantes :
Propriété | Valeur |
---|---|
bubbles | false |
cancelable | false |
currentTarget | Objet définissant l’écouteur d’événement qui traite l’événement. Par exemple, si vous utilisez myButton.addEventListener() pour enregistrer un écouteur d’événement, myButton est la valeur de currentTarget . |
field | Chaîne vide. |
message | Chaîne vide. |
results | Tableau vide. |
target | Objet qui a distribué l’événement (il ne s’agit pas toujours de l’objet qui écoute l’événement). Pour accéder systématiquement à l’objet qui écoute l’événement, utilisez la propriété currentTarget . |
DECIMAL_DIGITS | Constante |
protected static const DECIMAL_DIGITS:String = "0123456789"
Version du langage: | ActionScript 3.0 |
Version du produit: | Flex 3 |
Versions du moteur d’exécution: | Flash Player 9, AIR 1.1 |
Chaîne contenant les chiffres décimaux de 0 à 9.
ROMAN_LETTERS | Constante |
protected static const ROMAN_LETTERS:String = "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz"
Version du langage: | ActionScript 3.0 |
Version du produit: | Flex 3 |
Versions du moteur d’exécution: | Flash Player 9, AIR 1.1 |
Chaîne contenant les lettres majuscules et minuscules de l’alphabet romain (« A » à « Z » et « a » à « 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, 09:30 AM Z