Package | mx.validators |
Class | public class PhoneNumberValidator |
Inheritance | PhoneNumberValidator Validator flash.events.EventDispatcher |
Language Version : | ActionScript 3.0 |
Product Version : | Flex 3 |
Runtime Versions : | Flash Player 9, AIR 1.1 |
The <mx:PhoneNumberValidator>
tag
inherits all of the tag attributes of its superclass,
and adds the following tag attributes:
<mx:PhoneNumberValidator allowedFormatChars="()- .+" invalidCharError="Your telephone number contains invalid characters." minDigits="10" wrongLengthError="Your telephone number must contain at least 10 digits." />
Property | Defined By | ||
---|---|---|---|
allowedFormatChars : String
The set of allowable formatting characters. | PhoneNumberValidator | ||
enabled : Boolean
Setting this value to false will stop the validator
from performing validation. | Validator | ||
invalidCharError : String
Error message when the value contains invalid characters. | PhoneNumberValidator | ||
listener : Object
Specifies the validation listener. | Validator | ||
minDigits : Object
Minimum number of digits for a valid phone number. | PhoneNumberValidator | ||
property : String
A String specifying the name of the property
of the source object that contains
the value to validate. | Validator | ||
required : Boolean
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 | ||
wrongLengthError : String
Error message when the value has fewer than 10 digits. | PhoneNumberValidator |
Method | Defined By | ||
---|---|---|---|
Constructor. | PhoneNumberValidator | ||
initialized(document:Object, id:String):void
Called automatically by the MXML compiler when the Validator
is created using an MXML tag. | Validator | ||
validate(value:Object = null, suppressEvents:Boolean = false):ValidationResultEvent
Performs validation and optionally notifies
the listeners of the result. | Validator | ||
validateAll(validators:Array):Array [static]
Invokes all the validators in the validators Array. | Validator | ||
validatePhoneNumber(validator:PhoneNumberValidator, value:Object, baseField:String):Array [static]
Convenience method for calling a validator
from within a custom validation function. | PhoneNumberValidator |
Method | Defined By | ||
---|---|---|---|
addListenerHandler():void
Sets up all of the listeners for the
valid and invalid
events dispatched from the validator. | Validator | ||
doValidation(value:Object):Array [override]
Override of the base class doValidation() method
to validate a phone number. | PhoneNumberValidator | ||
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 |
allowedFormatChars | property |
allowedFormatChars:String
Language Version : | ActionScript 3.0 |
Product Version : | Flex 3 |
Runtime Versions : | Flash Player 9, AIR 1.1 |
The set of allowable formatting characters.
The default value is "()- .+"
.
public function get allowedFormatChars():String
public function set allowedFormatChars(value:String):void
invalidCharError | property |
invalidCharError:String
Language Version : | ActionScript 3.0 |
Product Version : | Flex 3 |
Runtime Versions : | Flash Player 9, AIR 1.1 |
Error message when the value contains invalid characters.
The default value is "Your telephone number contains invalid characters."
.
public function get invalidCharError():String
public function set invalidCharError(value:String):void
minDigits | property |
minDigits:Object
Language Version : | ActionScript 3.0 |
Product Version : | Flex 3 |
Runtime Versions : | Flash Player 9, AIR 1.1 |
Minimum number of digits for a valid phone number. A value of NaN means this property is ignored.
The default value is 10
.
public function get minDigits():Object
public function set minDigits(value:Object):void
wrongLengthError | property |
wrongLengthError:String
Language Version : | ActionScript 3.0 |
Product Version : | Flex 3 |
Runtime Versions : | Flash Player 9, AIR 1.1 |
Error message when the value has fewer than 10 digits.
The default value is "Your telephone number must contain at least 10 digits."
.
public function get wrongLengthError():String
public function set wrongLengthError(value:String):void
PhoneNumberValidator | () | Constructor |
public function PhoneNumberValidator()
Language Version : | ActionScript 3.0 |
Product Version : | Flex 3 |
Runtime Versions : | Flash Player 9, AIR 1.1 |
Constructor.
doValidation | () | method |
override protected function doValidation(value:Object):Array
Language Version : | ActionScript 3.0 |
Product Version : | Flex 3 |
Runtime Versions : | Flash Player 9, AIR 1.1 |
Override of the base class doValidation()
method
to validate a phone number.
You do not typically 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.
Parameters
value:Object — Object to validate.
|
Array — An Array of ValidationResult objects, with one ValidationResult
object for each field examined by the validator.
|
validatePhoneNumber | () | method |
public static function validatePhoneNumber(validator:PhoneNumberValidator, value:Object, baseField:String):Array
Language Version : | ActionScript 3.0 |
Product Version : | Flex 3 |
Runtime Versions : | Flash Player 9, AIR 1.1 |
Convenience method for calling a validator from within a custom validation function. Each of the standard Flex validators has a similar convenience method.
Parameters
validator:PhoneNumberValidator — The PhoneNumberValidator instance.
| |
value:Object — A field to validate.
| |
baseField:String — Text representation of the subfield
specified in the value parameter.
For example, if the value parameter specifies value.phone,
the baseField value is "phone".
|
Array — An Array of ValidationResult objects, with one ValidationResult
object for each field examined by the validator.
|
See also
<?xml version="1.0" encoding="utf-8"?> <!-- Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to You under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. --> <!-- Simple example to demonstrate the PhoneNumberValidator. --> <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:PhoneNumberValidator source="{phone}" property="text" trigger="{myButton}" triggerEvent="click" valid="Alert.show('Validation Succeeded!');" invalid="Alert.show('Validation Failed!');" /> </fx:Declarations> <s:Panel title="Phone Number Validator Panel" width="75%" height="75%" horizontalCenter="0" verticalCenter="0"> <mx:Form left="10" right="10" top="10" bottom="10"> <mx:FormItem label="Enter 10-digit phone number: "> <s:TextInput id="phone" width="100%"/> </mx:FormItem> <mx:FormItem > <s:Button id="myButton" label="Validate" /> </mx:FormItem> </mx:Form> </s:Panel> </s:Application>