StringValidator

Pacote	mx.validators
Classe	public class StringValidator
Herança	StringValidator Validator EventDispatcher Object

Versão da linguagem:

ActionScript 3.0

Versão de produto:

Flex 3

Versões de runtime:

Flash Player 9, AIR 1.1

The StringValidator class validates that the length of a String is within a specified range.

Sintaxe MXML expanded

Ocultar sintaxe 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." 
  />

Veja os exemplos

Propriedades públicas

Ocultar propriedades públicas herdadas

Mostrar propriedades públicas herdadas

	Propriedade		Definido por
		constructor : Object Uma referência ao objeto de classe ou à função de construtor de uma determinada ocorrência de objeto.	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
		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

Propriedades protegidas

Ocultar propriedades protegidas herdadas

Mostrar propriedades protegidas herdadas

	Propriedade		Definido por
		actualListeners : Array [somente leitura] Contains an Array of listener objects, if any, or the source object.	Validator
		actualTrigger : IEventDispatcher [somente leitura] Contains the trigger object, if any, or the source object.	Validator
		resourceManager : IResourceManager [somente leitura] 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étodos públicos

Ocultar métodos públicos herdados

Mostrar métodos públicos herdados

	Método		Definido por
		StringValidator() Constructor.	StringValidator
		addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void Registra um objeto de ouvinte de evento em um objeto EventDispatcher, de forma que o ouvinte receba a notificação de um evento.	EventDispatcher
		dispatchEvent(event:Event):Boolean Envia um evento para o fluxo de eventos.	EventDispatcher
		hasEventListener(type:String):Boolean Verifica se o objeto EventDispatcher tem ouvintes registrados para um tipo específico de evento.	EventDispatcher
		hasOwnProperty(name:String):Boolean Indica se um objeto tem uma propriedade especificada definida.	Object
		initialized(document:Object, id:String):void Called automatically by the MXML compiler when the Validator is created using an MXML tag.	Validator
		isPrototypeOf(theClass:Object):Boolean Indica se uma ocorrência da classe Object está na cadeia de protótipos do objeto especificado como o parâmetro.	Object
		propertyIsEnumerable(name:String):Boolean Indica se a propriedade especificada existe e é enumerável.	Object
		removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void Remove um ouvinte do objeto EventDispatcher.	EventDispatcher
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Define a disponibilidade de uma propriedade dinâmica para operações de repetição.	Object
		toLocaleString():String Retorna a representação da string deste objeto, formatado segundo as convenções específicas para a localidade.	Object
		toString():String Retorna a representação de string do objeto especificado.	Object
		validate(value:Object = null, suppressEvents:Boolean = false):ValidationResultEvent Performs validation and optionally notifies the listeners of the result.	Validator
		validateAll(validators:Array):Array [estático] Invokes all the validators in the validators Array.	Validator
		validateString(validator:StringValidator, value:Object, baseField:String = null):Array [estático] Convenience method for calling a validator.	StringValidator
		valueOf():Object Retorna o valor primitivo do objeto especificado.	Object
		willTrigger(type:String):Boolean Verifica se um ouvinte de evento está registrado nesse objeto EventDispatcher ou em qualquer um de seus ancestrais para o tipo de evento especificado.	EventDispatcher

Métodos protegidos

Ocultar métodos protegidos herdados

Mostrar métodos protegidos herdados

	Método		Definido por
		addListenerHandler():void Sets up all of the listeners for the valid and invalid events dispatched from the validator.	Validator
		doValidation(value:Object):Array [substituir] 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

Eventos

Clique para obter mais informações sobre eventos

Ocultar eventos herdados

Mostrar eventos herdados

	Resumo	Definido por
activate	[transmissão de evento] Despachado quando o Flash Player ou o aplicativo do AIR ganha o foco do sistema operacional e está se tornando inativo.	EventDispatcher
deactivate	[transmissão de evento] Despachado quando o Flash Player ou o aplicativo do AIR perde o foco do sistema operacional e está se tornando inativo.	EventDispatcher
invalid	Dispatched when validation fails.	Validator
valid	Dispatched when validation succeeds.	Validator

Constantes protegidas

Ocultar constantes protegidas herdadas

Mostrar constantes protegidas herdadas

	Constante		Definido por

Detalhes da propriedade

maxLength

propriedade

maxLength:Object

Versão da linguagem:

ActionScript 3.0

Versão de produto:

Flex 3

Versões de runtime:

Flash Player 9, AIR 1.1

Maximum length for a valid String. A value of NaN means this property is ignored.

O valor padrão é NaN.

Implementação
public function get maxLength():Object
public function set maxLength(value:Object):void

minLength

propriedade

minLength:Object

Versão da linguagem:

ActionScript 3.0

Versão de produto:

Flex 3

Versões de runtime:

Flash Player 9, AIR 1.1

Minimum length for a valid String. A value of NaN means this property is ignored.

O valor padrão é NaN.

Implementação
public function get minLength():Object
public function set minLength(value:Object):void

tooLongError

propriedade

tooLongError:String

Versão da linguagem:

ActionScript 3.0

Versão de produto:

Flex 3

Versões de runtime:

Flash Player 9, AIR 1.1

Error message when the String is longer than the maxLength property.

O valor padrão é "This string is longer than the maximum allowed length. This must be less than {0} characters long.".

Implementação
public function get tooLongError():String
public function set tooLongError(value:String):void

tooShortError

propriedade

tooShortError:String

Versão da linguagem:

ActionScript 3.0

Versão de produto:

Flex 3

Versões de runtime:

Flash Player 9, AIR 1.1

Error message when the string is shorter than the minLength property.

O valor padrão é "This string is shorter than the minimum allowed length. This must be at least {0} characters long.".

Implementação
public function get tooShortError():String
public function set tooShortError(value:String):void

Detalhes do construtor

()

Construtor

public function StringValidator()

Versão da linguagem:

ActionScript 3.0

Versão de produto:

Flex 3

Versões de runtime:

Flash Player 9, AIR 1.1

Constructor.

Detalhes do método

doValidation

()

método

override protected function doValidation(value:Object):Array

Versão da linguagem:

ActionScript 3.0

Versão de produto:

Flex 3

Versões de runtime:

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.

Parâmetros

value:Object — Object to validate.

Retorna

Array — An Array of ValidationResult objects, with one ValidationResult object for each field examined by the validator.

validateString

()

método

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

Versão da linguagem:

ActionScript 3.0

Versão de produto:

Flex 3

Versões de runtime:

Flash Player 9, AIR 1.1

Convenience method for calling a validator. Each of the standard Flex validators has a similar convenience method.

Parâmetros

	`validator:StringValidator` — The StringValidator instance.

	`value:Object` — A field to validate.

	`baseField:String` (default = `null`) — Text representation of the subfield specified in the `value` parameter. For example, if the `value` parameter specifies value.mystring, the `baseField` value is `"mystring"`.

Retorna

Array — An Array of ValidationResult objects, with one ValidationResult object for each field examined by the validator.

Elementos da API relacionados

mx.validators.ValidationResult

Exemplos Como usar este exemplo

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>

Aspectos jurídicos | Política de privacidade on-line

StringValidator - AS3 Flex

Classes x

maxLength

minLength

tooLongError

tooShortError