| Package | mx.controls |
| Class | public class DateField |
| Inheritance | DateField ComboBase UIComponent FlexSprite Sprite DisplayObjectContainer InteractiveObject DisplayObject EventDispatcher Object |
| Implements | IDataRenderer, IDropInListItemRenderer, IFocusManagerComponent, IListItemRenderer |
When the DateChooser control is open, the user can scroll through months and years, and select a date. When a date is selected, the DateChooser control closes, and the text field shows the selected date.
The user can also type the date in the text field if the editable
property of the DateField control is set to true.
The DateField has the same default characteristics (shown below) as the DateChooser for its expanded date chooser.
| Characteristic | Description |
|---|---|
| Default size | A size large enough to hold the calendar, and wide enough to display the day names |
| Minimum size | 0 pixels |
| Maximum size | No limit |
The DateField has the following default characteristics for the collapsed control:
| Characteristic | Description |
|---|---|
| Default size | A size large enough to hold the formatted date and the calendar icon |
| Minimum size | 0 pixels |
| Maximum size | No limit |
Hide MXML Syntax
The <mx:DateField> tag inherits all of the tag attributes
of its superclass, and adds the following tag attributes:
<mx:DateField
Properties
dayNames="["S", "M", "T", "W", "T", "F", "S"]"
disabledDays="No default"
disabledRanges="No default"
displayedMonth="Current month"
displayedYear="Current year"
dropdownFactory="ClassFactory that creates an mx.controls.DateChooser"
firstDayOfWeek="0"
formatString="MM/DD/YYYY"
labelFunction="Internal formatter"
maxYear="2100"
minYear="1900"
monthNames="["January", "February", "March", "April", "May",
"June", "July", "August", "September", "October", "November",
"December"]"
monthSymbol=""
parseFunction="Internal parser"
selectableRange="No default"
selectedDate="No default"
showToday="true|false"
yearNavigationEnabled="false|true"
yearSymbol=""
Styles
borderColor="0xAAB3B3"
borderThickness="1"
color="0x0xB333C"
dateChooserStyleName="dateFieldPopup"
disabledColor="0xAAB3B3"
disabledIconColor="0x999999"
focusAlpha="0.5"
focusRoundedCorners="tl tr bl br"
fontAntiAliasType="advanced"
fontFamily="Verdana"
fontGridFitType="pixel"
fontSharpness="0"
fontSize="10"
fontStyle="normal|italic"
fontThickness="0"
fontWeight="normal|bold"
iconColor="0x111111"
leading="2"
paddingLeft="0"
paddingRight="0"
rollOverColor="0xE3FFD6"
selectionColor="0xB7F39B"
textAlign="left|right|center"
textDecoration="none|underline"
textIndent="0"
todayColor="0x2B333C"
Events
change="No default"
close="No default"
dataChange="No default"
open="No default"
scroll="No default"
/>
See also
| Property | Defined By | ||
|---|---|---|---|
![]() | accessibilityProperties : AccessibilityProperties
The current accessibility options for this display object.
| DisplayObject | |
![]() | activeEffects : Array
[read-only]
The list of effects that are currently playing on the component,
as an Array of EffectInstance instances.
| UIComponent | |
![]() | alpha : Number
Indicates the alpha transparency value of the object specified.
| DisplayObject | |
![]() | automationDelegate : Object
The delegate object that handles the automation-related functionality.
| UIComponent | |
![]() | automationName : String
Name that can be used as an identifier for this object.
| UIComponent | |
![]() | automationTabularData : Object
[read-only]
An implementation of the IAutomationTabularData interface, which
can be used to retrieve the data.
| UIComponent | |
![]() | automationValue : Array
[read-only]
This value generally corresponds to the rendered appearance of the
object and should be usable for correlating the identifier with
the object as it appears visually within the application.
| UIComponent | |
![]() | baselinePosition : Number
[read-only]
The y-coordinate of the baseline
of the first line of text of the component.
| UIComponent | |
![]() | blendMode : String
A value from the BlendMode class that specifies which blend mode to use.
| DisplayObject | |
![]() | buttonMode : Boolean
Specifies the button mode of this sprite.
| Sprite | |
![]() | cacheAsBitmap : Boolean
If set to true, Flash Player or Adobe AIR caches an internal bitmap representation of the
display object.
| DisplayObject | |
![]() | cacheHeuristic : Boolean
[write-only]
Used by Flex to suggest bitmap caching for the object.
| UIComponent | |
![]() | cachePolicy : String
Specifies the bitmap caching policy for this object.
| UIComponent | |
![]() | className : String
[read-only]
The name of this instance's class, such as "Button".
| UIComponent | |
![]() | constructor : Object
A reference to the class object or constructor function for a given object instance.
| Object | |
![]() | contentMouseX : Number
[read-only]
Returns the x position of the mouse, in the content coordinate system.
| UIComponent | |
![]() | contentMouseY : Number
[read-only]
Returns the y position of the mouse, in the content coordinate system.
| UIComponent | |
![]() | contextMenu : NativeMenu
Specifies the context menu associated with this object.
| InteractiveObject | |
![]() | currentState : String
The current view state of the component.
| UIComponent | |
![]() | cursorManager : ICursorManager [read-only]
Gets the CursorManager that controls the cursor for this component
and its peers.
| UIComponent | |
| data : Object
The data property lets you pass a value
to the component when you use it in an item renderer or item editor.
| DateField | ||
![]() | dataProvider : Object
The set of items this component displays.
| ComboBase | |
| dayNames : Array
Weekday names for DateChooser control.
| DateField | ||
![]() | descriptor : UIComponentDescriptor
Reference to the UIComponentDescriptor, if any, that was used
by the createComponentFromDescriptor() method to create this
UIComponent instance.
| UIComponent | |
| disabledDays : Array
Days to disable in a week.
| DateField | ||
| disabledRanges : Array
Disables single and multiple days.
| DateField | ||
| displayedMonth : int
Used with the displayedYear property,
the displayedMonth property
specifies the month displayed in the DateChooser control.
| DateField | ||
| displayedYear : int
Used with the displayedMonth property,
the displayedYear property determines
which year is displayed in the DateChooser control.
| DateField | ||
![]() | document : Object
A reference to the document object associated with this UIComponent.
| UIComponent | |
![]() | doubleClickEnabled : Boolean
Specifies whether the UIComponent object receives doubleClick events.
| UIComponent | |
| dropdown : DateChooser
[read-only]
Contains a reference to the DateChooser control
contained by the DateField control.
| DateField | ||
| dropdownFactory : IFactory
The IFactory that creates a DateChooser-derived instance to use
as the date-chooser
The default value is an IFactory for DateChooser
| DateField | ||
![]() | dropTarget : DisplayObject
[read-only]
Specifies the display object over which the sprite is being dragged, or on
which the sprite was dropped.
| Sprite | |
![]() | editable : Boolean
A flag that indicates whether the control is editable,
which lets the user directly type entries that are not specified
in the dataProvider, or not editable, which requires the user select
from the items in the dataProvider.
| ComboBase | |
![]() | enabled : Boolean
Whether the component can accept user interaction.
| UIComponent | |
![]() | errorString : String
The text that will be displayed by a component's error tip when a
component is monitored by a Validator and validation fails.
| UIComponent | |
![]() | explicitHeight : Number
Number that specifies the explicit height of the component,
in pixels, in the component's coordinates.
| UIComponent | |
![]() | explicitMaxHeight : Number
Number that specifies the maximum height of the component,
in pixels, in the component's coordinates.
| UIComponent | |
![]() | explicitMaxWidth : Number
Number that specifies the maximum width of the component,
in pixels, in the component's coordinates.
| UIComponent | |
![]() | explicitMinHeight : Number
Number that specifies the minimum height of the component,
in pixels, in the component's coordinates.
| UIComponent | |
![]() | explicitMinWidth : Number
Number that specifies the minimum width of the component,
in pixels, in the component's coordinates.
| UIComponent | |
![]() | explicitWidth : Number
Number that specifies the explicit width of the component,
in pixels, in the component's coordinates.
| UIComponent | |
![]() | filters : Array
An indexed array that contains each filter object currently associated with the display object.
| DisplayObject | |
| firstDayOfWeek : Object
Day of the week (0-6, where 0 is the first element
of the dayNames Array) to display in the first column
of the DateChooser control.
| DateField | ||
![]() | flexContextMenu : IFlexContextMenu
The context menu for this UIComponent.
| UIComponent | |
![]() | focusEnabled : Boolean
Indicates whether the component can receive focus when tabbed to.
| UIComponent | |
![]() | focusManager : IFocusManager
Gets the FocusManager that controls focus for this component
and its peers.
| UIComponent | |
![]() | focusPane : Sprite
The focus pane associated with this object.
| UIComponent | |
![]() | focusRect : Object
Specifies whether this object displays a focus rectangle.
| InteractiveObject | |
| formatString : String
The format of the displayed date in the text field.
| DateField | ||
![]() | graphics : Graphics
[read-only]
Specifies the Graphics object that belongs to this sprite where vector
drawing commands can occur.
| Sprite | |
![]() | height : Number
Number that specifies the height of the component, in pixels,
in the parent's coordinates.
| UIComponent | |
![]() | hitArea : Sprite
Designates another sprite to serve as the hit area for a sprite.
| Sprite | |
![]() | id : String
ID of the component.
| UIComponent | |
![]() | imeMode : String
Specifies the IME (input method editor) mode.
| ComboBase | |
![]() | includeInLayout : Boolean
Specifies whether this component is included in the layout of the
parent container.
| UIComponent | |
![]() | inheritingStyles : Object
The beginning of this component's chain of inheriting styles.
| UIComponent | |
![]() | initialized : Boolean
A flag that determines if an object has been through all three phases
of layout: commitment, measurement, and layout (provided that any were required).
| UIComponent | |
![]() | instanceIndex : int
[read-only]
The index of a repeated component.
| UIComponent | |
![]() | instanceIndices : Array
An Array containing the indices required to reference
this UIComponent object from its parent document.
| UIComponent | |
![]() | isDocument : Boolean
[read-only]
Determines whether this UIComponent instance is a document object,
that is, whether it is at the top of the hierarchy of a Flex
application, MXML component, or ActionScript component.
| UIComponent | |
![]() | isPopUp : Boolean
Set to true by the PopUpManager to indicate
that component has been popped up.
| UIComponent | |
| labelFunction : Function
Function used to format the date displayed
in the text field of the DateField control.
| DateField | ||
| listData : BaseListData
When a component is used as a drop-in item renderer or drop-in
item editor, Flex initializes the listData property
of the component with the appropriate data from the List control.
| DateField | ||
![]() | loaderInfo : LoaderInfo
[read-only]
Returns a LoaderInfo object containing information about loading the file
to which this display object belongs.
| DisplayObject | |
![]() | mask : DisplayObject
The calling display object is masked by the specified mask object.
| DisplayObject | |
![]() | maxHeight : Number
Number that specifies the maximum height of the component,
in pixels, in the component's coordinates.
| UIComponent | |
![]() | maxWidth : Number
Number that specifies the maximum width of the component,
in pixels, in the component's coordinates.
| UIComponent | |
| maxYear : int
The last year selectable in the control.
| DateField | ||
![]() | measuredHeight : Number
The default height of the component, in pixels.
| UIComponent | |
![]() | measuredMinHeight : Number
The default minimum height of the component, in pixels.
| UIComponent | |
![]() | measuredMinWidth : Number
The default minimum width of the component, in pixels.
| UIComponent | |
![]() | measuredWidth : Number
The default width of the component, in pixels.
| UIComponent | |
![]() | minHeight : Number
Number that specifies the minimum height of the component,
in pixels, in the component's coordinates.
| UIComponent | |
![]() | minWidth : Number
Number that specifies the minimum width of the component,
in pixels, in the component's coordinates.
| UIComponent | |
| minYear : int
The first year selectable in the control.
| DateField | ||
![]() | moduleFactory : IFlexModuleFactory
The moduleFactory that is used to create TextFields in the correct SWF context.
| UIComponent | |
| monthNames : Array
Names of the months displayed at the top of the control.
| DateField | ||
| monthSymbol : String
This property is appended to the end of the value specified
by the monthNames property to define the names
of the months displayed at the top of the control.
| DateField | ||
![]() | mouseChildren : Boolean
Determines whether or not the children of the object are mouse enabled.
| DisplayObjectContainer | |
![]() | mouseEnabled : Boolean
Specifies whether this object receives mouse messages.
| InteractiveObject | |
![]() | mouseFocusEnabled : Boolean
Whether you can receive focus when clicked on.
| UIComponent | |
![]() | mouseX : Number
[read-only]
Indicates the x coordinate of the mouse position, in pixels.
| DisplayObject | |
![]() | mouseY : Number
[read-only]
Indicates the y coordinate of the mouse position, in pixels.
| DisplayObject | |
![]() | name : String
Indicates the instance name of the DisplayObject.
| DisplayObject | |
![]() | nestLevel : int
Depth of this object in the containment hierarchy.
| UIComponent | |
![]() | nonInheritingStyles : Object
The beginning of this component's chain of non-inheriting styles.
| UIComponent | |
![]() | numAutomationChildren : int
[read-only]
The number of automation children this container has.
| UIComponent | |
![]() | numChildren : int
[read-only]
Returns the number of children of this object.
| DisplayObjectContainer | |
![]() | opaqueBackground : Object
Specifies whether the display object is opaque with a certain background color.
| DisplayObject | |
![]() | owner : DisplayObjectContainer
The owner of this UIComponent.
| UIComponent | |
![]() | parent : DisplayObjectContainer
[read-only]
The parent container or component for this component.
| UIComponent | |
![]() | parentApplication : Object
[read-only]
A reference to the Application object that contains this UIComponent
instance.
| UIComponent | |
![]() | parentDocument : Object
[read-only]
A reference to the parent document object for this UIComponent.
| UIComponent | |
| parseFunction : Function
Function used to parse the date entered as text
in the text field area of the DateField control and return a
Date object to the control.
| DateField | ||
![]() | percentHeight : Number
Number that specifies the height of a component as a percentage
of its parent's size.
| UIComponent | |
![]() | percentWidth : Number
Number that specifies the width of a component as a percentage
of its parent's size.
| UIComponent | |
![]() | processedDescriptors : Boolean
Set to true after immediate or deferred child creation,
depending on which one happens.
| UIComponent | |
![]() | prototype : Object
[static]
A reference to the prototype object of a class or function object.
| Object | |
![]() | repeater : IRepeater
[read-only]
A reference to the Repeater object
in the parent document that produced this UIComponent.
| UIComponent | |
![]() | repeaterIndex : int
[read-only]
The index of the item in the data provider
of the Repeater that produced this UIComponent.
| UIComponent | |
![]() | repeaterIndices : Array
An Array containing the indices of the items in the data provider
of the Repeaters in the parent document that produced this UIComponent.
| UIComponent | |
![]() | repeaters : Array
An Array containing references to the Repeater objects
in the parent document that produced this UIComponent.
| UIComponent | |
![]() | restrict : String
Set of characters that a user can or cannot enter into the text field.
| ComboBase | |
![]() | root : DisplayObject
[read-only]
For a display object in a loaded SWF file, the root property is the
top-most display object in the portion of the display list's tree structure represented by that SWF file.
| DisplayObject | |
![]() | rotation : Number
Indicates the rotation of the DisplayObject instance, in degrees, from its original orientation.
| DisplayObject | |
![]() | scale9Grid : Rectangle
The current scaling grid that is in effect.
| DisplayObject | |
![]() | scaleX : Number
Number that specifies the horizontal scaling factor.
| UIComponent | |
![]() | scaleY : Number
Number that specifies the vertical scaling factor.
| UIComponent | |
![]() | screen : Rectangle
[read-only]
Returns an object that contains the size and position of the base
drawing surface for this object.
| UIComponent | |
![]() | scrollRect : Rectangle
The scroll rectangle bounds of the display object.
| DisplayObject | |
| selectableRange : Object
Range of dates between which dates are selectable.
| DateField | ||
| selectedDate : Date
Date as selected in the DateChooser control.
| DateField | ||
![]() | showInAutomationHierarchy : Boolean
A flag that determines if an automation object
shows in the automation hierarchy.
| UIComponent | |
| showToday : Boolean
If true, specifies that today is highlighted
in the DateChooser control.
| DateField | ||
![]() | soundTransform : SoundTransform
Controls sound within this sprite.
| Sprite | |
![]() | stage : Stage
[read-only]
The Stage of the display object.
| DisplayObject | |
![]() | states : Array
The view states that are defined for this component.
| UIComponent | |
![]() | styleDeclaration : CSSStyleDeclaration
Storage for the inline inheriting styles on this object.
| UIComponent | |
![]() | styleName : Object
The class style used by this component.
| UIComponent | |
![]() | systemManager : ISystemManager
Returns the SystemManager object used by this component.
| UIComponent | |
![]() | tabChildren : Boolean
Determines whether the children of the object are tab enabled.
| DisplayObjectContainer | |
![]() | tabEnabled : Boolean
Specifies whether this object is in the tab order.
| InteractiveObject | |
![]() | tabIndex : int
Specifies the tab ordering of objects in a SWF file.
| InteractiveObject | |
![]() | text : String
Contents of the text field.
| ComboBase | |
![]() | textSnapshot : TextSnapshot
[read-only]
Returns a TextSnapshot object for this DisplayObjectContainer instance.
| DisplayObjectContainer | |
![]() | toolTip : String
Text to display in the ToolTip.
| UIComponent | |
![]() | transform : Transform
An object with properties pertaining to a display object's matrix, color transform, and pixel bounds.
| DisplayObject | |
![]() | transitions : Array
An Array of Transition objects, where each Transition object defines a
set of effects to play when a view state change occurs.
| UIComponent | |
![]() | tweeningProperties : Array
Array of properties that are currently being tweened on this object.
| UIComponent | |
![]() | uid : String
A unique identifier for the object.
| UIComponent | |
![]() | updateCompletePendingFlag : Boolean
A flag that determines if an object has been through all three phases
of layout validation (provided that any were required).
| UIComponent | |
![]() | useHandCursor : Boolean
A Boolean value that indicates whether the pointing hand (hand cursor) appears when the mouse rolls
over a sprite in which the buttonMode property is set to true.
| Sprite | |
![]() | validationSubField : String
Used by a validator to associate a subfield with this component.
| UIComponent | |
![]() | value : Object
[read-only]
The value of the selected item.
| ComboBase | |
![]() | visible : Boolean
Controls the visibility of this UIComponent.
| UIComponent | |
![]() | width : Number
Number that specifies the width of the component, in pixels,
in the parent's coordinates.
| UIComponent | |
![]() | x : Number
Number that specifies the component's horizontal position,
in pixels, within its parent container.
| UIComponent | |
![]() | y : Number
Number that specifies the component's vertical position,
in pixels, within its parent container.
| UIComponent | |
| yearNavigationEnabled : Boolean
Enables year navigation.
| DateField | ||
| yearSymbol : String
This property is appended to the end of the year
displayed at the top of the control.
| DateField | ||
| Method | Defined By | ||
|---|---|---|---|
|
Constructor
| DateField | ||
![]() |
Adds a child DisplayObject instance to this DisplayObjectContainer instance.
| DisplayObjectContainer | |
![]() |
Adds a child DisplayObject instance to this DisplayObjectContainer
instance.
| DisplayObjectContainer | |
![]() |
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 | |
![]() |
Indicates whether the security restrictions
would cause any display objects to be omitted from the list returned by calling
the DisplayObjectContainer.getObjectsUnderPoint() method
with the specified point point.
| DisplayObjectContainer | |
![]() |
Queues a function to be called later.
| UIComponent | |
![]() |
Deletes a style property from this component instance.
| UIComponent | |
|
Closes the DateChooser control.
| DateField | ||
![]() |
Determines whether the specified display object is a child of the DisplayObjectContainer instance or
the instance itself.
| DisplayObjectContainer | |
![]() |
Converts a Point object from content coordinates to global coordinates.
| UIComponent | |
![]() |
Converts a Point object from content to local coordinates.
| UIComponent | |
![]() |
Returns a set of properties that identify the child within
this container.
| UIComponent | |
![]() |
Creates an id reference to this IUIComponent object
on its parent document object.
| UIComponent | |
|
[static]
Formats a Date into a String according to the outputFormat argument.
| DateField | ||
![]() |
Deletes the id reference to this IUIComponent object
on its parent document object.
| UIComponent | |
![]() |
Returns a UITextFormat object corresponding to the text styles
for this UIComponent.
| UIComponent | |
![]() |
Dispatches an event into the event flow.
| UIComponent | |
![]() |
Shows or hides the focus indicator around this component.
| UIComponent | |
![]() | |||