| Package | mx.controls |
| Class | public class ComboBox |
| Inheritance | ComboBox  ComboBase UIComponent FlexSprite flash.display.Sprite |
| Implements | IDataRenderer, IDropInListItemRenderer, IListItemRenderer |
| Subclasses | AutoCompleteComboBox |
The ComboBox control has the following default sizing characteristics:
| Characteristic | Description |
|---|---|
| Default size | 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.
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. |
| Minimum size | 0 pixels. |
| Maximum size | 5000 by 5000. |
| dropdownWidth | The width of the ComboBox control. |
| rowCount | 5 rows. |
Hide MXML Syntax
The <mx:ComboBox> tag inherits all the tag attributes
of its superclass, and adds the following tag attributes:
Show MXML Syntax
<mx:ComboBox
Properties
dataProvider="null"
dropdownFactory="ClassFactory that creates an mx.controls.List"
dropdownWidth="100 or width of the longest text in the dataProvider"
itemRenderer="null"
labelField="label"
labelFunction="null"
prompt="null"
rowCount="5"
selectedIndex="-1"
selectedItem="null"
Styles
alternatingItemColors="undefined"
arrowButtonWidth="22"
borderColor="0xB7BAABC"
borderThickness="1"
closeDuration="250"
closeEasingFunction="undefined"
color="0x0B333C"
cornerRadius="0"
disabledColor="0xAAB3B3"
disabledIconColor="0x919999"
dropdownBorderColor="undefined"
dropdownStyleName="comboDropdown"
fillAlphas="[0.6,0.4]"
fillColors="[0xFFFFFF, 0xCCCCCC]"
focusAlpha="0.4"
focusRoundedCorners="tl tr bl br"
fontAntiAliasType="advanced|normal"
fontFamily="Verdana"
fontGridFitType="pixel|none|subpixel"
fontSharpness="0"
fontSize="10"
fontStyle="normal|italic"
fontThickness="0"
fontWeight="normal|bold"
highlightAlphas="[0.3,0.0]"
iconColor="0x111111"
leading="0"
openDuration="250"
openEasingFunction="undefined"
paddingTop="0"
paddingBottom="0"
paddingLeft="5"
paddingRight="5"
rollOverColor="Depends on theme color"
selectionColor="Depends on theme color"
selectionDuration="250"
selectionEasingFunction="undefined"
textAlign="left|center|right"
textDecoration="none|underline"
textIndent="0"
textRollOverColor="0x2B333C"
textSelectedColor="0x2B333C"
Events
change="No default"
close="No default"
dataChange="No default"
enter="No default"
itemRollOut="No default"
itemRollOver="No default"
open="No default"
scroll="No default"
/>
Default MXML PropertydataProvider
See also
| Property | Defined by | ||
|---|---|---|---|
 | activeEffects : Array
The list of effects that are currently playing on the component,
as an Array of EffectInstance instances.
| UIComponent | |
| automationDelegate : Object
The delegate object that handles the automation-related functionality.
| UIComponent | |
| automationName : String
Name that can be used as an identifier for this object.
| UIComponent | |
| automationTabularData : Object
An implementation of the
IAutomationTabularData interface, which
can be used to retrieve the data. | UIComponent | |
| automationValue : Array
This value generally corresponds to the rendered appearance of the
object and should be usable for correlating the identifier with
the object as it appears visually within the application.
| UIComponent | |
| baselinePosition : Number
The y-coordinate of the baseline
of the first line of text of the component.
| UIComponent | |
| cacheHeuristic : Boolean
Used by Flex to suggest bitmap caching for the object.
| UIComponent | |
| cachePolicy : String
Specifies the bitmap caching policy for this object.
| UIComponent | |
| className : String
The name of this instance's class, such as
"Button". | UIComponent | |
| contentMouseX : Number
Returns the x position of the mouse, in the content coordinate system.
| UIComponent | |
| contentMouseY : Number
Returns the y position of the mouse, in the content coordinate system.
| UIComponent | |
| currentState : String
The current view state of the component.
| UIComponent | |
| cursorManager : ICursorManager
Gets the CursorManager that controls the cursor for this component
and its peers.
| UIComponent | |
| data : Object
The
data property lets you pass a value
to the component when you use it in an item renderer or item editor. | ComboBox | ||
| dataProvider : Object [write-only]
| ComboBox | ||
| descriptor : UIComponentDescriptor
Reference to the UIComponentDescriptor, if any, that was used
by the
createComponentFromDescriptor() method to create this
UIComponent instance. | UIComponent | |
| document : Object
A reference to the document object associated with this UIComponent.
| UIComponent | |
| doubleClickEnabled : Boolean
Specifies whether the UIComponent object receives
doubleClick events. | UIComponent | |
| dropdown : ListBase
[read-only]
A reference to the List control that acts as the drop-down in the ComboBox.
| ComboBox | ||
| dropdownFactory : IFactory
The IFactory that creates a ListBase-derived instance to use
as the drop-down.
| ComboBox | ||
| dropdownWidth : Number
Width of the drop-down list, in pixels.
| ComboBox | ||
| editable : Boolean
A flag that indicates whether the control is editable,
which lets the user directly type entries that are not specified
in the dataProvider, or not editable, which requires the user select
from the items in the dataProvider.
| ComboBase | |
| enabled : Boolean
Whether the component can accept user interaction.
| UIComponent | |
| errorString : String
The text that will be displayed by a component's error tip when a
component is monitored by a Validator and validation fails.
| UIComponent | |
| explicitHeight : Number
Number that specifies the explicit height of the component,
in pixels, in the component's coordinates.
| UIComponent | |
| explicitMaxHeight : Number
Number that specifies the maximum height of the component,
in pixels, in the component's coordinates.
| UIComponent | |
| explicitMaxWidth : Number
Number that specifies the maximum width of the component,
in pixels, in the component's coordinates.
| UIComponent | |
| explicitMinHeight : Number
Number that specifies the minimum height of the component,
in pixels, in the component's coordinates.
| UIComponent | |
| explicitMinWidth : Number
Number that specifies the minimum width of the component,
in pixels, in the component's coordinates.
| UIComponent | |
| explicitWidth : Number
Number that specifies the explicit width of the component,
in pixels, in the component's coordinates.
| UIComponent | |
| 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 | |
| height : Number
Number that specifies the height of the component, in pixels,
in the parent's coordinates.
| UIComponent | |
| id : String
ID of the component.
| UIComponent | |
| imeMode : String
Specifies the IME (input method editor) mode.
| ComboBase | |
| includeInLayout : Boolean
Specifies whether this component is included in the layout of the
parent container.
| UIComponent | |
| inheritingStyles : Object
The beginning of this component's chain of inheriting styles.
| UIComponent | |
| initialized : Boolean
A flag that determines if an object has been through all three phases
of layout: commitment, measurement, and layout (provided that any were required).
| UIComponent | |
| instanceIndex : int
The index of a repeated component.
| UIComponent | |
| instanceIndices : Array
An Array containing the indices required to reference
this UIComponent object from its parent document.
| UIComponent | |
| isDocument : Boolean
Determines whether this UIComponent instance is a document object,
that is, whether it is at the top of the hierarchy of a Flex
application, MXML component, or ActionScript component.
| UIComponent | |
| isPopUp : Boolean
Set to
true by the PopUpManager to indicate
that component has been popped up. | UIComponent | |
| itemRenderer : IFactory
IFactory that generates the instances that displays the data for the
drop-down list of the control.
| ComboBox | ||
| labelField : String
Name of the field in the items in the
dataProvider
Array to display as the label in the TextInput portion and drop-down list. | ComboBox | ||
| labelFunction : Function
User-supplied function to run on each item to determine its label.
| ComboBox | ||
| listData : BaseListData
When a component is used as a drop-in item renderer or drop-in item
editor, Flex initializes the
listData property of the
component with the appropriate data from the List control. | ComboBox | ||
| maxHeight : Number
Number that specifies the maximum height of the component,
in pixels, in the component's coordinates.
| UIComponent | |
| maxWidth : Number
Number that specifies the maximum width of the component,
in pixels, in the component's coordinates.
| UIComponent | |
| measuredHeight : Number
The default height of the component, in pixels.
| UIComponent | |
| measuredMinHeight : Number
The default minimum height of the component, in pixels.
| UIComponent | |
| measuredMinWidth : Number
The default minimum width of the component, in pixels.
| UIComponent | |
| measuredWidth : Number
The default width of the component, in pixels.
| UIComponent | |
| minHeight : Number
Number that specifies the minimum height of the component,
in pixels, in the component's coordinates.
| UIComponent | |
| minWidth : Number
Number that specifies the minimum width of the component,
in pixels, in the component's coordinates.
| UIComponent | |
| moduleFactory : IFlexModuleFactory
The moduleFactory that is used to create TextFields in the correct SWF context.
| UIComponent | |
| mouseFocusEnabled : Boolean
Whether you can receive focus when clicked on.
| UIComponent | |
| 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
The number of automation children this container has.
| UIComponent | |
| owner : DisplayObjectContainer
The owner of this UIComponent.
| UIComponent | |
| parent : DisplayObjectContainer
The parent container or component for this component.
| UIComponent | |
| parentApplication : Object
A reference to the Application object that contains this UIComponent
instance.
| UIComponent | |
| parentDocument : Object
A reference to the parent document object for this UIComponent.
| UIComponent | |
| percentHeight : Number
Number that specifies the height of a component as a percentage
of its parent's size.
| UIComponent | |
| percentWidth : Number
Number that specifies the width of a component as a percentage
of its parent's size.
| UIComponent | |
| processedDescriptors : Boolean
Set to
true after immediate or deferred child creation,
depending on which one happens. | UIComponent | |
| prompt : String
The prompt for the ComboBox control.
| ComboBox | ||
| repeater : IRepeater
A reference to the Repeater object
in the parent document that produced this UIComponent.
| UIComponent | |
| repeaterIndex : int
The index of the item in the data provider
of the Repeater that produced this UIComponent.
| UIComponent | |
| repeaterIndices : Array
An Array containing the indices of the items in the data provider
of the Repeaters in the parent document that produced this UIComponent.
| UIComponent | |
| repeaters : Array
An Array containing references to the Repeater objects
in the parent document that produced this UIComponent.
| UIComponent | |
| restrict : String
Set of characters that a user can or cannot enter into the text field.
| ComboBase | |
| rowCount : int
Maximum number of rows visible in the ComboBox control list.
| ComboBox | ||
| scaleX : Number
Number that specifies the horizontal scaling factor.
| UIComponent | |
| scaleY : Number
Number that specifies the vertical scaling factor.
| UIComponent | |
| screen : Rectangle
Returns an object that contains the size and position of the base
drawing surface for this object.
| UIComponent | |
| selectedIndex : int [write-only]
Index of the selected item in the drop-down list.
| ComboBox | ||
| selectedItem : Object [write-only]
Contains a reference to the selected item in the
dataProvider. | ComboBox | ||
| selectedLabel : String [read-only]
The String displayed in the TextInput portion of the ComboBox.
| ComboBox | ||
| showInAutomationHierarchy : Boolean
A flag that determines if an automation object
shows in the automation hierarchy.
| UIComponent | |
| states : Array
The view states that are defined for this component.
| UIComponent | |
| styleDeclaration : CSSStyleDeclaration
Storage for the inline inheriting styles on this object.
| UIComponent | |
| styleName : Object
The class style used by this component.
| UIComponent | |
| systemManager : ISystemManager
Returns the SystemManager object used by this component.
| UIComponent | |
| text : String
Contents of the text field.
| ComboBase | |
| toolTip : String
Text to display in the ToolTip.
| 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 | |
| validationSubField : String
Used by a validator to associate a subfield with this component.
| UIComponent | |
| value : Object
The value of the selected item.
| ComboBase | |
| visible : Boolean
Controls the visibility of this UIComponent.
| UIComponent | |
| width : Number
Number that specifies the width of the component, in pixels,
in the parent's coordinates.
| UIComponent | |
| x : Number
Number that specifies the component's horizontal position,
in pixels, within its parent container.
| UIComponent | |
| y : Number
Number that specifies the component's vertical position,
in pixels, within its parent container.
| UIComponent | |
| Property | Defined by | ||
|---|---|---|---|
| arrowButtonStyleFilters : Object
Set of styles to pass from the ComboBase to the down arrow button
| ComboBase | |
| borderMetrics : EdgeMetrics
Returns an EdgeMetrics object that has four properties:
left, top, right,
and bottom. | ComboBase | |
| collection : ICollectionView
The ICollectionView of items this component displays.
| ComboBase | |
| dropDownStyleFilters : Object [read-only]Review needed.
The set of styles to pass from the ComboBox to the dropDown.
| ComboBox | ||
| iterator : IViewCursor
The main IViewCursor used to fetch items from the
dataProvider and pass the items to the renderers.
| ComboBase | |
| textInput : TextInput
The internal TextInput subcomponent that displays
the current selection.
| ComboBase | |
| textInputStyleFilters : Object
The set of styles to pass from the ComboBase to the text input.
| ComboBase | |
| unscaledHeight : Number
A convenience method for determining the unscaled height
of the component.
| UIComponent | |
| unscaledWidth : Number
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 | |
| Method | Defined by | ||
|---|---|---|---|
|
ComboBox()
Constructor.
| ComboBox | ||
|
callLater(method:Function, args:Array = null):void
Queues a function to be called later.
| UIComponent | |
|
clearStyle(styleProp:String):void
Deletes a style property from this component instance.
| UIComponent | |
|
close(trigger:Event = null):void
Hides the drop-down list.
| ComboBox | ||
|
contentToGlobal(point:Point):Point
Converts a
Point object from content coordinates to global coordinates. | UIComponent | |
|
contentToLocal(point:Point):Point
Converts a
Point object from content to local coordinates. | UIComponent | |
|
createAutomationIDPart(child:IAutomationObject):Object
Returns a set of properties that identify the child within
this container.
| UIComponent | |
|
createReferenceOnParentDocument(parentDocument:IFlexDisplayObject):void
Creates an
id reference to this IUIComponent object
on its parent document object. | UIComponent | |
|
deleteReferenceOnParentDocument(parentDocument:IFlexDisplayObject):void
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 | |
|
dispatchEvent(event:Event):Boolean
Dispatches an event into the event flow.
| UIComponent | |
|
drawFocus(isFocused:Boolean):void
Shows or hides the focus indicator around this component.
| UIComponent | |
|
drawRoundRect(x:Number, y:Number, w:Number, h:Number, r:Object = null, c:Object = null, alpha:Object = null, rot:Object = null, gradient:String = null, ratios:Array = null, hole:Object = null):void
Programatically draws a rectangle into this skin's Graphics object.
| UIComponent | |
|
effectFinished(effectInst:IEffectInstance):void
Called by the effect instance when it stops playing on the component.
| UIComponent | |
|
effectStarted(effectInst:IEffectInstance):void
Called by the effect instance when it starts playing on the component.
| UIComponent | |
|
endEffectsStarted():void
Ends all currently playing effects on the component.
| UIComponent | |
|
executeBindings(recurse:Boolean = false):void
Executes the data bindings into this UIComponent object.
| UIComponent | |
|
finishPrint(obj:Object, target:IFlexDisplayObject):void
Called after printing is complete.
| UIComponent | |
|
getAutomationChildAt(index:int):IAutomationObject
Provides the automation object at the specified index.
| UIComponent | |
|
getClassStyleDeclarations():Array
Finds the type selectors for this UIComponent instance.
| UIComponent | |
|
getConstraintValue(constraintName:String):*
Returns a layout constraint value, which is the same as
getting the constraint style for this component.
| UIComponent | |
|
getExplicitOrMeasuredHeight():Number
A convenience method for determining whether to use the
explicit or measured height
| UIComponent | |
|
getExplicitOrMeasuredWidth():Number
A convenience method for determining whether to use the
explicit or measured width
| UIComponent | |
|
getFocus():InteractiveObject
Gets the object that currently has focus.
| UIComponent | |
|
getRepeaterItem(whichRepeater:int = -1):Object
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 | |
|
getStyle(styleProp:String):*
Gets a style property that has been set anywhere in this
component's style lookup chain.
| UIComponent | |
|
globalToContent(point:Point):Point
Converts a
Point object from global to content coordinates. | UIComponent | |
|
horizontalGradientMatrix(x:Number, y:Number, width:Number, height:Number):Matrix
Returns a box Matrix which can be passed to the
drawRoundRect() method
as the rot parameter when drawing a horizontal gradient. | UIComponent | |
|
initialize():void
Initializes the internal structure of this component.
| UIComponent | |
|
initializeRepeaterArrays(parent:IRepeaterClient):void
Initializes various properties which keep track of repeated instances
of this component.
| UIComponent | |
|
invalidateDisplayList():void
Marks a component so that its
updateDisplayList()
method gets called during a later screen update. | UIComponent | |
|
invalidateProperties():void
Marks a component so that its
commitProperties()
method gets called during a later screen update. | UIComponent | |
|
invalidateSize():void
Marks a component so that its
measure()
method gets called during a later screen update. | UIComponent | |
|
itemToLabel(item:Object):String
Returns a string representing the
item parameter. | ComboBox | ||
|
localToContent(point:Point):Point
Converts a
Point object from local to content coordinates. | UIComponent | |
|
measureHTMLText(htmlText:String):TextLineMetrics
Measures the specified HTML text, which may contain HTML tags such
as
<font> and <b>,
assuming that it is displayed
in a single-line UITextField using a UITextFormat
determined by the styles of this UIComponent. | UIComponent | |
|
measureText(text:String):TextLineMetrics
Measures the specified text, assuming that it is displayed
in a single-line UITextField using a UITextFormat
determined by the styles of this UIComponent.
| UIComponent | |
|
move(x:Number, y:Number):void
Moves the component to a specified position within its parent.
| UIComponent | |
|
notifyStyleChangeInChildren(styleProp:String, recursive:Boolean):void
Propagates style changes to the children.
| UIComponent | |
|
open():void
Displays the drop-down list.
| ComboBox | ||
|
owns(child:DisplayObject):Boolean
Returns
true if the chain of owner properties
points from child to this UIComponent. | UIComponent | |
|
parentChanged(p:DisplayObjectContainer):void
Called by Flex when a UIComponent object is added to or removed from a parent.
| UIComponent | |
|
prepareToPrint(target:IFlexDisplayObject):Object
Prepares an IFlexDisplayObject for printing.
| UIComponent | |
|
regenerateStyleCache(recursive:Boolean):void
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 | |
|
registerEffects(effects:Array):void
For each effect event, registers the EffectManager
as one of the event listeners.
| UIComponent | |
|
replayAutomatableEvent(event:Event):Boolean
Replays the specified event.
| UIComponent | |
|
resolveAutomationIDPart(criteria:Object):Array
Resolves a child by using the id provided.
| UIComponent | |
|
resumeBackgroundProcessing():void
[static]
Resumes the background processing of methods
queued by
callLater(), after a call to
suspendBackgroundProcessing(). | UIComponent | |
|
setActualSize(w:Number, h:Number):void
Sizes the object.
| UIComponent | |
|
setConstraintValue(constraintName:String, value:*):void
Sets a layout constraint value, which is the same as
setting the constraint style for this component.
| UIComponent | |
|
setCurrentState(stateName:String, playTransition:Boolean = true):void
Set the current state.
| UIComponent | |
|
setFocus():void
Sets the focus to this component.
| UIComponent | |
|
setStyle(styleProp:String, newValue:*):void
Sets a style property on this component instance.
| UIComponent | |
|
setVisible(value:Boolean, noEvent:Boolean = false):void
Called when the
visible property changes. | UIComponent | |
|
styleChanged(styleProp:String):void
Detects changes to style properties.
| UIComponent | |
|
stylesInitialized():void
Flex calls the
stylesInitialized() method when
the styles for a component are first initialized. | UIComponent | |
|
suspendBackgroundProcessing():void
[static]
Blocks the background processing of methods
queued by
callLater(),
until resumeBackgroundProcessing() is called. | UIComponent | |
|
toString():String
Returns a string indicating the location of this object
within the hierarchy of DisplayObjects in the Application.
| FlexSprite | |
|
validateDisplayList():void
Validates the position and size of children and draws other
visuals.
| UIComponent | |
|
validateNow():void
Validate and update the properties and layout of this object
and redraw it, if necessary.
| UIComponent | |
|
validateProperties():void
Used by layout logic to validate the properties of a component
by calling the
commitProperties() method. | UIComponent | |
|
validateSize(recursive:Boolean = false):void
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 | |
|
validationResultHandler(event:ValidationResultEvent):void
Handles both the
valid and invalid events from a
validator assigned to this component. | UIComponent | |
|
verticalGradientMatrix(x:Number, y:Number, width:Number, height:Number):Matrix
Returns a box Matrix which can be passed to
drawRoundRect()
as the rot parameter when drawing a vertical gradient. | UIComponent | |
| Method | Defined by | ||
|---|---|---|---|
|
adjustFocusRect(obj:DisplayObject = null):void
Adjust the focus rectangle.
| UIComponent | |
|
attachOverlay():void
This is an internal method used by the Flex framework
to support the Dissolve effect.
| UIComponent | |
|
calculatePreferredSizeFromData(count:int):Object
Determines default values of the height and width to use for each
entry in the drop-down list, based on the maximum size of the label
text in the first
numItems items in the data provider. | ComboBox | ||
|
childrenCreated():void
Performs any final processing after child objects are created.
| UIComponent | |
|
collectionChangeHandler(event:Event):void
Responds to changes to the data provider.
| ComboBase | |
|
commitProperties():void
Processes the properties set on the component.
| UIComponent | |
|
createChildren():void
Create child objects of the component.
| UIComponent | |
|
createInFontContext(classObj:Class):Object
Creates a new object using a context
based on the embedded font being used.
| UIComponent | |
|
createInModuleContext(moduleFactory:IFlexModuleFactory, className:String):Object
Creates the object using a given moduleFactory.
| UIComponent | |
|
downArrowButton_buttonDownHandler(event:FlexEvent):void
Performs some action when the drop-down button is pressed.
| ComboBase | |
|
focusInHandler(event:FocusEvent):void
The event handler called when a UIComponent object gets focus.
| UIComponent | |
|
focusOutHandler(event:FocusEvent):void
The event handler called when a UIComponent object loses focus.
| UIComponent | |
|
initializationComplete():void
Finalizes the initialization of this component.
| UIComponent | |
|
initializeAccessibility():void
Initializes this component's accessibility code.
| UIComponent | |
|
isOurFocus(target:DisplayObject):Boolean
Typically overridden by components containing UITextField objects,
where the UITextField object gets focus.
| UIComponent | |
|
itemToUID(data:Object):String
Determines the UID for a dataProvider item.
| ComboBase | |
|
keyDownHandler(event:KeyboardEvent):void
The event handler called for a
keyDown event. | UIComponent | |
|
keyUpHandler(event:KeyboardEvent):void
The event handler called for a
keyUp event. | UIComponent | |
|
measure():void
Makes sure the control is at least 40 pixels wide,
and tall enough to fit one line of text
in the TextInput portion of the control but at least
22 pixels high.
| ComboBox | ||
|
resourcesChanged():void
This method is called when a UIComponent is constructed,
and again whenever the ResourceManager dispatches
a
"change" Event to indicate
that the localized resources have changed in some way. | UIComponent | |
|
textInput_changeHandler(event:Event):void
Handles changes to the TextInput that serves as the editable
text field in the component.
| ComboBase | |
|
updateDisplayList(unscaledWidth:Number, unscaledHeight:Number):void
Sizes and positions the internal components in the given width
and height.
| ComboBase | |
| Event | Summary | Defined by | ||
|---|---|---|---|---|
|
Dispatched when the component is added to a container as a content child
by using the addChild() or addChildAt() method. | UIComponent | ||
Dispatched when the ComboBox contents changes as a result of user
interaction, when the selectedIndex or
selectedItem property changes, and, if the ComboBox control
is editable, each time a keystroke is entered in the box. | ComboBox | |||
Dispatched when the drop-down list is dismissed for any reason such when
the user:
| ComboBox | |||
| 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 data property changes. | ComboBox | |||
| 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 if the editable property
is set to true and the user presses the Enter key
while typing in the editable text field. | ComboBox | |||
| Dispatched after the component has returned to the root view state. | UIComponent | ||
| Dispatched before the component exits from the root view state. | UIComponent | ||
| Dispatched when an object's state changes from visible to invisible. | UIComponent | ||
| Dispatched when the component has finished its construction and has all initialization properties set. | UIComponent | ||
| Dispatched when a component is monitored by a Validator and the validation failed. | UIComponent | ||
| Dispatched when user rolls the mouse out of a drop-down list item. | ComboBox | |||
| Dispatched when the user rolls the mouse over a drop-down list item. | ComboBox | |||
| Dispatched from a component opened using the PopUpManager when the user clicks outside it. | UIComponent | ||
| 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 when the user clicks the drop-down button to display the drop-down list. | ComboBox | |||
| Dispatched at the beginning of the component initialization sequence. | UIComponent | ||
|
Dispatched when the component is removed from a container as a content child
by using the removeChild() or removeChildAt() method. | UIComponent | ||
| Dispatched when the component is resized. | UIComponent | ||
| Dispatched when the user scrolls the ComboBox control's drop-down list. | ComboBox | |||
| Dispatched when an object's state changes from invisible to visible. | UIComponent | ||
| Dispatched by the component when it is time to create a ToolTip. | UIComponent | ||
| Dispatched by the component when its ToolTip has been hidden and will be discarded soon. | UIComponent | ||
| Dispatched by the component when its ToolTip is about to be hidden. | UIComponent | ||
| Dispatched by the component when its ToolTip is about to be shown. | UIComponent | ||
| Dispatched by the component when its ToolTip has been shown. | UIComponent | ||
|
Dispatched by a component whose toolTip property is set,
as soon as the user moves the mouse over it. | UIComponent | ||
|
Dispatched when an object has had its commitProperties(),
measure(), and
updateDisplayList() methods called (if needed). | UIComponent | ||
| Dispatched when a component is monitored by a Validator and the validation succeeded. | UIComponent | ||
| Dispatched when values are changed programmatically or by user interaction. | UIComponent | ||
| Style | Description | Defined by | ||
|---|---|---|---|---|
|
alternatingItemColors
| Type: Array Format: Color CSS Inheritance: yes The set of BackgroundColors for drop-down list rows in an alternating pattern. Value can be an Array of two of more colors. If undefined then the rows will use the drop-down list's
backgroundColor style.
The default value is undefined. | ComboBox | ||
|
arrowButtonWidth
| Type: Number Format: Length CSS Inheritance: no Width of the arrow button in pixels. The default value is 22. | ComboBox | ||
| Type: String CSS Inheritance: no The vertical distance in pixels from the top edge of the content area to the control's baseline position. | UIComponent | ||
|
borderColor
| Type: uint Format: Color CSS Inheritance: no Color of the border. The following controls support this style: Button, CheckBox, ComboBox, MenuBar, NumericStepper, ProgressBar, RadioButton, ScrollBar, Slider, and any components that support the borderStyle style.
The default value depends on the component class;
if not overriden for the class, the default value is 0xB7BABC.
| ComboBox | ||
|
borderThickness
| Type: Number Format: Length CSS Inheritance: no The thickness of the border of the drop-down list, in pixels. This value is overridden if you define borderThickness when setting the
dropdownStyleName CSSStyleDeclaration.
The default value is 1. | ComboBox | ||
| Type: String CSS Inheritance: no The vertical distance in pixels from the lower edge of the component to the lower edge of its content area. | UIComponent | ||
|
closeDuration
| Type: Number Format: Time CSS Inheritance: no The length of the transition when the drop-down list closes, in milliseconds. The default transition has the drop-down slide up into the ComboBox. The default value is 250. | ComboBox | ||
|
closeEasingFunction
| Type: Function CSS Inheritance: no An easing function to control the close transition. Easing functions can be used to control the acceleration and deceleration of the transition. The default value is undefined. | ComboBox | ||
|
color
| Type: uint Format: Color CSS Inheritance: yes Color of text in the component, including the component label. The default value is 0x0B333C. | ComboBox | ||
|
cornerRadius
| Type: Number Format: Length CSS Inheritance: no Radius of component corners. The following components support this style: Alert, Button, ComboBox, LinkButton, MenuBar, NumericStepper, Panel, ScrollBar, Tab, TitleWindow, and any component that supports a borderStyle property set to "solid".
The default value depends on the component class;
if not overriden for the class, the default value is 0.
| ComboBox | ||
|
disabledColor
| Type: uint Format: Color CSS Inheritance: yes Color of text in the component if it is disabled. The default value is 0xAAB3B3. | ComboBox | ||
|
disabledIconColor
| Type: uint Format: Color CSS Inheritance: yes The color for the icon in a disabled skin. For example, this style is used by the CheckBoxIcon skin class to draw the check mark for a disabled CheckBox control, by the ComboBoxSkin class to draw the down arrow of a disabled ComboBox control, and by the DateChooserMonthArrowSkin skin class to draw the month arrow for a disabled DateChooser control. The default value depends on the component class; if it is not overridden by the class, the default value is 0x999999.
| ComboBox | ||
| Type: Class CSS Inheritance: no Name of the class to use as the skin for the background and border when the control is disabled. | ComboBase | ||
| Type: Class CSS Inheritance: no Name of the class to use as the skin for the background and border when the user holds down the mouse button. | ComboBase | ||
|
dropdownBorderColor
| Type: uint Format: Color CSS Inheritance: yes The color of the border of the ComboBox. If undefined
the drop-down list will use its normal borderColor style. This style
is used by the validators to show the ComboBox in an error state.
The default value is undefined. | ComboBox | ||
|
dropdownStyleName
| Type: String CSS Inheritance: no The name of a CSSStyleDeclaration to be used by the drop-down list. This allows you to control the appearance of the drop-down list or its item renderers. The default value is "comboDropdown". | ComboBox | ||
|
dropDownStyleName
| Type: String CSS Inheritance: no The name of a CSSStyleDeclaration to be used by the drop-down list. This allows you to control the appearance of the drop-down list or its item renderers. [deprecated] The default value is "comboDropDown". | ComboBox | ||
| Type: Class CSS Inheritance: no Name of the class to use as the skin for the background and border when the control is disabled, and the editable
property is true. | ComboBase | ||
| Type: Class CSS Inheritance: no Name of the class to use as the skin for the background and border when the user holds down the mouse button, and the editable
property is true. | ComboBase | ||
| Type: Class CSS Inheritance: no Name of the class to use as the skin for the background and border when the mouse is over the control, and the editable
property is true. | ComboBase | ||
| Type: Class CSS Inheritance: no Name of the class to use as the skin for the background and border when the mouse is not over the control, and the editable
property is true. | ComboBase | ||
| Type: uint Format: Color CSS Inheritance: yes Color of the component highlight when validation fails. | UIComponent | ||
|
fillAlphas
| Type: Array CSS Inheritance: no Alphas used for the background fill of controls. Use [1, 1] to make the control background opaque. The default value is [ 0.6, 0.4 ]. | ComboBox | ||
|
fillColors
| Type: Array Format: Color CSS Inheritance: no Colors used to tint the background of the control. Pass the same color for both values for a flat-looking control. The default value is [ 0xFFFFFF, 0xCCCCCC ]. | ComboBox | ||
|
focusAlpha
| Type: Number CSS Inheritance: no Specifies the alpha transparency value of the focus skin. The default value is 0.4. | ComboBox | ||
| 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".
| ComboBox | ||
| 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". | ComboBox | ||
|
fontFamily
| Type: String CSS Inheritance: yes Name of the font to use. Unlike in a full CSS implementation, comma-separated lists are not supported. You can use any font family name. If you specify a generic font name, it is converted to an appropriate device font. The default value is "Verdana". | ComboBox | ||
|
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". | ComboBox | ||
|
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 is0. | ComboBox | ||
|
fontSize
| Type: Number Format: Length CSS Inheritance: yes Height of the text, in pixels. The default value is 10 for all controls except the ColorPicker control. For the ColorPicker control, the default value is 11. | ComboBox | ||
|
fontStyle
| Type: String CSS Inheritance: yes Determines whether the text is italic font. Recognized values are "normal" and "italic".
The default value is "normal". | ComboBox | ||
|
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 is0. | ComboBox | ||
|
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.
| ComboBox | ||
|
highlightAlphas
| Type: Array CSS Inheritance: no 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 ]. | ComboBox | ||
| Type: String CSS Inheritance: no The horizontal distance in pixels from the center of the component's content area to the center of the component. | UIComponent | ||
|
iconColor
| Type: uint Format: Color CSS Inheritance: yes The color for the icon in a skin. For example, this style is used by the CheckBoxIcon skin class to draw the check mark for a CheckBox control, by the ComboBoxSkin class to draw the down arrow of the ComboBox control, and by the DateChooserMonthArrowSkin skin class to draw the month arrow for the DateChooser control. The default value depends on the component class; if it is not overridden by the class, the default value is 0x111111.
| ComboBox | ||
|
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. | ComboBox | ||
|
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. | ComboBox | ||
| Type: String CSS Inheritance: no The horizontal distance in pixels from the left edge of the component's content area to the left edge of the component. | UIComponent | ||
|
letterSpacing
| Type: Number CSS Inheritance: yes The number of additional pixels to appear between each character. A positive value increases the character spacing beyond the normal spacing, while a negative value decreases it. The default value is 0. | ComboBox | ||
|
openDuration
| Type: Number Format: Time CSS Inheritance: no Length of the transition when the drop-down list opens, in milliseconds. The default transition has the drop-down slide down from the ComboBox. The default value is 250. | ComboBox | ||
|
openEasingFunction
| Type: Function CSS Inheritance: no An easing function to control the open transition. Easing functions can be used to control the acceleration and deceleration of the transition. The default value is undefined. | ComboBox | ||
| Type: Class CSS Inheritance: no Name of the class to use as the skin for the background and border when the mouse is over the control. | ComboBase | ||
|
paddingBottom
| Type: Number Format: Length CSS Inheritance: no Number of pixels between the control's bottom border and the bottom of its content area. When the editable property is true,
paddingTop and paddingBottom affect the size
of the ComboBox control, but do not affect the position of the editable text field.
The default value is 0. | ComboBox | ||
|
paddingLeft
| Type: Number Format: Length CSS Inheritance: no Number of pixels between the component's left border and the left edge of its content area. The default value is 0. The default value for a Button control is 10. The default value for the ComboBox control is 5. The default value for the Form container is 16. The default value for the Tree control is 2. | ComboBox | ||
|
paddingRight
| Type: Number Format: Length CSS Inheritance: no Number of pixels between the component's right border and the right edge of its content area. The default value is 0. The default value for a Button control is 10. The default value for the ComboBox control is 5. The default value for the Form container is 16. | ComboBox | ||
|
paddingTop
| Type: Number Format: Length CSS Inheritance: no Number of pixels between the control's top border and the top of its content area. When the editable property is true,
paddingTop and paddingBottom affect the size
of the ComboBox control, but do not affect the position of the editable text field.
The default value is 0. | ComboBox | ||
| Type: String CSS Inheritance: no The horizontal distance in pixels from the right edge of the component to the right edge of its content area. | UIComponent | ||
|
rollOverColor
| Type: uint Format: Color CSS Inheritance: yes The rollOverColor of the drop-down list. | ComboBox | ||
|
selectionColor
| Type: uint Format: Color CSS Inheritance: yes The selectionColor of the drop-down list. | ComboBox | ||
|
selectionDuration
| Type: uint Format: Time CSS Inheritance: no The selectionDuration of the drop-down list. The default value is 250. | ComboBox | ||
|
selectionEasingFunction
| Type: Function CSS Inheritance: no The selectionEasingFunction of the drop-down list. The default value is undefined. | ComboBox | ||
| Type: Class CSS Inheritance: no Name of the class to use as the default skin for the background and border. | ComboBase | ||
|
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 | ComboBox | ||
|
textDecoration
| Type: String CSS Inheritance: yes Determines whether the text is underlined. Possible values are "none" and "underline".
The default value is "none". | ComboBox | ||
|
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. | ComboBox | ||
| Type: String CSS Inheritance: no The style declaration for the internal TextInput subcomponent that displays the current selection. | ComboBase | ||
|
textRollOverColor
| Type: uint Format: Color CSS Inheritance: yes The textRollOverColor of the drop-down list. The default value is #2B333C. | ComboBox | ||
|
textSelectedColor
| Type: uint Format: Color CSS Inheritance: yes The textSelectedColor of the drop-down list. The default value is #2B333C. | ComboBox | ||
| Type: uint Format: Color CSS Inheritance: yes Theme color of a component. | UIComponent | ||
| Type: String CSS Inheritance: no The vertical distance in pixels from the top edge of the control's content area to the top edge of the component. | UIComponent | ||
| Type: Class CSS Inheritance: no Name of the class to use as the skin for the background and border when the mouse is not over the control. | ComboBase | ||
| Type: String CSS Inheritance: no The vertical distance in pixels from the center of the component's content area to the center of the component. | UIComponent | ||
| data | property |
data:Object [read-write]
The data property lets you pass a value
to the component when you use it in an item renderer or item editor.
You typically use data binding to bind a field of the data
property to a property of this component.
The ComboBox control uses the listData property and the
data property as follows. If the ComboBox is in a
DataGrid control, it expects the dataField property of the
column to map to a property in the data and sets
selectedItem to that property. If the ComboBox control is
in a List control, it expects the labelField of the list
to map to a property in the data and sets selectedItem to
that property.
Otherwise, it sets selectedItem to the data itself.
You do not set this property in MXML.
This property can be used as the source for data binding.
Implementation public function get data():Object
public function set data(value:Object):void
See also
| dataProvider | property |
dataProvider:Object [write-only]
This property can be used as the source for data binding.
Implementation public function set dataProvider(value:Object):void
| dropdown | property |
dropdown:ListBase [read-only]A reference to the List control that acts as the drop-down in the ComboBox.
Implementation public function get dropdown():ListBase
| dropdownFactory | property |
dropdownFactory:IFactory [read-write]The IFactory that creates a ListBase-derived instance to use as the drop-down. The default value is an IFactory for List
This property can be used as the source for data binding.
Implementation public function get dropdownFactory():IFactory
public function set dropdownFactory(value:IFactory):void
| dropDownStyleFilters | property |
dropDownStyleFilters:Object [read-only]The set of styles to pass from the ComboBox to the dropDown. Styles in the dropDownStyleName style will override these styles.
Implementation protected function get dropDownStyleFilters():Object
See also
| dropdownWidth | property |
dropdownWidth:Number [read-write]Width of the drop-down list, in pixels.
The default value is 100 or the width of the longest text
in the dataProvider, whichever is greater.
This property can be used as the source for data binding.
Implementation public function get dropdownWidth():Number
public function set dropdownWidth(value:Number):void
| itemRenderer | property |
itemRenderer:IFactory [read-write]IFactory that generates the instances that displays the data for the drop-down list of the control. You can use this property to specify a custom item renderer for the drop-down list.
The control uses a List control internally to create the drop-down list. The default item renderer for the List control is the ListItemRenderer class, which draws the text associated with each item in the list, and an optional icon.
Implementation public function get itemRenderer():IFactory
public function set itemRenderer(value:IFactory):void
See also
| labelField | property |
labelField:String [read-write]
Name of the field in the items in the dataProvider
Array to display as the label in the TextInput portion and drop-down list.
By default, the control uses a property named label
on each Array object and displays it.
However, if the dataProvider items do not contain
a label property, you can set the labelField
property to use a different property.
This property can be used as the source for data binding.
Implementation public function get labelField():String
public function set labelField(value:String):void
| labelFunction | property |
labelFunction:Function [read-write]
User-supplied function to run on each item to determine its label.
By default the control uses a property named label
on each dataProvider item to determine its label.
However, some data sets do not have a label property,
or do not have another property that can be used for displaying
as a label.
An example is a data set that has lastName and
firstName fields but you want to display full names.
You use labelFunction to specify a callback function
that uses the appropriate fields and return a displayable String.
The labelFunction takes a single argument which is the item in the dataProvider and returns a String:
myLabelFunction(item:Object):String
This property can be used as the source for data binding.
Implementation public function get labelFunction():Function
public function set labelFunction(value:Function):void
| listData | property |
listData:BaseListData [read-write]
When a component is used as a drop-in item renderer or drop-in item
editor, Flex initializes the listData property of the
component with the appropriate data from the List control. The
component can then use the listData property and the
data property to display the appropriate information
as a drop-in item renderer or drop-in item editor.
You do not set this property in MXML or ActionScript; Flex sets it when the component is used as a drop-in item renderer or drop-in item editor.
This property can be used as the source for data binding.
Implementation public function get listData():BaseListData
public function set listData(value:BaseListData):void
See also
| prompt | property |
prompt:String [read-write]
The prompt for the ComboBox control. A prompt is
a String that is displayed in the TextInput portion of the
ComboBox when selectedIndex = -1. It is usually
a String like "Select one...". If there is no
prompt, the ComboBox control sets selectedIndex to 0
and displays the first item in the dataProvider.
public function get prompt():String
public function set prompt(value:String):void
| rowCount | property |
rowCount:int [read-write]Maximum number of rows visible in the ComboBox control list. If there are fewer items in the dataProvider, the ComboBox shows only as many items as there are in the dataProvider.
The default value is 5.
This property can be used as the source for data binding.
Implementation public function get rowCount():int
public function set rowCount(value:int):void
| selectedIndex | property |
selectedIndex:int [write-only]Index of the selected item in the drop-down list. Setting this property sets the current index and displays the associated label in the TextInput portion.
The default value is -1, but it set to 0
when a dataProvider is assigned, unless there is a prompt.
If the control is editable, and the user types in the TextInput portion,
the value of the selectedIndex property becomes
-1. If the value of the selectedIndex
property is out of range, the selectedIndex property is set to the last
item in the dataProvider.
This property can be used as the source for data binding.
Implementation public function set selectedIndex(value:int):void
| selectedItem | property |
selectedItem:Object [write-only]
Contains a reference to the selected item in the
dataProvider.
If the data is an object or class instance, modifying
properties in the object or instance modifies the dataProvider
and thus its views. Setting the selectedItem itself causes the
ComboBox to select that item (display it in the TextInput portion and set
the selectedIndex) if it exists in the dataProvider.
If the ComboBox control is editable, the selectedItem
property is null if the user types any text
into the TextInput.
It has a value only if the user selects an item from the drop-down
list, or if it is set programmatically.
This property can be used as the source for data binding.
Implementation public function set selectedItem(value:Object):void
| selectedLabel | property |
selectedLabel:String [read-only]
The String displayed in the TextInput portion of the ComboBox. It
is calculated from the data by using the labelField
or labelFunction.
public function get selectedLabel():String
| ComboBox | () | constructor |
public function ComboBox()Constructor.
| calculatePreferredSizeFromData | () | method |
protected override function calculatePreferredSizeFromData(count:int):Object
Determines default values of the height and width to use for each
entry in the drop-down list, based on the maximum size of the label
text in the first numItems items in the data provider.
count:int — The number of items to check to determine the value.
|
Object — An Object containing two properties: width and height.
|
| close | () | method |
public function close(trigger:Event = null):voidHides the drop-down list.
Parameterstrigger:Event (default = null) |
| itemToLabel | () | method |
public function itemToLabel(item:Object):String
Returns a string representing the item parameter.
This method checks in the following order to find a value to return:
labelFunction property,
returns the result of passing the item to the function.labelField property, returns the contents of the property.item:Object |
String |
| measure | () | method |
protected override function measure():voidMakes sure the control is at least 40 pixels wide, and tall enough to fit one line of text in the TextInput portion of the control but at least 22 pixels high.
| open | () | method |
public function open():voidDisplays the drop-down list.
| change | event |
mx.events.ListEvent
mx.events.ListEvent.CHANGE
Dispatched when the ComboBox contents changes as a result of user
interaction, when the selectedIndex or
selectedItem property changes, and, if the ComboBox control
is editable, each time a keystroke is entered in the box.
The ListEvent.CHANGE constant defines the value of the
type property of the ListEvent object for a
change event, which indicates that selection
changed as a result of user interaction.
The properties of the event object have the following values:
| Property | Value |
|---|---|
bubbles | false |
cancelable | false |
columnIndex | The zero-based index of the column associated with the event. |
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. |
itemRenderer | The item renderer that was clicked. |
reason | null |
rowIndex | The zero-based index of the item associated with the event. |
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. |
Type | ListEvent.CHANGE |
| close | event |
mx.events.DropdownEvent
mx.events.DropdownEvent.CLOSE
Dispatched when the drop-down list is dismissed for any reason such when the user:
The DropdownEvent.CLOSE constant defines the value of the
type property of the event object for a close event.
The properties of the event object have the following values:
| Property | Value |
|---|---|
bubbles | false |
cancelable | false |
currentTarget | The Object that defines the
event listener that handles the event. For example, if you use
myButton.addEventListener() to register an event listener,
myButton is the value of the currentTarget. |
target | The Object that dispatched the event;
it is not always the Object listening for the event.
Use the currentTarget property to always access the
Object listening for the event. |
triggerEvent | A value indicating the type of input action that triggered the event. |
| dataChange | event |
mx.events.FlexEvent
mx.events.FlexEvent.DATA_CHANGE
Dispatched when the data property changes.
When you use a component as an item renderer,
the data property contains an item from the
dataProvider.
You can listen for this event and update the component
when the data property changes.
The FlexEvent.DATA_CHANGE constant defines the value of the
type property of the event object for a dataChange event.
The properties of the event object have the following values:
| Property | Value |
|---|---|
bubbles | false |
cancelable | false |
currentTarget | The Object that defines the
event listener that handles the event. For example, if you use
myButton.addEventListener() to register an event listener,
myButton is the value of the currentTarget. |
target | The Object that dispatched the event;
it is not always the Object listening for the event.
Use the currentTarget property to always access the
Object listening for the event. |
| enter | event |
mx.events.FlexEvent
mx.events.FlexEvent.ENTER
Dispatched if the editable property
is set to true and the user presses the Enter key
while typing in the editable text field.
The FlexEvent.ENTER constant defines the value of the
type property of the event object for a enter event.
The properties of the event object have the following values:
| Property | Value |
|---|---|
bubbles | false |
cancelable | false |
currentTarget | The Object that defines the
event listener that handles the event. For example, if you use
myButton.addEventListener() to register an event listener,
myButton is the value of the currentTarget. |
target | The Object that dispatched the event;
it is not always the Object listening for the event.
Use the currentTarget property to always access the
Object listening for the event. |
| itemRollOut | event |
mx.events.ListEvent
mx.events.ListEvent.ITEM_ROLL_OUT
Dispatched when user rolls the mouse out of a drop-down list item.
The event object's target property contains a reference
to the ComboBox and not the drop-down list.
The ListEvent.ITEM_ROLL_OUT constant defines the value of the
type property of the ListEvent object for an
itemRollOut event, which indicates that the user rolled
the mouse pointer out of a visual item in the control.
The properties of the event object have the following values:
| Property | Value |
|---|---|
bubbles | false |
cancelable | false |
columnIndex | The zero-based index of the column associated with the event. |
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. |
itemRenderer | The item renderer that was rolled out. |
reason | null |
rowIndex | The zero-based index of the item associated with the event. |
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. |
Type | ListEvent.ITEM_ROLL_OUT |
| itemRollOver | event |
mx.events.ListEvent
mx.events.ListEvent.ITEM_ROLL_OVER
Dispatched when the user rolls the mouse over a drop-down list item.
The event object's target property contains a reference
to the ComboBox and not the drop-down list.
The ListEvent.ITEM_ROLL_OVER constant defines the value of the
type property of the ListEvent object for an
itemRollOver event, which indicates that the user rolled
the mouse pointer over a visual item in the control.
The properties of the event object have the following values:
| Property | Value |
|---|---|
bubbles | false |
cancelable | false |
columnIndex | The zero-based index of the column associated with the event. |
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. |
itemRenderer | The item renderer that was rolled over. |
reason | null |
rowIndex | The zero-based index of the item associated with the event. |
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. |
Type | ListEvent.ITEM_ROLL_OVER |
| open | event |
mx.events.DropdownEvent
mx.events.DropdownEvent.OPEN
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.
The DropdownEvent.OPEN constant defines the value of the
type property of the event object for a open event.
The properties of the event object have the following values:
| Property | Value |
|---|---|
bubbles | false |
cancelable | false |
currentTarget | The Object that defines the
event listener that handles the event. For example, if you use
myButton.addEventListener() to register an event listener,
myButton is the value of the currentTarget. |
target | The Object that dispatched the event;
it is not always the Object listening for the event.
Use the currentTarget property to always access the
Object listening for the event. |
triggerEvent | A value indicating the type of input action that triggered the event. |
| scroll | event |
mx.events.ScrollEvent
mx.events.ScrollEvent.SCROLL
Dispatched when the user scrolls the ComboBox control's drop-down list.
The ScrollEvent.SCROLL constant defines the value of the
type property of the event object for a scroll 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. |
delta | Contains the change in scroll position, expressed in pixels. A positive value indicates the scroll was down or to the right. A negative value indicates the scroll was up or to the left. |
direction | Contains the
scroll direction, either ScrollEventDirection.HORIZONTAL or
ScrollEventDirection.VERTICAL. |
position | Contains the new scroll position. |
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. |