StringValidator

Package	mx.validators
Classe	public class StringValidator
Héritage	StringValidator Validator EventDispatcher Object

Version du langage:

ActionScript 3.0

Version du produit:

Flex 3

Versions du moteur d’exécution:

Flash Player 9, AIR 1.1

La classe StringValidator valide le fait que la longueur d’une chaîne se situe dans une plage spécifiée.

Syntaxe MXML expanded

Masquer la syntaxe 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." 
  />

Consulter les exemples

Propriétés publiques

Masquer les propriétés publiques héritées

Afficher les propriétés publiques héritées

	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
		maxLength : Object Longueur maximale d’une chaîne valide.	StringValidator
		minLength : Object Longueur minimale d’une chaîne valide.	StringValidator
		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
		tooLongError : String Message d’erreur lorsque la chaîne est plus longue que la valeur spécifiée par la propriété maxLength.	StringValidator
		tooShortError : String Message d’erreur lorsque la chaîne est plus courte que la valeur spécifiée par la propriété minLength.	StringValidator
		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és protégées

Masquer les propriétés protégées héritées

Afficher les propriétés protégées héritées

	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éthodes publiques

Masquer les méthodes publiques héritées

Afficher les méthodes publiques héritées

	Méthode		Défini par
		StringValidator() Constructeur.	StringValidator
		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
		dispatchEvent(event:Event):Boolean Distribue un événement dans le flux d’événements.	EventDispatcher
		hasEventListener(type:String):Boolean Vérifie si des écouteurs sont enregistrés auprès de l’objet EventDispatcher pour un type spécifique d’événement.	EventDispatcher
		hasOwnProperty(name:String):Boolean Indique si la propriété spécifiée d’un objet est définie.	Object
		initialized(document:Object, id:String):void Appelé automatiquement par le compilateur MXML lorsque la classe Validator est créée à l’aide d’une balise MXML.	Validator
		isPrototypeOf(theClass:Object):Boolean 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
		propertyIsEnumerable(name:String):Boolean Indique si la propriété spécifiée existe et est énumérable.	Object
		removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void Supprime un écouteur de l’objet EventDispatcher.	EventDispatcher
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Définit la disponibilité d’une propriété dynamique pour les opérations en boucle.	Object
		toLocaleString():String Renvoie la représentation de chaîne de cet objet, formatée selon les paramètres régionaux en vigueur.	Object
		toString():String Renvoie la représentation sous forme de chaîne de l’objet spécifié.	Object
		validate(value:Object = null, suppressEvents:Boolean = false):ValidationResultEvent Procède à la validation et, le cas échéant, informe les écouteurs du résultat.	Validator
		validateAll(validators:Array):Array [statique] Invoque tous les objets Validator dans le tableau d’objets Validator.	Validator
		validateString(validator:StringValidator, value:Object, baseField:String = null):Array [statique] Méthode pratique pour appeler une classe Validator.	StringValidator
		valueOf():Object Renvoie la valeur primitive de l’objet spécifié.	Object
		willTrigger(type:String):Boolean 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éthodes protégées

Masquer les méthodes protégées héritées

Afficher les méthodes protégées héritées

	Méthode		Défini par
		addListenerHandler():void Définit tous les écouteurs pour les événements valid et invalid distribués à partir du programme de validation.	Validator
		doValidation(value:Object):Array [override] Remplace la méthode doValidation() de la classe de base pour valider une chaîne.	StringValidator
		getValueFromSource():Object Renvoie l’objet à valider.	Validator
		handleResults(errorResults:Array):ValidationResultEvent Renvoie une classe ValidationResultEvent depuis le tableau des résultats d’erreurs.	Validator
		isRealValue(value:Object):Boolean Renvoie true si la valeur n’est pas nulle.	Validator
		removeListenerHandler():void Déconnecte tous les écouteurs pour les événements valid et invalid distribués à partir du programme de validation.	Validator
		resourcesChanged():void 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énements

Cliquez pour plus d’informations sur les événements

Masquer les événements hérités

Afficher les événements hérités

	Synthèse	Défini par
activate	[Evénement de diffusion] Distribué lorsque l’application Flash Player obtient le focus du système d’exploitation et devient active.	EventDispatcher
deactivate	[Evénement de diffusion] Distribué lorsque l’application Flash Player ou AIR perd le focus du système d’exploitation et devient inactive.	EventDispatcher
invalid	Distribué si la validation échoue.	Validator
valid	Distribué si la validation réussit.	Validator

Constantes protégées

Masquer les constantes protégées héritées

Afficher les constantes protégées héritées

	Constante		Défini par

Détails de la propriété

maxLength

propriété

maxLength:Object

Version du langage:

ActionScript 3.0

Version du produit:

Flex 3

Versions du moteur d’exécution:

Flash Player 9, AIR 1.1

Longueur maximale d’une chaîne valide. Une valeur NaN signifie que cette propriété est ignorée.

La valeur par défaut est NaN.

Implémentation
public function get maxLength():Object
public function set maxLength(value:Object):void

minLength

propriété

minLength:Object

Version du langage:

ActionScript 3.0

Version du produit:

Flex 3

Versions du moteur d’exécution:

Flash Player 9, AIR 1.1

Longueur minimale d’une chaîne valide. Une valeur NaN signifie que cette propriété est ignorée.

La valeur par défaut est NaN.

Implémentation
public function get minLength():Object
public function set minLength(value:Object):void

tooLongError

propriété

tooLongError: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 lorsque la chaîne est plus longue que la valeur spécifiée par la propriété maxLength.

La valeur par défaut est "This string is longer than the maximum allowed length. This must be less than {0} characters long.".

Implémentation
public function get tooLongError():String
public function set tooLongError(value:String):void

tooShortError

propriété

tooShortError: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 lorsque la chaîne est plus courte que la valeur spécifiée par la propriété minLength.

La valeur par défaut est "This string is shorter than the minimum allowed length. This must be at least {0} characters long.".

Implémentation
public function get tooShortError():String
public function set tooShortError(value:String):void

Détails du constructeur

()

Constructeur

public function StringValidator()

Version du langage:

ActionScript 3.0

Version du produit:

Flex 3

Versions du moteur d’exécution:

Flash Player 9, AIR 1.1

Constructeur.

Détails de la méthode

doValidation

()

méthode

override 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

Remplace la méthode doValidation() de la classe de base pour valider une chaîne.

Vous n’appelez pas cette méthode directement ; Flex l’appelle dans le cadre d’une validation. Si vous créez une classe Validator personnalisée, vous devez implémenter cette méthode.

Paramètres

value:Object — Objet à valider.

Valeur renvoyée

Array — Tableau d’objets ValidationResult, avec un objet ValidationResult pour chaque champ examiné par le programme de validation.

validateString

()

méthode

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

Version du langage:

ActionScript 3.0

Version du produit:

Flex 3

Versions du moteur d’exécution:

Flash Player 9, AIR 1.1

Méthode pratique pour appeler une classe Validator. Chacune des classes Validator Flex standard comporte une méthode pratique similaire.

Paramètres

	`validator:StringValidator` — Instance StringValidator.

	`value:Object` — Champ à valider.

	`baseField:String` (default = `null`) — Représentation textuelle du sous-champ spécifié dans le paramètre `value`. Par exemple, si le paramètre `value` spécifie value.mystring, la valeur `baseField` est `"mystring"`.

Valeur renvoyée

Array — Tableau d’objets ValidationResult, avec un objet ValidationResult pour chaque champ examiné par le programme de validation.

Eléments de l’API associés

mx.validators.ValidationResult

Exemples Comment utiliser cet exemple

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>

Informations juridiques | Politique de confidentialité en ligne

StringValidator - AS3 Flex

Classes x

maxLength

minLength

tooLongError

tooShortError