| Package | mx.validators |
| Class | public class DateValidator |
| Inheritance | DateValidator  Validator EventDispatcher Object |
Date objects)You can specify the date in the DateValidator class in two ways:
source
and property properties to specify the String.
The String can contain digits and the formatting characters
specified by the allowedFormatChars property,
which include the "/\-. " characters.
By default, the input format of the date in a String field
is "MM/DD/YYYY" where "MM" is the month, "DD" is the day,
and "YYYY" is the year.
You can use the inputFormat property
to specify a different format.Date object.daySource, dayProperty,
monthSource, monthProperty,
yearSource, and yearProperty.
Hide MXML Syntax
The <mx:DateValidator> tag
inherits all of the tag attributes of its superclass,
and adds the following tag attributes:
Show MXML Syntax
<mx:DateValidator
allowedFormatChars="/\-. "
dayListener="Object specified by daySource"
dayProperty="No default"
daySource="No default"
formatError= "Configuration error: Incorrect formatting string."
inputFormat="MM/DD/YYYY"
invalidCharError="The date contains invalid characters."
monthListener="Object specified by monthSource"
monthProperty="No default"
monthSource="No default"
validateAsString="true|false"
wrongDayError="Enter a valid day for the month."
wrongLengthError="Type the date in the format inputFormat."
wrongMonthError="Enter a month between 1 and 12."
wrongYearError="Enter a year between 0 and 9999."
yearListener="Object specified by yearSource"
yearProperty="No default"
yearSource="No default"
/>
| Property | Defined By | ||
|---|---|---|---|
| allowedFormatChars : String
The set of formatting characters allowed for separating
the month, day, and year values.
| DateValidator | ||
 | constructor : Object
A reference to the class object or constructor function for a given object instance.
| Object | |
| dayListener : IValidatorListener
The component that listens for the validation result
for the day subfield.
| DateValidator | ||
| dayProperty : String
Name of the day property to validate.
| DateValidator | ||
| daySource : Object
Object that contains the value of the day field.
| DateValidator | ||
| enabled : Boolean
Setting this value to false will stop the validator
from performing validation.
| Validator | |
| formatError : String
Error message when the inputFormat property
is not in the correct format.
| DateValidator | ||
| inputFormat : String
The date format to validate the value against.
| DateValidator | ||
| invalidCharError : String
Error message when there are invalid characters in the date.
| DateValidator | ||
| listener : Object
Specifies the validation listener.
| Validator | |
| monthListener : IValidatorListener
The component that listens for the validation result
for the month subfield.
| DateValidator | ||
| monthProperty : String
Name of the month property to validate.
| DateValidator | ||
| monthSource : Object
Object that contains the value of the month field.
| DateValidator | ||
| property : String
A String specifying the name of the property
of the source object that contains
the value to validate.
| Validator | |
| prototype : Object
[static]
A reference to the prototype object of a class or function object.
| Object | |
| 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 | |
| validateAsString : Object
Determines how to validate the value.
| DateValidator | ||
| wrongDayError : String
Error message when the day is invalid.
| DateValidator | ||
| wrongLengthError : String
Error message when the length of the date
doesn't match that of the inputFormat property.
| DateValidator | ||
| wrongMonthError : String
Error message when the month is invalid.
| DateValidator | ||
| wrongYearError : String
Error message when the year is invalid.
| DateValidator | ||
| yearListener : IValidatorListener
The component that listens for the validation result
for the year subfield.
| DateValidator | ||
| yearProperty : String
Name of the year property to validate.
| DateValidator | ||
| yearSource : Object
Object that contains the value of the year field.
| DateValidator | ||
| Method | Defined By | ||
|---|---|---|---|
|
Constructor.
| DateValidator | ||
|
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 | |
|
Dispatches an event into the event flow.
| EventDispatcher | |
|
Checks whether the EventDispatcher object has any listeners registered for a specific type
of event.
| EventDispatcher | |
|
Indicates whether an object has a specified property defined.
| Object | |
|
Called automatically by the MXML compiler when the Validator
is created using an MXML tag.
| Validator | |
|
Indicates whether an instance of the Object class is in the prototype chain of the object specified
as the parameter.
| Object | |
|
Indicates whether the specified property exists and is enumerable.
| Object | |
|
Removes a listener from the EventDispatcher object.
| EventDispatcher | |
|
Sets the availability of a dynamic property for loop operations.
| Object | |
|
Returns the string representation of the specified object.
| Object | |
|
Performs validation and optionally notifies
the listeners of the result.
| Validator | |
|
[static]
Invokes all the validators in the validators Array.
| Validator | |
|
[static]
Convenience method for calling a validator
from within a custom validation function.
| DateValidator | ||
|
Returns the primitive value of the specified object.
| Object | |
|
Checks whether an event listener is registered with this EventDispatcher object or any of
its ancestors for the specified event type.
| EventDispatcher | |
| Method | Defined By | ||
|---|---|---|---|
|
Sets up all of the listeners for the
valid and invalid
events dispatched from the validator.
| Validator | |
|
Override of the base class doValidation() method
to validate a date.
| DateValidator | ||
|
Returns the Object to validate.
| Validator | |
|
Returns a ValidationResultEvent from the Array of error results.
| Validator | |
|
Returns true if value is not null.
| Validator | |
|
Disconnects all of the listeners for the
valid and invalid
events dispatched from the validator.
| Validator | |
|
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 [read-write] The set of formatting characters allowed for separating the month, day, and year values.
The default value is "/\-. ".
public function get allowedFormatChars():String
public function set allowedFormatChars(value:String):void
| dayListener | property |
dayListener:IValidatorListener [read-write]
The component that listens for the validation result
for the day subfield.
If none is specified, use the value specified
for the daySource property.
public function get dayListener():IValidatorListener
public function set dayListener(value:IValidatorListener):void
| dayProperty | property |
public var dayProperty:String
Name of the day property to validate.
This property is optional, but if you specify the
daySource property, you should also set this property.
| daySource | property |
daySource:Object [read-write]
Object that contains the value of the day field.
If you specify a value for this property, you must also
specify a value for the dayProperty property.
Do not use this property if you set the source
and property properties.
public function get daySource():Object
public function set daySource(value:Object):void
| formatError | property |
formatError:String [read-write]
Error message when the inputFormat property
is not in the correct format.
The default value is "Configuration error: Incorrect formatting string.".
public function get formatError():String
public function set formatError(value:String):void
| inputFormat | property |
inputFormat:String [read-write] The date format to validate the value against. "MM" is the month, "DD" is the day, and "YYYY" is the year. This String is case-sensitive.
The default value is "MM/DD/YYYY".
public function get inputFormat():String
public function set inputFormat(value:String):void
| invalidCharError | property |
invalidCharError:String [read-write] Error message when there are invalid characters in the date.
The default value is "Invalid characters in your date.".
public function get invalidCharError():String
public function set invalidCharError(value:String):void
| monthListener | property |
monthListener:IValidatorListener [read-write]
The component that listens for the validation result
for the month subfield.
If none is specified, use the value specified
for the monthSource property.
public function get monthListener():IValidatorListener
public function set monthListener(value:IValidatorListener):void
| monthProperty | property |
public var monthProperty:String
Name of the month property to validate.
This property is optional, but if you specify the
monthSource property, you should also set this property.
| monthSource | property |
monthSource:Object [read-write]
Object that contains the value of the month field.
If you specify a value for this property, you must also specify
a value for the monthProperty property.
Do not use this property if you set the source
and property properties.
public function get monthSource():Object
public function set monthSource(value:Object):void
| validateAsString | property |
validateAsString:Object [read-write]
Determines how to validate the value.
If set to true, the validator evaluates the value
as a String, unless the value has a month,
day, or year property.
If false, the validator evaluates the value
as a Date object.
The default value is true.
public function get validateAsString():Object
public function set validateAsString(value:Object):void
| wrongDayError | property |
wrongDayError:String [read-write] Error message when the day is invalid.
The default value is "Enter a valid day for the month.".
public function get wrongDayError():String
public function set wrongDayError(value:String):void
| wrongLengthError | property |
wrongLengthError:String [read-write]
Error message when the length of the date
doesn't match that of the inputFormat property.
The default value is "Type the date in the format <i>inputFormat</i>.".
public function get wrongLengthError():String
public function set wrongLengthError(value:String):void
| wrongMonthError | property |
wrongMonthError:String [read-write] Error message when the month is invalid.
The default value is "Enter a month between 1 and 12.".
public function get wrongMonthError():String
public function set wrongMonthError(value:String):void
| wrongYearError | property |
wrongYearError:String [read-write] Error message when the year is invalid.
The default value is "Enter a year between 0 and 9999.".
public function get wrongYearError():String
public function set wrongYearError(value:String):void
| yearListener | property |
yearListener:IValidatorListener [read-write]
The component that listens for the validation result
for the year subfield.
If none is specified, use the value specified
for the yearSource property.
public function get yearListener():IValidatorListener
public function set yearListener(value:IValidatorListener):void
| yearProperty | property |
public var yearProperty:String
Name of the year property to validate.
This property is optional, but if you specify the
yearSource property, you should also set this property.
| yearSource | property |
yearSource:Object [read-write]
Object that contains the value of the year field.
If you specify a value for this property, you must also specify
a value for the yearProperty property.
Do not use this property if you set the source
and property properties.
public function get yearSource():Object
public function set yearSource(value:Object):void
| DateValidator | () | Constructor |
public function DateValidator()
Constructor.
| doValidation | () | method |
protected override function doValidation(value:Object):Array
Override of the base class doValidation() method
to validate a date.
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 — Either a String or an Object to validate.
|
Array — An Array of ValidationResult objects, with one ValidationResult
object for each field examined by the validator.
|
| validateDate | () | method |
public static function validateDate(validator:DateValidator, value:Object, baseField:String):Array
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:DateValidator — The DateValidator 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.date, the baseField value is "date".
|
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"?>
<!-- Simple example to demonstrate the DateValidator. -->
<mx:Application xmlns:mx="http://www.adobe.com/2006/mxml">
<mx:Script>
import mx.controls.Alert;
</mx:Script>
<mx:Model id="CheckModel">
<dateInfo>
<DOB>{dob.text}</DOB>
</dateInfo>
</mx:Model>
<mx:DateValidator source="{dob}" property="text" allowedFormatChars="/"
trigger="{myButton}" triggerEvent="click"
valid="Alert.show('Validation Succeeded!');"/>
<mx:Panel title="DateValidator Example" width="75%" height="75%"
paddingTop="10" paddingLeft="10" paddingRight="10" paddingBottom="10">
<mx:Form>
<mx:FormItem label="Enter date of birth (mm/dd/yyyy): ">
<mx:TextInput id="dob" width="100%"/>
</mx:FormItem>
<mx:FormItem >
<mx:Button id="myButton" label="Validate" />
</mx:FormItem>
</mx:Form>
</mx:Panel>
</mx:Application>