mx.controls.ComboBox (Flex 3.4)

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.

Public Properties

	Property		Defined By
		accessibilityProperties : AccessibilityProperties The current accessibility options for this display object.	DisplayObject
		activeEffects : Array [read-only] The list of effects that are currently playing on the component, as an Array of EffectInstance instances.	UIComponent
		alpha : Number Indicates the alpha transparency value of the object specified.	DisplayObject
		automationDelegate : Object The delegate object that handles the automation-related functionality.	UIComponent
		automationName : String Name that can be used as an identifier for this object.	UIComponent
		automationTabularData : Object [read-only] An implementation of the IAutomationTabularData interface, which can be used to retrieve the data.	UIComponent
		automationValue : Array [read-only] This value generally corresponds to the rendered appearance of the object and should be usable for correlating the identifier with the object as it appears visually within the application.	UIComponent
		baselinePosition : Number [read-only] The y-coordinate of the baseline of the first line of text of the component.	UIComponent
		blendMode : String A value from the BlendMode class that specifies which blend mode to use.	DisplayObject
		blendShader : Shader [write-only] Sets a shader that is used for blending the foreground and background.	DisplayObject
		buttonMode : Boolean Specifies the button mode of this sprite.	Sprite
		cacheAsBitmap : Boolean If set to true, Flash Player or Adobe AIR caches an internal bitmap representation of the display object.	DisplayObject
		cacheHeuristic : Boolean [write-only] Used by Flex to suggest bitmap caching for the object.	UIComponent
		cachePolicy : String Specifies the bitmap caching policy for this object.	UIComponent
		className : String [read-only] The name of this instance's class, such as "Button".	UIComponent
		constructor : Object A reference to the class object or constructor function for a given object instance.	Object
		contentMouseX : Number [read-only] Returns the x position of the mouse, in the content coordinate system.	UIComponent
		contentMouseY : Number [read-only] Returns the y position of the mouse, in the content coordinate system.	UIComponent
		contextMenu : NativeMenu Specifies the context menu associated with this object.	InteractiveObject
		currentState : String The current view state of the component.	UIComponent
		cursorManager : ICursorManager [read-only] Gets the CursorManager that controls the cursor for this component and its peers.	UIComponent
		data : Object The data property lets you pass a value to the component when you use it in an item renderer or item editor.	ComboBox
		dataProvider : Object [override] [write-only] The set of items this component displays.	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 [override] 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
		dropTarget : DisplayObject [read-only] Specifies the display object over which the sprite is being dragged, or on which the sprite was dropped.	Sprite
		editable : Boolean A flag that indicates whether the control is editable, which lets the user directly type entries that are not specified in the dataProvider, or not editable, which requires the user select from the items in the dataProvider.	ComboBase
		enabled : Boolean Whether the component can accept user interaction.	UIComponent
		errorString : String The text that will be displayed by a component's error tip when a component is monitored by a Validator and validation fails.	UIComponent
		explicitHeight : Number Number that specifies the explicit height of the component, in pixels, in the component's coordinates.	UIComponent
		explicitMaxHeight : Number The maximum recommended height of the component to be considered by the parent during layout.	UIComponent
		explicitMaxWidth : Number The maximum recommended width of the component to be considered by the parent during layout.	UIComponent
		explicitMinHeight : Number The minimum recommended height of the component to be considered by the parent during layout.	UIComponent
		explicitMinWidth : Number The minimum recommended width of the component to be considered by the parent during layout.	UIComponent
		explicitWidth : Number Number that specifies the explicit width of the component, in pixels, in the component's coordinates.	UIComponent
		filters : Array An indexed array that contains each filter object currently associated with the display object.	DisplayObject
		flexContextMenu : IFlexContextMenu The context menu for this UIComponent.	UIComponent
		focusEnabled : Boolean Indicates whether the component can receive focus when tabbed to.	UIComponent
		focusManager : IFocusManager Gets the FocusManager that controls focus for this component and its peers.	UIComponent
		focusPane : Sprite The focus pane associated with this object.	UIComponent
		focusRect : Object Specifies whether this object displays a focus rectangle.	InteractiveObject
		graphics : Graphics [read-only] Specifies the Graphics object that belongs to this sprite where vector drawing commands can occur.	Sprite
		height : Number [override] Number that specifies the height of the component, in pixels, in the parent's coordinates.	UIComponent
		hitArea : Sprite Designates another sprite to serve as the hit area for a sprite.	Sprite
		id : String ID of the component.	UIComponent
		imeMode : String Specifies the IME (input method editor) mode.	ComboBase
		includeInLayout : Boolean Specifies whether this component is included in the layout of the parent container.	UIComponent
		inheritingStyles : Object The beginning of this component's chain of inheriting styles.	UIComponent
		initialized : Boolean A flag that determines if an object has been through all three phases of layout: commitment, measurement, and layout (provided that any were required).	UIComponent
		instanceIndex : int [read-only] The index of a repeated component.	UIComponent
		instanceIndices : Array An Array containing the indices required to reference this UIComponent object from its parent document.	UIComponent
		isDocument : Boolean [read-only] Determines whether this UIComponent instance is a document object, that is, whether it is at the top of the hierarchy of a Flex application, MXML component, or ActionScript component.	UIComponent
		isPopUp : Boolean Set to true by the PopUpManager to indicate that component has been popped up.	UIComponent
		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
		loaderInfo : LoaderInfo [read-only] Returns a LoaderInfo object containing information about loading the file to which this display object belongs.	DisplayObject
		mask : DisplayObject The calling display object is masked by the specified mask object.	DisplayObject
		maxHeight : Number The maximum recommended height of the component to be considered by the parent during layout.	UIComponent
		maxWidth : Number The maximum recommended width of the component to be considered by the parent during layout.	UIComponent
		measuredHeight : Number The default height of the component, in pixels.	UIComponent
		measuredMinHeight : Number The default minimum height of the component, in pixels.	UIComponent
		measuredMinWidth : Number The default minimum width of the component, in pixels.	UIComponent
		measuredWidth : Number The default width of the component, in pixels.	UIComponent
		minHeight : Number The minimum recommended height of the component to be considered by the parent during layout.	UIComponent
		minWidth : Number The minimum recommended width of the component to be considered by the parent during layout.	UIComponent
		moduleFactory : IFlexModuleFactory The moduleFactory that is used to create TextFields in the correct SWF context.	UIComponent
		mouseChildren : Boolean Determines whether or not the children of the object are mouse enabled.	DisplayObjectContainer
		mouseEnabled : Boolean Specifies whether this object receives mouse messages.	InteractiveObject
		mouseFocusEnabled : Boolean Whether you can receive focus when clicked on.	UIComponent
		mouseX : Number [read-only] Indicates the x coordinate of the mouse position, in pixels.	DisplayObject
		mouseY : Number [read-only] Indicates the y coordinate of the mouse position, in pixels.	DisplayObject
		name : String Indicates the instance name of the DisplayObject.	DisplayObject
		nestLevel : int Depth of this object in the containment hierarchy.	UIComponent
		nonInheritingStyles : Object The beginning of this component's chain of non-inheriting styles.	UIComponent
		numAutomationChildren : int [read-only] The number of automation children this container has.	UIComponent
		numChildren : int [read-only] Returns the number of children of this object.	DisplayObjectContainer
		opaqueBackground : Object Specifies whether the display object is opaque with a certain background color.	DisplayObject
		owner : DisplayObjectContainer The owner of this UIComponent.	UIComponent
		parent : DisplayObjectContainer [override] [read-only] The parent container or component for this component.	UIComponent
		parentApplication : Object [read-only] A reference to the Application object that contains this UIComponent instance.	UIComponent
		parentDocument : Object [read-only] A reference to the parent document object for this UIComponent.	UIComponent
		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
		prototype : Object [static] A reference to the prototype object of a class or function object.	Object
		repeater : IRepeater [read-only] A reference to the Repeater object in the parent document that produced this UIComponent.	UIComponent
		repeaterIndex : int [read-only] The index of the item in the data provider of the Repeater that produced this UIComponent.	UIComponent
		repeaterIndices : Array An Array containing the indices of the items in the data provider of the Repeaters in the parent document that produced this UIComponent.	UIComponent
		repeaters : Array An Array containing references to the Repeater objects in the parent document that produced this UIComponent.	UIComponent
		restrict : String Set of characters that a user can or cannot enter into the text field.	ComboBase
		root : DisplayObject [read-only] For a display object in a loaded SWF file, the root property is the top-most display object in the portion of the display list's tree structure represented by that SWF file.	DisplayObject
		rotation : Number Indicates the rotation of the DisplayObject instance, in degrees, from its original orientation.	DisplayObject
		rotationX : Number Indicates the x-axis rotation of the DisplayObject instance, in degrees, from its original orientation relative to the 3D parent container.	DisplayObject
		rotationY : Number Indicates the y-axis rotation of the DisplayObject instance, in degrees, from its original orientation relative to the 3D parent container.	DisplayObject
		rotationZ : Number Indicates the z-axis rotation of the DisplayObject instance, in degrees, from its original orientation relative to the 3D parent container.	DisplayObject
		rowCount : int Maximum number of rows visible in the ComboBox control list.	ComboBox
		scale9Grid : Rectangle The current scaling grid that is in effect.	DisplayObject
		scaleX : Number [override] Number that specifies the horizontal scaling factor.	UIComponent
		scaleY : Number [override] Number that specifies the vertical scaling factor.	UIComponent
		scaleZ : Number Indicates the depth scale (percentage) of an object as applied from the registration point of the object.	DisplayObject
		screen : Rectangle [read-only] Returns an object that contains the size and position of the base drawing surface for this object.	UIComponent
		scrollRect : Rectangle The scroll rectangle bounds of the display object.	DisplayObject
		selectedIndex : int [override] [write-only] Index of the selected item in the drop-down list.	ComboBox
		selectedItem : Object [override] [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
		soundTransform : flash.media:SoundTransform Controls sound within this sprite.	Sprite
		stage : Stage [read-only] The Stage of the display object.	DisplayObject
		states : Array The view states that are defined for this component.	UIComponent
		styleDeclaration : CSSStyleDeclaration Storage for the inline inheriting styles on this object.	UIComponent
		styleName : Object The class style used by this component.	UIComponent
		systemManager : ISystemManager Returns the SystemManager object used by this component.	UIComponent
		tabChildren : Boolean Determines whether the children of the object are tab enabled.	DisplayObjectContainer
		tabEnabled : Boolean Specifies whether this object is in the tab order.	InteractiveObject
		tabIndex : int Specifies the tab ordering of objects in a SWF file.	InteractiveObject
		text : String Contents of the text field.	ComboBase
		textSnapshot : flash.text:TextSnapshot [read-only] Returns a TextSnapshot object for this DisplayObjectContainer instance.	DisplayObjectContainer
		toolTip : String Text to display in the ToolTip.	UIComponent
		transform : flash.geom:Transform An object with properties pertaining to a display object's matrix, color transform, and pixel bounds.	DisplayObject
		transitions : Array An Array of Transition objects, where each Transition object defines a set of effects to play when a view state change occurs.	UIComponent
		tweeningProperties : Array Array of properties that are currently being tweened on this object.	UIComponent
		uid : String A unique identifier for the object.	UIComponent
		updateCompletePendingFlag : Boolean A flag that determines if an object has been through all three phases of layout validation (provided that any were required).	UIComponent
		useHandCursor : Boolean A Boolean value that indicates whether the pointing hand (hand cursor) appears when the mouse rolls over a sprite in which the buttonMode property is set to true.	Sprite
		validationSubField : String Used by a validator to associate a subfield with this component.	UIComponent
		value : Object [read-only] The value of the selected item.	ComboBase
		visible : Boolean [override] Controls the visibility of this UIComponent.	UIComponent
		width : Number [override] Number that specifies the width of the component, in pixels, in the parent's coordinates.	UIComponent
		x : Number [override] Number that specifies the component's horizontal position, in pixels, within its parent container.	UIComponent
		y : Number [override] Number that specifies the component's vertical position, in pixels, within its parent container.	UIComponent
		z : Number Indicates the z coordinate position along the z-axis of the DisplayObject instance relative to the 3D parent container.	DisplayObject

	Property	Defined By
		arrowButtonStyleFilters : Object [read-only] Set of styles to pass from the ComboBase to the down arrow button	ComboBase
		borderMetrics : EdgeMetrics [read-only] 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] 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
		resourceManager : IResourceManager [read-only] A reference to the object which manages all of the application's localized resources.	UIComponent
		textInput : mx.controls:TextInput The internal TextInput subcomponent that displays the current selection.	ComboBase
		textInputStyleFilters : Object [read-only] The set of styles to pass from the ComboBase to the text input.	ComboBase
		unscaledHeight : Number [read-only] A convenience method for determining the unscaled height of the component.	UIComponent
		unscaledWidth : Number [read-only] A convenience method for determining the unscaled width of the component All of a component's drawing and child layout should be done within a bounding rectangle of this width, which is also passed as an argument to updateDisplayList().	UIComponent

Public Methods

Hide Inherited Public Methods

Show Inherited Public Methods

	Method		Defined By
		ComboBox() Constructor.	ComboBox
		addChild(child:DisplayObject):DisplayObject Adds a child DisplayObject instance to this DisplayObjectContainer instance.	DisplayObjectContainer
		addChildAt(child:DisplayObject, index:int):DisplayObject Adds a child DisplayObject instance to this DisplayObjectContainer instance.	DisplayObjectContainer
		addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void Registers an event listener object with an EventDispatcher object so that the listener receives notification of an event.	EventDispatcher
		areInaccessibleObjectsUnderPoint(point:Point):Boolean Indicates whether the security restrictions would cause any display objects to be omitted from the list returned by calling the DisplayObjectContainer.getObjectsUnderPoint() method with the specified point point.	DisplayObjectContainer
		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
		contains(child:DisplayObject):Boolean Determines whether the specified display object is a child of the DisplayObjectContainer instance or the instance itself.	DisplayObjectContainer
		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
		determineTextFormatFromStyles():mx.core:UITextFormat Returns a UITextFormat object corresponding to the text styles for this UIComponent.	UIComponent
		dispatchEvent(event:Event):Boolean [override] 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
		getBounds(targetCoordinateSpace:DisplayObject):Rectangle Returns a rectangle that defines the area of the display object relative to the coordinate system of the targetCoordinateSpace object.	DisplayObject
		getChildAt(index:int):DisplayObject Returns the child display object instance that exists at the specified index.	DisplayObjectContainer
		getChildByName(name:String):DisplayObject Returns the child display object that exists with the specified name.	DisplayObjectContainer
		getChildIndex(child:DisplayObject):int Returns the index position of a child DisplayObject instance.	DisplayObjectContainer
		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
		getObjectsUnderPoint(point:Point):Array Returns an array of objects that lie under the specified point and are children (or grandchildren, and so on) of this DisplayObjectContainer instance.	DisplayObjectContainer
		getRect(targetCoordinateSpace:DisplayObject):Rectangle Returns a rectangle that defines the boundary of the display object, based on the coordinate system defined by the targetCoordinateSpace parameter, excluding any strokes on shapes.	DisplayObject
		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
		globalToLocal(point:Point):Point Converts the point object from the Stage (global) coordinates to the display object's (local) coordinates.	DisplayObject
		globalToLocal3D(point:Point):Vector3D Converts a two-dimensional point from the Stage (global) coordinates to a three-dimensional display object's (local) coordinates.	DisplayObject
		hasEventListener(type:String):Boolean Checks whether the EventDispatcher object has any listeners registered for a specific type of event.	EventDispatcher
		hasOwnProperty(name:String):Boolean Indicates whether an object has a specified property defined.	Object
		hitTestObject(obj:DisplayObject):Boolean Evaluates the bounding box of the display object to see if it overlaps or intersects with the bounding box of the obj display object.	DisplayObject
		hitTestPoint(x:Number, y:Number, shapeFlag:Boolean = false):Boolean Evaluates the display object to see if it overlaps or intersects with the point specified by the x and y parameters.	DisplayObject
		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
		isPrototypeOf(theClass:Object):Boolean Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.	Object
		itemToLabel(item:Object):String Returns a string representing the item parameter.	ComboBox
		local3DToGlobal(point3d:Vector3D):Point Converts a three-dimensional point of the three-dimensional display object's (local) coordinates to a two-dimensional point in the Stage (global) coordinates.	DisplayObject
		localToContent(point:Point):Point Converts a Point object from local to content coordinates.	UIComponent
		localToGlobal(point:Point):Point Converts the point object from the display object's (local) coordinates to the Stage (global) coordinates.	DisplayObject
		measureHTMLText(htmlText:String):flash.text: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):flash.text: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
		propertyIsEnumerable(name:String):Boolean Indicates whether the specified property exists and is enumerable.	Object
		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
		removeChild(child:DisplayObject):DisplayObject Removes the specified child DisplayObject instance from the child list of the DisplayObjectContainer instance.	DisplayObjectContainer
		removeChildAt(index:int):DisplayObject Removes a child DisplayObject from the specified index position in the child list of the DisplayObjectContainer.	DisplayObjectContainer
		removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void Removes a listener from the EventDispatcher object.	EventDispatcher
		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
		setChildIndex(child:DisplayObject, index:int):void Changes the position of an existing child in the display object container.	DisplayObjectContainer
		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
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Sets the availability of a dynamic property for loop operations.	Object
		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
		startDrag(lockCenter:Boolean = false, bounds:Rectangle = null):void Lets the user drag the specified sprite.	Sprite
		stopDrag():void Ends the startDrag() method.	Sprite
		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
		swapChildren(child1:DisplayObject, child2:DisplayObject):void Swaps the z-order (front-to-back order) of the two specified child objects.	DisplayObjectContainer
		swapChildrenAt(index1:int, index2:int):void Swaps the z-order (front-to-back order) of the child objects at the two specified index positions in the child list.	DisplayObjectContainer
		toLocaleString():String Returns the string representation of this object, formatted according to locale-specific conventions.	Object
		toString():String [override] 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
		valueOf():Object Returns the primitive value of the specified object.	Object
		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
		willTrigger(type:String):Boolean Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type.	EventDispatcher

	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 [override] 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 [override] 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 [override] Sizes and positions the internal components in the given width and height.	ComboBase

Events

Hide Inherited Events

Show Inherited Events

	Summary	Defined By
activate	[broadcast event] Dispatched when the Flash Player or AIR application gains operating system focus and becomes active.	EventDispatcher
add	Dispatched when the component is added to a container as a content child by using the addChild() or addChildAt() method.	UIComponent
added	Dispatched when a display object is added to the display list.	DisplayObject
addedToStage	Dispatched when a display object is added to the on stage display list, either directly or through the addition of a sub tree in which the display object is contained.	DisplayObject
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.	ComboBox
clear	Dispatched when the user selects 'Clear' (or 'Delete') from the text context menu.	InteractiveObject
click	Dispatched when a user presses and releases the main button of the user's pointing device over the same InteractiveObject.	InteractiveObject
close	Dispatched when the drop-down list is dismissed for any reason such when the user: selects an item in the drop-down list clicks outside of the drop-down list clicks the drop-down button while the drop-down list is displayed presses the ESC key while the drop-down list is displayed	ComboBox
contextMenu	Dispatched when a user gesture triggers the context menu associated with this interactive object in an AIR application.	InteractiveObject
copy	Dispatched when the user activates the platform specific accelerator key combination for a copy operation or selects 'Copy' from the text context menu.	InteractiveObject
creationComplete	Dispatched when the component has finished its construction, property processing, measuring, layout, and drawing.	UIComponent
currentStateChange	Dispatched after the view state has changed.	UIComponent
currentStateChanging	Dispatched after the currentState property changes, but before the view state changes.	UIComponent
cut	Dispatched when the user activates the platform specific accelerator key combination for a cut operation or selects 'Cut' from the text context menu.	InteractiveObject
dataChange	Dispatched when the data property changes.	ComboBox
deactivate	[broadcast event] Dispatched when the Flash Player or AIR application operating loses system focus and is becoming inactive.	EventDispatcher
doubleClick	Dispatched when a user presses and releases the main button of a pointing device twice in rapid succession over the same InteractiveObject when that object's doubleClickEnabled flag is set to true.	InteractiveObject
dragComplete	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
dragDrop	Dispatched by the drop target when the user releases the mouse over it.	UIComponent
dragEnter	Dispatched by a component when the user moves the mouse over the component during a drag operation.	UIComponent
dragExit	Dispatched by the component when the user drags outside the component, but does not drop the data onto the target.	UIComponent
dragOver	Dispatched by a component when the user moves the mouse while over the component during a drag operation.	UIComponent
dragStart	Dispatched by the drag initiator when starting a drag operation.	UIComponent
effectEnd	Dispatched after an effect ends.	UIComponent
effectStart	Dispatched just before an effect starts.	UIComponent
enter	Dispatched if the editable property is set to true and the user presses the Enter key while typing in the editable text field.	ComboBox
enterFrame	[broadcast event] Dispatched when the playhead is entering a new frame.	DisplayObject
enterState	Dispatched after the component has returned to the root view state.	UIComponent
exitFrame	[broadcast event] Dispatched when the playhead is exiting the current frame.	DisplayObject
exitState	Dispatched before the component exits from the root view state.	UIComponent
focusIn	Dispatched after a display object gains focus.	InteractiveObject
focusOut	Dispatched after a display object loses focus.	InteractiveObject
frameConstructed	[broadcast event] Dispatched after the constructors of frame display objects have run but before frame scripts have run.	DisplayObject
hide	Dispatched when an object's state changes from visible to invisible.	UIComponent
initialize	Dispatched when the component has finished its construction and has all initialization properties set.	UIComponent
invalid	Dispatched when a component is monitored by a Validator and the validation failed.	UIComponent
itemRollOut	Dispatched when user rolls the mouse out of a drop-down list item.	ComboBox
itemRollOver	Dispatched when the user rolls the mouse over a drop-down list item.	ComboBox
keyDown	Dispatched when the user presses a key.	InteractiveObject
keyFocusChange	Dispatched when the user attempts to change focus by using keyboard navigation.	InteractiveObject
keyUp	Dispatched when the user releases a key.	InteractiveObject
middleClick	Dispatched when a user presses and releases the middle button of the user's pointing device over the same InteractiveObject.	InteractiveObject
middleMouseDown	Dispatched when a user presses the middle pointing device button over an InteractiveObject instance.	InteractiveObject
middleMouseUp	Dispatched when a user releases the pointing device button over an InteractiveObject instance.	InteractiveObject
mouseDown	Dispatched when a user presses the pointing device button over an InteractiveObject instance.	InteractiveObject
mouseDownOutside	Dispatched from a component opened using the PopUpManager when the user clicks outside it.	UIComponent
mouseFocusChange	Dispatched when the user attempts to change focus by using a pointer device.	InteractiveObject
mouseMove	Dispatched when a user moves the pointing device while it is over an InteractiveObject.	InteractiveObject
mouseOut	Dispatched when the user moves a pointing device away from an InteractiveObject instance.	InteractiveObject
mouseOver	Dispatched when the user moves a pointing device over an InteractiveObject instance.	InteractiveObject
mouseUp	Dispatched when a user releases the pointing device button over an InteractiveObject instance.	InteractiveObject
mouseWheel	Dispatched when a mouse wheel is spun over an InteractiveObject instance.	InteractiveObject
mouseWheelOutside	Dispatched from a component opened using the PopUpManager when the user scrolls the mouse wheel outside it.	UIComponent
move	Dispatched when the object has moved.	UIComponent
nativeDragComplete	Dispatched by the drag initiator InteractiveObject when the user releases the drag gesture.	InteractiveObject
nativeDragDrop	Dispatched by the target InteractiveObject when a dragged object is dropped on it and the drop has been accepted with a call to DragManager.acceptDragDrop().	InteractiveObject
nativeDragEnter	Dispatched by an InteractiveObject when a drag gesture enters its boundary.	InteractiveObject
nativeDragExit	Dispatched by an InteractiveObject when a drag gesture leaves its boundary.	InteractiveObject
nativeDragOver	Dispatched by an InteractiveObject continually while a drag gesture remains within its boundary.	InteractiveObject
nativeDragStart	Dispatched at the beginning of a drag operation by the InteractiveObject that is specified as the drag initiator in the DragManager.doDrag() call.	InteractiveObject
nativeDragUpdate	Dispatched during a drag operation by the InteractiveObject that is specified as the drag initiator in the DragManager.doDrag() call.	InteractiveObject
open	Dispatched when the user clicks the drop-down button to display the drop-down list.	ComboBox
paste	Dispatched when the user activates the platform specific accelerator key combination for a paste operation or selects 'Paste' from the text context menu.	InteractiveObject
preinitialize	Dispatched at the beginning of the component initialization sequence.	UIComponent
remove	Dispatched when the component is removed from a container as a content child by using the removeChild() or removeChildAt() method.	UIComponent
removed	Dispatched when a display object is about to be removed from the display list.	DisplayObject
removedFromStage	Dispatched when a display object is about to be removed from the display list, either directly or through the removal of a sub tree in which the display object is contained.	DisplayObject
render	[broadcast event] Dispatched when the display list is about to be updated and rendered.	DisplayObject
resize	Dispatched when the component is resized.	UIComponent
rightClick	Dispatched when a user presses and releases the right button of the user's pointing device over the same InteractiveObject.	InteractiveObject
rightMouseDown	Dispatched when a user presses the pointing device button over an InteractiveObject instance.	InteractiveObject
rightMouseUp	Dispatched when a user releases the pointing device button over an InteractiveObject instance.	InteractiveObject
rollOut	Dispatched when the user moves a pointing device away from an InteractiveObject instance.	InteractiveObject
rollOver	Dispatched when the user moves a pointing device over an InteractiveObject instance.	InteractiveObject
scroll	Dispatched when the user scrolls the ComboBox control's drop-down list.	ComboBox
selectAll	Dispatched when the user activates the platform specific accelerator key combination for a select all operation or selects 'Select All' from the text context menu.	InteractiveObject
show	Dispatched when an object's state changes from invisible to visible.	UIComponent
tabChildrenChange	Dispatched when the value of the object's tabChildren flag changes.	InteractiveObject
tabEnabledChange	Dispatched when the object's tabEnabled flag changes.	InteractiveObject
tabIndexChange	Dispatched when the value of the object's tabIndex property changes.	InteractiveObject
textInput	Dispatched when a user enters one or more characters of text.	InteractiveObject
toolTipCreate	Dispatched by the component when it is time to create a ToolTip.	UIComponent
toolTipEnd	Dispatched by the component when its ToolTip has been hidden and will be discarded soon.	UIComponent
toolTipHide	Dispatched by the component when its ToolTip is about to be hidden.	UIComponent
toolTipShow	Dispatched by the component when its ToolTip is about to be shown.	UIComponent
toolTipShown	Dispatched by the component when its ToolTip has been shown.	UIComponent
toolTipStart	Dispatched by a component whose toolTip property is set, as soon as the user moves the mouse over it.	UIComponent
updateComplete	Dispatched when an object has had its commitProperties(), measure(), and updateDisplayList() methods called (if needed).	UIComponent
valid	Dispatched when a component is monitored by a Validator and the validation succeeded.	UIComponent
valueCommit	Dispatched when values are changed programmatically or by user interaction.	UIComponent

Styles

Hide Inherited Styles

Show Inherited Styles

	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
baseline	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
bottom	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
disabledSkin	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
downSkin	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 Deprecated: Please Use dropdownStyleName 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
editableDisabledSkin	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
editableDownSkin	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
editableOverSkin	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
editableUpSkin	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
errorColor	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
focusBlendMode	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
focusSkin	Type: Class CSS Inheritance: no Skin used to draw the focus rectangle.	UIComponent
focusThickness	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 `"advanced"`, which enables advanced anti-aliasing for the font. Set to `"normal"` to disable the advanced anti-aliasing. This style has no effect for system fonts. This style applies to all the text in a TextField subcontrol; you cannot apply it to some characters and not others. The default value is `"advanced"`. See also flash.text.TextField flash.text.AntiAliasType	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 `fontAntiAliasType` property is set to `"advanced"`. This style has no effect for system fonts. This style applies to all the text in a TextField subcontrol; you can't apply it to some characters and not others. The default value is `"pixel"`. See also flash.text.TextField flash.text.GridFitType	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 `fontAntiAliasType` property is set to `"advanced"`. This style has no effect for system fonts. This style applies to all the text in a TextField subcontrol; you can't apply it to some characters and not others. The default value is `0`. See also flash.text.TextField	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 `fontAntiAliasType` property is set to `"advanced"`. This style has no effect on system fonts. This style applies to all the text in a TextField subcontrol; you can't apply it to some characters and not others. The default value is `0`. See also flash.text.TextField	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
horizontalCenter	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
left	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
overSkin	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
right	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. See also mx.controls.List	ComboBox
selectionColor	Type: uint Format: Color CSS Inheritance: yes The selectionColor of the drop-down list. See also mx.controls.List	ComboBox
selectionDuration	Type: uint Format: Time CSS Inheritance: no The selectionDuration of the drop-down list. The default value is `250`. See also mx.controls.List	ComboBox
selectionEasingFunction	Type: Function CSS Inheritance: no The selectionEasingFunction of the drop-down list. The default value is `undefined`. See also mx.controls.List	ComboBox
skin	Type: Class CSS Inheritance: no Name of the class to use as the default skin for the background and border. You can use the skin style to assign the skin for the following skin states: up, over, down, disabled, editableUp, editableOver, editableDown, editableDisabled.	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 `"left"`. For the FormItem component, the default value is `"right"`. For the Button, LinkButton, and AccordionHeader components, the default value is `"center"`, and this property is only recognized when the `labelPlacement` property is set to `"left"` or `"right"`. If `labelPlacement` is set to `"top"` or `"bottom"`, the text and any icon are centered.	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
textInputStyleName	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`. See also mx.controls.List	ComboBox
textSelectedColor	Type: uint Format: Color CSS Inheritance: yes The textSelectedColor of the drop-down list. The default value is `#2B333C`. See also mx.controls.List	ComboBox
themeColor	Type: uint Format: Color CSS Inheritance: yes Theme color of a component.	UIComponent
top	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
upSkin	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
verticalCenter	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

Description	Defined By
addedEffect	Triggering Event: added Played when the component is added as a child to a Container.	UIComponent
creationCompleteEffect	Triggering Event: creationComplete Played when the component is created.	UIComponent
focusInEffect	Triggering Event: focusIn Played when the component gains keyboard focus.	UIComponent
focusOutEffect	Triggering Event: focusOut Played when the component loses keyboard focus.	UIComponent
hideEffect	Triggering Event: hide Played when the component becomes invisible.	UIComponent
mouseDownEffect	Triggering Event: mouseDown Played when the user presses the mouse button while over the component.	UIComponent
mouseUpEffect	Triggering Event: mouseUp Played when the user releases the mouse button while over the component.	UIComponent
moveEffect	Triggering Event: move Played when the component is moved.	UIComponent
removedEffect	Triggering Event: removed Played when the component is removed from a Container.	UIComponent
resizeEffect	Triggering Event: resize Played when the component is resized.	UIComponent
rollOutEffect	Triggering Event: rollOut Played when the user rolls the mouse so it is no longer over the component.	UIComponent
rollOverEffect	Triggering Event: rollOver Played when the user rolls the mouse over the component.	UIComponent
showEffect	Triggering Event: show Played when the component becomes visible.	UIComponent

	Constant	Defined By
		DEFAULT_MAX_HEIGHT : Number = 10000 [static] The default value for the maxHeight property.	UIComponent
		DEFAULT_MAX_WIDTH : Number = 10000 [static] The default value for the maxWidth property.	UIComponent
		DEFAULT_MEASURED_HEIGHT : Number = 22 [static] The default value for the measuredHeight property.	UIComponent
		DEFAULT_MEASURED_MIN_HEIGHT : Number = 22 [static] The default value for the measuredMinHeight property.	UIComponent
		DEFAULT_MEASURED_MIN_WIDTH : Number = 40 [static] The default value for the measuredMinWidth property.	UIComponent
		DEFAULT_MEASURED_WIDTH : Number = 160 [static] The default value for the measuredWidth property.	UIComponent

Property Detail

data

property

data:Object

The data property lets you pass a value to the component when you use it in an item renderer or item editor. You typically use data binding to bind a field of the data property to a property of this component.

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. When this property is modified, it dispatches the dataChange event.

Implementation
public function get data():Object
public function set data(value:Object):void

See also

mx.core.IDataRenderer

dataProvider

property

dataProvider:Object [write-only] [override]

The set of items this component displays. This property is of type Object because the derived classes can handle a variety of data types such as Arrays, XML, ICollectionViews, and other classes. All are converted into an ICollectionView and that ICollectionView is returned if you get the value of this property; you will not get the value you set if it was not an ICollectionView.

Setting this property will adjust the selectedIndex property (and therefore the selectedItem property) if the selectedIndex property has not otherwise been set. If there is no prompt property, the selectedIndex property will be set to 0; otherwise it will remain at -1, the index used for the prompt string. If the selectedIndex property has been set and it is out of range of the new data provider, unexpected behavior is likely to occur.

This property can be used as the source for data binding. When this property is modified, it dispatches the collectionChange event.

Implementation
override 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

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. When this property is modified, it dispatches the dropdownFactoryChanged event.

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

mx.styles.StyleProxy

dropdownWidth

property

dropdownWidth:Number

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. When this property is modified, it dispatches the dropdownWidthChanged event.

Implementation
public function get dropdownWidth():Number
public function set dropdownWidth(value:Number):void

itemRenderer

property

itemRenderer:IFactory

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

labelField

property

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. 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. When this property is modified, it dispatches the labelFieldChanged event.

Implementation
public function get labelField():String
public function set labelField(value:String):void

labelFunction

property

labelFunction:Function

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. When this property is modified, it dispatches the labelFunctionChanged event.

Implementation
public function get labelFunction():Function
public function set labelFunction(value:Function):void

listData

property

listData:BaseListData

When a component is used as a drop-in item renderer or drop-in item editor, Flex initializes the listData property of the component with the appropriate data from the List control. The component can then use the listData property 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. When this property is modified, it dispatches the dataChange event.

Implementation
public function get listData():BaseListData
public function set listData(value:BaseListData):void

prompt

property

prompt:String

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.

Implementation
public function get prompt():String
public function set prompt(value:String):void

rowCount

property

rowCount:int

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. When this property is modified, it dispatches the resize event.

Implementation
public function get rowCount():int
public function set rowCount(value:int):void

selectedIndex

property

selectedIndex:int [write-only] [override]

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. When this property is modified, it dispatches the valueCommit event.

Implementation
override public function set selectedIndex(value:int):void

selectedItem

property

selectedItem:Object [write-only] [override]

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. When this property is modified, it dispatches the valueCommit event.

Implementation
override 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.

Implementation
public function get selectedLabel():String

Constructor Detail

ComboBox

()

Constructor

public function ComboBox()

Constructor.

Method Detail

calculatePreferredSizeFromData

()

method

override protected 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.

Parameters

count:int — The number of items to check to determine the value.

Returns

Object — An Object containing two properties: width and height.

()

method

public function close(trigger:Event = null):void

Hides the drop-down list.

Parameters

trigger: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:

If you have specified a labelFunction property, returns the result of passing the item to the function.
If the item is a String, Number, Boolean, or Function, returns the item.
If the item has a property with the name specified by the control's labelField property, returns the contents of the property.
If the item has a label property, returns its value.

Parameters

item:Object — The object that contains the value to convert to a label. If the item is null, this method returns the empty string.

Returns

String

measure

()

method

override protected function 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.

open

()

method

public function open():void

Displays the drop-down list.

Event Detail

change

Event

Event Object Type: mx.events.ListEvent
property ListEvent.type = 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

Event

Event Object Type: mx.events.DropdownEvent
property DropdownEvent.type = mx.events.DropdownEvent.CLOSE

Dispatched when the drop-down list is dismissed for any reason such when the user:

selects an item in the drop-down list
clicks outside of the drop-down list
clicks the drop-down button while the drop-down list is displayed
presses the ESC key while the drop-down list is displayed

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

Event Object Type: mx.events.FlexEvent
property FlexEvent.type = 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

Event Object Type: mx.events.FlexEvent
property FlexEvent.type = 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

Event Object Type: mx.events.ListEvent
property ListEvent.type = 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

Event Object Type: mx.events.ListEvent
property ListEvent.type = 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

Event Object Type: mx.events.DropdownEvent
property DropdownEvent.type = 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

Event Object Type: mx.events.ScrollEvent
property ScrollEvent.type = 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.

Examples How to use this example

SimpleComboBox.mxml

<?xml version="1.0"?>
<!-- Simple example to demonstrate the ComboBox control. -->
<mx:Application xmlns:mx="http://www.adobe.com/2006/mxml">

    <mx:Script>
        <![CDATA[
            import mx.collections.ArrayCollection;

            [Bindable]
            public var cards:ArrayCollection = new ArrayCollection(
                [ {label:"Visa", data:1}, 
                  {label:"MasterCard", data:2}, 
                  {label:"American Express", data:3} ]);
        
            private function closeHandler(event:Event):void {
                myLabel.text = "You selected: " +  ComboBox(event.target).selectedItem.label;
                myData.text = "Data: " +  ComboBox(event.target).selectedItem.data;
            }     
        ]]>
    </mx:Script>

    <mx:Panel title="ComboBox Control Example" 
        height="75%" width="75%" layout="horizontal"
        paddingTop="10" paddingBottom="10" paddingLeft="10" paddingRight="10">

        <mx:ComboBox dataProvider="{cards}" width="150" 
            close="closeHandler(event);"/>

        <mx:VBox width="250">
            <mx:Text  width="200" color="blue" text="Select a type of credit card."/>
            <mx:Label id="myLabel" text="You selected:"/>
            <mx:Label id="myData" text="Data:"/>
        </mx:VBox>         

    </mx:Panel>    
</mx:Application>

Adobe® Flex™ 3.4 Language Reference Language Reference only	All Packages \| All Classes \| Language Elements \| Index \| Appendixes \| Conventions \| Frames No Frames
ComboBox	Properties \| Methods \| Events \| Styles \| Effects \| Constants \| Examples

Package	mx.controls
Class	public class ComboBox
Inheritance	ComboBox ComboBase UIComponent FlexSprite Sprite DisplayObjectContainer InteractiveObject DisplayObject EventDispatcher Object
Implements	IDataRenderer, IDropInListItemRenderer, IListItemRenderer
Subclasses	FileSystemComboBox