CreditCardValidator

(Preview)

Package	mx.validators
Class	public class CreditCardValidator
Inheritance	CreditCardValidator Validator EventDispatcher Object

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

The CreditCardValidator class validates that a credit card number is the correct length, has the correct prefix, and passes the Luhn mod10 algorithm for the specified card type. This validator does not check whether the credit card is an actual active credit card account.

You can specify the input to the CreditCardValidator in two ways:

Use the cardNumberSource and cardNumberProperty properties to specify the location of the credit card number, and the cardTypeSource and cardTypeProperty properties to specify the location of the credit card type to validate.
Use the source and property properties to specify a single Object. The Object should contain the following fields:
- cardType - Specifies the type of credit card being validated.
  In MXML, use the values: "American Express", "Diners Club", "Discover", "MasterCard", or "Visa".
  
  In ActionScript, use the static constants CreditCardValidatorCardType.MASTER_CARD, CreditCardValidatorCardType.VISA, or CreditCardValidatorCardType.AMERICAN_EXPRESS CreditCardValidatorCardType.DISCOVER, or CreditCardValidatorCardType.DINERS_CLUB.
- cardNumber - Specifies the number of the card being validated.

To perform the validation, it uses the following guidelines:

Length:

Visa: 13 or 16 digits
MasterCard: 16 digits
Discover: 16 digits
American Express: 15 digits
Diners Club: 14 digits or 16 digits if it also functions as MasterCard

Prefix:

Visa: 4
MasterCard: 51 to 55
Discover: 6011
American Express: 34 or 37
Diners Club: 300 to 305, 36 or 38, 51 to 55

MXML Syntax expanded

Hide MXML Syntax

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

  <mx:CreditCardValidator
    allowedFormatChars=" -" 
    cardNumberListener="Object specified by cardNumberSource"
    cardNumberProperty="No default"
    cardNumberSource="No default"
    cardTypeListener="Object specified by cardTypeSource"
    cardTypeProperty="No default"
    cardTypeSource="No default"
    invalidCharError= "Invalid characters in your credit card number. (Enter numbers only.)"
    invalidNumberError="The credit card number is invalid." 
    noNumError="No credit card number is specified."
    noTypeError="No credit card type is specified or the type is not valid." 
    wrongLengthError="Your credit card number contains the wrong number of digits." 
    wrongTypeError="Incorrect card type is specified." 
  />

View the examples

More examples

Validating data
Validating credit card numbers

Related API Elements

mx.validators.CreditCardValidatorCardType

Public Properties

Hide Inherited Public Properties

Show Inherited Public Properties

	Property		Defined By
		allowedFormatChars : String The set of formatting characters allowed in the cardNumber field.	CreditCardValidator
		cardNumberListener : IValidatorListener The component that listens for the validation result for the card number subfield.	CreditCardValidator
		cardNumberProperty : String Name of the card number property to validate.	CreditCardValidator
		cardNumberSource : Object Object that contains the value of the card number field.	CreditCardValidator
		cardTypeListener : IValidatorListener The component that listens for the validation result for the card type subfield.	CreditCardValidator
		cardTypeProperty : String Name of the card type property to validate.	CreditCardValidator
		cardTypeSource : Object Object that contains the value of the card type field.	CreditCardValidator
		constructor : Object A reference to the class object or constructor function for a given object instance.	Object
		enabled : Boolean Setting this value to false will stop the validator from performing validation.	Validator
		invalidCharError : String Error message when the cardNumber field contains invalid characters.	CreditCardValidator
		invalidNumberError : String Error message when the credit card number is invalid.	CreditCardValidator
		listener : Object Specifies the validation listener.	Validator
		noNumError : String Error message when the cardNumber field is empty.	CreditCardValidator
		noTypeError : String Error message when the cardType field is blank.	CreditCardValidator
		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
		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 cardNumber field contains the wrong number of digits for the specified credit card type.	CreditCardValidator
		wrongTypeError : String Error message the cardType field contains an invalid credit card type.	CreditCardValidator

Protected Properties

Hide Inherited Protected Properties

Show Inherited Protected Properties

	Property		Defined By
		actualListeners : Array [read-only] Contains an Array of listener objects, if any, or the source object.	Validator
		actualTrigger : IEventDispatcher [read-only] Contains the trigger object, if any, or the source object.	Validator
		resourceManager : IResourceManager [read-only] 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

Public Methods

Hide Inherited Public Methods

Show Inherited Public Methods

	Method		Defined By
		CreditCardValidator() Constructor.	CreditCardValidator
		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
		dispatchEvent(event:Event):Boolean Dispatches an event into the event flow.	EventDispatcher
		hasEventListener(type:String):Boolean Checks whether the EventDispatcher object has any listeners registered for a specific type of event.	EventDispatcher
		hasOwnProperty(name:String):Boolean Indicates whether an object has a specified property defined.	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 Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.	Object
		propertyIsEnumerable(name:String):Boolean Indicates whether the specified property exists and is enumerable.	Object
		removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void Removes a listener from the EventDispatcher object.	EventDispatcher
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Sets the availability of a dynamic property for loop operations.	Object
		toLocaleString():String Returns the string representation of this object, formatted according to locale-specific conventions.	Object
		toString():String Returns the string representation of the specified object.	Object
		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
		validateCreditCard(validator:CreditCardValidator, value:Object, baseField:String):Array [static] Convenience method for calling a validator.	CreditCardValidator
		valueOf():Object Returns the primitive value of the specified object.	Object
		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

Hide Inherited Protected Methods

Show Inherited Protected Methods

	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 credit card number.	CreditCardValidator
		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

Events

Click for more information on events

Hide Inherited Events

Show Inherited Events

	Summary	Defined By
activate	[broadcast event] Dispatched when the Flash Player or AIR application gains operating system focus and becomes active.	EventDispatcher
deactivate	[broadcast event] Dispatched when the Flash Player or AIR application operating loses system focus and is becoming inactive.	EventDispatcher
invalid	Dispatched when validation fails.	Validator
valid	Dispatched when validation succeeds.	Validator

Protected Constants

Hide Inherited Protected Constants

Show Inherited Protected Constants

	Constant		Defined By

Property Detail

Constructor Detail

Method Detail

Examples How to use this example

CreditCardValidatorExample.mxml

Copy

<?xml version="1.0" encoding="utf-8"?>
<!-- Simple example to demonstrate the CreditCardValidator. -->
<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>
        <!-- Define model for the credit card data. -->
        <fx:Model id="creditcard">
            <card>
                <cardType>{cardTypeCombo.selectedItem.data}</cardType>
                <cardNumber>{cardNumberInput.text}</cardNumber>
            </card>
        </fx:Model>

        <mx:CreditCardValidator id="ccV" 
                cardTypeSource="{creditcard}" cardTypeProperty="cardType"
                cardNumberSource="{creditcard}" cardNumberProperty="cardNumber"
                trigger="{myButton}" triggerEvent="click"
                cardTypeListener="{cardTypeCombo}"
                cardNumberListener="{cardNumberInput}"
                valid="Alert.show('Validation Succeeded!');"/>
    </fx:Declarations>

    <s:Panel title="CreditCardValidator Example"
            width="75%" height="75%"
            horizontalCenter="0" verticalCenter="0">
        <mx:Form id="creditCardForm" left="10" right="10" top="10" bottom="10">
            <mx:FormItem label="Card Type">
                <mx:ComboBox id="cardTypeCombo">
                    <mx:dataProvider>
                        <fx:Object label="American Express" data="American Express"/>
                        <fx:Object label="Diners Club" data="Diners Club"/>
                        <fx:Object label="Discover" data="Discover"/>
                        <fx:Object label="MasterCard" data="MasterCard"/>
                        <fx:Object label="Visa" data="Visa"/>
                    </mx:dataProvider>
                </mx:ComboBox>
            </mx:FormItem>
            <mx:FormItem label="Credit Card Number">
                <s:TextInput id="cardNumberInput"/>
            </mx:FormItem>
            <mx:FormItem>
                <s:Button id="myButton" label="Check Credit"/>
            </mx:FormItem>
        </mx:Form>
    </s:Panel>

</s:Application>

[an error occurred while processing this directive]

Legal Notices | Online Privacy Policy

CreditCardValidator - AS3 Flex

Packagesx

Language Elements

Appendixes

Package mx.validators

allowedFormatChars

cardNumberListener

cardNumberProperty

cardNumberSource

cardTypeListener

cardTypeProperty

cardTypeSource

invalidCharError

invalidNumberError

noNumError

noTypeError

wrongLengthError

wrongTypeError

doValidation

validateCreditCard

	`validator:CreditCardValidator` — The CreditCardValidator instance.

	`value:Object` — A field to validate, which must contain the following fields: `cardType` - Specifies the type of credit card being validated. Use the static constants `CreditCardValidatorCardType.MASTER_CARD`, `CreditCardValidatorCardType.VISA`, `CreditCardValidatorCardType.AMERICAN_EXPRESS`, `CreditCardValidatorCardType.DISCOVER`, or `CreditCardValidatorCardType.DINERS_CLUB`. `cardNumber` - Specifies the number of the card being validated.

	`baseField:String` — Text representation of the subfield specified in the value parameter. For example, if the `value` parameter specifies value.date, the `baseField` value is "date".