Packagemx.validators
Classpublic class SocialSecurityValidator
InheritanceSocialSecurityValidator Inheritance Validator Inheritance EventDispatcher Inheritance Object

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

The SocialSecurityValidator class validates that a String is a valid United States Social Security number. It does not check whether it is an existing Social Security number.

MXML SyntaxexpandedHide MXML Syntax

The <mx:SocialSecurityValidator> tag inherits all of the tag attributes of its superclass, and adds the following tag attributes:

  <mx:SocialSecurityValidator
    allowedFormatChars=" -"
    invalidCharError="You entered invalid characters in your Social Security number."
    wrongFormatError="The Social Security number must be 9 digits or in the form NNN-NN-NNNN."
    zeroStartError="Invalid Social Security number; the number cannot start with 000."
  />

View the examples


Public Properties
 PropertyDefined By
  allowedFormatChars : String
Specifies the set of formatting characters allowed in the input.
SocialSecurityValidator
 Inheritedconstructor : Object
A reference to the class object or constructor function for a given object instance.
Object
 Inheritedenabled : Boolean
Setting this value to false will stop the validator from performing validation.
Validator
  invalidCharError : String
Error message when the value contains characters other than digits and formatting characters defined by the allowedFormatChars property.
SocialSecurityValidator
 Inheritedlistener : Object
Specifies the validation listener.
Validator
 Inheritedproperty : String
A String specifying the name of the property of the source object that contains the value to validate.
Validator
 Inheritedprototype : Object
[static] A reference to the prototype object of a class or function object.
Object
 Inheritedrequired : Boolean = true
If true, specifies that a missing or empty value causes a validation error.
Validator
 InheritedrequiredFieldError : String
Error message when a value is missing and the required property is true.
Validator
 Inheritedsource : Object
Specifies the object containing the property to validate.
Validator
 Inheritedtrigger : IEventDispatcher
Specifies the component generating the event that triggers the validator.
Validator
 InheritedtriggerEvent : String
Specifies the event that triggers the validation.
Validator
  wrongFormatError : String
Error message when the value is incorrectly formatted.
SocialSecurityValidator
  zeroStartError : String
Error message when the value contains an invalid Social Security number.
SocialSecurityValidator
Protected Properties
 PropertyDefined By
 InheritedactualListeners : Array
[read-only] Contains an Array of listener objects, if any, or the source object.
Validator
 InheritedactualTrigger : IEventDispatcher
[read-only] Contains the trigger object, if any, or the source object.
Validator
 InheritedresourceManager : IResourceManager
[read-only] A reference to the object which manages all of the application's localized resources.
Validator
 InheritedsubFields : Array
An Array of Strings containing the names for the properties contained in the value Object passed to the validate() method.
Validator
Public Methods
 MethodDefined By
  
SocialSecurityValidator()
Constructor.
SocialSecurityValidator
 Inherited
addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
Registers an event listener object with an EventDispatcher object so that the listener receives notification of an event.
EventDispatcher
 Inherited
dispatchEvent(event:Event):Boolean
Dispatches an event into the event flow.
EventDispatcher
 Inherited
hasEventListener(type:String):Boolean
Checks whether the EventDispatcher object has any listeners registered for a specific type of event.
EventDispatcher
 Inherited
hasOwnProperty(name:String):Boolean
Indicates whether an object has a specified property defined.
Object
 Inherited
initialized(document:Object, id:String):void
Called automatically by the MXML compiler when the Validator is created using an MXML tag.
Validator
 Inherited
isPrototypeOf(theClass:Object):Boolean
Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.
Object
 Inherited
propertyIsEnumerable(name:String):Boolean
Indicates whether the specified property exists and is enumerable.
Object
 Inherited
removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void
Removes a listener from the EventDispatcher object.
EventDispatcher
 Inherited
setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void
Sets the availability of a dynamic property for loop operations.
Object
 Inherited
toLocaleString():String
Returns the string representation of this object, formatted according to locale-specific conventions.
Object
 Inherited
toString():String
Returns the string representation of the specified object.
Object
 Inherited
validate(value:Object = null, suppressEvents:Boolean = false):ValidationResultEvent
Performs validation and optionally notifies the listeners of the result.
Validator
 Inherited
validateAll(validators:Array):Array
[static] Invokes all the validators in the validators Array.
Validator
  
validateSocialSecurity(validator:SocialSecurityValidator, value:Object, baseField:String):Array
[static] Convenience method for calling a validator.
SocialSecurityValidator
 Inherited
valueOf():Object
Returns the primitive value of the specified object.
Object
 Inherited
willTrigger(type:String):Boolean
Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type.
EventDispatcher
Protected Methods
 MethodDefined By
 Inherited
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 Social Security number.
SocialSecurityValidator
 Inherited
getValueFromSource():Object
Returns the Object to validate.
Validator
 Inherited
handleResults(errorResults:Array):ValidationResultEvent
Returns a ValidationResultEvent from the Array of error results.
Validator
 Inherited
isRealValue(value:Object):Boolean
Returns true if value is not null.
Validator
 Inherited
removeListenerHandler():void
Disconnects all of the listeners for the valid and invalid events dispatched from the validator.
Validator
 Inherited
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
Events
Click for more information on events
 Event Summary Defined By
 Inherited
activate
[broadcast event] Dispatched when the Flash Player or AIR application gains operating system focus and becomes active.EventDispatcher
 Inherited
deactivate
[broadcast event] Dispatched when the Flash Player or AIR application operating loses system focus and is becoming inactive.EventDispatcher
 Inherited
invalid
Dispatched when validation fails.Validator
 Inherited
valid
Dispatched when validation succeeds.Validator
Protected Constants
 ConstantDefined By
 InheritedDECIMAL_DIGITS : String = "0123456789"
[static] A String containing the decimal digits 0 through 9.
Validator
 InheritedROMAN_LETTERS : String = "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz"
[static] A string containing the upper- and lower-case letters of the Roman alphabet ("A" through "Z" and "a" through "z").
Validator
Property Detail
allowedFormatCharsproperty
allowedFormatChars:String

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

Specifies the set of formatting characters allowed in the input.

The default value is "()- .+" // ?????.



Implementation
    public function get allowedFormatChars():String
    public function set allowedFormatChars(value:String):void
invalidCharErrorproperty 
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 characters other than digits and formatting characters defined by the allowedFormatChars property.

The default value is "You entered invalid characters in your Social Security number.".



Implementation
    public function get invalidCharError():String
    public function set invalidCharError(value:String):void
wrongFormatErrorproperty 
wrongFormatError:String

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

Error message when the value is incorrectly formatted.

The default value is "The Social Security number must be 9 digits or in the form NNN-NN-NNNN.".



Implementation
    public function get wrongFormatError():String
    public function set wrongFormatError(value:String):void
zeroStartErrorproperty 
zeroStartError:String

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

Error message when the value contains an invalid Social Security number.

The default value is "Invalid Social Security number; the number cannot start with 000.".



Implementation
    public function get zeroStartError():String
    public function set zeroStartError(value:String):void
Constructor Detail
SocialSecurityValidator()Constructor
public function SocialSecurityValidator()

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

Constructor.

Method Detail
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 Social Security number.

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.

Parameters

value:Object — Object to validate.

Returns
Array — An Array of ValidationResult objects, with one ValidationResult object for each field examined by the validator.
validateSocialSecurity()method 
public static function validateSocialSecurity(validator:SocialSecurityValidator, 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. Each of the standard Flex validators has a similar convenience method.

Parameters

validator:SocialSecurityValidator — The SocialSecurityValidator 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.social, the baseField value is social.

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

See also

mx.validators.ValidationResult
Examples (  How to use this example  )
SocialSecurityValidatorExample.mxml
<?xml version="1.0" encoding="utf-8"?>
<!-- Simple example to demonstrate SocialSecurityValidator. -->
<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/halo">

    <fx:Script>
        import mx.controls.Alert;
    </fx:Script>

    <fx:Declarations>
        <mx:SocialSecurityValidator source="{ssn}" property="text" 
                trigger="{myButton}" triggerEvent="click"
                valid="Alert.show('Validation Succeeded!');"
                invalid="Alert.show('Validation Failed!');"/>
    </fx:Declarations>

    <s:Panel title="Social Security Validator Panel"
            width="75%" height="75%"
            horizontalCenter="0" verticalCenter="0">
        <mx:Form left="10" right="10" top="10" bottom="10">
            <mx:FormItem label="Enter Social Security number: ">
                <s:TextInput id="ssn" width="100%"/>
            </mx:FormItem>
            <mx:FormItem >
                <s:Button id="myButton" label="Validate" />
            </mx:FormItem>
        </mx:Form>
    </s:Panel>

</s:Application>



© 2009 Adobe Systems Incorporated. All rights reserved.
Sat Oct 3 2009, 04:15 AM -07:00