| { "type": "class", | |
| "qname": "mx.controls.DateChooser", | |
| "baseClassname": "mx.core.UIComponent" | |
| , | |
| "description": "The DateChooser control displays the name of a month, the year, and a grid of the days of the month, with columns labeled for the day of the week. The user can select a date, a range of dates, or multiple dates. The control contains forward and back arrow buttons for changing the month and year. You can let users select multiple dates, disable the selection of certain dates, and limit the display to a range of dates. <p>The DateChooser control has the following default characteristics:</p> <table class="innertable"> <tr> <th>Characteristic</th> <th>Description</th> </tr> <tr> <td>Default size</td> <td>A size large enough to hold the calendar, and wide enough to display the day names</td> </tr> <tr> <td>Minimum size</td> <td>0 pixels</td> </tr> <tr> <td>Maximum size</td> <td>No limit</td> </tr> </table> <p>The <code><mx:DateChooser></code> tag inherits all of the tag attributes of its superclass, and adds the following tag attributes:</p> <pre>\\n <mx:DateChooser\\n <strong>Properties</strong>\\n allowDisjointSelection="true|false"\\n allowMultipleSelection="false|true"\\n dayNames="["S", "M", "T", "W", "T", "F", "S"]"\\n disabledDays="<i>No default</i>"\\n disabledRanges="<i>No default</i>"\\n displayedMonth="<i>Current month</i>"\\n displayedYear="<i>Current year</i>"\\n firstDayOfWeek="0"\\n maxYear="2100"\\n minYear="1900"\\n monthNames="["January", "February", "March", "April", "May",\\n "June", "July", "August", "September", "October", "November",\\n "December"]"\\n monthSymbol=""\\n selectableRange="<i>No default</i>"\\n selectedDate="<i>No default</i>"\\n selectedRanges="<i>No default</i>"\\n showToday="true|false"\\n yearNavigationEnabled="false|true"\\n yearSymbol=""\\n \\n <strong>Styles</strong>\\n backgroundColor="0xFFFFFF"\\n backgroundAlpha="1.0"\\n borderColor="0xAAB3B3"\\n borderThickness="1"\\n color="0x0B333C"\\n cornerRadius="4"\\n disabledColor="0xAAB3B3"\\n disabledIconColor="0x999999"\\n fillAlphas="[0.6, 0.4]"\\n fillColors="[0xFFFFFF, 0xCCCCCC]"\\n focusAlpha="0.5"\\n focusRoundedCorners"tl tr bl br"\\n fontAntiAliasType="advanced"\\n fontFamily="Verdana"\\n fontGridFitType="pixel"\\n fontSharpness="0"\\n fontSize="10"\\n fontStyle="normal|italic"\\n fontThickness="0"\\n fontWeight="normal|bold"\\n headerColors="[0xE1E5EB, 0xF4F5F7]"\\n headerStyleName="headerDateText"\\n highlightAlphas="[0.3, 0.0]"\\n horizontalGap="8"\\n iconColor="0x111111"\\n leading="2"\\n nextMonthDisabledSkin="DateChooserMonthArrowSkin"\\n nextMonthDownSkin="DateChooserMonthArrowSkin"\\n nextMonthOverSkin="DateChooserMonthArrowSkin"\\n nextMonthSkin = "DateChooserMonthArrowSkin"\\n nextMonthUpSkin="DateChooserMonthArrowSkin"\\n nextYearDisabledSkin="DateChooserYearArrowSkin"\\n nextYearDownSkin="DateChooserYearArrowSkin"\\n nextYearOverSkin="DateChooserYearArrowSkin"\\n nextYearSkin = "DateChooserYearArrowSkin"\\n nextYearUpSkin="DateChooserYearArrowSkin"\\n prevMonthDisabledSkin="DateChooserMonthArrowSkin"\\n prevMonthDownSkin="DateChooserMonthArrowSkin"\\n prevMonthOverSkin="DateChooserMonthArrowSkin"\\n prevMonthSkin = "DateChooserMonthArrowSkin"\\n prevMonthUpSkin="DateChooserMonthArrowSkin"\\n prevYearDisabledSkin="DateChooserYearArrowSkin"\\n prevYearDownSkin="DateChooserYearArrowSkin"\\n prevYearOverSkin="DateChooserYearArrowSkin"\\n prevYearSkin = "DateChooserYearArrowSkin"\\n prevYearUpSkin="DateChooserYearArrowSkin"\\n rollOverColor="0xEEFEE6"\\n rollOverIndicatorSkin="DateChooserIndicator"\\n selectionColor="0xB7F39B"\\n selectionIndicatorSkin="DateChooserIndicator"\\n textAlign="left|right|center"\\n textDecoration="none|underline"\\n textIndent="0"\\n todayColor="0x818181"\\n todayIndicatorSkin="DateChooserIndicator"\\n todayStyleName="todayStyle"\\n verticalGap="6"\\n weekDayStyleName="weekDayStyle"\\n \\n <strong>Events</strong>\\n change="<i>No default</i>"\\n scroll="<i>No default</i>"\\n />\\n </pre>", | |
| "tags": [ | |
| { "tagName": "includeExample", | |
| "values": ["examples/DateChooserExample.mxml"]}, | |
| { "tagName": "see", | |
| "values": ["mx.controls.DateField"]}, | |
| { "tagName": "mxml", | |
| "values": []}, | |
| { "tagName": "playerversion", | |
| "values": ["Flash 9", "AIR 1.1"]}, | |
| { "tagName": "productversion", | |
| "values": ["Flex 3"]}, | |
| { "tagName": "langversion", | |
| "values": ["3.0"]} ], | |
| "members": [ | |
| { "type": "method", | |
| "qname": "mx.controls.DateChooser", | |
| "namespace": "", | |
| "bindable": [], | |
| "details": [], | |
| "deprecated": {}, | |
| "description": "Constructor.", | |
| "tags": [ | |
| { "tagName": "playerversion", | |
| "values": ["Flash 9", "AIR 1.1"]}, | |
| { "tagName": "productversion", | |
| "values": ["Flex 3"]}, | |
| { "tagName": "langversion", | |
| "values": ["3.0"]} ], | |
| "return": "", | |
| "params": []} | |
| , | |
| { "type": "accessor", | |
| "access": "read-write", | |
| "return": "Boolean", | |
| "qname": "enabled", | |
| "namespace": "public", | |
| "bindable": [], | |
| "details": ["override"], | |
| "deprecated": {}, | |
| "description": "", | |
| "tags": [ | |
| { "tagName": "private", | |
| "values": []} ]}, | |
| { "type": "accessor", | |
| "access": "read-write", | |
| "return": "Array", | |
| "qname": "dayNames", | |
| "namespace": "public", | |
| "bindable": ["dayNamesChanged"], | |
| "details": [], | |
| "deprecated": {}, | |
| "description": "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.", | |
| "tags": [ | |
| { "tagName": "default", | |
| "values": ["[ "S", "M", "T", "W", "T", "F", "S" ]."]}, | |
| { "tagName": "playerversion", | |
| "values": ["Flash 9", "AIR 1.1"]}, | |
| { "tagName": "productversion", | |
| "values": ["Flex 3"]}, | |
| { "tagName": "langversion", | |
| "values": ["3.0"]} ]}, | |
| { "type": "accessor", | |
| "access": "read-write", | |
| "return": "Array", | |
| "qname": "disabledDays", | |
| "namespace": "public", | |
| "bindable": ["disabledDaysChanged"], | |
| "details": [], | |
| "deprecated": {}, | |
| "description": "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 <code>[ 0, 6 ]</code> disables Sunday and Saturday.", | |
| "tags": [ | |
| { "tagName": "default", | |
| "values": ["[]"]}, | |
| { "tagName": "playerversion", | |
| "values": ["Flash 9", "AIR 1.1"]}, | |
| { "tagName": "productversion", | |
| "values": ["Flex 3"]}, | |
| { "tagName": "langversion", | |
| "values": ["3.0"]} ]}, | |
| { "type": "accessor", | |
| "access": "read-write", | |
| "return": "Array", | |
| "qname": "disabledRanges", | |
| "namespace": "public", | |
| "bindable": ["disabledRangesChanged"], | |
| "details": [], | |
| "deprecated": {}, | |
| "description": "Disables single and multiple days. <p>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 <code>rangeStart</code> and <code>rangeEnd</code> 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 <code>rangeStart</code>, all the dates after the specified date are disabled, including the <code>rangeStart</code> date. If you specify only <code>rangeEnd</code>, all the dates before the specified date are disabled, including the <code>rangeEnd</code> 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.</p> <p>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.</p> <p><code>disabledRanges="{[ new Date(2006,0,11), {rangeStart: new Date(2006,0,23), rangeEnd: new Date(2006,1,10)}, {rangeStart: new Date(2006,2,1)} ]}"</code></p>", | |
| "tags": [ | |
| { "tagName": "default", | |
| "values": ["[]"]}, | |
| { "tagName": "playerversion", | |
| "values": ["Flash 9", "AIR 1.1"]}, | |
| { "tagName": "productversion", | |
| "values": ["Flex 3"]}, | |
| { "tagName": "langversion", | |
| "values": ["3.0"]} ]}, | |
| { "type": "accessor", | |
| "access": "read-write", | |
| "return": "int", | |
| "qname": "displayedMonth", | |
| "namespace": "public", | |
| "bindable": ["viewChanged","scroll"], | |
| "details": [], | |
| "deprecated": {}, | |
| "description": "Used together with the <code>displayedYear</code> property, the <code>displayedMonth</code> 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. <p>The default value is the current month.</p>", | |
| "tags": [ | |
| { "tagName": "playerversion", | |
| "values": ["Flash 9", "AIR 1.1"]}, | |
| { "tagName": "productversion", | |
| "values": ["Flex 3"]}, | |
| { "tagName": "langversion", | |
| "values": ["3.0"]} ]}, | |
| { "type": "accessor", | |
| "access": "read-write", | |
| "return": "int", | |
| "qname": "displayedYear", | |
| "namespace": "public", | |
| "bindable": [], | |
| "details": [], | |
| "deprecated": {}, | |
| "description": "Used together with the <code>displayedMonth</code> property, the <code>displayedYear</code> property specifies the year displayed in the DateChooser control. Setting this property changes the appearance of the DateChooser control. <p>The default value is the current year.</p>", | |
| "tags": [ | |
| { "tagName": "playerversion", | |
| "values": ["Flash 9", "AIR 1.1"]}, | |
| { "tagName": "productversion", | |
| "values": ["Flex 3"]}, | |
| { "tagName": "langversion", | |
| "values": ["3.0"]} ]}, | |
| { "type": "accessor", | |
| "access": "read-write", | |
| "return": "Object", | |
| "qname": "firstDayOfWeek", | |
| "namespace": "public", | |
| "bindable": ["firstDayOfWeekChanged"], | |
| "details": [], | |
| "deprecated": {}, | |
| "description": "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 <code>dayNames</code> Array. <p>Setting this property changes the order of the day columns. For example, setting it to 1 makes Monday the first column in the control.</p>", | |
| "tags": [ | |
| { "tagName": "default", | |
| "values": ["0 (Sunday)"]}, | |
| { "tagName": "playerversion", | |
| "values": ["Flash 9", "AIR 1.1"]}, | |
| { "tagName": "productversion", | |
| "values": ["Flex 3"]}, | |
| { "tagName": "langversion", | |
| "values": ["3.0"]} ]}, | |
| { "type": "accessor", | |
| "access": "read-write", | |
| "return": "int", | |
| "qname": "maxYear", | |
| "namespace": "public", | |
| "bindable": [], | |
| "details": [], | |
| "deprecated": {}, | |
| "description": "The last year selectable in the control.", | |
| "tags": [ | |
| { "tagName": "default", | |
| "values": ["2100"]}, | |
| { "tagName": "playerversion", | |
| "values": ["Flash 9", "AIR 1.1"]}, | |
| { "tagName": "productversion", | |
| "values": ["Flex 3"]}, | |
| { "tagName": "langversion", | |
| "values": ["3.0"]} ]}, | |
| { "type": "accessor", | |
| "access": "read-write", | |
| "return": "int", | |
| "qname": "minYear", | |
| "namespace": "public", | |
| "bindable": [], | |
| "details": [], | |
| "deprecated": {}, | |
| "description": "The first year selectable in the control.", | |
| "tags": [ | |
| { "tagName": "default", | |
| "values": ["1900"]}, | |
| { "tagName": "playerversion", | |
| "values": ["Flash 9", "AIR 1.1"]}, | |
| { "tagName": "productversion", | |
| "values": ["Flex 3"]}, | |
| { "tagName": "langversion", | |
| "values": ["3.0"]} ]}, | |
| { "type": "accessor", | |
| "access": "read-write", | |
| "return": "Array", | |
| "qname": "monthNames", | |
| "namespace": "public", | |
| "bindable": ["monthNamesChanged"], | |
| "details": [], | |
| "deprecated": {}, | |
| "description": "Names of the months displayed at the top of the DateChooser control. The <code>monthSymbol</code> property is appended to the end of the value specified by the <code>monthNames</code> property, which is useful in languages such as Japanese. "July", "August", "September", "October", "November", "December" ]", | |
| "tags": [ | |
| { "tagName": "default", | |
| "values": ["[ "January", "February", "March", "April", "May", "June","]}, | |
| { "tagName": "playerversion", | |
| "values": ["Flash 9", "AIR 1.1"]}, | |
| { "tagName": "productversion", | |
| "values": ["Flex 3"]}, | |
| { "tagName": "langversion", | |
| "values": ["3.0"]} ]}, | |
| { "type": "accessor", | |
| "access": "read-write", | |
| "return": "Object", | |
| "qname": "selectableRange", | |
| "namespace": "public", | |
| "bindable": ["selectableRangeChanged"], | |
| "details": [], | |
| "deprecated": {}, | |
| "description": "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. <p>This property accepts an Object as a parameter. The Object contains two properties, <code>rangeStart</code> and <code>rangeEnd</code>, of type Date. If you specify only <code>rangeStart</code>, all the dates on and after the specified date are enabled. If you only specify <code>rangeEnd</code>, all the dates on and 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.</p> <p>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.</p> <p><code>selectableRange="{{rangeStart : new Date(2006,0,1), rangeEnd : new Date(2006,5,30)}}"</code></p>", | |
| "tags": [ | |
| { "tagName": "default", | |
| "values": ["null"]}, | |
| { "tagName": "playerversion", | |
| "values": ["Flash 9", "AIR 1.1"]}, | |
| { "tagName": "productversion", | |
| "values": ["Flex 3"]}, | |
| { "tagName": "langversion", | |
| "values": ["3.0"]} ]}, | |
| { "type": "accessor", | |
| "access": "read-write", | |
| "return": "Date", | |
| "qname": "selectedDate", | |
| "namespace": "public", | |
| "bindable": ["change","valueCommit"], | |
| "details": [], | |
| "deprecated": {}, | |
| "description": "Date selected in the DateChooser control. If the incoming Date object has any time values, they are zeroed out. <p>Holding down the Control key when selecting the currently selected date in the control deselects it, sets the <code>selectedDate</code> property to <code>null</code>, and then dispatches the <code>change</code> event.</p>", | |
| "tags": [ | |
| { "tagName": "default", | |
| "values": ["null"]}, | |
| { "tagName": "playerversion", | |
| "values": ["Flash 9", "AIR 1.1"]}, | |
| { "tagName": "productversion", | |
| "values": ["Flex 3"]}, | |
| { "tagName": "langversion", | |
| "values": ["3.0"]} ]}, | |
| { "type": "accessor", | |
| "access": "read-write", | |
| "return": "Array", | |
| "qname": "selectedRanges", | |
| "namespace": "public", | |
| "bindable": ["change","valueCommit"], | |
| "details": [], | |
| "deprecated": {}, | |
| "description": "Selected date ranges. <p>This property accepts an Array of objects as a parameter. Each object in this array has two date Objects, <code>rangeStart</code> and <code>rangeEnd</code>. The range of dates between each set of <code>rangeStart</code> and <code>rangeEnd</code> (inclusive) are selected. To select a single day, set both <code>rangeStart</code> and <code>rangeEnd</code> to the same date. Time values are zeroed out from the Date object if they are present.</p> <p>The following example, selects the following dates: January 11 2006, the range January 23 - February 10 2006. </p> <p><code>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)} ]}"</code></p>", | |
| "tags": [ | |
| { "tagName": "default", | |
| "values": ["[]"]}, | |
| { "tagName": "playerversion", | |
| "values": ["Flash 9", "AIR 1.1"]}, | |
| { "tagName": "productversion", | |
| "values": ["Flex 3"]}, | |
| { "tagName": "langversion", | |
| "values": ["3.0"]} ]}, | |
| { "type": "accessor", | |
| "access": "read-write", | |
| "return": "Boolean", | |
| "qname": "showToday", | |
| "namespace": "public", | |
| "bindable": ["showTodayChanged"], | |
| "details": [], | |
| "deprecated": {}, | |
| "description": "If <code>true</code>, specifies that today is highlighted in the DateChooser control. Setting this property changes the appearance of the DateChooser control.", | |
| "tags": [ | |
| { "tagName": "default", | |
| "values": ["true"]}, | |
| { "tagName": "playerversion", | |
| "values": ["Flash 9", "AIR 1.1"]}, | |
| { "tagName": "productversion", | |
| "values": ["Flex 3"]}, | |
| { "tagName": "langversion", | |
| "values": ["3.0"]} ]}, | |
| { "type": "accessor", | |
| "access": "read-write", | |
| "return": "Boolean", | |
| "qname": "yearNavigationEnabled", | |
| "namespace": "public", | |
| "bindable": ["yearNavigationEnabledChanged"], | |
| "details": [], | |
| "deprecated": {}, | |
| "description": "Enables year navigation. When <code>true</code> 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.", | |
| "tags": [ | |
| { "tagName": "default", | |
| "values": ["false"]}, | |
| { "tagName": "playerversion", | |
| "values": ["Flash 9", "AIR 1.1"]}, | |
| { "tagName": "productversion", | |
| "values": ["Flex 3"]}, | |
| { "tagName": "langversion", | |
| "values": ["3.0"]} ]}, | |
| { "type": "method", | |
| "qname": "addedToParent", | |
| "namespace": "public", | |
| "bindable": [], | |
| "details": ["override"], | |
| "deprecated": {}, | |
| "return": "void", | |
| "params": []} | |
| , | |
| { "type": "method", | |
| "qname": "getLayoutHost", | |
| "namespace": "public", | |
| "bindable": [], | |
| "details": [], | |
| "deprecated": {}, | |
| "description": "Returns the ILayoutHost which is its view. From ILayoutParent.", | |
| "tags": [ | |
| { "tagName": "playerversion", | |
| "values": ["Flash 10.2", "AIR 2.6"]}, | |
| { "tagName": "productversion", | |
| "values": ["Royale 0.8"]}, | |
| { "tagName": "royaleignorecoercion", | |
| "values": ["org.apache.royale.core.ILayoutHost"]}, | |
| { "tagName": "langversion", | |
| "values": ["3.0"]} ], | |
| "return": "org.apache.royale.core.ILayoutHost", | |
| "params": []} | |
| ] | |
| , | |
| "events": [ | |
| { "qname": "change", | |
| "type": "org.apache.royale.events.Event" | |
| , | |
| "description": "Dispatched when a date is selected or changed.", | |
| "tags": [ | |
| { "tagName": "playerversion", | |
| "values": ["Flash 9", "AIR 1.1"]}, | |
| { "tagName": "eventType", | |
| "values": ["mx.events.CalendarLayoutChangeEvent.CHANGE"]}, | |
| { "tagName": "productversion", | |
| "values": ["Flex 3"]}, | |
| { "tagName": "langversion", | |
| "values": ["3.0"]} ]}] | |
| } |