Language Version : | ActionScript 3.0 |
Runtime Versions : | Flash Player 9, AIR 1.1 |
The DateValidator class validates that a String, Date, or Object contains a
proper date and matches a specified format. Users can enter a single
digit or two digits for month, day, and year.
By default, the validator ensures the following formats:
- The month is between 1 and 12 (or 0-11 for
Date
objects)
- The day is between 1 and 31
- The year is a number
You can specify the date in the DateValidator class in two ways:
- Single String containing the date - Use the
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.
- Object or multiple fields containing the day, month, and year.
Use all of the following properties to specify the day, month,
and year inputs:
daySource
, dayProperty
,
monthSource
, monthProperty
,
yearSource
, and yearProperty
.
Show MXML Syntax
Hide MXML Syntax The <mx:DateValidator>
tag
inherits all of the tag attributes of its superclass,
and adds the following tag attributes:
<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"
/>
allowedFormatChars:String
Language Version : | ActionScript 3.0 |
Runtime Versions : | Flash Player 9, AIR 1.1 |
The set of formatting characters allowed for separating
the month, day, and year values.
The default value is "/\-. "
.
Implementation public function get allowedFormatChars():String
public function set allowedFormatChars(value:String):void
dayListener:IValidatorListener
Language Version : | ActionScript 3.0 |
Runtime Versions : | Flash Player 9, AIR 1.1 |
The component that listens for the validation result
for the day subfield.
If none is specified, use the value specified
for the daySource
property.
Implementation public function get dayListener():IValidatorListener
public function set dayListener(value:IValidatorListener):void
public var dayProperty:String
Language Version : | ActionScript 3.0 |
Runtime Versions : | Flash Player 9, AIR 1.1 |
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:Object
Language Version : | ActionScript 3.0 |
Runtime Versions : | Flash Player 9, AIR 1.1 |
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.
Implementation public function get daySource():Object
public function set daySource(value:Object):void
formatError:String
Language Version : | ActionScript 3.0 |
Runtime Versions : | Flash Player 9, AIR 1.1 |
Error message when the inputFormat
property
is not in the correct format.
The default value is "Configuration error: Incorrect formatting string."
.
Implementation public function get formatError():String
public function set formatError(value:String):void
inputFormat:String
Language Version : | ActionScript 3.0 |
Runtime Versions : | Flash Player 9, AIR 1.1 |
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"
.
Implementation public function get inputFormat():String
public function set inputFormat(value:String):void
invalidCharError:String
Language Version : | ActionScript 3.0 |
Runtime Versions : | Flash Player 9, AIR 1.1 |
Error message when there are invalid characters in the date.
The default value is "Invalid characters in your date."
.
Implementation public function get invalidCharError():String
public function set invalidCharError(value:String):void
monthListener:IValidatorListener
Language Version : | ActionScript 3.0 |
Runtime Versions : | Flash Player 9, AIR 1.1 |
The component that listens for the validation result
for the month subfield.
If none is specified, use the value specified
for the monthSource
property.
Implementation public function get monthListener():IValidatorListener
public function set monthListener(value:IValidatorListener):void
public var monthProperty:String
Language Version : | ActionScript 3.0 |
Runtime Versions : | Flash Player 9, AIR 1.1 |
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:Object
Language Version : | ActionScript 3.0 |
Runtime Versions : | Flash Player 9, AIR 1.1 |
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.
Implementation public function get monthSource():Object
public function set monthSource(value:Object):void
validateAsString:Object
Language Version : | ActionScript 3.0 |
Runtime Versions : | Flash Player 9, AIR 1.1 |
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
.
Implementation public function get validateAsString():Object
public function set validateAsString(value:Object):void
wrongDayError:String
Language Version : | ActionScript 3.0 |
Runtime Versions : | Flash Player 9, AIR 1.1 |
Error message when the day is invalid.
The default value is "Enter a valid day for the month."
.
Implementation public function get wrongDayError():String
public function set wrongDayError(value:String):void
wrongLengthError:String
Language Version : | ActionScript 3.0 |
Runtime Versions : | Flash Player 9, AIR 1.1 |
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 inputFormat."
.
Implementation public function get wrongLengthError():String
public function set wrongLengthError(value:String):void
wrongMonthError:String
Language Version : | ActionScript 3.0 |
Runtime Versions : | Flash Player 9, AIR 1.1 |
Error message when the month is invalid.
The default value is "Enter a month between 1 and 12."
.
Implementation public function get wrongMonthError():String
public function set wrongMonthError(value:String):void
wrongYearError:String
Language Version : | ActionScript 3.0 |
Runtime Versions : | Flash Player 9, AIR 1.1 |
Error message when the year is invalid.
The default value is "Enter a year between 0 and 9999."
.
Implementation public function get wrongYearError():String
public function set wrongYearError(value:String):void
yearListener:IValidatorListener
Language Version : | ActionScript 3.0 |
Runtime Versions : | Flash Player 9, AIR 1.1 |
The component that listens for the validation result
for the year subfield.
If none is specified, use the value specified
for the yearSource
property.
Implementation public function get yearListener():IValidatorListener
public function set yearListener(value:IValidatorListener):void
public var yearProperty:String
Language Version : | ActionScript 3.0 |
Runtime Versions : | Flash Player 9, AIR 1.1 |
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:Object
Language Version : | ActionScript 3.0 |
Runtime Versions : | Flash Player 9, AIR 1.1 |
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.
Implementation public function get yearSource():Object
public function set yearSource(value:Object):void
public function DateValidator()
Language Version : | ActionScript 3.0 |
Runtime Versions : | Flash Player 9, AIR 1.1 |
Constructor.
override protected function doValidation(value:Object):Array
Language Version : | ActionScript 3.0 |
Runtime Versions : | Flash Player 9, AIR 1.1 |
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.
|
Returns | Array — An Array of ValidationResult objects, with one ValidationResult
object for each field examined by the validator.
|
public static function validateDate(validator:DateValidator, value:Object, baseField:String):Array
Language Version : | ActionScript 3.0 |
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: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".
|
Returns | Array — An Array of ValidationResult objects, with one ValidationResult
object for each field examined by the validator.
|
See also
Mon Feb 18 2013, 01:33 PM +11:00