| { "type": "class", | |
| "qname": "mx.controls.ComboBox", | |
| "baseClassname": "mx.controls.ComboBase" | |
| , | |
| "description": "The ComboBox control contains a drop-down list from which the user can select a single value. Its functionality is very similar to that of the SELECT form element in HTML. The ComboBox can be editable, in which case the user can type entries into the TextInput portion of the ComboBox that are not in the list. <p>The ComboBox control has the following default sizing characteristics:</p> <table class="innertable"> <tr> <th>Characteristic</th> <th>Description</th> </tr> <tr> <td>Default size</td> <td>Wide enough to accommodate the longest entry in the drop-down list in the display area of the main control, plus the drop-down button. When the drop-down list is not visible, the default height is based on the label text size. <p>The default drop-down list height is five rows, or the number of entries in the drop-down list, whichever is smaller. The default height of each entry in the drop-down list is 22 pixels.</p></td> </tr> <tr> <td>Minimum size</td> <td>0 pixels.</td> </tr> <tr> <td>Maximum size</td> <td>5000 by 5000.</td> </tr> <tr> <td>dropdownWidth</td> <td>The width of the ComboBox control.</td> </tr> <tr> <td>rowCount</td> <td>5 rows.</td> </tr> </table> <p>The <code><mx:ComboBox></code> tag inherits all the tag attributes of its superclass, and adds the following tag attributes:</p> <pre>\\n <mx:ComboBox\\n <b>Properties</b>\\n dataProvider="null"\\n dropdownFactory="<i>ClassFactory that creates an mx.controls.List</i>"\\n dropdownWidth="<i>100 or width of the longest text in the dataProvider</i>"\\n itemRenderer="null"\\n labelField="label"\\n labelFunction="null"\\n prompt="null"\\n rowCount="5"\\n selectedIndex="-1"\\n selectedItem="null"\\n \\n <b>Styles</b>\\n alternatingItemColors="undefined"\\n arrowButtonWidth="22"\\n borderColor="0xB7BABC"\\n borderThickness="1"\\n closeDuration="250"\\n closeEasingFunction="undefined"\\n color="0x0B333C"\\n cornerRadius="0"\\n disabledColor="0xAAB3B3"\\n disabledIconColor="0x919999"\\n dropdownBorderColor="undefined"\\n dropdownStyleName="comboDropdown"\\n fillAlphas="[0.6,0.4]"\\n fillColors="[0xFFFFFF, 0xCCCCCC]"\\n focusAlpha="0.4"\\n focusRoundedCorners="tl tr bl br"\\n fontAntiAliasType="advanced|normal"\\n fontFamily="Verdana"\\n fontGridFitType="pixel|none|subpixel"\\n fontSharpness="0"\\n fontSize="10"\\n fontStyle="normal|italic"\\n fontThickness="0"\\n fontWeight="normal|bold"\\n highlightAlphas="[0.3,0.0]"\\n iconColor="0x111111"\\n leading="0"\\n openDuration="250"\\n openEasingFunction="undefined"\\n paddingTop="0"\\n paddingBottom="0"\\n paddingLeft="5"\\n paddingRight="5"\\n rollOverColor="<i>Depends on theme color"</i>\\n selectionColor="<i>Depends on theme color"</i>\\n selectionDuration="250"\\n selectionEasingFunction="undefined"\\n textAlign="left|center|right"\\n textDecoration="none|underline"\\n textIndent="0"\\n textRollOverColor="0x2B333C"\\n textSelectedColor="0x2B333C"\\n \\n <b>Events</b>\\n change="<i>No default</i>"\\n close="<i>No default</i>"\\n dataChange="<i>No default</i>"\\n enter="<i>No default</i>"\\n itemRollOut="<i>No default</i>"\\n itemRollOver="<i>No default</i>"\\n open="<i>No default</i>"\\n scroll="<i>No default</i>"\\n />\\n </pre>", | |
| "tags": [ | |
| { "tagName": "includeExample", | |
| "values": ["examples/SimpleComboBox.mxml"]}, | |
| { "tagName": "see", | |
| "values": ["mx.controls.List", "mx.effects.Tween", "mx.managers.PopUpManager"]}, | |
| { "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.ComboBox", | |
| "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": "String", | |
| "qname": "labelField", | |
| "namespace": "public", | |
| "bindable": [], | |
| "details": [], | |
| "deprecated": {}}, | |
| { "type": "accessor", | |
| "access": "read-only", | |
| "return": "Object", | |
| "qname": "dropdown", | |
| "namespace": "public", | |
| "bindable": [], | |
| "details": [], | |
| "deprecated": {}, | |
| "description": "A reference to the List control that acts as the drop-down in the ComboBox.", | |
| "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": "data", | |
| "namespace": "public", | |
| "bindable": ["dataChange"], | |
| "details": [], | |
| "deprecated": {}, | |
| "description": "The <code>data</code> property lets you pass a value to the component when you use it in an item renderer or item editor. You typically use data binding to bind a field of the <code>data</code> property to a property of this component. <p>The ComboBox control uses the <code>listData</code> property and the <code>data</code> property as follows. If the ComboBox is in a DataGrid control, it expects the <code>dataField</code> property of the column to map to a property in the data and sets <code>selectedItem</code> to that property. If the ComboBox control is in a List control, it expects the <code>labelField</code> of the list to map to a property in the data and sets <code>selectedItem</code> to that property. Otherwise, it sets <code>selectedItem</code> to the data itself.</p> <p>You do not set this property in MXML.</p>", | |
| "tags": [ | |
| { "tagName": "see", | |
| "values": ["mx.core.IDataRenderer"]}, | |
| { "tagName": "playerversion", | |
| "values": ["Flash 9", "AIR 1.1"]}, | |
| { "tagName": "productversion", | |
| "values": ["Flex 3"]}, | |
| { "tagName": "langversion", | |
| "values": ["3.0"]} ]}, | |
| { "type": "accessor", | |
| "access": "read-write", | |
| "return": "mx.controls.listClasses.BaseListData", | |
| "qname": "listData", | |
| "namespace": "public", | |
| "bindable": ["dataChange"], | |
| "details": [], | |
| "deprecated": {}, | |
| "description": "When a component is used as a drop-in item renderer or drop-in item editor, Flex initializes the <code>listData</code> property of the component with the appropriate data from the List control. The component can then use the <code>listData</code> property and the <code>data</code> property to display the appropriate information as a drop-in item renderer or drop-in item editor. <p>You do not set this property in MXML or ActionScript; Flex sets it when the component is used as a drop-in item renderer or drop-in item editor.</p>", | |
| "tags": [ | |
| { "tagName": "see", | |
| "values": ["mx.controls.listClasses.IDropInListItemRenderer"]}, | |
| { "tagName": "playerversion", | |
| "values": ["Flash 9", "AIR 1.1"]}, | |
| { "tagName": "productversion", | |
| "values": ["Flex 3"]}, | |
| { "tagName": "langversion", | |
| "values": ["3.0"]} ]}, | |
| { "type": "accessor", | |
| "access": "read-only", | |
| "return": "String", | |
| "qname": "selectedLabel", | |
| "namespace": "public", | |
| "bindable": [], | |
| "details": [], | |
| "deprecated": {}, | |
| "description": "The String displayed in the TextInput portion of the ComboBox. It is calculated from the data by using the <code>labelField</code> or <code>labelFunction</code>.", | |
| "tags": [ | |
| { "tagName": "playerversion", | |
| "values": ["Flash 9", "AIR 1.1"]}, | |
| { "tagName": "productversion", | |
| "values": ["Flex 3"]}, | |
| { "tagName": "langversion", | |
| "values": ["3.0"]} ]}, | |
| { "type": "method", | |
| "qname": "itemToLabel", | |
| "namespace": "public", | |
| "bindable": [], | |
| "details": [], | |
| "deprecated": {}, | |
| "description": "Returns a string representing the <code>item</code> parameter. <p>This method checks in the following order to find a value to return:</p> <ol> <li>If you have specified a <code>labelFunction</code> property, returns the result of passing the item to the function.</li> <li>If the item is a String, Number, Boolean, or Function, returns the item.</li> <li>If the item has a property with the name specified by the control's <code>labelField</code> property, returns the contents of the property.</li> <li>If the item has a label property, returns its value.</li> </ol> If the item is null, this method returns the empty string.", | |
| "tags": [ | |
| { "tagName": "param", | |
| "values": ["item The object that contains the value to convert to a label."]}, | |
| { "tagName": "playerversion", | |
| "values": ["Flash 9", "AIR 1.1"]}, | |
| { "tagName": "productversion", | |
| "values": ["Flex 3"]}, | |
| { "tagName": "return", | |
| "values": ["A string representing the <code>item</code> parameter."]}, | |
| { "tagName": "langversion", | |
| "values": ["3.0"]} ], | |
| "return": "String", | |
| "params": [{ "name": "item", "type": "Object"}, | |
| { "name": "rest", "type": "Array"}]} | |
| ] | |
| , | |
| "events": [ | |
| { "qname": "change", | |
| "type": "mx.events.ListEvent" | |
| , | |
| "description": "Dispatched when the ComboBox contents changes as a result of user interaction, when the <code>selectedIndex</code> or <code>selectedItem</code> property changes, and, if the ComboBox control is editable, each time a keystroke is entered in the box.", | |
| "tags": [ | |
| { "tagName": "playerversion", | |
| "values": ["Flash 9", "AIR 1.1"]}, | |
| { "tagName": "eventType", | |
| "values": ["mx.events.ListEvent.CHANGE"]}, | |
| { "tagName": "productversion", | |
| "values": ["Flex 3"]}, | |
| { "tagName": "langversion", | |
| "values": ["3.0"]} ]}, | |
| { "qname": "close", | |
| "type": "org.apache.royale.events.Event" | |
| , | |
| "description": "Dispatched when the drop-down list is dismissed for any reason such when the user: <ul> <li>selects an item in the drop-down list</li> <li>clicks outside of the drop-down list</li> <li>clicks the drop-down button while the drop-down list is displayed</li> <li>presses the ESC key while the drop-down list is displayed</li> </ul>", | |
| "tags": [ | |
| { "tagName": "playerversion", | |
| "values": ["Flash 9", "AIR 1.1"]}, | |
| { "tagName": "eventType", | |
| "values": ["mx.events.DropdownEvent.CLOSE"]}, | |
| { "tagName": "productversion", | |
| "values": ["Flex 3"]}, | |
| { "tagName": "langversion", | |
| "values": ["3.0"]} ]}, | |
| { "qname": "dataChange", | |
| "type": "mx.events.FlexEvent" | |
| , | |
| "description": "Dispatched when the <code>data</code> property changes. <p>When you use a component as an item renderer, the <code>data</code> property contains an item from the dataProvider. You can listen for this event and update the component when the <code>data</code> property changes.</p>", | |
| "tags": [ | |
| { "tagName": "playerversion", | |
| "values": ["Flash 9", "AIR 1.1"]}, | |
| { "tagName": "eventType", | |
| "values": ["mx.events.FlexEvent.DATA_CHANGE"]}, | |
| { "tagName": "productversion", | |
| "values": ["Flex 3"]}, | |
| { "tagName": "langversion", | |
| "values": ["3.0"]} ]}, | |
| { "qname": "enter", | |
| "type": "mx.events.FlexEvent" | |
| , | |
| "description": "Dispatched if the <code>editable</code> property is set to <code>true</code> and the user presses the Enter key while typing in the editable text field.", | |
| "tags": [ | |
| { "tagName": "playerversion", | |
| "values": ["Flash 9", "AIR 1.1"]}, | |
| { "tagName": "eventType", | |
| "values": ["mx.events.FlexEvent.ENTER"]}, | |
| { "tagName": "productversion", | |
| "values": ["Flex 3"]}, | |
| { "tagName": "langversion", | |
| "values": ["3.0"]} ]}, | |
| { "qname": "itemRollOut", | |
| "type": "mx.events.ListEvent" | |
| , | |
| "description": "Dispatched when user rolls the mouse out of a drop-down list item. The event object's <code>target</code> property contains a reference to the ComboBox and not the drop-down list.", | |
| "tags": [ | |
| { "tagName": "playerversion", | |
| "values": ["Flash 9", "AIR 1.1"]}, | |
| { "tagName": "eventType", | |
| "values": ["mx.events.ListEvent.ITEM_ROLL_OUT"]}, | |
| { "tagName": "productversion", | |
| "values": ["Flex 3"]}, | |
| { "tagName": "langversion", | |
| "values": ["3.0"]} ]}, | |
| { "qname": "itemRollOver", | |
| "type": "mx.events.ListEvent" | |
| , | |
| "description": "Dispatched when the user rolls the mouse over a drop-down list item. The event object's <code>target</code> property contains a reference to the ComboBox and not the drop-down list.", | |
| "tags": [ | |
| { "tagName": "playerversion", | |
| "values": ["Flash 9", "AIR 1.1"]}, | |
| { "tagName": "eventType", | |
| "values": ["mx.events.ListEvent.ITEM_ROLL_OVER"]}, | |
| { "tagName": "productversion", | |
| "values": ["Flex 3"]}, | |
| { "tagName": "langversion", | |
| "values": ["3.0"]} ]}, | |
| { "qname": "open", | |
| "type": "org.apache.royale.events.Event" | |
| , | |
| "description": "Dispatched when the user clicks the drop-down button to display the drop-down list. It is also dispatched if the user uses the keyboard and types Ctrl-Down to open the drop-down.", | |
| "tags": [ | |
| { "tagName": "playerversion", | |
| "values": ["Flash 9", "AIR 1.1"]}, | |
| { "tagName": "eventType", | |
| "values": ["mx.events.DropdownEvent.OPEN"]}, | |
| { "tagName": "productversion", | |
| "values": ["Flex 3"]}, | |
| { "tagName": "langversion", | |
| "values": ["3.0"]} ]}, | |
| { "qname": "scroll", | |
| "type": "mx.events.ScrollEvent" | |
| , | |
| "description": "Dispatched when the user scrolls the ComboBox control's drop-down list.", | |
| "tags": [ | |
| { "tagName": "playerversion", | |
| "values": ["Flash 9", "AIR 1.1"]}, | |
| { "tagName": "eventType", | |
| "values": ["mx.events.ScrollEvent.SCROLL"]}, | |
| { "tagName": "productversion", | |
| "values": ["Flex 3"]}, | |
| { "tagName": "langversion", | |
| "values": ["3.0"]} ]}] | |
| } |