| Пакет | mx.validators |
| Класс | public class Validator |
| Наследование | Validator  EventDispatcher Object |
| Реализует | IMXMLObject, IValidator |
| Подклассы | CreditCardValidator, CurrencyValidator, DateValidator, EmailValidator, MultiTriggerValidator, MultiTriggerValidator, NumberValidator, PhoneNumberValidator, RegExpValidator, SocialSecurityValidator, StringValidator, StyleValidator, ZipCodeValidator |
| Язык версии: | ActionScript 3.0 |
| Версия продукта: | Flex 3 |
| Версии среды выполнения: | Flash Player 9, AIR 1.1 |
Показать синтаксис MXML
Скрыть синтаксис 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"
/>
Связанные элементы API
| Свойство | Определено | ||
|---|---|---|---|
 | constructor : Object
Ссылка на объект класса или функцию конструктора для данного экземпляра объекта. | Object | |
| enabled : Boolean
Установка этого значения на false помешает выполнению проверки средством проверки. | Validator | ||
| listener : Object
Указывает прослушиватель проверки. | Validator | ||
| property : String
Строка с именем свойства для объекта source, содержащего проверяемое значение. | Validator | ||
| required : Boolean = true
Значение true указывает на то, что ошибка проверки вызвана отсутствующим или пустым значением. | Validator | ||
| requiredFieldError : String
Сообщение об ошибке, если значение отсутствует, а свойство required имеет значение true. | Validator | ||
| source : Object
Указывает объект, содержащий проверяемое свойство. | Validator | ||
| trigger : IEventDispatcher
Указывает компонент, генерирующий запускающее средство проверки событие. | Validator | ||
| triggerEvent : String
Указывает запускающее проверку событие. | Validator | ||
| Свойство | Определено | ||
|---|---|---|---|
| actualListeners : Array [только для чтения]
Содержит массив объектов прослушивателей при их наличии или исходный объект. | Validator | ||
| actualTrigger : IEventDispatcher [только для чтения]
Содержит объект-триггер при его наличии или исходный объект. | Validator | ||
| resourceManager : IResourceManager [только для чтения]
Ссылка на объект, управляющий всеми локализованными ресурсами приложения. | Validator | ||
| subFields : Array
Массив строк, содержащий имена свойств из объекта value, переданного в метод validate(). | Validator | ||
| Метод | Определено | ||
|---|---|---|---|
Конструктор. | Validator | ||
| addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
Регистрирует объект прослушивателя события на объекте EventDispatcher для получения прослушивателем уведомления о событии. | EventDispatcher | |
|
Посылает событие в поток событий. | EventDispatcher | |
|
Проверяет, имеет ли объект EventDispatcher прослушиватели, зарегистрированные для определенного типа события. | EventDispatcher | |
|
Показывает, определено ли заданное свойство для объекта. | Object | |
Вызывается автоматически компилятором MXML при создании класса Validator с помощью тега MXML. | Validator | ||
|
Показывает, есть ли экземпляр класса Object в цепи прототипов объекта, заданного в качестве параметра. | Object | |
|
Показывает наличие заданного свойства и его перечисляемость. | Object | |
|
Удаляет прослушиватель из объекта EventDispatcher. | EventDispatcher | |
|
Задает доступность динамического свойства для операций цикла. | Object | |
|
Возвращает строковое представление этого объекта, отформатированного в соответствии со стандартами, принятыми для данной локали. | Object | |
|
Возвращает строковое представление заданного объекта. | Object | |
Выполняет проверку и дополнительно оповещает прослушиватели результата. | Validator | ||
[статические]
Вызывает все средства проверки в массиве validators. | Validator | ||
|
Возвращает элементарное значение заданного объекта. | Object | |
|
Проверяет, зарегистрирован ли прослушиватель события для указанного типа события с данным объектом EventDispatcher или любым его предшественником. | EventDispatcher | |
| Метод | Определено | ||
|---|---|---|---|
Настраивает все прослушиватели на события valid и invalid, передаваемые из средства проверки. | Validator | ||
Выполняет логику проверки этого средства проверки, включая проверку ошибки из-за отсутствующего или пустого значения, определяемую значением свойства required. | Validator | ||
Возвращает проверяемый объект. | Validator | ||
Возвращает ValidationResultEvent из массива результатов ошибки. | Validator | ||
Возвращает true, если value не имеет значения null. | Validator | ||
Отключает все прослушиватели для событий valid и invalid, передаваемых из средства проверки. | Validator | ||
Этот метод вызывается при создании класса Validator и каждый раз при отправке ResourceManager события change для указания изменения локализованных ресурсов сходным образом. | Validator | ||
| Событие | Сводка | Определено | ||
|---|---|---|---|---|
| [многоадресное событие] Отправляется, когда проигрыватель Flash Player или приложение AIR перемещается в фокус операционной системы и становится активным. | EventDispatcher | ||
| [многоадресное событие] Отправляется, когда проигрыватель Flash Player или приложение AIR теряет фокус системы и становится неактивным. | EventDispatcher | ||
| Передается при сбое проверки. | Validator | |||
| Передается при успешном завершении проверки. | Validator | |||
| Константа | Определено | ||
|---|---|---|---|
| DECIMAL_DIGITS : String = "0123456789" [статические]
Строка, содержащая десятичные цифры от 0 до 9. | Validator | ||
| ROMAN_LETTERS : String = "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz" [статические]
Строка, содержащая буквы верхнего и нижнего регистра римского алфавита (от A до Z и от a до z). | Validator | ||
actualListeners | свойство |
actualListeners:Array [только для чтения] | Язык версии: | ActionScript 3.0 |
| Версия продукта: | Flex 3 |
| Версии среды выполнения: | Flash Player 9, AIR 1.1 |
Содержит массив объектов прослушивателей при их наличии или исходный объект. Используется для определения объекта, который необходимо оповестить о результате проверки.
Реализация
protected function get actualListeners():ArrayactualTrigger | свойство |
actualTrigger:IEventDispatcher [только для чтения] | Язык версии: | ActionScript 3.0 |
| Версия продукта: | Flex 3 |
| Версии среды выполнения: | Flash Player 9, AIR 1.1 |
Содержит объект-триггер при его наличии или исходный объект. Используется для определения объекта прослушивателя для triggerEvent.
Реализация
protected function get actualTrigger():IEventDispatcherenabled | свойство |
enabled:Boolean| Язык версии: | ActionScript 3.0 |
| Версия продукта: | Flex 3 |
| Версии среды выполнения: | Flash Player 9, AIR 1.1 |
Установка этого значения на false помешает выполнению проверки средством проверки. Если средство проверки отключено, оно не передает события, а метод validate() возвращает значение null.
Значением по умолчанию является true.
Реализация
public function get enabled():Boolean public function set enabled(value:Boolean):voidlistener | свойство |
listener:Object| Язык версии: | ActionScript 3.0 |
| Версия продукта: | Flex 3 |
| Версии среды выполнения: | Flash Player 9, AIR 1.1 |
Указывает прослушиватель проверки.
Если прослушиватель не указан, Flex использует значение свойства source. После определения Flex исходного компонента изменяется цвет границы компонента, появляется сообщение об ошибке в результате сбоя или скрывается любое существующее сообщение об успешной проверке.
Реализация
public function get listener():Object public function set listener(value:Object):voidproperty | свойство |
property:String| Язык версии: | ActionScript 3.0 |
| Версия продукта: | Flex 3 |
| Версии среды выполнения: | Flash Player 9, AIR 1.1 |
Строка с именем свойства для объекта source, содержащего проверяемое значение. Это свойство является необязательным, но при указании source требуется также установить значение для этого свойства.
Значением по умолчанию является null.
Реализация
public function get property():String public function set property(value:String):voidrequired | свойство |
public var required:Boolean = true| Язык версии: | ActionScript 3.0 |
| Версия продукта: | Flex 3 |
| Версии среды выполнения: | Flash Player 9, AIR 1.1 |
Значение true указывает на то, что ошибка проверки вызвана отсутствующим или пустым значением.
Значением по умолчанию является true.
requiredFieldError | свойство |
requiredFieldError:String| Язык версии: | ActionScript 3.0 |
| Версия продукта: | Flex 3 |
| Версии среды выполнения: | Flash Player 9, AIR 1.1 |
Сообщение об ошибке, если значение отсутствует, а свойство required имеет значение true.
Значением по умолчанию является "This field is required.".
Реализация
public function get requiredFieldError():String public function set requiredFieldError(value:String):voidresourceManager | свойство |
resourceManager:IResourceManager [только для чтения] | Язык версии: | ActionScript 3.0 |
| Версия продукта: | Flex 3 |
| Версии среды выполнения: | Flash Player 9, AIR 1.1 |
Ссылка на объект, управляющий всеми локализованными ресурсами приложения. Это одиночный экземпляр единичного предмета, реализующий интерфейс IResourceManager.
Это свойство можно использовать в качестве источника для связывания данных. При изменении этого свойства отправляется событие unused .
Реализация
protected function get resourceManager():IResourceManagersource | свойство |
source:Object| Язык версии: | ActionScript 3.0 |
| Версия продукта: | Flex 3 |
| Версии среды выполнения: | Flash Player 9, AIR 1.1 |
Указывает объект, содержащий проверяемое свойство. Определяет данный элемент как экземпляр компонента или модель данных. Синтаксис связывания данных в MXML используется для определения значения. Это свойство поддерживает разделенные точкой строки для определения вложенных свойств. Если указано значение свойства source, требуется также определить значение свойства property. Свойство source является необязательным.
Значением по умолчанию является null.
Реализация
public function get source():Object public function set source(value:Object):voidsubFields | свойство |
protected var subFields:Array| Язык версии: | ActionScript 3.0 |
| Версия продукта: | Flex 3 |
| Версии среды выполнения: | Flash Player 9, AIR 1.1 |
Массив строк, содержащий имена свойств из объекта value, переданного в метод validate(). Например, CreditCardValidator определяет это свойство значениями [ "cardNumber", "cardType" ]. Это значение означает, что объект value, передаваемый в метод validate() должен содержать свойство cardNumber и cardType.
Подклассы класса Validator, проверяющие несколько полей данных (например, CreditCardValidator и DateValidator) должны назначать это свойство в своем конструкторе.
trigger | свойство |
trigger:IEventDispatcher| Язык версии: | ActionScript 3.0 |
| Версия продукта: | Flex 3 |
| Версии среды выполнения: | Flash Player 9, AIR 1.1 |
Указывает компонент, генерирующий запускающее средство проверки событие. Если он опущен, по умолчанию Flex использует значение свойства source. Если trigger передает triggerEvent, проверка выполняется.
Реализация
public function get trigger():IEventDispatcher public function set trigger(value:IEventDispatcher):voidtriggerEvent | свойство |
triggerEvent:String| Язык версии: | ActionScript 3.0 |
| Версия продукта: | Flex 3 |
| Версии среды выполнения: | Flash Player 9, AIR 1.1 |
Указывает запускающее проверку событие. Если оно опущено, Flex использует событие valueCommit. Flex передает событие valueCommit, если пользователь выполняет ввод данных в элемент управления. Обычно происходит при удалении пользователем фокуса из компонента или при программном изменении значения свойства. При необходимости игнорирования средством проверки всех событий установите triggerEvent как пустую строку ("").
Реализация
public function get triggerEvent():String public function set triggerEvent(value:String):voidValidator | () | Конструктор |
public function Validator()| Язык версии: | ActionScript 3.0 |
| Версия продукта: | Flex 3 |
| Версии среды выполнения: | Flash Player 9, AIR 1.1 |
Конструктор.
addListenerHandler | () | метод |
protected function addListenerHandler():void| Язык версии: | ActionScript 3.0 |
| Версия продукта: | Flex 3 |
| Версии среды выполнения: | Flash Player 9, AIR 1.1 |
Настраивает все прослушиватели на события valid и invalid, передаваемые из средства проверки. Подклассы класса Validator должны сначала вызвать метод removeListenerHandler(), а затем метод addListenerHandler(), если изменяется значение одного из прослушивателей или источников. Классы CreditCardValidator и DateValidator используют эту функцию на внутреннем уровне.
doValidation | () | метод |
protected function doValidation(value:Object):Array| Язык версии: | ActionScript 3.0 |
| Версия продукта: | Flex 3 |
| Версии среды выполнения: | Flash Player 9, AIR 1.1 |
Выполняет логику проверки этого средства проверки, включая проверку ошибки из-за отсутствующего или пустого значения, определяемую значением свойства required.
При создании подкласса класса Validator следует переопределить этот метод.
Параметры
value:Object — Проверяемое значение.
|
Array — Для недопустимого результата массив объектов ValidationResult с одним объектом ValidationResult для каждого поля, проверенного средством проверки со сбоем.
|
Связанные элементы API
getValueFromSource | () | метод |
protected function getValueFromSource():Object| Язык версии: | ActionScript 3.0 |
| Версия продукта: | Flex 3 |
| Версии среды выполнения: | Flash Player 9, AIR 1.1 |
Возвращает проверяемый объект. Подклассы, например классы CreditCardValidator и DateValidator, переопределяют этот метод, так как для них необходим доступ к значениям из нескольких подчиненных полей.
ВозвращаетObject — Проверяемый объект.
|
handleResults | () | метод |
protected function handleResults(errorResults:Array):ValidationResultEvent| Язык версии: | ActionScript 3.0 |
| Версия продукта: | Flex 3 |
| Версии среды выполнения: | Flash Player 9, AIR 1.1 |
Возвращает ValidationResultEvent из массива результатов ошибки. Внутренне эта функция принимает результаты из метода doValidation() и помещает их в объект ValidationResultEvent. Подклассы, например класс RegExpValidator, должны переопределять эту функцию, если они выводят подкласс объектов ValidationResultEvent, таких как объекты RegExpValidationResult, и должны заполнять объект дополнительной информацией. Данная функция никогда не вызывается напрямую, поэтому частое переопределение функции не требуется.
Параметры
errorResults:Array — Массив объектов ValidationResult.
|
ValidationResultEvent — ValidationResultEvent, возвращенный с помощью метода validate().
|
initialized | () | метод |
public function initialized(document:Object, id:String):void| Язык версии: | ActionScript 3.0 |
| Версия продукта: | Flex 3 |
| Версии среды выполнения: | Flash Player 9, AIR 1.1 |
Вызывается автоматически компилятором MXML при создании класса Validator с помощью тега MXML.
Параметры
document:Object — Документ MXML, содержащий этот класс Validator.
| |
id:String — Игнорируется.
|
isRealValue | () | метод |
protected function isRealValue(value:Object):Boolean| Язык версии: | ActionScript 3.0 |
| Версия продукта: | Flex 3 |
| Версии среды выполнения: | Flash Player 9, AIR 1.1 |
Возвращает true, если value не имеет значения null.
Параметры
value:Object — Тестируемое значение.
|
Boolean — true, если value не имеет значение null.
|
removeListenerHandler | () | метод |
protected function removeListenerHandler():void| Язык версии: | ActionScript 3.0 |
| Версия продукта: | Flex 3 |
| Версии среды выполнения: | Flash Player 9, AIR 1.1 |
Отключает все прослушиватели для событий valid и invalid, передаваемых из средства проверки. Подклассы должны сначала вызывать метод removeListenerHandler(), а затем метод addListenerHandler при изменении значения одного из прослушивателей или источников. Классы CreditCardValidator и DateValidator используют эту функцию на внутреннем уровне.
resourcesChanged | () | метод |
protected function resourcesChanged():void| Язык версии: | ActionScript 3.0 |
| Версия продукта: | Flex 3 |
| Версии среды выполнения: | Flash Player 9, AIR 1.1 |
Этот метод вызывается при создании класса Validator и каждый раз при отправке ResourceManager события change для указания изменения локализованных ресурсов сходным образом.
Это событие передается при установке значения для свойства ResourceManager localeChain после завершения загрузки модуля ресурсов и при вызове метода ResourceManager update().
Подклассы должны отменять этот метод и после вызова super.resourcesChanged() выполнять соответствующую операцию в ответ на получение новых значений ресурсов.
validate | () | метод |
public function validate(value:Object = null, suppressEvents:Boolean = false):ValidationResultEvent| Язык версии: | ActionScript 3.0 |
| Версия продукта: | Flex 3 |
| Версии среды выполнения: | Flash Player 9, AIR 1.1 |
Выполняет проверку и дополнительно оповещает прослушиватели результата.
Параметры
value:Object (default = null)source и property для определения значения. При определении этого аргумента следует также настроить свойство listener для определения целевого компонента любых сообщений об ошибках, возникающих при проверке.
| |
suppressEvents:Boolean (default = false)false, после проверки средство проверки оповещает прослушиватель результата.
|
ValidationResultEvent — Объект ValidationResultEvent, содержащий результаты проверки. В случае успешной проверки свойство массива ValidationResultEvent.results является пустым. В случае сбоя проверки свойство массива ValidationResultEvent.results содержит по одному объекту ValidationResult для каждого поля, проверяемого средством проверки, как для не прошедших, так и для прошедших проверку полей. Проверьте свойство ValidationResult.isError для определения успешного выполнения или сбоя проверки поля.
|
Связанные элементы API
validateAll | () | метод |
public static function validateAll(validators:Array):Array| Язык версии: | ActionScript 3.0 |
| Версия продукта: | Flex 3 |
| Версии среды выполнения: | Flash Player 9, AIR 1.1 |
Вызывает все средства проверки в массиве validators. Возвращает массив, содержащий по одному объекту ValidationResultEvent на каждое средство проверки, выполненное с ошибкой. Возвращает пустой массив, если все средства проверки выполнены успешно.
Параметры
validators:Array — Массив, содержащий выполняемые объекты класса Validator.
|
Array — Массив объектов ValidationResultEvent, где массив содержит по одному объекту ValidationResultEvent на каждое средство проверки, выполненное с ошибкой. Массив пуст, если все средства проверки были выполнены успешно.
|
invalid | Событие |
mx.events.ValidationResultEventсвойство ValidationResultEvent.type =
mx.events.ValidationResultEvent.INVALID| Язык версии: | ActionScript 3.0 |
| Версия продукта: | Flex 3 |
| Версии среды выполнения: | Flash Player 9, AIR 1.1 |
Передается при сбое проверки.
КонстантаValidationResultEvent.INVALID определяет значение свойства type объекта события invalid. Эта константа имеет значение invalid.
Свойства объекта события имеют следующие значения:
| Свойство | Значение |
|---|---|
bubbles | false |
cancelable | false |
currentTarget | Объект, определяющий прослушиватель события, который выполняет обработку события. Например, если используется myButton.addEventListener() для регистрации прослушивателя события, значением currentTarget является myButton. |
field | Имя поля, не прошедшего проверку правильности. |
message | Отдельная строка в массиве результатов, содержащая сообщение об ошибке из любого объекта ValidationResult. |
results | Массив объектов ValidationResult, по одному объекту на проверяемое поле. |
target | Объект, отправивший событие. Это не всегда тот объект, который прослушивает событие. Свойство currentTarget всегда используется для получения доступа к объекту, прослушивающему событие. |
valid | Событие |
mx.events.ValidationResultEventсвойство ValidationResultEvent.type =
mx.events.ValidationResultEvent.VALID| Язык версии: | ActionScript 3.0 |
| Версия продукта: | Flex 3 |
| Версии среды выполнения: | Flash Player 9, AIR 1.1 |
Передается при успешном завершении проверки.
КонстантаValidationResultEvent.VALID определяет значение свойства type объекта события valid. Эта константа имеет значение valid.
Свойства объекта события имеют следующие значения:
| Свойство | Значение |
|---|---|
bubbles | false |
cancelable | false |
currentTarget | Объект, определяющий прослушиватель события, который выполняет обработку события. Например, если используется myButton.addEventListener() для регистрации прослушивателя события, значением currentTarget является myButton. |
field | Пустая строка. |
message | Пустая строка. |
results | Пустой массив. |
target | Объект, отправивший событие. Это не всегда тот объект, который прослушивает событие. Свойство currentTarget всегда используется для получения доступа к объекту, прослушивающему событие. |
DECIMAL_DIGITS | Константа |
protected static const DECIMAL_DIGITS:String = "0123456789"| Язык версии: | ActionScript 3.0 |
| Версия продукта: | Flex 3 |
| Версии среды выполнения: | Flash Player 9, AIR 1.1 |
Строка, содержащая десятичные цифры от 0 до 9.
ROMAN_LETTERS | Константа |
protected static const ROMAN_LETTERS:String = "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz"| Язык версии: | ActionScript 3.0 |
| Версия продукта: | Flex 3 |
| Версии среды выполнения: | Flash Player 9, AIR 1.1 |
Строка, содержащая буквы верхнего и нижнего регистра римского алфавита (от A до Z и от 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, 11:34 AM Z