| Package | mx.controls |
| Class | public class ComboBox |
| Inheritance | ComboBox  ComboBase UIComponent FlexSprite Sprite DisplayObjectContainer InteractiveObject DisplayObject EventDispatcher Object |
| Implements | IDataRenderer, IDropInListItemRenderer, IListItemRenderer |
| Subclasses | FileSystemComboBox |
| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
 | Starting with Flex 4.0, Adobe recommends that you use the spark.components.ComboBox class as an alternative to this class. |
| Starting with Flex 4.0, Adobe recommends that you use the spark.components.DropDownList class as an alternative to this class. |
The ComboBox control contains a drop-down list from which the user can select a single value. Its functionality is very similar to that of the SELECT form element in HTML. The ComboBox can be editable, in which case the user can type entries into the TextInput portion of the ComboBox that are not in the list.
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. |
Show MXML Syntax
Hide MXML SyntaxThe <mx:ComboBox> tag inherits all the tag attributes
of its superclass, and adds the following tag attributes:
<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="0xB7BABC"
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
More examples
Creating a ComboBox control
Using events with ComboBox controls
Specifying ComboBox labels
Populating a ComboBox control by using variables and models
Creating MXML components
Using events with ComboBox controls
Specifying ComboBox labels
Populating a ComboBox control by using variables and models
Creating MXML components
Learn more
Related API Elements
Public Properties
| Property | Defined By | ||
|---|---|---|---|
 | accessibilityDescription : String
A convenience accessor for the description property
in this UIComponent's accessibilityProperties object. | UIComponent | |
| accessibilityEnabled : Boolean
A convenience accessor for the silent property
in this UIComponent's accessibilityProperties object. | UIComponent | |
| accessibilityImplementation : AccessibilityImplementation
The current accessibility implementation (AccessibilityImplementation)
for this InteractiveObject instance. | InteractiveObject | |
| accessibilityName : String
A convenience accessor for the name property
in this UIComponent's accessibilityProperties object. | UIComponent | |
| accessibilityProperties : AccessibilityProperties
The current accessibility options for this display object. | DisplayObject | |
| accessibilityShortcut : String
A convenience accessor for the shortcut property
in this UIComponent's accessibilityProperties object. | UIComponent | |
| activeEffects : Array [read-only]
The list of effects that are currently playing on the component,
as an Array of EffectInstance instances. | UIComponent | |
| alpha : Number
Indicates the alpha transparency value of the object specified. | DisplayObject | |
| automationDelegate : Object
The delegate object that handles the automation-related functionality. | UIComponent | |
| automationEnabled : Boolean [read-only]
True if this component is enabled for automation, false
otherwise. | UIComponent | |
| automationName : String
Name that can be used as an identifier for this object. | UIComponent | |
| automationOwner : DisplayObjectContainer [read-only]
The owner of this component for automation purposes. | UIComponent | |
| automationParent : DisplayObjectContainer [read-only]
The parent of this component for automation purposes. | UIComponent | |
| automationTabularData : Object [read-only]
An implementation of the IAutomationTabularData interface, which
can be used to retrieve the data. | UIComponent | |
| automationValue : Array [read-only]
This value generally corresponds to the rendered appearance of the
object and should be usable for correlating the identifier with
the object as it appears visually within the application. | UIComponent | |
| automationVisible : Boolean [read-only]
True if this component is visible for automation, false
otherwise. | UIComponent | |
| baseline : Object
For components, this layout constraint property is a
facade on top of the similarly-named style. | UIComponent | |
| baselinePosition : Number [read-only]
The y-coordinate of the baseline
of the first line of text of the component. | UIComponent | |
| blendMode : String
A value from the BlendMode class that specifies which blend mode to use. | DisplayObject | |
| blendShader : Shader [write-only]
Sets a shader that is used for blending the foreground and background. | DisplayObject | |
| bottom : Object
For components, this layout constraint property is a
facade on top of the similarly-named style. | UIComponent | |
| buttonMode : Boolean
Specifies the button mode of this sprite. | Sprite | |
| cacheAsBitmap : Boolean
If set to true, Flash runtimes cache an internal bitmap representation of the
display object. | DisplayObject | |
| cacheAsBitmapMatrix : Matrix
If non-null, this Matrix object defines how a display object is rendered when
cacheAsBitmap is set to true. | DisplayObject | |
| cacheHeuristic : Boolean [write-only]
Used by Flex to suggest bitmap caching for the object. | UIComponent | |
| cachePolicy : String
Specifies the bitmap caching policy for this object. | UIComponent | |
| className : String [read-only]
The name of this instance's class, such as "Button". | UIComponent | |
| constructor : Object
A reference to the class object or constructor function for a given object instance. | Object | |
| contentMouseX : Number [read-only]
Returns the x position of the mouse, in the content coordinate system. | UIComponent | |
| contentMouseY : Number [read-only]
Returns the y position of the mouse, in the content coordinate system. | UIComponent | |
| contextMenu : NativeMenu
Specifies the context menu associated with this object. | InteractiveObject | |
| currentState : String
The current view state of the component. | UIComponent | |
| cursorManager : ICursorManager [read-only]
Gets the CursorManager that controls the cursor for this component
and its peers. | UIComponent | |
| 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]
The set of items this component displays. | ComboBox | ||
| depth : Number
Determines the order in which items inside of containers
are rendered. | UIComponent | |
| descriptor : UIComponentDescriptor
Reference to the UIComponentDescriptor, if any, that was used
by the createComponentFromDescriptor() method to create this
UIComponent instance. | UIComponent | |
| designLayer : DesignLayer
Specifies the optional DesignLayer instance associated with this visual
element. | UIComponent | |
| 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 | |
| enableIME : Boolean [read-only]
A flag that indicates whether the IME should
be enabled when the component receives focus. | ComboBase | |
| errorString : String
The text that displayed by a component's error tip when a
component is monitored by a Validator and validation fails. | UIComponent | |
| explicitHeight : Number
Number that specifies the explicit height of the component,
in pixels, in the component's coordinates. | UIComponent | |
| explicitMaxHeight : Number
The maximum recommended height of the component to be considered
by the parent during layout. | UIComponent | |
| explicitMaxWidth : Number
The maximum recommended width of the component to be considered
by the parent during layout. | UIComponent | |
| explicitMinHeight : Number
The minimum recommended height of the component to be considered
by the parent during layout. | UIComponent | |
| explicitMinWidth : Number
The minimum recommended width of the component to be considered
by the parent during layout. | UIComponent | |
| explicitWidth : Number
Number that specifies the explicit width of the component,
in pixels, in the component's coordinates. | UIComponent | |
| filters : Array
An indexed array that contains each filter object currently associated with the display object. | DisplayObject | |
| flexContextMenu : IFlexContextMenu
The context menu for this UIComponent. | UIComponent | |
| focusEnabled : Boolean
Indicates whether the component can receive focus when tabbed to. | UIComponent | |
| focusManager : IFocusManager
Gets the FocusManager that controls focus for this component
and its peers. | UIComponent | |
| focusPane : Sprite
The focus pane associated with this object. | UIComponent | |
| focusRect : Object
Specifies whether this object displays a focus rectangle. | InteractiveObject | |
| graphics : Graphics [read-only]
Specifies the Graphics object that belongs to this sprite where vector
drawing commands can occur. | Sprite | |
| hasFocusableChildren : Boolean
A flag that indicates whether child objects can receive focus. | UIComponent | |
| hasLayoutMatrix3D : Boolean [read-only]
Contains true if the element has 3D Matrix. | UIComponent | |
| height : Number [override]
Number that specifies the height of the component, in pixels,
in the parent's coordinates. | UIComponent | |
| hitArea : Sprite
Designates another sprite to serve as the hit area for a sprite. | Sprite | |
| horizontalCenter : Object
For components, this layout constraint property is a
facade on top of the similarly-named style. | UIComponent | |
| id : String
ID of the component. | UIComponent | |
| 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 | |
| is3D : Boolean [read-only]
Contains true when the element is in 3D. | UIComponent | |
| isDocument : Boolean [read-only]
Contains true if this UIComponent instance is a document object. | UIComponent | |
| isPopUp : Boolean
Set to true by the PopUpManager to indicate
that component has been popped up. | UIComponent | |
| 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 | ||
| layoutMatrix3D : Matrix3D [write-only]
The transform matrix that is used to calculate a component's layout
relative to its siblings. | UIComponent | |
| left : Object
For components, this layout constraint property is a
facade on top of the similarly-named style. | UIComponent | |
| 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 | |
| maintainProjectionCenter : Boolean
When true, the component keeps its projection matrix centered on the
middle of its bounding box. | UIComponent | |
| mask : DisplayObject
The calling display object is masked by the specified mask object. | DisplayObject | |
| maxHeight : Number
The maximum recommended height of the component to be considered
by the parent during layout. | UIComponent | |
| maxWidth : Number
The maximum recommended width of the component to be considered
by the parent during layout. | UIComponent | |
| 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
A module factory is used as context for using embedded fonts and for
finding the style manager that controls the styles for this
component. | UIComponent | |
| mouseChildren : Boolean
Determines whether or not the children of the object are mouse, or user input device, enabled. | DisplayObjectContainer | |
| mouseEnabled : Boolean
Specifies whether this object receives mouse, or other user input, messages. | InteractiveObject | |
| mouseFocusEnabled : Boolean
Whether you can receive focus when clicked on. | UIComponent | |
| mouseX : Number [read-only]
Indicates the x coordinate of the mouse or user input device position, in pixels. | DisplayObject | |
| mouseY : Number [read-only]
Indicates the y coordinate of the mouse or user input device position, in pixels. | DisplayObject | |
| name : String
Indicates the instance name of the DisplayObject. | DisplayObject | |
| needsSoftKeyboard : Boolean
Specifies whether a virtual keyboard (an on-screen, software keyboard) should display
when this InteractiveObject instance receives focus. | InteractiveObject | |
| nestLevel : int
Depth of this object in the containment hierarchy. | UIComponent | |
| nonInheritingStyles : Object
The beginning of this component's chain of non-inheriting styles. | UIComponent | |
| numAutomationChildren : int [read-only]
The number of automation children this container has. | UIComponent | |
| numChildren : int [read-only]
Returns the number of children of this object. | DisplayObjectContainer | |
| opaqueBackground : Object
Specifies whether the display object is opaque with a certain background color. | DisplayObject | |
| owner : DisplayObjectContainer
The owner of this IVisualElement object. | UIComponent | |
| parent : DisplayObjectContainer [override] [read-only]
The parent container or component for this component. | UIComponent | |
| parentApplication : Object [read-only]
A reference to the Application object that contains this UIComponent
instance. | UIComponent | |
| parentDocument : Object [read-only]
A reference to the parent document object for this UIComponent. | UIComponent | |
| percentHeight : Number
Specifies the height of a component as a percentage
of its parent's size. | UIComponent | |
| percentWidth : Number
Specifies the width of a component as a percentage
of its parent's size. | UIComponent | |
| postLayoutTransformOffsets : mx.geom:TransformOffsets
Defines a set of adjustments that can be applied to the object's
transform in a way that is invisible to its parent's layout. | UIComponent | |
| processedDescriptors : Boolean
Set to true after immediate or deferred child creation,
depending on which one happens. | UIComponent | |
| 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 | |
| right : Object
For components, this layout constraint property is a
facade on top of the similarly-named style. | UIComponent | |
| root : DisplayObject [read-only]
For a display object in a loaded SWF file, the root property is the
top-most display object in the portion of the display list's tree structure represented by that SWF file. | DisplayObject | |
| rotation : Number [override]
Indicates the rotation of the DisplayObject instance, in degrees, from its original orientation. | UIComponent | |
| rotationX : Number [override]
Indicates the x-axis rotation of the DisplayObject instance, in degrees, from its original orientation
relative to the 3D parent container. | UIComponent | |
| rotationY : Number [override]
Indicates the y-axis rotation of the DisplayObject instance, in degrees, from its original orientation
relative to the 3D parent container. | UIComponent | |
| rotationZ : Number [override]
Indicates the z-axis rotation of the DisplayObject instance, in degrees, from its original orientation relative to the 3D parent container. | UIComponent | |
| 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 [override]
Number that specifies the scaling factor along the z axis. | UIComponent | |
| screen : Rectangle [read-only]
Returns an object that contains the size and position of the base
drawing surface for this object. | UIComponent | |
| scrollRect : Rectangle
The scroll rectangle bounds of the display object. | DisplayObject | |
| selectedIndex : int [override]
Index of the selected item in the drop-down list. | ComboBox | ||
| selectedItem : Object [override]
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 | |
| softKeyboardInputAreaOfInterest : Rectangle
Defines the area that should remain on-screen when a soft keyboard is displayed. | InteractiveObject | |
| soundTransform : flash.media:SoundTransform
Controls sound within this sprite. | Sprite | |
| stage : Stage [read-only]
The Stage of the display object. | DisplayObject | |
| states : Array
The view states that are defined for this component. | UIComponent | |
| styleDeclaration : CSSStyleDeclaration
Storage for the inline inheriting styles on this object. | UIComponent | |
| styleManager : IStyleManager2 [read-only]
Returns the StyleManager instance used by this component. | UIComponent | |
| styleName : Object
The class style used by this component. | UIComponent | |
| styleParent : IAdvancedStyleClient
A component's parent is used to evaluate descendant selectors. | UIComponent | |
| systemManager : ISystemManager
Returns the SystemManager object used by this component. | UIComponent | |
| tabChildren : Boolean
Determines whether the children of the object are tab enabled. | DisplayObjectContainer | |
| tabEnabled : Boolean
Specifies whether this object is in the tab order. | InteractiveObject | |
| tabFocusEnabled : Boolean
A flag that indicates whether this object can receive focus
via the TAB key
This is similar to the tabEnabled property
used by the Flash Player.
This is usually true for components that
handle keyboard input, but some components in controlbars
have them set to false because they should not steal
focus from another component like an editor. | UIComponent | |
| tabIndex : int
Specifies the tab ordering of objects in a SWF file. | InteractiveObject | |
| 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 | |
| top : Object
For components, this layout constraint property is a
facade on top of the similarly-named style. | UIComponent | |
| transform : flash.geom:Transform [override]
An object with properties pertaining to a display object's matrix, color transform,
and pixel bounds. | UIComponent | |
| transformX : Number
Sets the x coordinate for the transform center of the component. | UIComponent | |
| transformY : Number
Sets the y coordinate for the transform center of the component. | UIComponent | |
| transformZ : Number
Sets the z coordinate for the transform center of the component. | UIComponent | |
| transitions : Array
An Array of Transition objects, where each Transition object defines a
set of effects to play when a view state change occurs. | UIComponent | |
| tweeningProperties : Array
Array of properties that are currently being tweened on this object. | UIComponent | |
| uid : String
A unique identifier for the object. | UIComponent | |
| updateCompletePendingFlag : Boolean
A flag that determines if an object has been through all three phases
of layout validation (provided that any were required). | UIComponent | |
| useHandCursor : Boolean
A Boolean value that indicates whether the pointing hand (hand cursor) appears when the pointer rolls
over a sprite in which the buttonMode property is set to true. | Sprite | |
| validationSubField : String
Used by a validator to associate a subfield with this component. | UIComponent | |
| value : Object [read-only]
The value of the selected item. | ComboBase | |
| verticalCenter : Object
For components, this layout constraint property is a
facade on top of the similarly-named style. | UIComponent | |
| visible : Boolean [override]
Whether or not the display object is visible. | UIComponent | |
| width : Number [override]
Number that specifies the width of the component, in pixels,
in the parent's coordinates. | UIComponent | |
| x : Number [override]
Number that specifies the component's horizontal position,
in pixels, within its parent container. | UIComponent | |
| y : Number [override]
Number that specifies the component's vertical position,
in pixels, within its parent container. | UIComponent | |
| z : Number [override]
Indicates the z coordinate position along the z-axis of the DisplayObject
instance relative to the 3D parent container. | UIComponent | |
Protected Properties
| Property | Defined By | ||
|---|---|---|---|
| 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 | |
| currentCSSState : String [read-only]
The state to be used when matching CSS pseudo-selectors. | UIComponent | |
| dropDownStyleFilters : Object [read-only]
The set of styles to pass from the ComboBox to the dropDown. | ComboBox | ||
| hasComplexLayoutMatrix : Boolean [read-only]
Returns true if the UIComponent has any non-translation (x,y) transform properties. | UIComponent | |
| 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.core:ITextInput
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
| Method | Defined By | ||
|---|---|---|---|
ComboBox()
Constructor. | ComboBox | ||
|
Adds a child DisplayObject instance to this DisplayObjectContainer instance. | DisplayObjectContainer | |
|
Adds a child DisplayObject instance to this DisplayObjectContainer
instance. | DisplayObjectContainer | |
| addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
Registers an event listener object with an EventDispatcher object so that the listener
receives notification of an event. | EventDispatcher | |
|
Adds a non-visual style client to this component instance. | UIComponent | |
|
Indicates whether the security restrictions
would cause any display objects to be omitted from the list returned by calling
the DisplayObjectContainer.getObjectsUnderPoint() method
with the specified point point. | DisplayObjectContainer | |
|
Queues a function to be called later. | UIComponent | |
|
Deletes a style property from this component instance. | UIComponent | |
Hides the drop-down list. | ComboBox | ||
|
Determines whether the specified display object is a child of the DisplayObjectContainer instance or
the instance itself. | DisplayObjectContainer | |
|
Converts a Point object from content coordinates to global coordinates. | UIComponent | |
|
Converts a Point object from content to local coordinates. | UIComponent | |
|
Returns a set of properties that identify the child within
this container. | UIComponent | |
|
Returns a set of properties that identify the child within
this container. | UIComponent | |
|
Creates an id reference to this IUIComponent object
on its parent document object. | UIComponent | |
|
Deletes the id reference to this IUIComponent object
on its parent document object. | UIComponent | |
|
Returns a UITextFormat object corresponding to the text styles
for this UIComponent. | UIComponent | |
| [override]
Dispatches an event into the event flow. | UIComponent | |
|
Shows or hides the focus indicator around this component. | UIComponent | |
| drawRoundRect(x:Number, y:Number, w:Number, h:Number, r:Object = null, c:Object = null, alpha:Object = null, rot:Object = null, gradient:String = null, ratios:Array = null, hole:Object = null):void
Programmatically draws a rectangle into this skin's Graphics object. | UIComponent | |
|
Called by the effect instance when it stops playing on the component. | UIComponent | |
|
Called by the effect instance when it starts playing on the component. | UIComponent | |
|
Ends all currently playing effects on the component. | UIComponent | |
|
Executes all the bindings for which the UIComponent object is the destination. | UIComponent | |
|
Called after printing is complete. | UIComponent | |
|
Provides the automation object at the specified index. | UIComponent | |
|
Provides the automation object list . | UIComponent | |
|
Returns a rectangle that defines the area of the display object relative to the coordinate system
of the targetCoordinateSpace object. | DisplayObject | |
|
Returns the x coordinate of the element's bounds at the specified element size. | UIComponent | |
|
Returns the y coordinate of the element's bounds at the specified element size. | UIComponent | |
|
Returns the child display object instance that exists at the specified index. | DisplayObjectContainer | |
|
Returns the child display object that exists with the specified name. | DisplayObjectContainer | |
|
Returns the index position of a child DisplayObject instance. | DisplayObjectContainer | |
|
Finds the type selectors for this UIComponent instance. | UIComponent | |
|
Returns a layout constraint value, which is the same as
getting the constraint style for this component. | UIComponent | |
|
A convenience method for determining whether to use the
explicit or measured height
| UIComponent | |
|
A convenience method for determining whether to use the
explicit or measured width
| UIComponent | |
|
Gets the object that currently has focus. | UIComponent | |
|
Returns the element's layout height. | UIComponent | |
|
Returns the element's layout width. | UIComponent | |
|
Returns the x coordinate that the element uses to draw on screen. | UIComponent | |
|
Returns the y coordinate that the element uses to draw on screen. | UIComponent | |
|
Returns the transform matrix that is used to calculate the component's
layout relative to its siblings. | UIComponent | |
|
Returns the layout transform Matrix3D for this element. | UIComponent | |
|
Returns the element's maximum height. | UIComponent | |
|
Returns the element's maximum width. | UIComponent | |
|
Returns the element's minimum height. | UIComponent | |
|
Returns the element's minimum width. | UIComponent | |
|
Returns an array of objects that lie under the specified point and are children
(or grandchildren, and so on) of this DisplayObjectContainer instance. | DisplayObjectContainer | |
|
Returns the element's preferred height. | UIComponent | |
|
Returns the element's preferred width. | UIComponent | |
|
Returns a rectangle that defines the boundary of the display object,
based on the coordinate system defined by the targetCoordinateSpace
parameter, excluding any strokes on shapes. | DisplayObject | |
|
Returns the item in the dataProvider that was used
by the specified Repeater to produce this Repeater, or
null if this Repeater isn't repeated. | UIComponent | |
|
Gets a style property that has been set anywhere in this
component's style lookup chain. | UIComponent | |
|
Converts a Point object from global to content coordinates. | UIComponent | |
|
Converts the point object from the Stage (global) coordinates
to the display object's (local) coordinates. | DisplayObject | |
|
Converts a two-dimensional point from the Stage (global) coordinates to a
three-dimensional display object's (local) coordinates. | DisplayObject | |
|
Returns true if currentCSSState is not null. | UIComponent | |
|
Checks whether the EventDispatcher object has any listeners registered for a specific type
of event. | EventDispatcher | |
|
Indicates whether an object has a specified property defined. | Object | |
|
Determines whether the specified state has been defined on this
UIComponent. | UIComponent | |
|
Evaluates the bounding box of the display object to see if it overlaps or intersects with the
bounding box of the obj display object. | DisplayObject | |
|
Evaluates the display object to see if it overlaps or intersects with the
point specified by the x and y parameters. | DisplayObject | |
|
Returns a box Matrix which can be passed to the
drawRoundRect() method
as the rot parameter when drawing a horizontal gradient. | UIComponent | |
|
Initializes the internal structure of this component. | UIComponent | |
|
Initializes various properties which keep track of repeated instances
of this component. | UIComponent | |
|
Marks a component so that its updateDisplayList()
method gets called during a later screen update. | UIComponent | |
|
Called by a component's items to indicate that their depth
property has changed. | UIComponent | |
|
An element must call this method when its layoutDirection changes or
when its parent's layoutDirection changes. | UIComponent | |
|
Marks a component so that its commitProperties()
method gets called during a later screen update. | UIComponent | |
|
Marks a component so that its measure()
method gets called during a later screen update. | UIComponent | |
|
Indicates whether an instance of the Object class is in the prototype chain of the object specified
as the parameter. | Object | |
Returns a string representing the item parameter. | ComboBox | ||
|
Converts a three-dimensional point of the three-dimensional display
object's (local) coordinates to a two-dimensional point in the Stage (global) coordinates. | DisplayObject | |
|
Converts a Point object from local to content coordinates. | UIComponent | |
|
Converts the point object from the display object's (local) coordinates to the
Stage (global) coordinates. | DisplayObject | |
|
Returns true if cssState matches currentCSSState. | UIComponent | |
|
Determines whether this instance is the same as, or is a subclass of,
the given type. | UIComponent | |
|
Measures the specified HTML text, which can contain HTML tags such
as <font> and <b>,
assuming that it is displayed
in a single-line UITextField using a UITextFormat
determined by the styles of this UIComponent. | UIComponent | |
|
Measures the specified text, assuming that it is displayed
in a single-line UITextField (or UIFTETextField) using a UITextFormat
determined by the styles of this UIComponent. | UIComponent | |
|
Moves the component to a specified position within its parent. | UIComponent | |
|
Propagates style changes to the children. | UIComponent | |
Displays the drop-down list. | ComboBox | ||
|
Returns true if the chain of owner properties
points from child to this UIComponent. | UIComponent | |
|
Called by Flex when a UIComponent object is added to or removed from a parent. | UIComponent | |
|
Prepares an IFlexDisplayObject for printing. | UIComponent | |
|
Indicates whether the specified property exists and is enumerable. | Object | |
|
Builds or rebuilds the CSS style cache for this component
and, if the recursive parameter is true,
for all descendants of this component as well. | UIComponent | |
|
For each effect event, registers the EffectManager
as one of the event listeners. | UIComponent | |
|
Removes the specified child DisplayObject instance from the child list of the DisplayObjectContainer instance. | DisplayObjectContainer | |
|
Removes a child DisplayObject from the specified index position in the child list of
the DisplayObjectContainer. | DisplayObjectContainer | |
|
Removes one or more child DisplayObject instances from the DisplayObjectContainer instance. | DisplayObjectContainer | |
|
Removes a listener from the EventDispatcher object. | EventDispatcher | |
|
Removes a non-visual style client from this component instance. | UIComponent | |
|
Replays the specified event. | UIComponent | |
|
Raises a virtual keyboard. | InteractiveObject | |
|
Resolves a child by using the id provided. | UIComponent | |
| [static]
Resumes the background processing of methods
queued by callLater(), after a call to
suspendBackgroundProcessing(). | UIComponent | |
|
Sizes the object. | UIComponent | |
|
Changes the position of an existing child in the display object container. | DisplayObjectContainer | |
|
Sets a layout constraint value, which is the same as
setting the constraint style for this component. | UIComponent | |
|
Set the current state. | UIComponent | |
|
Sets the focus to this component. | UIComponent | |
|
Sets the coordinates that the element uses to draw on screen. | UIComponent | |
|
Sets the layout size of the element. | UIComponent | |
|
Sets the transform Matrix that is used to calculate the component's layout
size and position relative to its siblings. | UIComponent | |
|
Sets the transform Matrix3D that is used to calculate the component's layout
size and position relative to its siblings. | UIComponent | |
|
Sets the availability of a dynamic property for loop operations. | Object | |
|
Sets a style property on this component instance. | UIComponent | |
|
Called when the visible property changes. | UIComponent | |
|
Lets the user drag the specified sprite. | Sprite | |
|
Lets the user drag the specified sprite on a touch-enabled device. | Sprite | |
|
Ends the startDrag() method. | Sprite | |
|
Ends the startTouchDrag() method, for use with touch-enabled devices. | Sprite | |
|
Detects changes to style properties. | UIComponent | |
|
Flex calls the stylesInitialized() method when
the styles for a component are first initialized. | UIComponent | |
| [static]
Blocks the background processing of methods
queued by callLater(),
until resumeBackgroundProcessing() is called. | UIComponent | |
|
Swaps the z-order (front-to-back order) of the two specified child objects. | DisplayObjectContainer | |
|
Swaps the z-order (front-to-back order) of the child objects at the two specified index positions in the
child list. | DisplayObjectContainer | |
|
Returns the string representation of this object, formatted according to locale-specific conventions. | Object | |
| [override]
Returns a string indicating the location of this object
within the hierarchy of DisplayObjects in the Application. | FlexSprite | |
| transformAround(transformCenter:Vector3D, scale:Vector3D = null, rotation:Vector3D = null, translation:Vector3D = null, postLayoutScale:Vector3D = null, postLayoutRotation:Vector3D = null, postLayoutTranslation:Vector3D = null, invalidateLayout:Boolean = true):void
A utility method to update the rotation, scale, and translation of the
transform while keeping a particular point, specified in the component's
own coordinate space, fixed in the parent's coordinate space. | UIComponent | |
|
A utility method to transform a point specified in the local
coordinates of this object to its location in the object's parent's
coordinates. | UIComponent | |
|
Validates the position and size of children and draws other
visuals. | UIComponent | |
|
Validate and update the properties and layout of this object
and redraw it, if necessary. | UIComponent | |
|
Used by layout logic to validate the properties of a component
by calling the commitProperties() method. | UIComponent | |
|
Validates the measured size of the component
If the LayoutManager.invalidateSize() method is called with
this ILayoutManagerClient, then the validateSize() method
is called when it's time to do measurements. | UIComponent | |
|
Handles both the valid and invalid events from a
validator assigned to this component. | UIComponent | |
|
Returns the primitive value of the specified object. | Object | |
|
Returns a box Matrix which can be passed to drawRoundRect()
as the rot parameter when drawing a vertical gradient. | UIComponent | |
|
Checks whether an event listener is registered with this EventDispatcher object or any of
its ancestors for the specified event type. | EventDispatcher | |
Protected Methods
| Method | Defined By | ||
|---|---|---|---|
|
Adjust the focus rectangle. | UIComponent | |
|
Commits the computed matrix built from the combination of the layout
matrix and the transform offsets to the flash displayObject's transform. | UIComponent | |
|
This is an internal method used by the Flex framework
to support the Dissolve effect. | UIComponent | |
[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 | ||
|
Determines if the call to the measure() method can be skipped. | UIComponent | |
|
Performs any final processing after child objects are created. | UIComponent | |
|
Responds to changes to the data provider. | ComboBase | |
|
Processes the properties set on the component. | UIComponent | |
|
Create child objects of the component. | UIComponent | |
|
Creates a new object using a context
based on the embedded font being used. | UIComponent | |
|
Creates the object using a given moduleFactory. | UIComponent | |
|
Helper method for dispatching a PropertyChangeEvent
when a property is updated. | UIComponent | |
|
Performs some action when the drop-down button is pressed. | ComboBase | |
|
The event handler called when a UIComponent object gets focus. | UIComponent | |
|
The event handler called when a UIComponent object loses focus. | UIComponent | |
|
Initializes the implementation and storage of some of the less frequently
used advanced layout features of a component. | UIComponent | |
|
Finalizes the initialization of this component. | UIComponent | |
|
Initializes this component's accessibility code. | UIComponent | |
|
Helper method to invalidate parent size and display list if
this object affects its layout (includeInLayout is true). | UIComponent | |
|
Typically overridden by components containing UITextField objects,
where the UITextField object gets focus. | UIComponent | |
|
Determines the UID for a dataProvider item. | ComboBase | |
|
The event handler called for a keyDown event. | UIComponent | |
|
The event handler called for a keyUp event. | UIComponent | |
[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 | ||
|
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 | |
|
Specifies a transform stretch factor in the horizontal and vertical direction. | UIComponent | |
|
This method is called when a state changes to check whether
state-specific styles apply to this component. | UIComponent | |
|
Handles changes to the TextInput that serves as the editable
text field in the component. | ComboBase | |
| [override]
Sizes and positions the internal components in the given width
and height. | ComboBase | |
Events
| Event | Summary | Defined By | ||
|---|---|---|---|---|
| [broadcast event] Dispatched when the Flash Player or AIR application gains operating system focus and becomes active. | EventDispatcher | ||
| Dispatched when the component is added to a container as a content child by using the addChild(), addChildAt(), addElement(), or addElementAt() method. | UIComponent | ||
| Dispatched when a display object is added to the display list. | DisplayObject | ||
| Dispatched when a display object is added to the on stage display list, either directly or through the addition of a sub tree in which the display object is contained. | DisplayObject | ||
| Dispatched when 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 user selects 'Clear' (or 'Delete') from the text context menu. | InteractiveObject | ||
| Dispatched when a user presses and releases the main button of the user's pointing device over the same InteractiveObject. | InteractiveObject | ||
| Dispatched when 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 | |||
| Dispatched when a user gesture triggers the context menu associated with this interactive object in an AIR application. | InteractiveObject | ||
| Dispatched when the user activates the platform-specific accelerator key combination for a copy operation or selects 'Copy' from the text context menu. | InteractiveObject | ||
| Dispatched when the component has finished its construction, property processing, measuring, layout, and drawing. | UIComponent | ||
| Dispatched after the view state has changed. | UIComponent | ||
| Dispatched after the currentState property changes, but before the view state changes. | UIComponent | ||
| Dispatched when the user activates the platform-specific accelerator key combination for a cut operation or selects 'Cut' from the text context menu. | InteractiveObject | ||
| Dispatched when the data property changes. | ComboBox | |||
| [broadcast event] Dispatched when the Flash Player or AIR application operating loses system focus and is becoming inactive. | EventDispatcher | ||
| Dispatched when a user presses and releases the main button of a pointing device twice in rapid succession over the same InteractiveObject when that object's doubleClickEnabled flag is set to true. | InteractiveObject | ||
| Dispatched by the drag initiator (the component that is the source of the data being dragged) when the drag operation completes, either when you drop the dragged data onto a drop target or when you end the drag-and-drop operation without performing a drop. | UIComponent | ||
| Dispatched by the drop target when the user releases the mouse over it. | UIComponent | ||
| Dispatched by a component when the user moves the mouse over the component during a drag operation. | UIComponent | ||
| Dispatched by the component when the user drags outside the component, but does not drop the data onto the target. | UIComponent | ||
| Dispatched by a component when the user moves the mouse while over the component during a drag operation. | UIComponent | ||
| Dispatched by the drag initiator when starting a drag operation. | UIComponent | ||
| Dispatched after an effect ends. | UIComponent | ||
| Dispatched just before an effect starts. | UIComponent | ||
| Dispatched after an effect is stopped, which happens only by a call to stop() on the effect. | UIComponent | ||
| Dispatched if the editable property is set to true and the user presses the Enter key while typing in the editable text field. | ComboBox | |||
| [broadcast event] Dispatched when the playhead is entering a new frame. | DisplayObject | ||
| Dispatched after the component has entered a view state. | UIComponent | ||
| [broadcast event] Dispatched when the playhead is exiting the current frame. | DisplayObject | ||
| Dispatched just before the component exits a view state. | UIComponent | ||
| Dispatched after a display object gains focus. | InteractiveObject | ||
| Dispatched after a display object loses focus. | InteractiveObject | ||
| [broadcast event] Dispatched after the constructors of frame display objects have run but before frame scripts have run. | DisplayObject | ||
| Dispatched when the user moves a point of contact over the InteractiveObject instance on a touch-enabled device (such as moving a finger from left to right over a display object on a mobile phone or tablet with a touch screen). | InteractiveObject | ||
| Dispatched when the user creates a point of contact with an InteractiveObject instance, then taps on a touch-enabled device (such as placing several fingers over a display object to open a menu and then taps one finger to select a menu item on a mobile phone or tablet with a touch screen). | InteractiveObject | ||
| Dispatched when the user performs a rotation gesture at a point of contact with an InteractiveObject instance (such as touching two fingers and rotating them over a display object on a mobile phone or tablet with a touch screen). | InteractiveObject | ||
| Dispatched when the user performs a swipe gesture at a point of contact with an InteractiveObject instance (such as touching three fingers to a screen and then moving them in parallel over a display object on a mobile phone or tablet with a touch screen). | InteractiveObject | ||
| Dispatched when the user presses two points of contact over the same InteractiveObject instance on a touch-enabled device (such as presses and releases two fingers over a display object on a mobile phone or tablet with a touch screen). | InteractiveObject | ||
| Dispatched when the user performs a zoom gesture at a point of contact with an InteractiveObject instance (such as touching two fingers to a screen and then quickly spreading the fingers apart over a display object on a mobile phone or tablet with a touch screen). | InteractiveObject | ||
| Dispatched when an object's state changes from visible to invisible. | UIComponent | ||
| This event is dispatched to any client app that supports inline input with an IME | InteractiveObject | ||
| Dispatched when the component has finished its construction and has all initialization properties set. | UIComponent | ||
| Dispatched when a component is monitored by a Validator and the validation failed. | UIComponent | ||
| Dispatched when 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 when the user presses a key. | InteractiveObject | ||
| Dispatched when the user attempts to change focus by using keyboard navigation. | InteractiveObject | ||
| Dispatched when the user releases a key. | InteractiveObject | ||
| Dispatched when a user presses and releases the middle button of the user's pointing device over the same InteractiveObject. | InteractiveObject | ||
| Dispatched when a user presses the middle pointing device button over an InteractiveObject instance. | InteractiveObject | ||
| Dispatched when a user releases the pointing device button over an InteractiveObject instance. | InteractiveObject | ||
| Dispatched when a user presses the pointing device button over an InteractiveObject instance. | InteractiveObject | ||
| Dispatched from a component opened using the PopUpManager when the user clicks outside it. | UIComponent | ||
| Dispatched when the user attempts to change focus by using a pointer device. | InteractiveObject | ||
| Dispatched when a user moves the pointing device while it is over an InteractiveObject. | InteractiveObject | ||
| Dispatched when the user moves a pointing device away from an InteractiveObject instance. | InteractiveObject | ||
| Dispatched when the user moves a pointing device over an InteractiveObject instance. | InteractiveObject | ||
| Dispatched when a user releases the pointing device button over an InteractiveObject instance. | InteractiveObject | ||
| Dispatched when a mouse wheel is spun over an InteractiveObject instance. | InteractiveObject | ||
| Dispatched from a component opened using the PopUpManager when the user scrolls the mouse wheel outside it. | UIComponent | ||
| Dispatched when the object has moved. | UIComponent | ||
| Dispatched by the drag initiator InteractiveObject when the user releases the drag gesture. | InteractiveObject | ||
| Dispatched by the target InteractiveObject when a dragged object is dropped on it and the drop has been accepted with a call to DragManager.acceptDragDrop(). | InteractiveObject | ||
| Dispatched by an InteractiveObject when a drag gesture enters its boundary. | InteractiveObject | ||
| Dispatched by an InteractiveObject when a drag gesture leaves its boundary. | InteractiveObject | ||
| Dispatched by an InteractiveObject continually while a drag gesture remains within its boundary. | InteractiveObject | ||
| Dispatched at the beginning of a drag operation by the InteractiveObject that is specified as the drag initiator in the DragManager.doDrag() call. | InteractiveObject | ||
| Dispatched during a drag operation by the InteractiveObject that is specified as the drag initiator in the DragManager.doDrag() call. | InteractiveObject | ||
| Dispatched when the user clicks the drop-down button to display the drop-down list. | ComboBox | |||
| Dispatched when the user activates the platform-specific accelerator key combination for a paste operation or selects 'Paste' from the text context menu. | InteractiveObject | ||
| Dispatched at the beginning of the component initialization sequence. | UIComponent | ||
| Dispatched when the user lowers an active stylus past the proximity detection threshold of the screen. | InteractiveObject | ||
| Dispatched when the user lifts an active stylus above the proximity detection threshold of the screen. | InteractiveObject | ||
| Dispatched when the user moves an active stylus over the screen while remaining within the proximity detection threshold. | InteractiveObject | ||
| Dispatched when the user moves an active stylus away from this InteractiveObject while remaining within the proximity detection threshold of the screen. | InteractiveObject | ||
| Dispatched when the user moves an active stylus directly above this InteractiveObject while remaining within the proximity detection threshold of the screen. | InteractiveObject | ||
| Dispatched when the user moves an active stylus away from this InteractiveObject and any of its children while remaining within the proximity detection threshold of the screen. | InteractiveObject | ||
| Dispatched when the user moves an active stylus over this InteractiveObject from outside the object's tree of descendents in the display list (while remaining within the proximity detection threshold of the screen). | InteractiveObject | ||
| Dispatched when the component is removed from a container as a content child by using the removeChild(), removeChildAt(), removeElement(), or removeElementAt() method. | UIComponent | ||
| Dispatched when a display object is about to be removed from the display list. | DisplayObject | ||
| Dispatched when a display object is about to be removed from the display list, either directly or through the removal of a sub tree in which the display object is contained. | DisplayObject | ||
| [broadcast event] Dispatched when the display list is about to be updated and rendered. | DisplayObject | ||
| Dispatched when the component is resized. | UIComponent | ||
| Dispatched when a user presses and releases the right button of the user's pointing device over the same InteractiveObject. | InteractiveObject | ||
| Dispatched when a user presses the pointing device button over an InteractiveObject instance. | InteractiveObject | ||
| Dispatched when a user releases the pointing device button over an InteractiveObject instance. | InteractiveObject | ||
| Dispatched when the user moves a pointing device away from an InteractiveObject instance. | InteractiveObject | ||
| Dispatched when the user moves a pointing device over an InteractiveObject instance. | InteractiveObject | ||
| Dispatched when the user scrolls the ComboBox control's drop-down list. | ComboBox | |||
| Dispatched when the user activates the platform-specific accelerator key combination for a select all operation or selects 'Select All' from the text context menu. | InteractiveObject | ||
| Dispatched when an object's state changes from invisible to visible. | UIComponent | ||
| Dispatched immediately after the soft keyboard is raised. | InteractiveObject | ||
| Dispatched immediately before the soft keyboard is raised. | InteractiveObject | ||
| Dispatched immediately after the soft keyboard is lowered. | InteractiveObject | ||
| Dispatched after the component has entered a new state and any state transition animation to that state has finished playing. | UIComponent | ||
| Dispatched when a component interrupts a transition to its current state in order to switch to a new state. | UIComponent | ||
| Dispatched when the value of the object's tabChildren flag changes. | InteractiveObject | ||
| Dispatched when the object's tabEnabled flag changes. | InteractiveObject | ||
| Dispatched when the value of the object's tabIndex property changes. | InteractiveObject | ||
| Dispatched when a user enters one or more characters of text. | InteractiveObject | ||
| Dispatched by the component when it is time to create a ToolTip. | UIComponent | ||
| Dispatched by the component when its ToolTip has been hidden and is to be discarded soon. | UIComponent | ||
| Dispatched by the component when its ToolTip is about to be hidden. | UIComponent | ||
| Dispatched by the component when its ToolTip is about to be shown. | UIComponent | ||
| Dispatched by the component when its ToolTip has been shown. | UIComponent | ||
| Dispatched by a component whose toolTip property is set, as soon as the user moves the mouse over it. | UIComponent | ||
| Dispatched when the user first contacts a touch-enabled device (such as touches a finger to a mobile phone or tablet with a touch screen). | InteractiveObject | ||
| Dispatched when the user removes contact with a touch-enabled device (such as lifts a finger off a mobile phone or tablet with a touch screen). | InteractiveObject | ||
| A non-cancellable event, dispatched by a component when it is done responding to a touch interaction user gesture. | UIComponent | ||
| A non-cancellable event, dispatched by a component when it starts responding to a touch interaction user gesture. | UIComponent | ||
| A cancellable event, dispatched by a component in an attempt to respond to a touch interaction user gesture. | UIComponent | ||
| Dispatched when the user moves the point of contact with a touch-enabled device (such as drags a finger across a mobile phone or tablet with a touch screen). | InteractiveObject | ||
| Dispatched when the user moves the point of contact away from InteractiveObject instance on a touch-enabled device (such as drags a finger from one display object to another on a mobile phone or tablet with a touch screen). | InteractiveObject | ||
| Dispatched when the user moves the point of contact over an InteractiveObject instance on a touch-enabled device (such as drags a finger from a point outside a display object to a point over a display object on a mobile phone or tablet with a touch screen). | InteractiveObject | ||
| Dispatched when the user moves the point of contact away from an InteractiveObject instance on a touch-enabled device (such as drags a finger from over a display object to a point outside the display object on a mobile phone or tablet with a touch screen). | InteractiveObject | ||
| Dispatched when the user moves the point of contact over an InteractiveObject instance on a touch-enabled device (such as drags a finger from a point outside a display object to a point over a display object on a mobile phone or tablet with a touch screen). | InteractiveObject | ||
| Dispatched when the user lifts the point of contact over the same InteractiveObject instance on which the contact was initiated on a touch-enabled device (such as presses and releases a finger from a single point over a display object on a mobile phone or tablet with a touch screen). | InteractiveObject | ||
| Dispatched when an object has had its commitProperties(), measure(), and updateDisplayList() methods called (if needed). | UIComponent | ||
| Dispatched when a component is monitored by a Validator and the validation succeeded. | UIComponent | ||
| Dispatched when values are changed programmatically or by user interaction. | UIComponent | ||
Styles
Styles are either common or associated with a specific theme. If the style is common, it can be used with any theme. If a style is associated with a specific theme, it can only be used if your application uses that theme.
Common Styles
| Style | Description | Defined By | ||
|---|---|---|---|---|
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 for the Halo theme is 22. The default value for the Spark theme is 18. | 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 | ||
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 bottom edge of the component to the bottom edge of its parent container's 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 for the Halo theme is 250. The default value for the Spark theme is 50. | 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 for the Halo theme is 0x0B333C.
The default value for the Spark theme is 0x000000.
| ComboBox | ||
direction | Type: String CSS Inheritance: yes The directionality of the text displayed by the component. The allowed values are FTE and TLF use this value in their bidirectional text layout algorithm, which maps Unicode character order to glyph order. Note: This style only applies when an MX component
specifies UIFTETextField as its The "ltr". | 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 | ||
| 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 | ||
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 | ||
| 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 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 | ||
focusAlpha | Type: Number CSS Inheritance: no Specifies the alpha transparency value of the focus skin. The default value for the Halo theme is 0.4.
The default value for the Spark theme is 0.55.
| 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".Related API Elements | 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 font for the Halo theme is "Verdana".
The default font for the Spark theme is "Arial".
| 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".Related API Elements | 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 is 0.Related API Elements | ComboBox | ||
fontSize | Type: Number Format: Length CSS Inheritance: yes Height of the text, in pixels. In the Halo theme, the default value is 10 for all controls except the ColorPicker control. For the Halo themed ColorPicker control, the default value is 11. In the Spark theme, the default value is 12 for all controls except the ColorPicker control. For the Spark themed ColorPicker control, the default value is 11. | 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 is 0.Related API Elements | 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 | ||
| 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 | ||
| Type: String CSS Inheritance: yes The primary interaction mode for this component. | UIComponent | ||
kerning | Type: Boolean CSS Inheritance: yes A Boolean value that indicates whether kerning is enabled ( true) or disabled (false).
Kerning adjusts the gap between certain character pairs
to improve readability, and should be used only when necessary,
such as with headings in large fonts.
Kerning is supported for embedded fonts only.
Certain fonts, such as Verdana, and monospaced fonts,
such as Courier New, do not support kerning.
The default value is false. | ComboBox | ||
| Type: String CSS Inheritance: yes Specifies the desired layout direction of a component. | UIComponent | ||
leading | Type: Number Format: Length CSS Inheritance: yes Additional vertical space between lines of text. The default value is 2. The default value for the ComboBox control is 0. | ComboBox | ||
| Type: String CSS Inheritance: no The horizontal distance, in pixels, from the left edge of the component to the left edge of its parent container's content area. | UIComponent | ||
letterSpacing | Type: Number CSS Inheritance: yes The number of additional pixels to appear between each character. A positive value increases the character spacing beyond the normal spacing, while a negative value decreases it. The default value is 0. | ComboBox | ||
locale | Type: String CSS Inheritance: yes The locale of the text displayed by this component. FTE and TLF use this locale to map Unicode characters to font glyphs and to find fallback fonts. Note: This style only applies when an MX component
specifies UIFTETextField as its "en". | 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 for the Halo theme is 250. The default value for the Spark theme is 0. | 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 for the Halo theme is 0.
The default value for the Spark theme is -2.
| 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 in the Halo theme is 10 and in the Spark theme is 6. 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 in the Halo theme is 10 and in the Spark theme is 6. 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 for the Halo theme is 0.
The default value for the Spark theme is -1.
| ComboBox | ||
| Type: String CSS Inheritance: no The horizontal distance, in pixels, from the right edge of the component to the right edge of its parent container's content area. | UIComponent | ||
rollOverColor | Type: uint Format: Color CSS Inheritance: yes The rollOverColor of the drop-down list. The default value for the Halo theme is 0xB2E1FF.
The default value for the Spark theme is 0xCEDBEF.
Related API Elements | ComboBox | ||
selectionColor | Type: uint Format: Color CSS Inheritance: yes The selectionColor of the drop-down list. The default value for the Halo theme is 0x7FCEFF.
The default value for the Spark theme is 0xA8C6EE.
Related API Elements | ComboBox | ||
selectionDuration | Type: uint Format: Time CSS Inheritance: no The selectionDuration of the drop-down list. The default value is 250.Related API Elements | ComboBox | ||
selectionEasingFunction | Type: Function CSS Inheritance: no The selectionEasingFunction of the drop-down list. The default value is undefined.Related API Elements | ComboBox | ||
| Type: Boolean CSS Inheritance: yes Show the error border or skin when this component is invalid | UIComponent | ||
| Type: Boolean CSS Inheritance: yes Show the error tip when this component is invalid and the user rolls over it | UIComponent | ||
| 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 | ||
textFieldClass | Type: Class CSS Inheritance: no The class implementing IUITextField that is used by this component to render text. It can be set to either the mx.core.UITextField class (to use the classic TextField class built into Flash Player) or the mx.core.UIFTETextField class (to use the Text Layout Framework to get improved text rendering, including bidirectional layout). The default value is mx.core.UITextField. | 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: Class CSS Inheritance: no The class implementing ITextInput that is used by this component to input text. | ComboBase | ||
| 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 for the Halo theme is 0x2B333C.
The default value for the Spark theme is 0x000000.
Related API Elements | ComboBox | ||
textSelectedColor | Type: uint Format: Color CSS Inheritance: yes The textSelectedColor of the drop-down list. The default value for the Halo theme is 0x2B333C.
The default value for the Spark theme is 0x000000.
Related API Elements | ComboBox | ||
| Type: String CSS Inheritance: no The vertical distance, in pixels, from the top edge of the component to the top edge of its parent container's content area. | UIComponent | ||
| Type: 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 | ||
Spark Theme Styles
| Style | Description | Defined By | ||
|---|---|---|---|---|
| Type: uint Format: Color CSS Inheritance: yes Theme: spark The main color for a component. | UIComponent | ||
| Type: Number CSS Inheritance: yes Theme: spark The alpha of the content background for this component. | ComboBase | ||
| Type: uint Format: Color CSS Inheritance: yes Theme: spark Color of the content area of the component. | ComboBase | ||
cornerRadius | Type: Number Format: Length CSS Inheritance: no Theme: halo, spark 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 overridden for the class, the default value
for the Halo theme is 0 and for the Spark theme is 2.
| ComboBox | ||
| Type: uint Format: Color CSS Inheritance: yes Theme: spark Color of focus ring when the component is in focus | ComboBase | ||
| Type: uint Format: Color CSS Inheritance: yes Theme: spark Color of any symbol of a component. | ComboBase | ||
Halo Theme Styles
| Style | Description | Defined By | ||
|---|---|---|---|---|
borderColor | Type: uint Format: Color CSS Inheritance: no Theme: halo Color of the border. The following controls support this style: Button, CheckBox, ComboBox, MenuBar, NumericStepper, ProgressBar, RadioButton, ScrollBar, Slider, and any components that support the borderStyle style.
The default value depends on the component class;
if not overridden for the class, the default value is 0xB7BABC.
| ComboBox | ||
cornerRadius | Type: Number Format: Length CSS Inheritance: no Theme: halo, spark 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 overridden for the class, the default value
for the Halo theme is 0 and for the Spark theme is 2.
| ComboBox | ||
disabledIconColor | Type: uint Format: Color CSS Inheritance: yes Theme: halo The color for the icon in a disabled skin. For example, this style is used by the CheckBoxIcon skin class to draw the check mark for a disabled CheckBox control, by the ComboBoxSkin class to draw the down arrow of a disabled ComboBox control, and by the DateChooserMonthArrowSkin skin class to draw the month arrow for a disabled DateChooser control. The default value depends on the component class; if it is not overridden by the class, the default value is 0x999999.
| ComboBox | ||
dropdownBorderColor | Type: uint Format: Color CSS Inheritance: yes Theme: halo 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 | ||
fillAlphas | Type: Array CSS Inheritance: no Theme: halo 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 Theme: halo 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 | ||
highlightAlphas | Type: Array CSS Inheritance: no Theme: halo Alpha transparencies used for the highlight fill of controls. The first value specifies the transparency of the top of the highlight and the second value specifies the transparency of the bottom of the highlight. The highlight covers the top half of the skin. The default value is [ 0.3, 0.0 ]. | ComboBox | ||
iconColor | Type: uint Format: Color CSS Inheritance: yes Theme: halo The color for the icon in a skin. For example, this style is used by the CheckBoxIcon skin class to draw the check mark for a CheckBox control, by the ComboBoxSkin class to draw the down arrow of the ComboBox control, and by the DateChooserMonthArrowSkin skin class to draw the month arrow for the DateChooser control. The default value depends on the component class; if it is not overridden by the class, the default value is 0x111111.
| ComboBox | ||
| Type: uint Format: Color CSS Inheritance: yes Theme: halo Theme color of a component. | UIComponent | ||
Public Constants
Property Detail
data | property |
data:Object| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
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):voidRelated API Elements
dataProvider | property |
dataProvider:Object[override] | Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
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 get dataProvider():Object override public function set dataProvider(value:Object):voiddropdown | property |
dropdownFactory | property |
dropdownFactory:IFactory| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
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):voiddropDownStyleFilters | property |
dropDownStyleFilters:Object [read-only] | Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
The set of styles to pass from the ComboBox to the dropDown. Styles in the dropDownStyleName style will override these styles.
Implementation
protected function get dropDownStyleFilters():ObjectRelated API Elements
dropdownWidth | property |
dropdownWidth:Number| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
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):voiditemRenderer | property |
itemRenderer:IFactory| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
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):voidRelated API Elements
labelField | property |
labelField:String| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
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):voidlabelFunction | property |
labelFunction:Function| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
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):voidlistData | property |
listData:BaseListData| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
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):voidRelated API Elements
prompt | property |
prompt:String| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
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):voidrowCount | property |
rowCount:int| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
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):voidselectedIndex | property |
selectedIndex:int[override] | Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
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 get selectedIndex():int override public function set selectedIndex(value:int):voidselectedItem | property |
selectedItem:Object[override] | Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
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 get selectedItem():Object override public function set selectedItem(value:Object):voidselectedLabel | property |
selectedLabel:String [read-only] | Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
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():StringConstructor Detail
ComboBox | () | Constructor |
public function ComboBox()| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Constructor.
Method Detail
calculatePreferredSizeFromData | () | method |
override protected function calculatePreferredSizeFromData(count:int):Object| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
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.
|
Object — An Object containing two properties: width and height.
|
close | () | method |
itemToLabel | () | method |
public function itemToLabel(item:Object, ... rest):String| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
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
labelFunctionproperty, 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
labelFieldproperty, 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.
| |
... rest |
String — A string representing the item parameter.
|
measure | () | method |
override protected function measure():void| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
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| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Displays the drop-down list.
Event Detail
change | Event |
Event Object Type:
property ListEvent.type =
mx.events.ListEventproperty ListEvent.type =
mx.events.ListEvent.CHANGE| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
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.
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 |
Event Object Type:
property DropdownEvent.type =
mx.events.DropdownEventproperty DropdownEvent.type =
mx.events.DropdownEvent.CLOSE| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
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
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:
property FlexEvent.type =
mx.events.FlexEventproperty FlexEvent.type =
mx.events.FlexEvent.DATA_CHANGE| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
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.
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:
property FlexEvent.type =
mx.events.FlexEventproperty FlexEvent.type =
mx.events.FlexEvent.ENTER| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Dispatched if the editable property
is set to true and the user presses the Enter key
while typing in the editable text field.
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:
property ListEvent.type =
mx.events.ListEventproperty ListEvent.type =
mx.events.ListEvent.ITEM_ROLL_OUT| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
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.
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:
property ListEvent.type =
mx.events.ListEventproperty ListEvent.type =
mx.events.ListEvent.ITEM_ROLL_OVER| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
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.
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:
property DropdownEvent.type =
mx.events.DropdownEventproperty DropdownEvent.type =
mx.events.DropdownEvent.OPEN| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
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.
TheDropdownEvent.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:
property ScrollEvent.type =
mx.events.ScrollEventproperty ScrollEvent.type =
mx.events.ScrollEvent.SCROLL| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Dispatched when the user scrolls the ComboBox control's drop-down list.
TheScrollEvent.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" encoding="utf-8"?>
<!-- Simple example to demonstrate the Halo ComboBox control. -->
<s:Application xmlns:fx="http://ns.adobe.com/mxml/2009"
xmlns:s="library://ns.adobe.com/flex/spark"
xmlns:mx="library://ns.adobe.com/flex/mx">
<fx:Script>
<![CDATA[
import mx.collections.ArrayCollection;
import mx.events.DropdownEvent;
[Bindable]
public var cards:ArrayCollection = new ArrayCollection(
[ {label:"Visa", data:1},
{label:"MasterCard", data:2},
{label:"American Express", data:3} ]);
private function closeHandler(evt:DropdownEvent):void {
myLabel.text = "You selected: " + ComboBox(evt.target).selectedItem.label;
myData.text = "Data: " + ComboBox(evt.target).selectedItem.data;
}
]]>
</fx:Script>
<s:Panel title="Halo ComboBox Control Example"
width="75%" height="75%"
horizontalCenter="0" verticalCenter="0">
<s:HGroup left="10" right="10" top="10" bottom="10">
<mx:ComboBox dataProvider="{cards}" width="150"
close="closeHandler(event);"/>
<s:VGroup width="250">
<s:Label width="200" color="blue" text="Select a type of credit card."/>
<s:Label id="myLabel" text="You selected:"/>
<s:Label id="myData" text="Data:"/>
</s:VGroup>
</s:HGroup>
</s:Panel>
</s:Application>
Mon Nov 28 2011, 06:48 AM -08:00