| 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 SyntaxThe <mx:DateField> tag inherits all of the tag attributes
of its superclass, and adds the following tag attributes:
Show MXML Syntax
<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"
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 | |
| blendShader : Shader [write-only]
Sets a shader that is used for blending the foreground and background. | 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 [override]
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
The maximum recommended height of the component to be considered
by the parent during layout. | UIComponent | |
| explicitMaxWidth : Number
The maximum recommended width of the component to be considered
by the parent during layout. | UIComponent | |
| explicitMinHeight : Number
The minimum recommended height of the component to be considered
by the parent during layout. | UIComponent | |
| explicitMinWidth : Number
The minimum recommended width of the component to be considered
by the parent during layout. | 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 [override]
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
The maximum recommended height of the component to be considered
by the parent during layout. | UIComponent | |
| maxWidth : Number
The maximum recommended width of the component to be considered
by the parent during layout. | 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
The minimum recommended height of the component to be considered
by the parent during layout. | UIComponent | |
| minWidth : Number
The minimum recommended width of the component to be considered
by the parent during layout. | 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 [override] [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 | |
| rotationX : Number
Indicates the x-axis rotation of the DisplayObject instance, in degrees, from its original orientation relative to the 3D parent container. | DisplayObject | |
| rotationY : Number
Indicates the y-axis rotation of the DisplayObject instance, in degrees, from its original orientation relative to the 3D parent container. | DisplayObject | |
| rotationZ : Number
Indicates the z-axis rotation of the DisplayObject instance, in degrees, from its original orientation relative to the 3D parent container. | DisplayObject | |
| scale9Grid : Rectangle
The current scaling grid that is in effect. | DisplayObject | |
| scaleX : Number [override]
Number that specifies the horizontal scaling factor. | UIComponent | |
| scaleY : Number [override]
Number that specifies the vertical scaling factor. | UIComponent | |
| scaleZ : Number
Indicates the depth scale (percentage) of an object as applied from the registration point of the object. | DisplayObject | |
| 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 : flash.media: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 : flash.text:TextSnapshot [read-only]
Returns a TextSnapshot object for this DisplayObjectContainer instance. | DisplayObjectContainer | |
| toolTip : String
Text to display in the ToolTip. | UIComponent | |
| transform : flash.geom: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 [override]
Controls the visibility of this UIComponent. | UIComponent | |
| width : Number [override]
Number that specifies the width of the component, in pixels,
in the parent's coordinates. | UIComponent | |
| x : Number [override]
Number that specifies the component's horizontal position,
in pixels, within its parent container. | UIComponent | |
| y : Number [override]
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 | ||
| z : Number
Indicates the z coordinate position along the z-axis of the DisplayObject
instance relative to the 3D parent container. | DisplayObject | |
| 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 | |
| [override]
Dispatches an event into the event flow. | UIComponent | |
|
Shows or hides the focus indicator around this component. | UIComponent | |
| drawRoundRect(x:Number, y:Number, w:Number, h:Number, r:Object = null, c:Object = null, alpha:Object = null, rot:Object = null, gradient:String = null, ratios:Array = null, hole:Object = null):void
Programatically draws a rectangle into this skin's Graphics object. | UIComponent | |
|
Called by the effect instance when it stops playing on the component. | UIComponent | |
|
Called by the effect instance when it starts playing on the component. | UIComponent | |
|
Ends all currently playing effects on the component. | UIComponent | |
|
Executes the data bindings into this UIComponent object. | UIComponent | |
|
Called after printing is complete. | UIComponent | |
|
Provides the automation object at the specified index. | UIComponent | |
|
Returns a rectangle that defines the area of the display object relative to the coordinate system
of the targetCoordinateSpace object. | DisplayObject | |
|
Returns the child display object instance that exists at the specified index. | DisplayObjectContainer | |
|
Returns the child display object that exists with the specified name. | DisplayObjectContainer | |
|
Returns the index position of a child DisplayObject instance. | DisplayObjectContainer | |
|
Finds the type selectors for this UIComponent instance. | UIComponent | |
|
Returns a layout constraint value, which is the same as
getting the constraint style for this component. | UIComponent | |
|
A convenience method for determining whether to use the
explicit or measured height
| UIComponent | |
|
A convenience method for determining whether to use the
explicit or measured width
| UIComponent | |
|
Gets the object that currently has focus. | UIComponent | |
|
Returns an array of objects that lie under the specified point and are children
(or grandchildren, and so on) of this DisplayObjectContainer instance. | DisplayObjectContainer | |
|
Returns a rectangle that defines the boundary of the display object,
based on the coordinate system defined by the targetCoordinateSpace
parameter, excluding any strokes on shapes. | DisplayObject | |
|
Returns the item in the dataProvider that was used
by the specified Repeater to produce this Repeater, or
null if this Repeater isn't repeated. | UIComponent | |
|
Gets a style property that has been set anywhere in this
component's style lookup chain. | UIComponent | |
|
Converts a Point object from global to content coordinates. | UIComponent | |
|
Converts the point object from the Stage (global) coordinates
to the display object's (local) coordinates. | DisplayObject | |
|
Converts a two-dimensional point from the Stage (global) coordinates to a
three-dimensional display object's (local) coordinates. | DisplayObject | |
|
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 | |
|
Evaluates the bounding box of the display object to see if it overlaps or intersects with the
bounding box of the obj display object. | DisplayObject | |
|
Evaluates the display object to see if it overlaps or intersects with the
point specified by the x and y parameters. | DisplayObject | |
|
Returns a box Matrix which can be passed to the
drawRoundRect() method
as the rot parameter when drawing a horizontal gradient. | UIComponent | |
|
Initializes the internal structure of this component. | UIComponent | |
|
Initializes various properties which keep track of repeated instances
of this component. | UIComponent | |
|
Marks a component so that its updateDisplayList()
method gets called during a later screen update. | UIComponent | |
|
Marks a component so that its commitProperties()
method gets called during a later screen update. | UIComponent | |
|
Marks a component so that its measure()
method gets called during a later screen update. | UIComponent | |
|
Indicates whether an instance of the Object class is in the prototype chain of the object specified
as the parameter. | Object | |
|
Converts a three-dimensional point of the three-dimensional display
object's (local) coordinates to a two-dimensional point in the Stage (global) coordinates. | DisplayObject | |
|
Converts a Point object from local to content coordinates. | UIComponent | |
|
Converts the point object from the display object's (local) coordinates to the
Stage (global) coordinates. | DisplayObject | |
|
Measures the specified HTML text, which may contain HTML tags such
as <font> and <b>,
assuming that it is displayed
in a single-line UITextField using a UITextFormat
determined by the styles of this UIComponent. | UIComponent | |
|
Measures the specified text, assuming that it is displayed
in a single-line UITextField using a UITextFormat
determined by the styles of this UIComponent. | UIComponent | |
|
Moves the component to a specified position within its parent. | UIComponent | |
|
Propagates style changes to the children. | UIComponent | |
Opens the DateChooser control. | DateField | ||
|
Returns true if the chain of owner properties
points from child to this UIComponent. | UIComponent | |
|
Called by Flex when a UIComponent object is added to or removed from a parent. | UIComponent | |
|
Prepares an IFlexDisplayObject for printing. | UIComponent | |
|
Indicates whether the specified property exists and is enumerable. | Object | |
|
Builds or rebuilds the CSS style cache for this component
and, if the recursive parameter is true,
for all descendants of this component as well. | UIComponent | |
|
For each effect event, registers the EffectManager
as one of the event listeners. | UIComponent | |
|
Removes the specified child DisplayObject instance from the child list of the DisplayObjectContainer instance. | DisplayObjectContainer | |
|
Removes a child DisplayObject from the specified index position in the child list of
the DisplayObjectContainer. | DisplayObjectContainer | |
|
Removes a listener from the EventDispatcher object. | EventDispatcher | |
|
Replays the specified event. | UIComponent | |
|
Resolves a child by using the id provided. | UIComponent | |
| [static]
Resumes the background processing of methods
queued by callLater(), after a call to
suspendBackgroundProcessing(). | UIComponent | |
|
Sizes the object. | UIComponent | |
|
Changes the position of an existing child in the display object container. | DisplayObjectContainer | |
|
Sets a layout constraint value, which is the same as
setting the constraint style for this component. | UIComponent | |
|
Set the current state. | UIComponent | |
|
Sets the focus to this component. | UIComponent | |
|
Sets the availability of a dynamic property for loop operations. | Object | |
|
Sets a style property on this component instance. | UIComponent | |
|
Called when the visible property changes. | UIComponent | |
|
Lets the user drag the specified sprite. | Sprite | |
|
Ends the startDrag() method. | Sprite | |
[static]
Parses a String object that contains a date, and returns a Date
object corresponding to the String. | DateField | ||
|
Detects changes to style properties. | UIComponent | |
|
Flex calls the stylesInitialized() method when
the styles for a component are first initialized. | UIComponent | |
| [static]
Blocks the background processing of methods
queued by callLater(),
until resumeBackgroundProcessing() is called. | UIComponent | |
|
Swaps the z-order (front-to-back order) of the two specified child objects. | DisplayObjectContainer | |
|
Swaps the z-order (front-to-back order) of the child objects at the two specified index positions in the
child list. | DisplayObjectContainer | |
|
Returns the string representation of this object, formatted according to locale-specific conventions. | Object | |
| [override]
Returns a string indicating the location of this object
within the hierarchy of DisplayObjects in the Application. | FlexSprite | |
|
Validates the position and size of children and draws other
visuals. | UIComponent | |
|
Validate and update the properties and layout of this object
and redraw it, if necessary. | UIComponent | |
|
Used by layout logic to validate the properties of a component
by calling the commitProperties() method. | UIComponent | |
|
Validates the measured size of the component
If the LayoutManager.invalidateSize() method is called with
this ILayoutManagerClient, then the validateSize() method
is called when it's time to do measurements. | UIComponent | |
|
Handles both the valid and invalid events from a
validator assigned to this component. | UIComponent | |
|
Returns the primitive value of the specified object. | Object | |
|
Returns a box Matrix which can be passed to drawRoundRect()
as the rot parameter when drawing a vertical gradient. | UIComponent | |
|
Checks whether an event listener is registered with this EventDispatcher object or any of
its ancestors for the specified event type. | EventDispatcher | |
| Event | Summary | Defined By | ||
|---|---|---|---|---|
| [broadcast event] Dispatched when the Flash Player or AIR application gains operating system focus and becomes active. | EventDispatcher | ||
| Dispatched when the component is added to a container as a content child by using the addChild() or addChildAt() method. | UIComponent | ||
| Dispatched when a display object is added to the display list. | DisplayObject | ||
| Dispatched when a display object is added to the on stage display list, either directly or through the addition of a sub tree in which the display object is contained. | DisplayObject | ||
| Dispatched when a date is selected or changed, and the DateChooser control closes. | DateField | |||
| Dispatched when the user selects 'Clear' (or 'Delete') from the text context menu. | InteractiveObject | ||
| Dispatched when a user presses and releases the main button of the user's pointing device over the same InteractiveObject. | InteractiveObject | ||
| Dispatched when a date is selected or the user clicks outside the drop-down list. | DateField | |||
| Dispatched when a user gesture triggers the context menu associated with this interactive object in an AIR application. | InteractiveObject | ||
| Dispatched when the user activates the platform specific accelerator key combination for a copy operation or selects 'Copy' from the text context menu. | InteractiveObject | ||
| Dispatched when the component has finished its construction, property processing, measuring, layout, and drawing. | UIComponent | ||
| Dispatched after the view state has changed. | UIComponent | ||
| Dispatched after the currentState property changes, but before the view state changes. | UIComponent | ||
| Dispatched when the user activates the platform specific accelerator key combination for a cut operation or selects 'Cut' from the text context menu. | InteractiveObject | ||
| Dispatched when the data property changes. | DateField | |||
| [broadcast event] Dispatched when the Flash Player or AIR application operating loses system focus and is becoming inactive. | EventDispatcher | ||
| Dispatched when a user presses and releases the main button of a pointing device twice in rapid succession over the same InteractiveObject when that object's doubleClickEnabled flag is set to true. | InteractiveObject | ||
| Dispatched by the drag initiator (the component that is the source of the data being dragged) when the drag operation completes, either when you drop the dragged data onto a drop target or when you end the drag-and-drop operation without performing a drop. | UIComponent | ||
| Dispatched by the drop target when the user releases the mouse over it. | UIComponent | ||
| Dispatched by a component when the user moves the mouse over the component during a drag operation. | UIComponent | ||
| Dispatched by the component when the user drags outside the component, but does not drop the data onto the target. | UIComponent | ||
| Dispatched by a component when the user moves the mouse while over the component during a drag operation. | UIComponent | ||
| Dispatched by the drag initiator when starting a drag operation. | UIComponent | ||
| Dispatched after an effect ends. | UIComponent | ||
| Dispatched just before an effect starts. | UIComponent | ||
| [broadcast event] Dispatched when the playhead is entering a new frame. | DisplayObject | ||
| Dispatched after the component has returned to the root view state. | UIComponent | ||
| [broadcast event] Dispatched when the playhead is exiting the current frame. | DisplayObject | ||
| Dispatched before the component exits from the root view state. | UIComponent | ||
| Dispatched after a display object gains focus. | InteractiveObject | ||
| Dispatched after a display object loses focus. | InteractiveObject | ||
| [broadcast event] Dispatched after the constructors of frame display objects have run but before frame scripts have run. | DisplayObject | ||
| Dispatched when an object's state changes from visible to invisible. | UIComponent | ||
| Dispatched when the component has finished its construction and has all initialization properties set. | UIComponent | ||
| Dispatched when a component is monitored by a Validator and the validation failed. | UIComponent | ||
| Dispatched when the user presses a key. | InteractiveObject | ||
| Dispatched when the user attempts to change focus by using keyboard navigation. | InteractiveObject | ||
| Dispatched when the user releases a key. | InteractiveObject | ||
| Dispatched when a user presses and releases the middle button of the user's pointing device over the same InteractiveObject. | InteractiveObject | ||
| Dispatched when a user presses the middle pointing device button over an InteractiveObject instance. | InteractiveObject | ||
| Dispatched when a user releases the pointing device button over an InteractiveObject instance. | InteractiveObject | ||
| Dispatched when a user presses the pointing device button over an InteractiveObject instance. | InteractiveObject | ||
| Dispatched from a component opened using the PopUpManager when the user clicks outside it. | UIComponent | ||
| Dispatched when the user attempts to change focus by using a pointer device. | InteractiveObject | ||
| Dispatched when a user moves the pointing device while it is over an InteractiveObject. | InteractiveObject | ||
| Dispatched when the user moves a pointing device away from an InteractiveObject instance. | InteractiveObject | ||
| Dispatched when the user moves a pointing device over an InteractiveObject instance. | InteractiveObject | ||
| Dispatched when a user releases the pointing device button over an InteractiveObject instance. | InteractiveObject | ||
| Dispatched when a mouse wheel is spun over an InteractiveObject instance. | InteractiveObject | ||
| Dispatched from a component opened using the PopUpManager when the user scrolls the mouse wheel outside it. | UIComponent | ||
| Dispatched when the object has moved. | UIComponent | ||
| Dispatched by the drag initiator InteractiveObject when the user releases the drag gesture. | InteractiveObject | ||
| Dispatched by the target InteractiveObject when a dragged object is dropped on it and the drop has been accepted with a call to DragManager.acceptDragDrop(). | InteractiveObject | ||
| Dispatched by an InteractiveObject when a drag gesture enters its boundary. | InteractiveObject | ||
| Dispatched by an InteractiveObject when a drag gesture leaves its boundary. | InteractiveObject | ||
| Dispatched by an InteractiveObject continually while a drag gesture remains within its boundary. | InteractiveObject | ||
| Dispatched at the beginning of a drag operation by the InteractiveObject that is specified as the drag initiator in the DragManager.doDrag() call. | InteractiveObject | ||
| Dispatched during a drag operation by the InteractiveObject that is specified as the drag initiator in the DragManager.doDrag() call. | InteractiveObject | ||
| Dispatched when a user selects the field to open the drop-down list. | DateField | |||
| Dispatched when the user activates the platform specific accelerator key combination for a paste operation or selects 'Paste' from the text context menu. | InteractiveObject | ||
| Dispatched at the beginning of the component initialization sequence. | UIComponent | ||
| Dispatched when the component is removed from a container as a content child by using the removeChild() or removeChildAt() method. | UIComponent | ||
| Dispatched when a display object is about to be removed from the display list. | DisplayObject | ||
| Dispatched when a display object is about to be removed from the display list, either directly or through the removal of a sub tree in which the display object is contained. | DisplayObject | ||
| [broadcast event] Dispatched when the display list is about to be updated and rendered. | DisplayObject | ||
| Dispatched when the component is resized. | UIComponent | ||
| Dispatched when a user presses and releases the right button of the user's pointing device over the same InteractiveObject. | InteractiveObject | ||
| Dispatched when a user presses the pointing device button over an InteractiveObject instance. | InteractiveObject | ||
| Dispatched when a user releases the pointing device button over an InteractiveObject instance. | InteractiveObject | ||
| Dispatched when the user moves a pointing device away from an InteractiveObject instance. | InteractiveObject | ||
| Dispatched when the user moves a pointing device over an InteractiveObject instance. | InteractiveObject | ||
| Dispatched when the month changes due to user interaction. | DateField | |||
| Dispatched when the user activates the platform specific accelerator key combination for a select all operation or selects 'Select All' from the text context menu. | InteractiveObject | ||
| Dispatched when an object's state changes from invisible to visible. | UIComponent | ||
| Dispatched when the value of the object's tabChildren flag changes. | InteractiveObject | ||
| Dispatched when the object's tabEnabled flag changes. | InteractiveObject | ||
| Dispatched when the value of the object's tabIndex property changes. | InteractiveObject | ||
| Dispatched when a user enters one or more characters of text. | InteractiveObject | ||
| Dispatched by the component when it is time to create a ToolTip. | UIComponent | ||
| Dispatched by the component when its ToolTip has been hidden and will be discarded soon. | UIComponent | ||
| Dispatched by the component when its ToolTip is about to be hidden. | UIComponent | ||
| Dispatched by the component when its ToolTip is about to be shown. | UIComponent | ||
| Dispatched by the component when its ToolTip has been shown. | UIComponent | ||
| Dispatched by a component whose toolTip property is set, as soon as the user moves the mouse over it. | UIComponent | ||
| Dispatched when an object has had its commitProperties(), measure(), and updateDisplayList() methods called (if needed). | UIComponent | ||
| Dispatched when a component is monitored by a Validator and the validation succeeded. | UIComponent | ||
| Dispatched when values are changed programmatically or by user interaction. | UIComponent | ||
| Style | Description | Defined By | ||
|---|---|---|---|---|
| Type: String CSS Inheritance: no The vertical distance in pixels from the top edge of the content area to the control's baseline position. | UIComponent | ||
borderColor | Type: uint Format: Color CSS Inheritance: no Color of the border. The following controls support this style: Button, CheckBox, ComboBox, MenuBar, NumericStepper, ProgressBar, RadioButton, ScrollBar, Slider, and any components that support the borderStyle style.
The default value depends on the component class;
if not overriden for the class, the default value is 0xB7BABC.
| DateField | ||
| Type: String CSS Inheritance: no The vertical distance in pixels from the lower edge of the component to the lower edge of its content area. | UIComponent | ||
color | Type: uint Format: Color CSS Inheritance: yes Color of text in the component, including the component label. The default value is 0x0B333C. | DateField | ||
cornerRadius | Type: Number Format: Length CSS Inheritance: no Deprecated Since 3.0: Please Use dateChooserStyleName Radius of component corners. The following components support this style: Alert, Button, ComboBox, LinkButton, MenuBar, NumericStepper, Panel, ScrollBar, Tab, TitleWindow, and any component that supports a borderStyle property set to "solid".
The default value depends on the component class;
if not overriden for the class, the default value is 0.
| DateField | ||
dateChooserStyleName | Type: String CSS Inheritance: no Name of the CSS Style declaration to use for the styles for the DateChooser control's drop-down list. By default, the DateChooser control uses the DateField control's inheritable styles. You can use this class selector to set the values of all the style properties
of the DateChooser class, including | DateField | ||
disabledColor | Type: uint Format: Color CSS Inheritance: yes Color of text in the component if it is disabled. The default value is 0xAAB3B3. | DateField | ||
disabledIconColor | Type: uint Format: Color CSS Inheritance: yes The color for the icon in a disabled skin. For example, this style is used by the CheckBoxIcon skin class to draw the check mark for a disabled CheckBox control, by the ComboBoxSkin class to draw the down arrow of a disabled ComboBox control, and by the DateChooserMonthArrowSkin skin class to draw the month arrow for a disabled DateChooser control. The default value depends on the component class; if it is not overridden by the class, the default value is 0x999999.
| DateField | ||
| Type: Class CSS Inheritance: no Name of the class to use as the skin for the background and border when the control is disabled. | ComboBase | ||
| Type: Class CSS Inheritance: no Name of the class to use as the skin for the background and border when the user holds down the mouse button. | ComboBase | ||
| Type: uint Format: Color CSS Inheritance: yes Color of the component highlight when validation fails. | UIComponent | ||
fillAlphas | Type: Array CSS Inheritance: no Deprecated Since 3.0: Please Use nextMonthStyleFilters, prevMonthStyleFilters, dateChooserStyleName Alphas used for the background fill of controls. Use [1, 1] to make the control background opaque. The default value is [ 0.6, 0.4 ]. | DateField | ||
fillColors | Type: Array Format: Color CSS Inheritance: no Deprecated Since 3.0: Please Use nextMonthStyleFilters, prevMonthStyleFilters, dateChooserStyleName Colors used to tint the background of the control. Pass the same color for both values for a flat-looking control. The default value is [ 0xFFFFFF, 0xCCCCCC ]. | DateField | ||
focusAlpha | Type: Number CSS Inheritance: no Specifies the alpha transparency value of the focus skin. The default value is 0.4. | DateField | ||
| Type: String CSS Inheritance: no Blend mode used by the focus rectangle. | UIComponent | ||
focusRoundedCorners | Type: String CSS Inheritance: no Specifies which corners of the focus rectangle should be rounded. This value is a space-separated String that can contain any combination of "tl", "tr", "bl"
and "br".
For example, to specify that the right side corners should be rounded,
but the left side corners should be square, use "tr br".
The cornerRadius style property specifies
the radius of the rounded corners.
The default value depends on the component class; if not overridden for
the class, default value is "tl tr bl br".
| DateField | ||
| Type: Class CSS Inheritance: no Skin used to draw the focus rectangle. | UIComponent | ||
| Type: Number Format: Length CSS Inheritance: no Thickness, in pixels, of the focus rectangle outline. | UIComponent | ||
fontAntiAliasType | Type: String CSS Inheritance: yes Sets the antiAliasType property of internal TextFields. The possible values are
"normal" (flash.text.AntiAliasType.NORMAL)
and "advanced" (flash.text.AntiAliasType.ADVANCED).
The default value is This style has no effect for system fonts. This style applies to all the text in a TextField subcontrol; you cannot apply it to some characters and not others. The default value is "advanced".See also | DateField | ||
fontFamily | Type: String CSS Inheritance: yes Name of the font to use. Unlike in a full CSS implementation, comma-separated lists are not supported. You can use any font family name. If you specify a generic font name, it is converted to an appropriate device font. The default value is "Verdana". | DateField | ||
fontGridFitType | Type: String CSS Inheritance: yes Sets the gridFitType property of internal TextFields that represent text in Flex controls.
The possible values are "none" (flash.text.GridFitType.NONE),
"pixel" (flash.text.GridFitType.PIXEL),
and "subpixel" (flash.text.GridFitType.SUBPIXEL).
This property only applies when you are using an embedded font
and the This style has no effect for system fonts. This style applies to all the text in a TextField subcontrol; you can't apply it to some characters and not others. The default value is "pixel".See also | DateField | ||
fontSharpness | Type: Number CSS Inheritance: yes Sets the sharpness property of internal TextFields that represent text in Flex controls.
This property specifies the sharpness of the glyph edges. The possible values are Numbers
from -400 through 400.
This property only applies when you are using an embedded font
and the This style has no effect for system fonts. This style applies to all the text in a TextField subcontrol; you can't apply it to some characters and not others. The default value is 0.See also | DateField | ||
fontSize | Type: Number Format: Length CSS Inheritance: yes Height of the text, in pixels. The default value is 10 for all controls except the ColorPicker control. For the ColorPicker control, the default value is 11. | DateField | ||
fontStyle | Type: String CSS Inheritance: yes Determines whether the text is italic font. Recognized values are "normal" and "italic".
The default value is "normal". | DateField | ||
fontThickness | Type: Number CSS Inheritance: yes Sets the thickness property of internal TextFields that represent text in Flex controls.
This property specifies the thickness of the glyph edges.
The possible values are Numbers from -200 to 200.
This property only applies when you are using an embedded font
and the This style has no effect on system fonts. This style applies to all the text in a TextField subcontrol; you can't apply it to some characters and not others. The default value is 0.See also | DateField | ||
fontWeight | Type: String CSS Inheritance: yes Determines whether the text is boldface. Recognized values are normal and bold.
The default value for Button controls is bold.
The default value for all other controls is normal.
| DateField | ||
headerColors | Type: Array Format: Color CSS Inheritance: yes Deprecated Since 3.0: Please Use dateChooserStyleName Colors of the band at the top of the DateChooser control. The default value is [ 0xE6EEEE, 0xFFFFFF ].
| DateField | ||
headerStyleName | Type: String CSS Inheritance: no Deprecated Since 3.0: Please Use dateChooserStyleName Name of the style sheet definition to configure the text (month name and year) and appearance of the header area of the control. | DateField | ||
highlightAlphas | Type: Array CSS Inheritance: no Deprecated Since 3.0: Please Use dateChooserStyleName Alpha transparencies used for the highlight fill of controls. The first value specifies the transparency of the top of the highlight and the second value specifies the transparency of the bottom of the highlight. The highlight covers the top half of the skin. The default value is [ 0.3, 0.0 ]. | DateField | ||
| Type: String CSS Inheritance: no The horizontal distance in pixels from the center of the component's content area to the center of the component. | UIComponent | ||
iconColor | Type: uint Format: Color CSS Inheritance: yes The color for the icon in a skin. For example, this style is used by the CheckBoxIcon skin class to draw the check mark for a CheckBox control, by the ComboBoxSkin class to draw the down arrow of the ComboBox control, and by the DateChooserMonthArrowSkin skin class to draw the month arrow for the DateChooser control. The default value depends on the component class; if it is not overridden by the class, the default value is 0x111111.
| DateField | ||
kerning | Type: Boolean CSS Inheritance: yes A Boolean value that indicates whether kerning is enabled ( true) or disabled (false).
Kerning adjusts the gap between certain character pairs
to improve readability, and should be used only when necessary,
such as with headings in large fonts.
Kerning is supported for embedded fonts only.
Certain fonts, such as Verdana, and monospaced fonts,
such as Courier New, do not support kerning.
The default value is false. | DateField | ||
leading | Type: Number Format: Length CSS Inheritance: yes Additional vertical space between lines of text. The default value is 2. The default value for the ComboBox control is 0. | DateField | ||
| Type: String CSS Inheritance: no The horizontal distance in pixels from the left edge of the component's content area to the left edge of the component. | UIComponent | ||
letterSpacing | Type: Number CSS Inheritance: yes The number of additional pixels to appear between each character. A positive value increases the character spacing beyond the normal spacing, while a negative value decreases it. The default value is 0. | DateField | ||
| Type: Class CSS Inheritance: no Name of the class to use as the skin for the background and border when the mouse is over the control. | ComboBase | ||
paddingLeft | Type: Number Format: Length CSS Inheritance: no Number of pixels between the component's left border and the left edge of its content area. The default value is 0. The default value for a Button control is 10. The default value for the ComboBox control is 5. The default value for the Form container is 16. The default value for the Tree control is 2. | DateField | ||
paddingRight | Type: Number Format: Length CSS Inheritance: no Number of pixels between the component's right border and the right edge of its content area. The default value is 0. The default value for a Button control is 10. The default value for the ComboBox control is 5. The default value for the Form container is 16. | DateField | ||
| Type: String CSS Inheritance: no The horizontal distance in pixels from the right edge of the component to the right edge of its content area. | UIComponent | ||
rollOverColor | Type: uint Format: Color CSS Inheritance: yes Color of the highlight area of the date when the user holds the mouse pointer over a date in the DateChooser control. The default value is 0xE3FFD6. | DateField | ||
selectionColor | Type: uint Format: Color CSS Inheritance: yes Color of the highlight area of the currently selected date in the DateChooser control. The default value is 0xCDFFC1. | DateField | ||
skin | Type: Class CSS Inheritance: no Name of the class to use as the default skin for the background and border. For the DateField class, there is no default value. | DateField | ||
textAlign | Type: String CSS Inheritance: yes Alignment of text within a container. Possible values are "left", "right",
or "center".
The default value for most components is | DateField | ||
textDecoration | Type: String CSS Inheritance: yes Determines whether the text is underlined. Possible values are "none" and "underline".
The default value is "none". | DateField | ||
textIndent | Type: Number Format: Length CSS Inheritance: yes Offset of first line of text from the left side of the container, in pixels. The default value is 0. | DateField | ||
| Type: String CSS Inheritance: no The style declaration for the internal TextInput subcomponent that displays the current selection. | ComboBase | ||
| Type: uint Format: Color CSS Inheritance: yes Theme color of a component. | UIComponent | ||
todayColor | Type: uint Format: Color CSS Inheritance: yes Color of the highlight of today's date in the DateChooser control. The default value is 0x2B333.
| DateField | ||
todayStyleName | Type: String CSS Inheritance: no Deprecated Since 3.0: Please Use dateChooserStyleName Name of the style sheet definition to configure the appearance of the current day's numeric text, which is highlighted in the control when the showToday property is true.
Specify a color style property to change the font color.
If omitted, the current day text inherits
the text styles of the control.
| DateField | ||
| Type: String CSS Inheritance: no The vertical distance in pixels from the top edge of the control's content area to the top edge of the component. | UIComponent | ||
| Type: Class CSS Inheritance: no Name of the class to use as the skin for the background and border when the mouse is not over the control. | ComboBase | ||
| Type: String CSS Inheritance: no The vertical distance in pixels from the center of the component's content area to the center of the component. | UIComponent | ||
weekDayStyleName | Type: String CSS Inheritance: no Deprecated Since 3.0: Please Use dateChooserStyleName Name of the style sheet definition to configure the weekday names of the control. If omitted, the weekday names inherit the text styles of the control. | DateField | ||
| data | property |
data:Object
The data property lets you pass a value
to the component when you use it in an item renderer or item editor.
You typically use data binding to bind a field of the data
property to a property of this component.
When you use the control as a drop-in item renderer or drop-in
item editor, Flex automatically writes the current value of the item
to the selectedDate property of this control.
The default value is null.
This property can be used as the source for data binding. When this property is modified, it dispatches the dataChange event.
public function get data():Object public function set data(value:Object):voidSee also
| dayNames | property |
dayNames:ArrayWeekday names for DateChooser control. Setting this property changes the day labels of the DateChooser control. Sunday is the first day (at index 0). The rest of the week names follow in the normal order.
The default value is [ "S", "M", "T", "W", "T", "F", "S" ].
This property can be used as the source for data binding. When this property is modified, it dispatches the dayNamesChanged event.
public function get dayNames():Array public function set dayNames(value:Array):void| disabledDays | property |
disabledDays:Array
Days to disable in a week.
All the dates in a month, for the specified day, are disabled.
This property immediately changes the user interface
of the DateChooser control.
The elements of this Array can have values from 0 (Sunday)
to 6 (Saturday).
For example, a value of [0, 6] disables
Sunday and Saturday.
The default value is [].
This property can be used as the source for data binding. When this property is modified, it dispatches the disabledDaysChanged event.
public function get disabledDays():Array public function set disabledDays(value:Array):void| disabledRanges | property |
disabledRanges:ArrayDisables single and multiple days.
This property accepts an Array of objects as a parameter.
Each object in this Array is a Date object that specifies a
single day to disable; or an object containing one or both
of the rangeStart and rangeEnd properties,
each of whose values is a Date object.
The value of these properties describes the boundaries
of the date range.
If either is omitted, the range is considered
unbounded in that direction.
If you specify only rangeStart,
all the dates after the specified date are disabled,
including the rangeStart date.
If you specify only rangeEnd,
all the dates before the specified date are disabled,
including the rangeEnd date.
To disable a single day, use a single Date object that specifies a date
in the Array. Time values are zeroed out from the Date object if
they are present.
The following example, disables the following dates: January 11 2006, the range January 23 - February 10 2006, and March 1 2006 and all following dates.
disabledRanges="{[new Date(2006,0,11), {rangeStart:
new Date(2006,0,23), rangeEnd: new Date(2006,1,10)},
{rangeStart: new Date(2006,2,1)}]}"
Setting this property immediately changes the appearance of the
DateChooser control, if the disabled dates are included in the
displayedMonth and displayedYear
properties.
The default value is [].
This property can be used as the source for data binding. When this property is modified, it dispatches the disabledRangesChanged event.
public function get disabledRanges():Array public function set disabledRanges(value:Array):void| displayedMonth | property |
displayedMonth:int
Used with the displayedYear property,
the displayedMonth property
specifies the month displayed in the DateChooser control.
Month numbers are zero-based, so January is 0 and December is 11.
Setting this property immediately changes the appearance
of the DateChooser control.
The default value is the month number of today's date.
The default value is the current month.
This property can be used as the source for data binding. When this property is modified, it dispatches the displayedMonthChanged event.
public function get displayedMonth():int public function set displayedMonth(value:int):void| displayedYear | property |
displayedYear:int
Used with the displayedMonth property,
the displayedYear property determines
which year is displayed in the DateChooser control.
Setting this property immediately changes the appearance
of the DateChooser control.
The default value is the current year.
This property can be used as the source for data binding. When this property is modified, it dispatches the displayedYearChanged event.
public function get displayedYear():int public function set displayedYear(value:int):void| dropdown | property |
dropdown:DateChooser [read-only]
Contains a reference to the DateChooser control
contained by the DateField control. The class used
can be set with dropdownFactory as long as
it extends DateChooser.
public function get dropdown():DateChooser| dropdownFactory | property |
dropdownFactory:IFactoryThe IFactory that creates a DateChooser-derived instance to use as the date-chooser The default value is an IFactory for DateChooser
This property can be used as the source for data binding. When this property is modified, it dispatches the dropdownFactoryChanged event.
public function get dropdownFactory():IFactory public function set dropdownFactory(value:IFactory):void| firstDayOfWeek | property |
firstDayOfWeek:ObjectDay 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. Setting this property changes the order of the day columns.
The default value is 0 (Sunday).
public function get firstDayOfWeek():Object public function set firstDayOfWeek(value:Object):void| formatString | property |
formatString:String
The format of the displayed date in the text field.
This property can contain any combination of "MM",
"DD", "YY", "YYYY",
delimiter, and punctuation characters.
The default value is "MM/DD/YYYY".
public function get formatString():String public function set formatString(value:String):void| labelFunction | property |
labelFunction:FunctionFunction used to format the date displayed in the text field of the DateField control. If no function is specified, the default format is used.
The function takes a Date object as an argument, and returns a String in the format to be displayed, as the following example shows:
public function formatDate(currentDate:Date):String {
...
return dateString;
}
If you allow the user to enter a date in the text field
of the DateField control, and you define a formatting function using
the labelFunction property, you should specify a
function to the parseFunction property that converts
the input text string to a Date object for use by the DateField control,
or set the parseFunction property to null.
The default value is null.
This property can be used as the source for data binding. When this property is modified, it dispatches the labelFunctionChanged event.
public function get labelFunction():Function public function set labelFunction(value:Function):voidSee also
| listData | property |
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.
The component can then use the listData property
to initialize the data property of the drop-in
item renderer or drop-in item editor.
You do not set this property in MXML or ActionScript; Flex sets it when the component is used as a drop-in item renderer or drop-in item editor.
The default value is null.
This property can be used as the source for data binding. When this property is modified, it dispatches the dataChange event.
public function get listData():BaseListData public function set listData(value:BaseListData):voidSee also
| maxYear | property |
maxYear:intThe last year selectable in the control.
The default value is 2100.
public function get maxYear():int public function set maxYear(value:int):void| minYear | property |
minYear:intThe first year selectable in the control.
The default value is 1900.
public function get minYear():int public function set minYear(value:int):void| monthNames | property |
monthNames:Array
Names of the months displayed at the top of the control.
The monthSymbol property is appended to the end of
the value specified by the monthNames property,
which is useful in languages such as Japanese.
The default value is [ "January", "February", "March", "April", "May", "June", "July", "August", "September", "October", "November", "December" ].
This property can be used as the source for data binding. When this property is modified, it dispatches the monthNamesChanged event.
public function get monthNames():Array public function set monthNames(value:Array):void| monthSymbol | property |
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.
Some languages, such as Japanese, use an extra
symbol after the month name.
The default value is "".
This property can be used as the source for data binding. When this property is modified, it dispatches the monthSymbolChanged event.
public function get monthSymbol():String public function set monthSymbol(value:String):void| parseFunction | property |
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.
If no function is specified, Flex uses
the default function.
If you set the parseFunction property, it should
typically perform the reverse of the function specified to
the labelFunction property.
The function takes two arguments and returns a Date object to the DateField control, as the following example shows:
public function parseDate(valueString:String, inputFormat:String):Date {
...
return newDate
}
Where the valueString argument contains the text
string entered by the user in the text field, and the inputFormat
argument contains the format of the string. For example, if you
only allow the user to enter a text sting using two characters for
month, day, and year, then pass "MM/DD/YY" to
the inputFormat argument.
This property can be used as the source for data binding. When this property is modified, it dispatches the parseFunctionChanged event.
public function get parseFunction():Function public function set parseFunction(value:Function):voidSee also
| selectableRange | property |
selectableRange:ObjectRange of dates between which dates are selectable. For example, a date between 04-12-2006 and 04-12-2007 is selectable, but dates out of this range are disabled.
This property accepts an Object as a parameter.
The Object contains two properties, rangeStart
and rangeEnd, of type Date.
If you specify only rangeStart,
all the dates after the specified date are enabled.
If you only specify rangeEnd,
all the dates before the specified date are enabled.
To enable only a single day in a DateChooser control,
you can pass a Date object directly. Time values are
zeroed out from the Date object if they are present.
The following example enables only the range January 1, 2006 through June 30, 2006. Months before January and after June do not appear in the DateChooser.
selectableRange="{{rangeStart : new Date(2006,0,1),
rangeEnd : new Date(2006,5,30)}}"
The default value is null.
This property can be used as the source for data binding. When this property is modified, it dispatches the selectableRangeChanged event.
public function get selectableRange():Object public function set selectableRange(value:Object):void| selectedDate | property |
selectedDate:DateDate as selected in the DateChooser control. Accepts a Date object as a parameter. If the incoming Date object has any time values, they are zeroed out.
Selecting the currently selected date in the control deselects it,
sets the selectedDate property to null,
and then dispatches the change event.
The default value is null.
This property can be used as the source for data binding. When this property is modified, it dispatches the selectedDateChanged event.
public function get selectedDate():Date public function set selectedDate(value:Date):void| showToday | property |
showToday:Boolean
If true, specifies that today is highlighted
in the DateChooser control.
Setting this property immediately changes the appearance
of the DateChooser control.
The default value is true.
This property can be used as the source for data binding. When this property is modified, it dispatches the showTodayChanged event.
public function get showToday():Boolean public function set showToday(value:Boolean):void| yearNavigationEnabled | property |
yearNavigationEnabled:Boolean
Enables year navigation. When true
an up and down button appear to the right
of the displayed year. You can use these buttons
to change the current year.
These button appear to the left of the year in locales where year comes
before the month in the date format.
The default value is false.
This property can be used as the source for data binding. When this property is modified, it dispatches the yearNavigationEnabledChanged event.
public function get yearNavigationEnabled():Boolean public function set yearNavigationEnabled(value:Boolean):void| yearSymbol | property |
yearSymbol:StringThis property is appended to the end of the year displayed at the top of the control. Some languages, such as Japanese, add a symbol after the year.
The default value is "".
This property can be used as the source for data binding. When this property is modified, it dispatches the yearSymbolChanged event.
public function get yearSymbol():String public function set yearSymbol(value:String):void| DateField | () | Constructor |
public function DateField()Constructor.
| close | () | method |
public function close():voidCloses the DateChooser control.
| dateToString | () | method |
public static function dateToString(value:Date, outputFormat:String):String
Formats a Date into a String according to the outputFormat argument.
The outputFormat argument contains a pattern in which
the value String is formatted.
It can contain "M","D","Y",
and delimiter and punctuation characters.
Parameters
value:Date — Date value to format.
| |
outputFormat:String — String defining the date format.
|
String — The formatted date as a String.
|
var todaysDate:String = DateField.dateToString(new Date(), "MM/DD/YYYY");
| open | () | method |
public function open():voidOpens the DateChooser control.
| stringToDate | () | method |
public static function stringToDate(valueString:String, inputFormat:String):Date
Parses a String object that contains a date, and returns a Date
object corresponding to the String.
The inputFormat argument contains the pattern
in which the valueString String is formatted.
It can contain "M","D","Y",
and delimiter and punctuation characters.
The function does not check for the validity of the Date object. If the value of the date, month, or year is NaN, this method returns null.
For example:
var dob:Date = DateField.stringToDate("06/30/2005", "MM/DD/YYYY");
Parameters
valueString:String — Date value to format.
| |
inputFormat:String — String defining the date format.
|
Date — The formatted date as a Date object.
|
| change | Event |
mx.events.CalendarLayoutChangeEventmx.events.CalendarLayoutChangeEvent.CHANGEDispatched when a date is selected or changed, and the DateChooser control closes.
TheCalendarLayoutChangeEvent.CHANGE constant
defines the value of the type property of the event
object for a change event.
The properties of the event object have the following values:
| Property | Value |
|---|---|
bubbles | false |
cancelable | false |
currentTarget | The Object that defines the
event listener that handles the event. For example, if you use
myButton.addEventListener() to register an event listener,
myButton is the value of the currentTarget. |
newDate | The date selected in the control. |
target | The Object that dispatched the event;
it is not always the Object listening for the event.
Use the currentTarget property to always access the
Object listening for the event. |
triggerEvent | The event that triggered this change event;
usually a change event. |
| close | Event |
mx.events.DropdownEventmx.events.DropdownEvent.CLOSEDispatched when a date is selected or the user clicks outside the drop-down list.
TheDropdownEvent.CLOSE constant defines the value of the
type property of the event object for a close event.
The properties of the event object have the following values:
| Property | Value |
|---|---|
bubbles | false |
cancelable | false |
currentTarget | The Object that defines the
event listener that handles the event. For example, if you use
myButton.addEventListener() to register an event listener,
myButton is the value of the currentTarget. |
target | The Object that dispatched the event;
it is not always the Object listening for the event.
Use the currentTarget property to always access the
Object listening for the event. |
triggerEvent | A value indicating the type of input action that triggered the event. |
| dataChange | Event |
mx.events.FlexEventmx.events.FlexEvent.DATA_CHANGE
Dispatched when the data property changes.
When you use a component as an item renderer,
the data property contains the data to display.
You can listen for this event and update the component
when the data property changes.
FlexEvent.DATA_CHANGE constant defines the value of the
type property of the event object for a dataChange event.
The properties of the event object have the following values:
| Property | Value |
|---|---|
bubbles | false |
cancelable | false |
currentTarget | The Object that defines the
event listener that handles the event. For example, if you use
myButton.addEventListener() to register an event listener,
myButton is the value of the currentTarget. |
target | The Object that dispatched the event;
it is not always the Object listening for the event.
Use the currentTarget property to always access the
Object listening for the event. |
| open | Event |
mx.events.DropdownEventmx.events.DropdownEvent.OPENDispatched when a user selects the field to open the drop-down list.
TheDropdownEvent.OPEN constant defines the value of the
type property of the event object for a open event.
The properties of the event object have the following values:
| Property | Value |
|---|---|
bubbles | false |
cancelable | false |
currentTarget | The Object that defines the
event listener that handles the event. For example, if you use
myButton.addEventListener() to register an event listener,
myButton is the value of the currentTarget. |
target | The Object that dispatched the event;
it is not always the Object listening for the event.
Use the currentTarget property to always access the
Object listening for the event. |
triggerEvent | A value indicating the type of input action that triggered the event. |
| scroll | Event |
mx.events.DateChooserEventmx.events.DateChooserEvent.SCROLLDispatched when the month changes due to user interaction.
TheDateChooserEvent.SCROLL constant defines the value of the
type property of the event object for a scrollevent.
The properties of the event object have the following values:
| Property | Value |
|---|---|
bubbles | false |
cancelable | false |
currentTarget | The Object that defines the
event listener that handles the event. For example, if you use
myButton.addEventListener() to register an event listener,
myButton is the value of the currentTarget. |
detail | The scroll direction. |
target | The Object that dispatched the event;
it is not always the Object listening for the event.
Use the currentTarget property to always access the
Object listening for the event. |
triggerEvent | The event that triggered this change event;
usually a scroll. |
<?xml version="1.0" encoding="utf-8"?>
<!-- Simple example to demonstrate the DateField control. -->
<mx:Application xmlns:mx="http://www.adobe.com/2006/mxml">
<mx:Script>
<![CDATA[
// Event handler for the DateField change event.
private function dateChanged(date:Date):void {
if (date == null)
selection.text = "Date selected: ";
else
selection.text = "Date selected: " + date.getFullYear().toString() +
'/' + (date.getMonth()+1).toString() + '/' + date.getDate();
}
]]>
</mx:Script>
<mx:DateFormatter id="df"/>
<mx:Panel title="DateField Control Example" height="75%" width="75%"
paddingTop="10" paddingLeft="10" paddingRight="10">
<mx:Label width="100%" color="blue"
text="Select a date in the DateField control. Select it again to clear it."/>
<mx:Label text="Basic DateField:"/>
<mx:DateField id="dateField1" yearNavigationEnabled="true"
change="dateChanged(DateField(event.target).selectedDate)" />
<mx:Label id="selection" color="blue" text="Date selected:" />
<mx:Label text="Disable dates on or before June 1, 2006."/>
<mx:DateField id="dateField2" yearNavigationEnabled="true"
disabledRanges="{[ {rangeEnd: new Date(2006, 5, 1)} ]}" />
<mx:Label color="blue" text="Date selected: {df.format(dateField2.selectedDate)}"/>
</mx:Panel>
</mx:Application>
