| Package | mx.controls |
| Class | public class DateChooser |
| Inheritance | DateChooser  UIComponent FlexSprite Sprite DisplayObjectContainer InteractiveObject DisplayObject EventDispatcher Object |
| Implements | IFocusManagerComponent, IFontContextComponent |
| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
The DateChooser control has the following default characteristics:
| 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 |
Show MXML Syntax
Hide MXML SyntaxThe <mx:DateChooser> tag inherits all of the tag attributes
of its superclass, and adds the following tag attributes:
<mx:DateChooser
Properties
allowDisjointSelection="true|false"
allowMultipleSelection="false|true"
dayNames="["S", "M", "T", "W", "T", "F", "S"]"
disabledDays="No default"
disabledRanges="No default"
displayedMonth="Current month"
displayedYear="Current year"
firstDayOfWeek="0"
maxYear="2100"
minYear="1900"
monthNames="["January", "February", "March", "April", "May",
"June", "July", "August", "September", "October", "November",
"December"]"
monthSymbol=""
selectableRange="No default"
selectedDate="No default"
selectedRanges="No default"
showToday="true|false"
yearNavigationEnabled="false|true"
yearSymbol=""
Styles
backgroundColor="0xFFFFFF"
backgroundAlpha="1.0"
borderColor="0xAAB3B3"
borderThickness="1"
color="0x0B333C"
cornerRadius="4"
disabledColor="0xAAB3B3"
disabledIconColor="0x999999"
fillAlphas="[0.6, 0.4]"
fillColors="[0xFFFFFF, 0xCCCCCC]"
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"
headerColors="[0xE1E5EB, 0xF4F5F7]"
headerStyleName="headerDateText"
highlightAlphas="[0.3, 0.0]"
horizontalGap="8"
iconColor="0x111111"
leading="2"
nextMonthDisabledSkin="DateChooserMonthArrowSkin"
nextMonthDownSkin="DateChooserMonthArrowSkin"
nextMonthOverSkin="DateChooserMonthArrowSkin"
nextMonthSkin = "DateChooserMonthArrowSkin"
nextMonthUpSkin="DateChooserMonthArrowSkin"
nextYearDisabledSkin="DateChooserYearArrowSkin"
nextYearDownSkin="DateChooserYearArrowSkin"
nextYearOverSkin="DateChooserYearArrowSkin"
nextYearSkin = "DateChooserYearArrowSkin"
nextYearUpSkin="DateChooserYearArrowSkin"
prevMonthDisabledSkin="DateChooserMonthArrowSkin"
prevMonthDownSkin="DateChooserMonthArrowSkin"
prevMonthOverSkin="DateChooserMonthArrowSkin"
prevMonthSkin = "DateChooserMonthArrowSkin"
prevMonthUpSkin="DateChooserMonthArrowSkin"
prevYearDisabledSkin="DateChooserYearArrowSkin"
prevYearDownSkin="DateChooserYearArrowSkin"
prevYearOverSkin="DateChooserYearArrowSkin"
prevYearSkin = "DateChooserYearArrowSkin"
prevYearUpSkin="DateChooserYearArrowSkin"
rollOverColor="0xEEFEE6"
rollOverIndicatorSkin="DateChooserIndicator"
selectionColor="0xB7F39B"
selectionIndicatorSkin="DateChooserIndicator"
textAlign="left|right|center"
textDecoration="none|underline"
textIndent="0"
todayColor="0x818181"
todayIndicatorSkin="DateChooserIndicator"
todayStyleName="todayStyle"
verticalGap="6"
weekDayStyleName="weekDayStyle"
Events
change="No default"
scroll="No default"
/>
More examples
Creating a DateChooser or DateField
control
Using the Date class
Specifying header, weekday, and today’s day text styles
Specifying selectable dates
Setting DateChooser and DateField properties in ActionScript
Formatting dates with the DateField control
Using the Date class
Specifying header, weekday, and today’s day text styles
Specifying selectable dates
Setting DateChooser and DateField properties in ActionScript
Formatting dates with the DateField control
Learn more
Related API Elements
Public Properties
| Property | Defined By | ||
|---|---|---|---|
 | accessibilityDescription : String
A convenience accessor for the description property
in this UIComponent's accessibilityProperties object. | UIComponent | |
| accessibilityEnabled : Boolean
A convenience accessor for the silent property
in this UIComponent's accessibilityProperties object. | UIComponent | |
| accessibilityImplementation : AccessibilityImplementation
The current accessibility implementation (AccessibilityImplementation)
for this InteractiveObject instance. | InteractiveObject | |
| accessibilityName : String
A convenience accessor for the name property
in this UIComponent's accessibilityProperties object. | UIComponent | |
| accessibilityProperties : AccessibilityProperties
The current accessibility options for this display object. | DisplayObject | |
| accessibilityShortcut : String
A convenience accessor for the shortcut property
in this UIComponent's accessibilityProperties object. | UIComponent | |
| activeEffects : Array [read-only]
The list of effects that are currently playing on the component,
as an Array of EffectInstance instances. | UIComponent | |
| allowDisjointSelection : Boolean
If true, specifies that non-contiguous(disjoint)
selection is allowed in the DateChooser control. | DateChooser | ||
| allowMultipleSelection : Boolean
If true, specifies that multiple selection
is allowed in the DateChooser control. | DateChooser | ||
| alpha : Number
Indicates the alpha transparency value of the object specified. | DisplayObject | |
| automationDelegate : Object
The delegate object that handles the automation-related functionality. | UIComponent | |
| automationEnabled : Boolean [read-only]
True if this component is enabled for automation, false
otherwise. | UIComponent | |
| automationName : String
Name that can be used as an identifier for this object. | UIComponent | |
| automationOwner : DisplayObjectContainer [read-only]
The owner of this component for automation purposes. | UIComponent | |
| automationParent : DisplayObjectContainer [read-only]
The parent of this component for automation purposes. | 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 | |
| automationVisible : Boolean [read-only]
True if this component is visible for automation, false
otherwise. | UIComponent | |
| baseline : Object
For components, this layout constraint property is a
facade on top of the similarly-named style. | 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 | |
| bottom : Object
For components, this layout constraint property is a
facade on top of the similarly-named style. | UIComponent | |
| buttonMode : Boolean
Specifies the button mode of this sprite. | Sprite | |
| cacheAsBitmap : Boolean
If set to true, Flash runtimes cache an internal bitmap representation of the
display object. | DisplayObject | |
| cacheAsBitmapMatrix : Matrix
If non-null, this Matrix object defines how a display object is rendered when
cacheAsBitmap is set to true. | 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 | |
| dayNames : Array
The weekday names for DateChooser control. | DateChooser | ||
| depth : Number
Determines the order in which items inside of containers
are rendered. | UIComponent | |
| descriptor : UIComponentDescriptor
Reference to the UIComponentDescriptor, if any, that was used
by the createComponentFromDescriptor() method to create this
UIComponent instance. | UIComponent | |
| designLayer : DesignLayer
Specifies the optional DesignLayer instance associated with this visual
element. | UIComponent | |
| disabledDays : Array
The days to disable in a week. | DateChooser | ||
| disabledRanges : Array
Disables single and multiple days. | DateChooser | ||
| displayedMonth : int
Used together with the displayedYear property,
the displayedMonth property specifies the month
displayed in the DateChooser control. | DateChooser | ||
| displayedYear : int
Used together with the displayedMonth property,
the displayedYear property specifies the year
displayed in the DateChooser control. | DateChooser | ||
| 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 | |
| dropTarget : DisplayObject [read-only]
Specifies the display object over which the sprite is being dragged, or on
which the sprite was dropped. | Sprite | |
| enabled : Boolean
Whether the component can accept user interaction. | UIComponent | |
| errorString : String
The text that 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
Number representing the day of the week to display in the
first column of the DateChooser control. | DateChooser | ||
| 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 | |
| graphics : Graphics [read-only]
Specifies the Graphics object that belongs to this sprite where vector
drawing commands can occur. | Sprite | |
| hasFocusableChildren : Boolean
A flag that indicates whether child objects can receive focus. | UIComponent | |
| hasLayoutMatrix3D : Boolean [read-only]
Contains true if the element has 3D Matrix. | UIComponent | |
| 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 | |
| horizontalCenter : Object
For components, this layout constraint property is a
facade on top of the similarly-named style. | UIComponent | |
| id : String
ID of the component. | UIComponent | |
| 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 | |
| is3D : Boolean [read-only]
Contains true when the element is in 3D. | UIComponent | |
| isDocument : Boolean [read-only]
Contains true if this UIComponent instance is a document object. | UIComponent | |
| isPopUp : Boolean
Set to true by the PopUpManager to indicate
that component has been popped up. | UIComponent | |
| layoutMatrix3D : Matrix3D [write-only]
The transform matrix that is used to calculate a component's layout
relative to its siblings. | UIComponent | |
| left : Object
For components, this layout constraint property is a
facade on top of the similarly-named style. | UIComponent | |
| loaderInfo : LoaderInfo [read-only]
Returns a LoaderInfo object containing information about loading the file
to which this display object belongs. | DisplayObject | |
| maintainProjectionCenter : Boolean
When true, the component keeps its projection matrix centered on the
middle of its bounding box. | UIComponent | |
| 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. | DateChooser | ||
| 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. | DateChooser | ||
| moduleFactory : IFlexModuleFactory
A module factory is used as context for using embedded fonts and for
finding the style manager that controls the styles for this
component. | UIComponent | |
| monthNames : Array
Names of the months displayed at the top of the DateChooser control. | DateChooser | ||
| 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 DateChooser control. | DateChooser | ||
| mouseChildren : Boolean
Determines whether or not the children of the object are mouse, or user input device, enabled. | DisplayObjectContainer | |
| mouseEnabled : Boolean
Specifies whether this object receives mouse, or other user input, messages. | InteractiveObject | |
| mouseFocusEnabled : Boolean
Whether you can receive focus when clicked on. | UIComponent | |
| mouseX : Number [read-only]
Indicates the x coordinate of the mouse or user input device position, in pixels. | DisplayObject | |
| mouseY : Number [read-only]
Indicates the y coordinate of the mouse or user input device position, in pixels. | DisplayObject | |
| name : String
Indicates the instance name of the DisplayObject. | DisplayObject | |
| needsSoftKeyboard : Boolean
Specifies whether a virtual keyboard (an on-screen, software keyboard) should display
when this InteractiveObject instance receives focus. | InteractiveObject | |
| 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 IVisualElement object. | 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 | |
| percentHeight : Number
Specifies the height of a component as a percentage
of its parent's size. | UIComponent | |
| percentWidth : Number
Specifies the width of a component as a percentage
of its parent's size. | UIComponent | |
| postLayoutTransformOffsets : mx.geom:TransformOffsets
Defines a set of adjustments that can be applied to the object's
transform in a way that is invisible to its parent's layout. | 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 | |
| right : Object
For components, this layout constraint property is a
facade on top of the similarly-named style. | UIComponent | |
| 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 [override]
Indicates the rotation of the DisplayObject instance, in degrees, from its original orientation. | UIComponent | |
| rotationX : Number [override]
Indicates the x-axis rotation of the DisplayObject instance, in degrees, from its original orientation
relative to the 3D parent container. | UIComponent | |
| rotationY : Number [override]
Indicates the y-axis rotation of the DisplayObject instance, in degrees, from its original orientation
relative to the 3D parent container. | UIComponent | |
| rotationZ : Number [override]
Indicates the z-axis rotation of the DisplayObject instance, in degrees, from its original orientation relative to the 3D parent container. | UIComponent | |
| 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 [override]
Number that specifies the scaling factor along the z axis. | 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. | DateChooser | ||
| selectedDate : Date
Date selected in the DateChooser control. | DateChooser | ||
| selectedRanges : Array
Selected date ranges. | DateChooser | ||
| 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. | DateChooser | ||
| softKeyboardInputAreaOfInterest : Rectangle
Defines the area that should remain on-screen when a soft keyboard is displayed. | InteractiveObject | |
| 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 | |
| styleManager : IStyleManager2 [read-only]
Returns the StyleManager instance used by this component. | UIComponent | |
| styleName : Object
The class style used by this component. | UIComponent | |
| styleParent : IAdvancedStyleClient
A component's parent is used to evaluate descendant selectors. | 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 | |
| tabFocusEnabled : Boolean
A flag that indicates whether this object can receive focus
via the TAB key
This is similar to the tabEnabled property
used by the Flash Player.
This is usually true for components that
handle keyboard input, but some components in controlbars
have them set to false because they should not steal
focus from another component like an editor. | UIComponent | |
| tabIndex : int
Specifies the tab ordering of objects in a SWF file. | InteractiveObject | |
| textSnapshot : flash.text:TextSnapshot [read-only]
Returns a TextSnapshot object for this DisplayObjectContainer instance. | DisplayObjectContainer | |
| toolTip : String
Text to display in the ToolTip. | UIComponent | |
| top : Object
For components, this layout constraint property is a
facade on top of the similarly-named style. | UIComponent | |
| transform : flash.geom:Transform [override]
An object with properties pertaining to a display object's matrix, color transform,
and pixel bounds. | UIComponent | |
| transformX : Number
Sets the x coordinate for the transform center of the component. | UIComponent | |
| transformY : Number
Sets the y coordinate for the transform center of the component. | UIComponent | |
| transformZ : Number
Sets the z coordinate for the transform center of the component. | UIComponent | |
| 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 pointer 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 | |
| verticalCenter : Object
For components, this layout constraint property is a
facade on top of the similarly-named style. | UIComponent | |
| visible : Boolean [override]
Whether or not the display object is visible. | 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. | DateChooser | ||
| yearSymbol : String
This property is appended to the end of the year
displayed at the top of the DateChooser control. | DateChooser | ||
| z : Number [override]
Indicates the z coordinate position along the z-axis of the DisplayObject
instance relative to the 3D parent container. | UIComponent | |
Protected Properties
| Property | Defined By | ||
|---|---|---|---|
| calendarLayoutStyleFilters : Object [read-only]
The set of styles to pass from the DateChooser to the calendar layout. | DateChooser | ||
| currentCSSState : String [read-only]
The state to be used when matching CSS pseudo-selectors. | UIComponent | |
| hasComplexLayoutMatrix : Boolean [read-only]
Returns true if the UIComponent has any non-translation (x,y) transform properties. | UIComponent | |
| nextMonthStyleFilters : Object [read-only]
The set of styles to pass from the DateChooser to the next month button. | DateChooser | ||
| nextYearStyleFilters : Object [read-only]
The set of styles to pass from the DateChooser to the next year button. | DateChooser | ||
| prevMonthStyleFilters : Object [read-only]
The set of styles to pass from the DateChooser to the previous month button. | DateChooser | ||
| prevYearStyleFilters : Object [read-only]
The set of styles to pass from the DateChooser to the previous year button. | DateChooser | ||
| resourceManager : IResourceManager [read-only]
A reference to the object which manages
all of the application's localized resources. | UIComponent | |
| unscaledHeight : Number [read-only]
A convenience method for determining the unscaled height
of the component. | UIComponent | |
| unscaledWidth : Number [read-only]
A convenience method for determining the unscaled width
of the component
All of a component's drawing and child layout should be done
within a bounding rectangle of this width, which is also passed
as an argument to updateDisplayList(). | UIComponent | |
Public Methods
| Method | Defined By | ||
|---|---|---|---|
Constructor. | DateChooser | ||
|
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 | |
|
Adds a non-visual style client to this component instance. | UIComponent | |
|
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 | |
|
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 | |
|
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 | |
|
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
Programmatically 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 all the bindings for which the UIComponent object is the destination. | UIComponent | |
|
Called after printing is complete. | UIComponent | |
|
Provides the automation object at the specified index. | UIComponent | |
|
Provides the automation object list . | UIComponent | |
|
Returns a rectangle that defines the area of the display object relative to the coordinate system
of the targetCoordinateSpace object. | DisplayObject | |
|
Returns the x coordinate of the element's bounds at the specified element size. | UIComponent | |
|
Returns the y coordinate of the element's bounds at the specified element size. | UIComponent | |
|
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 the element's layout height. | UIComponent | |
|
Returns the element's layout width. | UIComponent | |
|
Returns the x coordinate that the element uses to draw on screen. | UIComponent | |
|
Returns the y coordinate that the element uses to draw on screen. | UIComponent | |
|
Returns the transform matrix that is used to calculate the component's
layout relative to its siblings. | UIComponent | |
|
Returns the layout transform Matrix3D for this element. | UIComponent | |
|
Returns the element's maximum height. | UIComponent | |
|
Returns the element's maximum width. | UIComponent | |
|
Returns the element's minimum height. | UIComponent | |
|
Returns the element's minimum width. | 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 the element's preferred height. | UIComponent | |
|
Returns the element's preferred width. | UIComponent | |
|
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 | |
|
Returns true if currentCSSState is not null. | UIComponent | |
|
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 | |
|
Determines whether the specified state has been defined on this
UIComponent. | UIComponent | |
|
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 | |
|
Called by a component's items to indicate that their depth
property has changed. | UIComponent | |
|
An element must call this method when its layoutDirection changes or
when its parent's layoutDirection changes. | 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 | |
|
Returns true if cssState matches currentCSSState. | UIComponent | |
|
Determines whether this instance is the same as, or is a subclass of,
the given type. | UIComponent | |
|
Measures the specified HTML text, which can 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 (or UIFTETextField) 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 | |
|
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 one or more child DisplayObject instances from the DisplayObjectContainer instance. | DisplayObjectContainer | |
|
Removes a listener from the EventDispatcher object. | EventDispatcher | |
|
Removes a non-visual style client from this component instance. | UIComponent | |
|
Replays the specified event. | UIComponent | |
|
Raises a virtual keyboard. | InteractiveObject | |
|
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 coordinates that the element uses to draw on screen. | UIComponent | |
|
Sets the layout size of the element. | UIComponent | |
|
Sets the transform Matrix that is used to calculate the component's layout
size and position relative to its siblings. | UIComponent | |
|
Sets the transform Matrix3D that is used to calculate the component's layout
size and position relative to its siblings. | 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 | |
|
Lets the user drag the specified sprite on a touch-enabled device. | Sprite | |
|
Ends the startDrag() method. | Sprite | |
|
Ends the startTouchDrag() method, for use with touch-enabled devices. | Sprite | |
|
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 | |
| transformAround(transformCenter:Vector3D, scale:Vector3D = null, rotation:Vector3D = null, translation:Vector3D = null, postLayoutScale:Vector3D = null, postLayoutRotation:Vector3D = null, postLayoutTranslation:Vector3D = null, invalidateLayout:Boolean = true):void
A utility method to update the rotation, scale, and translation of the
transform while keeping a particular point, specified in the component's
own coordinate space, fixed in the parent's coordinate space. | UIComponent | |
|
A utility method to transform a point specified in the local
coordinates of this object to its location in the object's parent's
coordinates. | UIComponent | |
|
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 | |
Protected Methods
Events
| 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(), addChildAt(), addElement(), or addElementAt() 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. | DateChooser | |||
| 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 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 | ||
| [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 | ||
| Dispatched after an effect is stopped, which happens only by a call to stop() on the effect. | UIComponent | ||
| [broadcast event] Dispatched when the playhead is entering a new frame. | DisplayObject | ||
| Dispatched after the component has entered a view state. | UIComponent | ||
| [broadcast event] Dispatched when the playhead is exiting the current frame. | DisplayObject | ||
| Dispatched just before the component exits a 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 the user moves a point of contact over the InteractiveObject instance on a touch-enabled device (such as moving a finger from left to right over a display object on a mobile phone or tablet with a touch screen). | InteractiveObject | ||
| Dispatched when the user creates a point of contact with an InteractiveObject instance, then taps on a touch-enabled device (such as placing several fingers over a display object to open a menu and then taps one finger to select a menu item on a mobile phone or tablet with a touch screen). | InteractiveObject | ||
| Dispatched when the user performs a rotation gesture at a point of contact with an InteractiveObject instance (such as touching two fingers and rotating them over a display object on a mobile phone or tablet with a touch screen). | InteractiveObject | ||
| Dispatched when the user performs a swipe gesture at a point of contact with an InteractiveObject instance (such as touching three fingers to a screen and then moving them in parallel over a display object on a mobile phone or tablet with a touch screen). | InteractiveObject | ||
| Dispatched when the user presses two points of contact over the same InteractiveObject instance on a touch-enabled device (such as presses and releases two fingers over a display object on a mobile phone or tablet with a touch screen). | InteractiveObject | ||
| Dispatched when the user performs a zoom gesture at a point of contact with an InteractiveObject instance (such as touching two fingers to a screen and then quickly spreading the fingers apart over a display object on a mobile phone or tablet with a touch screen). | InteractiveObject | ||
| Dispatched when an object's state changes from visible to invisible. | UIComponent | ||
| This event is dispatched to any client app that supports inline input with an IME | InteractiveObject | ||
| 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 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 user lowers an active stylus past the proximity detection threshold of the screen. | InteractiveObject | ||
| Dispatched when the user lifts an active stylus above the proximity detection threshold of the screen. | InteractiveObject | ||
| Dispatched when the user moves an active stylus over the screen while remaining within the proximity detection threshold. | InteractiveObject | ||
| Dispatched when the user moves an active stylus away from this InteractiveObject while remaining within the proximity detection threshold of the screen. | InteractiveObject | ||
| Dispatched when the user moves an active stylus directly above this InteractiveObject while remaining within the proximity detection threshold of the screen. | InteractiveObject | ||
| Dispatched when the user moves an active stylus away from this InteractiveObject and any of its children while remaining within the proximity detection threshold of the screen. | InteractiveObject | ||
| Dispatched when the user moves an active stylus over this InteractiveObject from outside the object's tree of descendents in the display list (while remaining within the proximity detection threshold of the screen). | InteractiveObject | ||
| Dispatched when the component is removed from a container as a content child by using the removeChild(), removeChildAt(), removeElement(), or removeElementAt() 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. | DateChooser | |||
| 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 immediately after the soft keyboard is raised. | InteractiveObject | ||
| Dispatched immediately before the soft keyboard is raised. | InteractiveObject | ||
| Dispatched immediately after the soft keyboard is lowered. | InteractiveObject | ||
| Dispatched after the component has entered a new state and any state transition animation to that state has finished playing. | UIComponent | ||
| Dispatched when a component interrupts a transition to its current state in order to switch to a new state. | 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 is to 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 the user first contacts a touch-enabled device (such as touches a finger to a mobile phone or tablet with a touch screen). | InteractiveObject | ||
| Dispatched when the user removes contact with a touch-enabled device (such as lifts a finger off a mobile phone or tablet with a touch screen). | InteractiveObject | ||
| A non-cancellable event, dispatched by a component when it is done responding to a touch interaction user gesture. | UIComponent | ||
| A non-cancellable event, dispatched by a component when it starts responding to a touch interaction user gesture. | UIComponent | ||
| A cancellable event, dispatched by a component in an attempt to respond to a touch interaction user gesture. | UIComponent | ||
| Dispatched when the user moves the point of contact with a touch-enabled device (such as drags a finger across a mobile phone or tablet with a touch screen). | InteractiveObject | ||
| Dispatched when the user moves the point of contact away from InteractiveObject instance on a touch-enabled device (such as drags a finger from one display object to another on a mobile phone or tablet with a touch screen). | InteractiveObject | ||
| Dispatched when the user moves the point of contact over an InteractiveObject instance on a touch-enabled device (such as drags a finger from a point outside a display object to a point over a display object on a mobile phone or tablet with a touch screen). | InteractiveObject | ||
| Dispatched when the user moves the point of contact away from an InteractiveObject instance on a touch-enabled device (such as drags a finger from over a display object to a point outside the display object on a mobile phone or tablet with a touch screen). | InteractiveObject | ||
| Dispatched when the user moves the point of contact over an InteractiveObject instance on a touch-enabled device (such as drags a finger from a point outside a display object to a point over a display object on a mobile phone or tablet with a touch screen). | InteractiveObject | ||
| Dispatched when the user lifts the point of contact over the same InteractiveObject instance on which the contact was initiated on a touch-enabled device (such as presses and releases a finger from a single point over a display object on a mobile phone or tablet with a touch screen). | InteractiveObject | ||
| 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 | ||
Styles
Styles are either common or associated with a specific theme. If the style is common, it can be used with any theme. If a style is associated with a specific theme, it can only be used if your application uses that theme.
Common Styles
| 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 | ||
| Type: String CSS Inheritance: no The vertical distance, in pixels, from the bottom edge of the component to the bottom edge of its parent container's content area. | UIComponent | ||
color | Type: uint Format: Color CSS Inheritance: yes Color of text in the component, including the component label. The default value for the Halo theme is 0x0B333C.
The default value for the Spark theme is 0x000000.
| DateChooser | ||
direction | Type: String CSS Inheritance: yes The directionality of the text displayed by the component. The allowed values are FTE and TLF use this value in their bidirectional text layout algorithm, which maps Unicode character order to glyph order. Note: This style only applies when an MX component
specifies UIFTETextField as its The "ltr". | DateChooser | ||
disabledColor | Type: uint Format: Color CSS Inheritance: yes Color of text in the component if it is disabled. The default value is 0xAAB3B3. | DateChooser | ||
| Type: uint Format: Color CSS Inheritance: yes Color of the component highlight when validation fails. | UIComponent | ||
focusAlpha | Type: Number CSS Inheritance: no Specifies the alpha transparency value of the focus skin. The default value for the Halo theme is 0.4.
The default value for the Spark theme is 0.55.
| DateChooser | ||
| 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".
| DateChooser | ||
| 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".Related API Elements | DateChooser | ||
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 font for the Halo theme is "Verdana".
The default font for the Spark theme is "Arial".
| DateChooser | ||
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".Related API Elements | DateChooser | ||
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.Related API Elements | DateChooser | ||
fontSize | Type: Number Format: Length CSS Inheritance: yes Height of the text, in pixels. In the Halo theme, the default value is 10 for all controls except the ColorPicker control. For the Halo themed ColorPicker control, the default value is 11. In the Spark theme, the default value is 12 for all controls except the ColorPicker control. For the Spark themed ColorPicker control, the default value is 11. | DateChooser | ||
fontStyle | Type: String CSS Inheritance: yes Determines whether the text is italic font. Recognized values are "normal" and "italic".
The default value is "normal". | DateChooser | ||
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.Related API Elements | DateChooser | ||
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.
| DateChooser | ||
headerStyleName | Type: String CSS Inheritance: no Name of the style sheet definition to configure the text (month name and year) and appearance of the header area of the control. | DateChooser | ||
| 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 | ||
horizontalGap | Type: Number Format: Length CSS Inheritance: no Number of pixels between children in the horizontal direction. The default value depends on the component class; if not overridden for the class, the default value is 8. | DateChooser | ||
| Type: String CSS Inheritance: yes The primary interaction mode for this component. | UIComponent | ||
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. | DateChooser | ||
| Type: String CSS Inheritance: yes Specifies the desired layout direction of a component. | UIComponent | ||
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. | DateChooser | ||
| Type: String CSS Inheritance: no The horizontal distance, in pixels, from the left edge of the component to the left edge of its parent container's content area. | 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. | DateChooser | ||
locale | Type: String CSS Inheritance: yes The locale of the text displayed by this component. FTE and TLF use this locale to map Unicode characters to font glyphs and to find fallback fonts. Note: This style only applies when an MX component
specifies UIFTETextField as its "en". | DateChooser | ||
nextMonthDisabledSkin | Type: Class CSS Inheritance: no Name of the class to use as the skin for the next month arrow when the arrow is disabled. The default value for the Halo theme is mx.skins.halo.DateChooserMonthArrowSkin.
The default value for the Spark theme is mx.skins.spark.DateChooserNextMonthSkin.
| DateChooser | ||
nextMonthDownSkin | Type: Class CSS Inheritance: no Name of the class to use as the skin for the next month arrow when the user presses the mouse button down on the arrow. The default value for the Halo theme is mx.skins.halo.DateChooserMonthArrowSkin.
The default value for the Spark theme is mx.skins.spark.DateChooserNextMonthSkin.
| DateChooser | ||
nextMonthOverSkin | Type: Class CSS Inheritance: no Name of the class to use as the skin for the next month arrow when the user moves the mouse pointer over the arrow. The default value for the Halo theme is mx.skins.halo.DateChooserMonthArrowSkin.
The default value for the Spark theme is mx.skins.spark.DateChooserNextMonthSkin.
| DateChooser | ||
nextMonthSkin | Type: Class CSS Inheritance: no Name of the class to use as the skin for the next month arrow. The default value for the Halo theme is mx.skins.halo.DateChooserMonthArrowSkin.
The default value for the Spark theme is mx.skins.spark.DateChooserNextMonthSkin.
| DateChooser | ||
nextMonthUpSkin | Type: Class CSS Inheritance: no Name of the class to use as the skin for the next month arrow when the mouse pointer is not over the arrow. The default value for the Halo theme is mx.skins.halo.DateChooserMonthArrowSkin.
The default value for the Spark theme is mx.skins.spark.DateChooserNextMonthSkin.
| DateChooser | ||
nextYearDisabledSkin | Type: Class CSS Inheritance: no Name of the class to use as the skin for the next year arrow when the arrow is disabled. The default value for the Halo theme is mx.skins.halo.DateChooserYearArrowSkin.
The default value for the Spark theme is mx.skins.spark.DateChooserNextYearSkin.
| DateChooser | ||
nextYearDownSkin | Type: Class CSS Inheritance: no Name of the class to use as the skin for the next Year arrow when the user presses the mouse button down on the arrow. The default value for the Halo theme is mx.skins.halo.DateChooserYearArrowSkin.
The default value for the Spark theme is mx.skins.spark.DateChooserNextYearSkin.
| DateChooser | ||
nextYearOverSkin | Type: Class CSS Inheritance: no Name of the class to use as the skin for the next Year arrow when the user moves the mouse pointer over the arrow. The default value for the Halo theme is mx.skins.halo.DateChooserYearArrowSkin.
The default value for the Spark theme is mx.skins.spark.DateChooserNextYearSkin.
| DateChooser | ||
nextYearSkin | Type: Class CSS Inheritance: no Name of the class to use as the skin for the next year arrow. The default value for the Halo theme is mx.skins.halo.DateChooserYearArrowSkin.
The default value for the Spark theme is mx.skins.spark.DateChooserNextYearSkin.
| DateChooser | ||
nextYearUpSkin | Type: Class CSS Inheritance: no Name of the class to use as the skin for the next Year arrow when the mouse pointer is not over the arrow. The default value for the Halo theme is mx.skins.halo.DateChooserYearArrowSkin.
The default value for the Spark theme is mx.skins.spark.DateChooserNextYearSkin.
| DateChooser | ||
prevMonthDisabledSkin | Type: Class CSS Inheritance: no Name of the class to use as the skin for the previous month arrow when the arrow is disabled. The default value for the Halo theme is mx.skins.halo.DateChooserMonthArrowSkin.
The default value for the Spark theme is mx.skins.spark.DateChooserPrevMonthSkin.
| DateChooser | ||
prevMonthDownSkin | Type: Class CSS Inheritance: no Name of the class to use as the skin for the previous month arrow when the user presses the mouse button down over the arrow. The default value for the Halo theme is mx.skins.halo.DateChooserMonthArrowSkin.
The default value for the Spark theme is mx.skins.spark.DateChooserPrevMonthSkin.
| DateChooser | ||
prevMonthOverSkin | Type: Class CSS Inheritance: no Name of the class to use as the skin for the previous month arrow when the user holds the mouse pointer over the arrow. The default value for the Halo theme is mx.skins.halo.DateChooserMonthArrowSkin.
The default value for the Spark theme is mx.skins.spark.DateChooserPrevMonthSkin.
| DateChooser | ||
prevMonthSkin | Type: Class CSS Inheritance: no Name of the class to use as the skin for the previous month arrow. The default value for the Halo theme is mx.skins.halo.DateChooserMonthArrowSkin.
The default value for the Spark theme is mx.skins.spark.DateChooserPrevMonthSkin.
| DateChooser | ||
prevMonthUpSkin | Type: Class CSS Inheritance: no Name of the class to use as the skin for the previous month arrow when the mouse pointer is not over the arrow. The default value for the Halo theme is mx.skins.halo.DateChooserMonthArrowSkin.
The default value for the Spark theme is mx.skins.spark.DateChooserPrevMonthSkin.
| DateChooser | ||
prevYearDisabledSkin | Type: Class CSS Inheritance: no Name of the class to use as the skin for the previous Year arrow when the arrow is disabled. The default value for the Halo theme is mx.skins.halo.DateChooserYearArrowSkin.
The default value for the Spark theme is mx.skins.spark.DateChooserPrevYearSkin.
| DateChooser | ||
prevYearDownSkin | Type: Class CSS Inheritance: no Name of the class to use as the skin for the previous Year arrow when the user presses the mouse button down over the arrow. The default value for the Halo theme is mx.skins.halo.DateChooserYearArrowSkin.
The default value for the Spark theme is mx.skins.spark.DateChooserPrevYearSkin.
| DateChooser | ||
prevYearOverSkin | Type: Class CSS Inheritance: no Name of the class to use as the skin for the previous Year arrow when the user holds the mouse pointer over the arrow. The default value for the Halo theme is mx.skins.halo.DateChooserYearArrowSkin.
The default value for the Spark theme is mx.skins.spark.DateChooserPrevYearSkin.
| DateChooser | ||
prevYearSkin | Type: Class CSS Inheritance: no Name of the class to use as the skin for the previous year arrow. The default value for the Halo theme is mx.skins.halo.DateChooserYearArrowSkin.
The default value for the Spark theme is mx.skins.spark.DateChooserPrevYearSkin.
| DateChooser | ||
prevYearUpSkin | Type: Class CSS Inheritance: no Name of the class to use as the skin for the previous Year arrow when the mouse button not over the arrow. The default value for the Halo theme is mx.skins.halo.DateChooserYearArrowSkin.
The default value for the Spark theme is mx.skins.spark.DateChooserPrevYearSkin.
| DateChooser | ||
| Type: String CSS Inheritance: no The horizontal distance, in pixels, from the right edge of the component to the right edge of its parent container's 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 for the Halo theme is 0xB2E1FF.
The default value for the Spark theme is 0xCEDBEF.
| DateChooser | ||
rollOverIndicatorSkin | Type: Class CSS Inheritance: no Name of the class to use as the skin for the highlight area of the date when the user holds the mouse pointer over a date in the DateChooser control. The default value for the Halo theme is mx.skins.halo.DateChooserIndicator.
The default value for the Spark theme is mx.skins.spark.DateChooserRollOverIndicatorSkin.
| DateChooser | ||
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 for the Halo theme is 0x7FCEFF.
The default value for the Spark theme is 0xA8C6EE.
| DateChooser | ||
selectionIndicatorSkin | Type: Class CSS Inheritance: no Name of the class to use as the skin for the highlight area of the currently selected date in the DateChooser control. The default value for the Halo theme is mx.skins.halo.DateChooserIndicator.
The default value for the Spark theme is mx.skins.spark.DateChooserSelectionIndicatorSkin.
| DateChooser | ||
| Type: Boolean CSS Inheritance: yes Show the error border or skin when this component is invalid | UIComponent | ||
| Type: Boolean CSS Inheritance: yes Show the error tip when this component is invalid and the user rolls over it | UIComponent | ||
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 | DateChooser | ||
textDecoration | Type: String CSS Inheritance: yes Determines whether the text is underlined. Possible values are "none" and "underline".
The default value is "none". | DateChooser | ||
textFieldClass | Type: Class CSS Inheritance: no The class implementing IUITextField that is used by this component to render text. It can be set to either the mx.core.UITextField class (to use the classic TextField class built into Flash Player) or the mx.core.UIFTETextField class (to use the Text Layout Framework to get improved text rendering, including bidirectional layout). The default value is mx.core.UITextField. | DateChooser | ||
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. | DateChooser | ||
todayIndicatorSkin | Type: Class CSS Inheritance: no Name of the class to use as the skin for the highlight area of today's date in the DateChooser control. The default value for the Halo theme is mx.skins.halo.DateChooserIndicator.
The default value for the Spark theme is mx.skins.spark.DateChooserTodayIndicatorSkin.
| DateChooser | ||
todayStyleName | Type: String CSS Inheritance: no 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 to change the font color.
If omitted, the current day text inherits
the text styles of the control.
| DateChooser | ||
| Type: String CSS Inheritance: no The vertical distance, in pixels, from the top edge of the component to the top edge of its parent container's content area. | UIComponent | ||
| 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 | ||
verticalGap | Type: Number Format: Length CSS Inheritance: no Number of pixels between children in the vertical direction. The default value depends on the component class; if not overridden for the class, the default value is 6. | DateChooser | ||
weekDayStyleName | Type: String CSS Inheritance: no 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. | DateChooser | ||
Spark Theme Styles
| Style | Description | Defined By | ||
|---|---|---|---|---|
borderAlpha | Type: Number CSS Inheritance: no Theme: spark Alpha of the border. The default value is 1. | DateChooser | ||
borderColor | Type: uint Format: Color CSS Inheritance: no Theme: halo, spark 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 overridden for the class, the default value is 0xB7BABC
for the Halo theme and 0x696969 for the Spark theme.
| DateChooser | ||
borderVisible | Type: Boolean CSS Inheritance: no Theme: spark Visibility of the border. The default value is 1. | DateChooser | ||
| Type: uint Format: Color CSS Inheritance: yes Theme: spark The main color for a component. | UIComponent | ||
contentBackgroundAlpha | Type: Number CSS Inheritance: yes Theme: spark The alpha of the content background for this component. | DateChooser | ||
contentBackgroundColor | Type: uint Format: Color CSS Inheritance: yes Theme: spark Color of the content area of the component. The default value is 0xFFFFFF. | DateChooser | ||
cornerRadius | Type: Number Format: Length CSS Inheritance: no Theme: halo, spark Radius of corners of the component. The default value for the Halo theme is 4.
The default value for the Spark theme is 0.
| DateChooser | ||
focusColor | Type: uint Format: Color CSS Inheritance: yes Theme: spark Color of focus ring when the component is in focus The default value is 0x70B2EE. | DateChooser | ||
headerColors | Type: Array Format: Color CSS Inheritance: yes Theme: halo, spark Colors of the band at the top of the DateChooser control. The default value is [ 0xE1E5EB, 0xF4F5F7 ].
| DateChooser | ||
symbolColor | Type: uint Format: Color CSS Inheritance: yes Theme: spark Color of any symbol of a component. Examples include the check mark of a CheckBox or the arrow of a ScrollBar button. The default value is 0x000000. | DateChooser | ||
todayColor | Type: uint Format: Color CSS Inheritance: yes Theme: halo, spark Color of the background of today's date. The default value for the Halo theme is 0x818181
The default value for the Spark theme is 0xC6D0DB.
| DateChooser | ||
Halo Theme Styles
| Style | Description | Defined By | ||
|---|---|---|---|---|
backgroundAlpha | Type: Number CSS Inheritance: no Theme: halo Alpha level of the color defined by the backgroundColor
property.
Valid values range from 0.0 to 1.0.
The default value is 1.0. | DateChooser | ||
backgroundColor | Type: uint Format: Color CSS Inheritance: no Theme: halo Background color of the DateChooser control. The default value is 0xFFFFF. | DateChooser | ||
borderColor | Type: uint Format: Color CSS Inheritance: no Theme: halo, spark 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 overridden for the class, the default value is 0xB7BABC
for the Halo theme and 0x696969 for the Spark theme.
| DateChooser | ||
borderThickness | Type: Number Format: Length CSS Inheritance: no Theme: halo Bounding box thickness. Only used when borderStyle is set to "solid".
The default value is 1. | DateChooser | ||
cornerRadius | Type: Number Format: Length CSS Inheritance: no Theme: halo, spark Radius of corners of the component. The default value for the Halo theme is 4.
The default value for the Spark theme is 0.
| DateChooser | ||
disabledIconColor | Type: uint Format: Color CSS Inheritance: yes Theme: halo 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.
| DateChooser | ||
headerColors | Type: Array Format: Color CSS Inheritance: yes Theme: halo, spark Colors of the band at the top of the DateChooser control. The default value is [ 0xE1E5EB, 0xF4F5F7 ].
| DateChooser | ||
highlightAlphas | Type: Array CSS Inheritance: no Theme: halo 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 ]. | DateChooser | ||
iconColor | Type: uint Format: Color CSS Inheritance: yes Theme: halo 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.
| DateChooser | ||
| Type: uint Format: Color CSS Inheritance: yes Theme: halo Theme color of a component. | UIComponent | ||
todayColor | Type: uint Format: Color CSS Inheritance: yes Theme: halo, spark Color of the background of today's date. The default value for the Halo theme is 0x818181
The default value for the Spark theme is 0xC6D0DB.
| DateChooser | ||
Public Constants
Property Detail
allowDisjointSelection | property |
allowDisjointSelection:Boolean| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
If true, specifies that non-contiguous(disjoint)
selection is allowed in the DateChooser control.
This property has an effect only if the
allowMultipleSelection property is true.
Setting this property 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 allowDisjointSelectionChanged event.
Implementation
public function get allowDisjointSelection():Boolean public function set allowDisjointSelection(value:Boolean):voidallowMultipleSelection | property |
allowMultipleSelection:Boolean| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
If true, specifies that multiple selection
is allowed in the DateChooser control.
Setting this property changes the appearance of the DateChooser control.
The default value is false.
This property can be used as the source for data binding. When this property is modified, it dispatches the allowMultipleSelectionChanged event.
Implementation
public function get allowMultipleSelection():Boolean public function set allowMultipleSelection(value:Boolean):voidcalendarLayoutStyleFilters | property |
calendarLayoutStyleFilters:Object [read-only] | Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
The set of styles to pass from the DateChooser to the calendar layout.
Implementation
protected function get calendarLayoutStyleFilters():ObjectRelated API Elements
dayNames | property |
dayNames:Array| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
The weekday names for DateChooser control. Changing 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.
Implementation
public function get dayNames():Array public function set dayNames(value:Array):voiddisabledDays | property |
disabledDays:Array| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
The days to disable in a week.
All the dates in a month, for the specified day, are disabled.
This property changes the appearance 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.
Implementation
public function get disabledDays():Array public function set disabledDays(value:Array):voiddisabledRanges | property |
disabledRanges:Array| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Disables single and multiple days.
This property accepts an Array of objects as a parameter.
Each object in this array is a Date object, specifying a
single day to disable; or an object containing either 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 specifying 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)} ]}"
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.
Implementation
public function get disabledRanges():Array public function set disabledRanges(value:Array):voiddisplayedMonth | property |
displayedMonth:int| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Used together 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 changes the appearance of the DateChooser control.
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 viewChanged event.
Implementation
public function get displayedMonth():int public function set displayedMonth(value:int):voiddisplayedYear | property |
displayedYear:int| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Used together with the displayedMonth property,
the displayedYear property specifies the year
displayed in the DateChooser control.
Setting this property 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 viewChanged event.
Implementation
public function get displayedYear():int public function set displayedYear(value:int):voidfirstDayOfWeek | property |
firstDayOfWeek:Object| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Number representing the day of the week to display in the
first column of the DateChooser control.
The value must be in the range 0 to 6, where 0 corresponds to Sunday,
the first element of the dayNames Array.
Setting this property changes the order of the day columns. For example, setting it to 1 makes Monday the first column in the control.
The default value is 0 (Sunday).
This property can be used as the source for data binding. When this property is modified, it dispatches the firstDayOfWeekChanged event.
Implementation
public function get firstDayOfWeek():Object public function set firstDayOfWeek(value:Object):voidmaxYear | property |
minYear | property |
monthNames | property |
monthNames:Array| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Names of the months displayed at the top of the DateChooser 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.
Implementation
public function get monthNames():Array public function set monthNames(value:Array):voidmonthSymbol | property |
monthSymbol:String| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
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 DateChooser 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.
Implementation
public function get monthSymbol():String public function set monthSymbol(value:String):voidnextMonthStyleFilters | property |
nextMonthStyleFilters:Object [read-only] | Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
The set of styles to pass from the DateChooser to the next month button.
Implementation
protected function get nextMonthStyleFilters():ObjectRelated API Elements
nextYearStyleFilters | property |
prevMonthStyleFilters | property |
prevMonthStyleFilters:Object [read-only] | Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
The set of styles to pass from the DateChooser to the previous month button.
Implementation
protected function get prevMonthStyleFilters():ObjectRelated API Elements
prevYearStyleFilters | property |
prevYearStyleFilters:Object [read-only] | Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
The set of styles to pass from the DateChooser to the previous year button.
Implementation
protected function get prevYearStyleFilters():ObjectRelated API Elements
selectableRange | property |
selectableRange:Object| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Range 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.
Implementation
public function get selectableRange():Object public function set selectableRange(value:Object):voidselectedDate | property |
selectedDate:Date| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Date selected in the DateChooser control. If the incoming Date object has any time values, they are zeroed out.
Holding down the Control key when 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 valueCommit event.
Implementation
public function get selectedDate():Date public function set selectedDate(value:Date):voidselectedRanges | property |
selectedRanges:Array| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Selected date ranges.
This property accepts an Array of objects as a parameter.
Each object in this array has two date Objects,
rangeStart and rangeEnd.
The range of dates between each set of rangeStart
and rangeEnd (inclusive) are selected.
To select a single day, set both rangeStart and rangeEnd
to the same date. Time values are zeroed out from the Date
object if they are present.
The following example, selects the following dates: January 11 2006, the range January 23 - February 10 2006.
selectedRanges="{[ {rangeStart: new Date(2006,0,11),
rangeEnd: new Date(2006,0,11)}, {rangeStart:new Date(2006,0,23),
rangeEnd: new Date(2006,1,10)} ]}"
The default value is [].
This property can be used as the source for data binding. When this property is modified, it dispatches the valueCommit event.
Implementation
public function get selectedRanges():Array public function set selectedRanges(value:Array):voidshowToday | property |
showToday:Boolean| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
If true, specifies that today is highlighted
in the DateChooser control.
Setting this property 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.
Implementation
public function get showToday():Boolean public function set showToday(value:Boolean):voidyearNavigationEnabled | property |
yearNavigationEnabled:Boolean| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
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.
Implementation
public function get yearNavigationEnabled():Boolean public function set yearNavigationEnabled(value:Boolean):voidyearSymbol | property |
yearSymbol:String| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
This property is appended to the end of the year displayed at the top of the DateChooser 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.
Implementation
public function get yearSymbol():String public function set yearSymbol(value:String):voidConstructor Detail
DateChooser | () | Constructor |
public function DateChooser()| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Constructor.
Event Detail
change | Event |
Event Object Type:
property CalendarLayoutChangeEvent.type =
mx.events.CalendarLayoutChangeEventproperty CalendarLayoutChangeEvent.type =
mx.events.CalendarLayoutChangeEvent.CHANGE| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Dispatched when a date is selected or changed.
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. |
scroll | Event |
Event Object Type:
property DateChooserEvent.type =
mx.events.DateChooserEventproperty DateChooserEvent.type =
mx.events.DateChooserEvent.SCROLL| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Dispatched 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. |
Examples How to use this example
DateChooserExample.mxml
<?xml version="1.0"?>
<!-- Simple example to demonstrate Halo DateChooser control. -->
<s:Application xmlns:fx="http://ns.adobe.com/mxml/2009"
xmlns:s="library://ns.adobe.com/flex/spark"
xmlns:mx="library://ns.adobe.com/flex/mx">
<fx:Script>
<![CDATA[
// Event handler function to write the selected
// date to the Spark Label control.
private function displayDate(date:Date):void {
if (date == null) {
selection.text = "Date selected: ";
} else {
selection.text = "Date selected: " + date.getFullYear().toString() +
"/" + (date.getMonth()+1).toString() + "/" + date.getDate();
}
}
]]>
</fx:Script>
<fx:Declarations>
<mx:DateFormatter id="df" />
</fx:Declarations>
<s:Panel title="Halo DateChooser Control Example"
width="75%" height="75%"
horizontalCenter="0" verticalCenter="0">
<s:VGroup left="10" right="10" top="10" bottom="10">
<s:Label width="100%" color="blue"
text="Select a date in the Halo DateChooser control."/>
<s:Label width="100%" color="blue"
text="Select it again while holding down the Control key to clear it."/>
<s:HGroup gap="25">
<s:VGroup>
<s:Label text="Simple Halo DateChooser control."/>
<mx:DateChooser id="dateChooser1" yearNavigationEnabled="true"
change="displayDate(DateChooser(event.target).selectedDate)"/>
<s:Label id="selection" color="blue" text="Date selected:"/>
</s:VGroup>
<s:VGroup>
<s:Label text="Disable dates before June 1, 2006."/>
<mx:DateChooser id="dateChooser2" yearNavigationEnabled="true"
disabledRanges="{[ {rangeEnd: new Date(2006, 5, 1)} ]}"/>
<s:Label color="blue" text="Date selected: {df.format(dateChooser2.selectedDate)}"/>
</s:VGroup>
</s:HGroup>
</s:VGroup>
</s:Panel>
</s:Application>
Mon Nov 28 2011, 06:48 AM -08:00