| Package | com.flextras.autoCompleteComboBox |
| Class | public class AutoCompleteComboBox |
| Inheritance | AutoCompleteComboBox  ComboBox ComboBase UIComponent FlexSprite flash.display.Sprite |
See also
| Property | Defined by | ||
|---|---|---|---|
 | activeEffects : Array
The list of effects that are currently playing on the component,
as an Array of EffectInstance instances.
| UIComponent | |
| autoCompleteEnabled : Boolean
This property enables the AutoComplete functionality.
| AutoCompleteComboBox | ||
| autoCompleteFilterFunction : Function
This property defines the filter function used to filter the
dataProvider for AutoComplete purposes. | AutoCompleteComboBox | ||
| autoCompleteHighlightOnFocus : Boolean
Use this property if you want to select all characters in the autoCompleteTextInput when it gains focus.
| AutoCompleteComboBox | ||
| autoCompleteRemoteData : Boolean
Use this property if you are populating the dataProvider from a remote data source and want to change the dataProvider
with each character the user types.
| AutoCompleteComboBox | ||
| autoCompleteResetIndex : int
This property allows you to specify a default selectedIndex when the dataProvider is set or reset.
| AutoCompleteComboBox | ||
| autoCompleteSelectOnEnter : Boolean
Use this property if you want to select the first item in the AutoComplete's filtered drop down list when the user
presses the enter key.
| AutoCompleteComboBox | ||
| autoCompleteSelectOnEnterIfEmpty : Boolean
If set to true, the top item in the drop down will be selected when the user presses enter without having entered
any text.
| AutoCompleteComboBox | ||
| autoCompleteSelectOnEqual : Boolean
Use this property if you want to select an item in the AutoComplete's filtered drop down list
if that item is equal to the text you typed.
| AutoCompleteComboBox | ||
| autoCompleteSelectOnEqualCaseSensitivity : Boolean
This controls the case sensitivity of the autoCompleteSelectOnEqual comparison.
| AutoCompleteComboBox | ||
| autoCompleteSelectOnOne : Boolean
Use this property if you want to select an item in the AutoComplete's filtered drop down list
if there is only a single item remaining.
| AutoCompleteComboBox | ||
| automationDelegate : Object
The delegate object that handles the automation-related functionality.
| UIComponent | |
| automationName : String
Name that can be used as an identifier for this object.
| UIComponent | |
| automationTabularData : Object
An implementation of the
IAutomationTabularData interface, which
can be used to retrieve the data. | UIComponent | |
| automationValue : Array
This value generally corresponds to the rendered appearance of the
object and should be usable for correlating the identifier with
the object as it appears visually within the application.
| UIComponent | |
| baselinePosition : Number
The y-coordinate of the baseline
of the first line of text of the component.
| UIComponent | |
| cacheHeuristic : Boolean
Used by Flex to suggest bitmap caching for the object.
| UIComponent | |
| cachePolicy : String
Specifies the bitmap caching policy for this object.
| UIComponent | |
| className : String
The name of this instance's class, such as
"Button". | UIComponent | |
| contentMouseX : Number
Returns the x position of the mouse, in the content coordinate system.
| UIComponent | |
| contentMouseY : Number
Returns the y position of the mouse, in the content coordinate system.
| UIComponent | |
| currentState : String
The current view state of the component.
| UIComponent | |
| cursorManager : ICursorManager
Gets the CursorManager that controls the cursor for this component
and its peers.
| UIComponent | |
| data : Object
The
data property lets you pass a value
to the component when you use it in an item renderer or item editor. | ComboBox | |
| dataProvider : Object
The set of items this component displays.
| AutoCompleteComboBox | ||
| descriptor : UIComponentDescriptor
Reference to the UIComponentDescriptor, if any, that was used
by the
createComponentFromDescriptor() method to create this
UIComponent instance. | UIComponent | |
| document : Object
A reference to the document object associated with this UIComponent.
| UIComponent | |
| doubleClickEnabled : Boolean
Specifies whether the UIComponent object receives
doubleClick events. | UIComponent | |
| downArrowVisible : Boolean
This property will control the visibility of the down arrow.
| AutoCompleteComboBox | ||
| dropdown : ListBase
[read-only]
A reference to the List control that acts as the drop-down in the ComboBox.
| AutoCompleteComboBox | ||
| dropdownFactory : IFactory
The IFactory that creates a ListBase-derived instance to use
as the drop-down.
| ComboBox | |
| dropdownWidth : Number
Width of the drop-down list, in pixels.
| ComboBox | |
| editable : Boolean
A flag that indicates whether the control is editable,
which lets the user directly type entries that are not specified
in the dataProvider, or not editable, which requires the user select
from the items in the dataProvider.
| ComboBase | |
| enabled : Boolean
Whether the component can accept user interaction.
| UIComponent | |
| errorString : String
The text that will be displayed by a component's error tip when a
component is monitored by a Validator and validation fails.
| UIComponent | |
| expandDropDownToContent : Boolean
This property specifies whether or not the drop down list will expand its’
width to make sure that none of it’s content will
be truncated. | AutoCompleteComboBox | ||
| explicitHeight : Number
Number that specifies the explicit height of the component,
in pixels, in the component's coordinates.
| UIComponent | |
| explicitMaxHeight : Number
Number that specifies the maximum height of the component,
in pixels, in the component's coordinates.
| UIComponent | |
| explicitMaxWidth : Number
Number that specifies the maximum width of the component,
in pixels, in the component's coordinates.
| UIComponent | |
| explicitMinHeight : Number
Number that specifies the minimum height of the component,
in pixels, in the component's coordinates.
| UIComponent | |
| explicitMinWidth : Number
Number that specifies the minimum width of the component,
in pixels, in the component's coordinates.
| UIComponent | |
| explicitWidth : Number
Number that specifies the explicit width of the component,
in pixels, in the component's coordinates.
| UIComponent | |
| flexContextMenu : IFlexContextMenu
The context menu for this UIComponent.
| UIComponent | |
| focusEnabled : Boolean
Indicates whether the component can receive focus when tabbed to.
| UIComponent | |
| focusManager : IFocusManager
Gets the FocusManager that controls focus for this component
and its peers.
| UIComponent | |
| focusPane : Sprite
The focus pane associated with this object.
| UIComponent | |
| height : Number
Number that specifies the height of the component, in pixels,
in the parent's coordinates.
| UIComponent | |
| id : String
ID of the component.
| UIComponent | |
| imeMode : String
Specifies the IME (input method editor) mode.
| ComboBase | |
| includeInLayout : Boolean
Specifies whether this component is included in the layout of the
parent container.
| UIComponent | |
| inheritingStyles : Object
The beginning of this component's chain of inheriting styles.
| UIComponent | |
| initialized : Boolean
A flag that determines if an object has been through all three phases
of layout: commitment, measurement, and layout (provided that any were required).
| UIComponent | |
| instanceIndex : int
The index of a repeated component.
| UIComponent | |
| instanceIndices : Array
An Array containing the indices required to reference
this UIComponent object from its parent document.
| UIComponent | |
| isDocument : Boolean
Determines whether this UIComponent instance is a document object,
that is, whether it is at the top of the hierarchy of a Flex
application, MXML component, or ActionScript component.
| UIComponent | |
| isPopUp : Boolean
Set to
true by the PopUpManager to indicate
that component has been popped up. | UIComponent | |
| itemRenderer : IFactory
IFactory that generates the instances that displays the data for the
drop-down list of the control.
| ComboBox | |
| labelField : String
Name of the field in the items in the
dataProvider
Array to display as the label in the TextInput portion and drop-down list. | ComboBox | |
| labelFunction : Function
User-supplied function to run on each item to determine its label.
| ComboBox | |
| listData : BaseListData
When a component is used as a drop-in item renderer or drop-in item
editor, Flex initializes the
listData property of the
component with the appropriate data from the List control. | ComboBox | |
| maxHeight : Number
Number that specifies the maximum height of the component,
in pixels, in the component's coordinates.
| UIComponent | |
| maxWidth : Number
Number that specifies the maximum width of the component,
in pixels, in the component's coordinates.
| UIComponent | |
| measuredHeight : Number
The default height of the component, in pixels.
| UIComponent | |
| measuredMinHeight : Number
The default minimum height of the component, in pixels.
| UIComponent | |
| measuredMinWidth : Number
The default minimum width of the component, in pixels.
| UIComponent | |
| measuredWidth : Number
The default width of the component, in pixels.
| UIComponent | |
| minHeight : Number
Number that specifies the minimum height of the component,
in pixels, in the component's coordinates.
| UIComponent | |
| minWidth : Number
Number that specifies the minimum width of the component,
in pixels, in the component's coordinates.
| UIComponent | |
| moduleFactory : IFlexModuleFactory
The moduleFactory that is used to create TextFields in the correct SWF context.
| UIComponent | |
| mouseFocusEnabled : Boolean
Whether you can receive focus when clicked on.
| UIComponent | |
| nestLevel : int
Depth of this object in the containment hierarchy.
| UIComponent | |
| nonInheritingStyles : Object
The beginning of this component's chain of non-inheriting styles.
| UIComponent | |
| numAutomationChildren : int
The number of automation children this container has.
| UIComponent | |
| owner : DisplayObjectContainer
The owner of this UIComponent.
| UIComponent | |
| parent : DisplayObjectContainer
The parent container or component for this component.
| UIComponent | |
| parentApplication : Object
A reference to the Application object that contains this UIComponent
instance.
| UIComponent | |
| parentDocument : Object
A reference to the parent document object for this UIComponent.
| UIComponent | |
| percentHeight : Number
Number that specifies the height of a component as a percentage
of its parent's size.
| UIComponent | |
| percentWidth : Number
Number that specifies the width of a component as a percentage
of its parent's size.
| UIComponent | |
| processedDescriptors : Boolean
Set to
true after immediate or deferred child creation,
depending on which one happens. | UIComponent | |
| prompt : String
The prompt for the ComboBox control.
| ComboBox | |
| repeater : IRepeater
A reference to the Repeater object
in the parent document that produced this UIComponent.
| UIComponent | |
| repeaterIndex : int
The index of the item in the data provider
of the Repeater that produced this UIComponent.
| UIComponent | |
| repeaterIndices : Array
An Array containing the indices of the items in the data provider
of the Repeaters in the parent document that produced this UIComponent.
| UIComponent | |
| repeaters : Array
An Array containing references to the Repeater objects
in the parent document that produced this UIComponent.
| UIComponent | |
| restrict : String
Set of characters that a user can or cannot enter into the text field.
| ComboBase | |
| rowCount : int
Maximum number of rows visible in the ComboBox control list.
| AutoCompleteComboBox | ||
| scaleX : Number
Number that specifies the horizontal scaling factor.
| UIComponent | |
| scaleY : Number
Number that specifies the vertical scaling factor.
| UIComponent | |
| screen : Rectangle
Returns an object that contains the size and position of the base
drawing surface for this object.
| UIComponent | |
| selectedIndex : int
The index in the data provider of the selected item.
| AutoCompleteComboBox | ||
| selectedItem : Object
Contains a reference to the selected item in the
dataProvider. | ComboBox | |
| selectedLabel : String
The String displayed in the TextInput portion of the ComboBox.
| ComboBox | |
| selectedValue : String
In HTML select boxes, you have a display piece, or label, and the value, or data.
| AutoCompleteComboBox | ||
| showInAutomationHierarchy : Boolean
A flag that determines if an automation object
shows in the automation hierarchy.
| UIComponent | |
| states : Array
The view states that are defined for this component.
| UIComponent | |
| styleDeclaration : CSSStyleDeclaration
Storage for the inline inheriting styles on this object.
| UIComponent | |
| styleName : Object
The class style used by this component.
| UIComponent | |
| systemManager : ISystemManager
Returns the SystemManager object used by this component.
| UIComponent | |
| text : String
This property keeps track of the characters in the the AutoComplete input.
| AutoCompleteComboBox | ||
| toolTip : String
If you explicitly set a tooltop then it will not be reset when truncateToFit is on and the item is truncated
Text to display in the ToolTip.
| AutoCompleteComboBox | ||
| 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 | |
| truncateToFit : Boolean
If the
truncateToFit property is true, and the ComboBox control size is smaller than the
text it needs to display, the text of the Label control is truncated using the text specified by
truncationIndicator. | AutoCompleteComboBox | ||
| truncationIndicator : String
When the display text is too long for the space it can be showed in, this is the text used to truncate in display piece is too
long for the space, it will be truncated, and the
truncationIndicator text appended to the end. | AutoCompleteComboBox | ||
| tweeningProperties : Array
Array of properties that are currently being tweened on this object.
| UIComponent | |
| typeAheadEnabled : Boolean
This property specifies whether the user can type-ahead with multiple characters.
| AutoCompleteComboBox | ||
| typeAheadResetDelay : int
This property specifies the number of milliseconds before the type-ahead text is reset to an empty string.
| AutoCompleteComboBox | ||
| typeAheadTextValue : String
Exposes the type ahead text value that is used in both both typeAhead and AutoComplete functionality.
| AutoCompleteComboBox | ||
| uid : String
A unique identifier for the object.
| UIComponent | |
| updateCompletePendingFlag : Boolean
A flag that determines if an object has been through all three phases
of layout validation (provided that any were required).
| UIComponent | |
| validationSubField : String
Used by a validator to associate a subfield with this component.
| UIComponent | |
| value : Object
The value of the selected item.
| ComboBase | |
| valueField : String
This property contaibs the name of the data in the items in the
dataProvider Array that will be used for setting or
getting the selectedValue. | AutoCompleteComboBox | ||
| valueFunction : Function
This property represents a user-supplied function to run on each item to determine its value, or data.
| AutoCompleteComboBox | ||
| visible : Boolean
Controls the visibility of this UIComponent.
| UIComponent | |
| width : Number
Number that specifies the width of the component, in pixels,
in the parent's coordinates.
| AutoCompleteComboBox | ||
| x : Number
Number that specifies the component's horizontal position,
in pixels, within its parent container.
| UIComponent | |
| y : Number
Number that specifies the component's vertical position,
in pixels, within its parent container.
| UIComponent | |
| Property | Defined by | ||
|---|---|---|---|
| arrowButtonStyleFilters : Object
Set of styles to pass from the ComboBase to the down arrow button
| ComboBase | |
| borderMetrics : EdgeMetrics
Returns an EdgeMetrics object that has four properties:
left, top, right,
and bottom. | ComboBase | |
| collection : ICollectionView
The ICollectionView of items this component displays.
| ComboBase | |
| dropDownStyleFilters : Object
The set of styles to pass from the ComboBox to the dropDown.
| ComboBox | |
| iterator : IViewCursor
The main IViewCursor used to fetch items from the
dataProvider and pass the items to the renderers.
| ComboBase | |
| textInput : TextInput
The internal TextInput subcomponent that displays
the current selection.
| ComboBase | |
| textInputStyleFilters : Object
The set of styles to pass from the ComboBase to the text input.
| ComboBase | |
| typeAheadText : String
This property keeps track of the characters that the user typed.
| AutoCompleteComboBox | ||
| unscaledHeight : Number
A convenience method for determining the unscaled height
of the component.
| UIComponent | |
| unscaledWidth : Number
A convenience method for determining the unscaled width
of the component
All of a component's drawing and child layout should be done
within a bounding rectangle of this width, which is also passed
as an argument to
updateDisplayList(). | UIComponent | |
| Method | Defined by | ||
|---|---|---|---|
|
Constructor.
| AutoCompleteComboBox | ||
|
autoCompleteSetTypeAheadText(value:String = ""):void
This method lets you reset the AutoComplete Type Ahead Text.
| AutoCompleteComboBox | ||
|
callLater(method:Function, args:Array = null):void
Queues a function to be called later.
| UIComponent | |
|
clearStyle(styleProp:String):void
Deletes a style property from this component instance.
| UIComponent | |
|
close(trigger:Event = null):void
Hides the drop-down list.
| AutoCompleteComboBox | ||
|
contentToGlobal(point:Point):Point
Converts a
Point object from content coordinates to global coordinates. | UIComponent | |
|
contentToLocal(point:Point):Point
Converts a
Point object from content to local coordinates. | UIComponent | |
|
createAutomationIDPart(child:IAutomationObject):Object
Returns a set of properties that identify the child within
this container.
| UIComponent | |
|
createReferenceOnParentDocument(parentDocument:IFlexDisplayObject):void
Creates an
id reference to this IUIComponent object
on its parent document object. | UIComponent | |
|
deleteReferenceOnParentDocument(parentDocument:IFlexDisplayObject):void
Deletes the
id reference to this IUIComponent object
on its parent document object. | UIComponent | |
|
Returns a UITextFormat object corresponding to the text styles
for this UIComponent.
| UIComponent | |
|
dispatchEvent(event:Event):Boolean
Dispatches an event into the event flow.
| UIComponent | |
|
drawFocus(isFocused:Boolean):void
Shows or hides the focus indicator around this component.
| UIComponent | |
|
drawRoundRect(x:Number, y:Number, w:Number, h:Number, r:Object = null, c:Object = null, alpha:Object = null, rot:Object = null, gradient:String = null, ratios:Array = null, hole:Object = null):void
Programatically draws a rectangle into this skin's Graphics object.
| UIComponent | |
|
effectFinished(effectInst:IEffectInstance):void
Called by the effect instance when it stops playing on the component.
| UIComponent | |
|
effectStarted(effectInst:IEffectInstance):void
Called by the effect instance when it starts playing on the component.
| UIComponent | |
|
endEffectsStarted():void
Ends all currently playing effects on the component.
| UIComponent | |
|
executeBindings(recurse:Boolean = false):void
Executes the data bindings into this UIComponent object.
| UIComponent | |
|
finishPrint(obj:Object, target:IFlexDisplayObject):void
Called after printing is complete.
| UIComponent | |
|
getAutomationChildAt(index:int):IAutomationObject
Provides the automation object at the specified index.
| UIComponent | |
|
getClassStyleDeclarations():Array
Finds the type selectors for this UIComponent instance.
| UIComponent | |
|
getConstraintValue(constraintName:String):*
Returns a layout constraint value, which is the same as
getting the constraint style for this component.
| UIComponent | |
|
getExplicitOrMeasuredHeight():Number
A convenience method for determining whether to use the
explicit or measured height
| UIComponent | |
|
getExplicitOrMeasuredWidth():Number
A convenience method for determining whether to use the
explicit or measured width
| UIComponent | |
|
getFocus():InteractiveObject
Gets the object that currently has focus.
| UIComponent | |
|
getRepeaterItem(whichRepeater:int = -1):Object
Returns the item in the
dataProvider that was used
by the specified Repeater to produce this Repeater, or
null if this Repeater isn't repeated. | UIComponent | |
|
getStyle(styleProp:String):*
Gets a style property that has been set anywhere in this
component's style lookup chain.
| UIComponent | |
|
globalToContent(point:Point):Point
Converts a
Point object from global to content coordinates. | UIComponent | |
|
horizontalGradientMatrix(x:Number, y:Number, width:Number, height:Number):Matrix
Returns a box Matrix which can be passed to the
drawRoundRect() method
as the rot parameter when drawing a horizontal gradient. | UIComponent | |
|
initialize():void
Initializes the internal structure of this component.
| UIComponent | |
|
initializeRepeaterArrays(parent:IRepeaterClient):void
Initializes various properties which keep track of repeated instances
of this component.
| UIComponent | |
|
invalidateDisplayList():void
Marks a component so that its
updateDisplayList()
method gets called during a later screen update. | UIComponent | |
|
invalidateProperties():void
Marks a component so that its
commitProperties()
method gets called during a later screen update. | UIComponent | |
|
invalidateSize():void
Marks a component so that its
measure()
method gets called during a later screen update. | UIComponent | |
|
itemToData(item:Object):String
Returns a string representing the
data parameter, Modeled, conceptually, after itemToLabel
| AutoCompleteComboBox | ||
|
itemToLabel(item:Object):String
Returns a string representing the
item parameter. | ComboBox | |
|
localToContent(point:Point):Point
Converts a
Point object from local to content coordinates. | UIComponent | |
|
measureHTMLText(htmlText:String):TextLineMetrics
Measures the specified HTML text, which may contain HTML tags such
as
<font> and <b>,
assuming that it is displayed
in a single-line UITextField using a UITextFormat
determined by the styles of this UIComponent. | UIComponent | |
|
measureText(text:String):TextLineMetrics
Measures the specified text, assuming that it is displayed
in a single-line UITextField using a UITextFormat
determined by the styles of this UIComponent.
| UIComponent | |
|
move(x:Number, y:Number):void
Moves the component to a specified position within its parent.
| UIComponent | |
|
notifyStyleChangeInChildren(styleProp:String, recursive:Boolean):void
Propagates style changes to the children.
| UIComponent | |
|
open():void
Displays the drop-down list.
| AutoCompleteComboBox | ||
|
owns(child:DisplayObject):Boolean
Returns
true if the chain of owner properties
points from child to this UIComponent. | UIComponent | |
|
parentChanged(p:DisplayObjectContainer):void
Called by Flex when a UIComponent object is added to or removed from a parent.
| UIComponent | |
|
prepareToPrint(target:IFlexDisplayObject):Object
Prepares an IFlexDisplayObject for printing.
| UIComponent | |
|
regenerateStyleCache(recursive:Boolean):void
Builds or rebuilds the CSS style cache for this component
and, if the
recursive parameter is true,
for all descendants of this component as well. | UIComponent | |
|
registerEffects(effects:Array):void
For each effect event, registers the EffectManager
as one of the event listeners.
| UIComponent | |
|
replayAutomatableEvent(event:Event):Boolean
Replays the specified event.
| UIComponent | |
|
resolveAutomationIDPart(criteria:Object):Array
Resolves a child by using the id provided.
| UIComponent | |
|
resumeBackgroundProcessing():void
[static]
Resumes the background processing of methods
queued by
callLater(), after a call to
suspendBackgroundProcessing(). | UIComponent | |
|
setActualSize(w:Number, h:Number):void
Sizes the object.
| UIComponent | |
|
setConstraintValue(constraintName:String, value:*):void
Sets a layout constraint value, which is the same as
setting the constraint style for this component.
| UIComponent | |
|
setCurrentState(stateName:String, playTransition:Boolean = true):void
Set the current state.
| UIComponent | |
|
setFocus():void
Sets the focus to this component.
| UIComponent | |
|
setStyle(styleProp:String, newValue:*):void
Sets a style property on this component instance.
| UIComponent | |
|
setVisible(value:Boolean, noEvent:Boolean = false):void
Called when the
visible property changes. | UIComponent | |
|
styleChanged(styleProp:String):void
Detects changes to style properties.
| UIComponent | |
|
stylesInitialized():void
Flex calls the
stylesInitialized() method when
the styles for a component are first initialized. | UIComponent | |
|
suspendBackgroundProcessing():void
[static]
Blocks the background processing of methods
queued by
callLater(),
until resumeBackgroundProcessing() is called. | UIComponent | |
|
toString():String
Returns a string indicating the location of this object
within the hierarchy of DisplayObjects in the Application.
| FlexSprite | |
|
validateDisplayList():void
Validates the position and size of children and draws other
visuals.
| UIComponent | |
|
validateNow():void
Validate and update the properties and layout of this object
and redraw it, if necessary.
| UIComponent | |
|
validateProperties():void
Used by layout logic to validate the properties of a component
by calling the
commitProperties() method. | UIComponent | |
|
validateSize(recursive:Boolean = false):void
Validates the measured size of the component
If the
LayoutManager.invalidateSize() method is called with
this ILayoutManagerClient, then the validateSize() method
is called when it's time to do measurements. | UIComponent | |
|
validationResultHandler(event:ValidationResultEvent):void
Handles both the
valid and invalid events from a
validator assigned to this component. | UIComponent | |
|
verticalGradientMatrix(x:Number, y:Number, width:Number, height:Number):Matrix
Returns a box Matrix which can be passed to
drawRoundRect()
as the rot parameter when drawing a vertical gradient. | UIComponent | |
| Method | Defined by | ||
|---|---|---|---|
|
adjustFocusRect(obj:DisplayObject = null):void
Adjust the focus rectangle.
| UIComponent | |
|
attachOverlay():void
This is an internal method used by the Flex framework
to support the Dissolve effect.
| UIComponent | |
|
autoCompleteFilter(item:Object):Boolean
This is the default filter function for AutoComplete functionality.
| AutoCompleteComboBox | ||
|
calculatePreferredSizeFromData(count:int):Object
Determines default values of the height and width to use for each
entry in the drop-down list, based on the maximum size of the label
text in the first
numItems items in the data provider. | ComboBox | |
|
childrenCreated():void
Performs any final processing after child objects are created.
| UIComponent | |
|
collectionChangeHandler(event:Event):void
Responds to changes to the data provider.
| ComboBase | |
|
commitProperties():void
Processes the properties set on the component.
| UIComponent | |
|
createChildren():void
Create child objects of the component.
| UIComponent | |
|
createInFontContext(classObj:Class):Object
Creates a new object using a context
based on the embedded font being used.
| UIComponent | |
|
createInModuleContext(moduleFactory:IFlexModuleFactory, className:String):Object
Creates the object using a given moduleFactory.
| UIComponent | |
|
downArrowButton_buttonDownHandler(event:FlexEvent):void
Performs some action when the drop-down button is pressed.
| ComboBase | |
|
focusInHandler(event:FocusEvent):void
The event handler called when a UIComponent object gets focus.
| UIComponent | |
|
focusOutHandler(event:FocusEvent):void
The event handler called when a UIComponent object loses focus.
| UIComponent | |
|
initializationComplete():void
Finalizes the initialization of this component.
| UIComponent | |
|
initializeAccessibility():void
Initializes this component's accessibility code.
| UIComponent | |
|
isOurFocus(target:DisplayObject):Boolean
Typically overridden by components containing UITextField objects,
where the UITextField object gets focus.
| UIComponent | |
|
itemToUID(data:Object):String
Determines the UID for a dataProvider item.
| ComboBase | |
|
keyDownHandler(event:KeyboardEvent):void
The event handler called for a
keyDown event. | UIComponent | |
|
keyUpHandler(event:KeyboardEvent):void
The event handler called for a
keyUp event. | UIComponent | |
|
measure():void
Makes sure the control is at least 40 pixels wide,
and tall enough to fit one line of text
in the TextInput portion of the control but at least
22 pixels high.
| ComboBox | |
|
resourcesChanged():void
This method is called when a UIComponent is constructed,
and again whenever the ResourceManager dispatches
a
"change" Event to indicate
that the localized resources have changed in some way. | UIComponent | |
|
textInput_changeHandler(event:Event):void
Handles changes to the TextInput that serves as the editable
text field in the component.
| ComboBase | |
|
truncateLabel():Boolean
This method truncates text to make it fit horizontally in the area defined for the control, and append
the
trunctationIndicator to the text. | AutoCompleteComboBox | ||
|
updateDisplayList(unscaledWidth:Number, unscaledHeight:Number):void
Sizes and positions the internal components in the given width
and height.
| ComboBase | |
| Event | Summary | Defined by | ||
|---|---|---|---|---|
|
Dispatched when the component is added to a container as a content child
by using the addChild() or addChildAt() method. | UIComponent | ||
This event is dispatched before the dataProvider is filtered for AutoComplete Purposes. | AutoCompleteComboBox | |||
This event is dispatched after the dataProvider is filtered for AutoComplete Purposes. | AutoCompleteComboBox | |||
|
Dispatched when the ComboBox contents changes as a result of user
interaction, when the selectedIndex or
selectedItem property changes, and, if the ComboBox control
is editable, each time a keystroke is entered in the box. | ComboBox | ||
|
Dispatched when the drop-down list is dismissed for any reason such when
the user:
| ComboBox | ||
| Dispatched when the component has finished its construction, property processing, measuring, layout, and drawing. | UIComponent | ||
| Dispatched after the view state has changed. | UIComponent | ||
|
Dispatched after the currentState property changes,
but before the view state changes. | UIComponent | ||
|
Dispatched when the data property changes. | ComboBox | ||
| Dispatched by the drag initiator (the component that is the source of the data being dragged) when the drag operation completes, either when you drop the dragged data onto a drop target or when you end the drag-and-drop operation without performing a drop. | UIComponent | ||
| Dispatched by the drop target when the user releases the mouse over it. | UIComponent | ||
| Dispatched by a component when the user moves the mouse over the component during a drag operation. | UIComponent | ||
| Dispatched by the component when the user drags outside the component, but does not drop the data onto the target. | UIComponent | ||
| Dispatched by a component when the user moves the mouse while over the component during a drag operation. | UIComponent | ||
| Dispatched by the drag initiator when starting a drag operation. | UIComponent | ||
| This event is dispatched when AutoComplete is enabled and the dataProvider was just filtered, causing a change in the number of dataProvider items, therefore needing an expansion or contraction of the drop down height. | AutoCompleteComboBox | |||
This event is dispatched when expandDropDownToContent is set to true and we're about to expand the width of the drop down. | AutoCompleteComboBox | |||
This event is dispatched when expandDropDownToContent is set to true and we just expanded the width of the drop down. | AutoCompleteComboBox | |||
| Dispatched after an effect ends. | UIComponent | ||
| Dispatched just before an effect starts. | UIComponent | ||
|
Dispatched if the editable property
is set to true and the user presses the Enter key
while typing in the editable text field. | ComboBox | ||
| Dispatched after the component has returned to the root view state. | UIComponent | ||
| Dispatched before the component exits from the root view state. | UIComponent | ||
| Dispatched when an object's state changes from visible to invisible. | UIComponent | ||
| Dispatched when the component has finished its construction and has all initialization properties set. | UIComponent | ||
| Dispatched when a component is monitored by a Validator and the validation failed. | UIComponent | ||
| Dispatched when user rolls the mouse out of a drop-down list item. | ComboBox | ||
| Dispatched when the user rolls the mouse over a drop-down list item. | ComboBox | ||
This event is dispatched when truncateToFit is set to true, but there was enough room to display the selectedLabel without shortening it. | AutoCompleteComboBox | |||
| This event is dispatched when the display label was truncated. | AutoCompleteComboBox | |||
| Dispatched from a component opened using the PopUpManager when the user clicks outside it. | UIComponent | ||
| Dispatched from a component opened using the PopUpManager when the user scrolls the mouse wheel outside it. | UIComponent | ||
| Dispatched when the object has moved. | UIComponent | ||
| Dispatched when the user clicks the drop-down button to display the drop-down list. | ComboBox | ||
| Dispatched at the beginning of the component initialization sequence. | UIComponent | ||
|
Dispatched when the component is removed from a container as a content child
by using the removeChild() or removeChildAt() method. | UIComponent | ||
| Dispatched when the component is resized. | UIComponent | ||
| Dispatched when the user scrolls the ComboBox control's drop-down list. | ComboBox | ||
This event is dispatched when the selectedValue was set, but not found in the dataProvider. | AutoCompleteComboBox | |||
| Dispatched when an object's state changes from invisible to visible. | UIComponent | ||
| Dispatched by the component when it is time to create a ToolTip. | UIComponent | ||
| Dispatched by the component when its ToolTip has been hidden and will be discarded soon. | UIComponent | ||
| Dispatched by the component when its ToolTip is about to be hidden. | UIComponent | ||
| Dispatched by the component when its ToolTip is about to be shown. | UIComponent | ||
| Dispatched by the component when its ToolTip has been shown. | UIComponent | ||
|
Dispatched by a component whose toolTip property is set,
as soon as the user moves the mouse over it. | UIComponent | ||
This event is dispatched when the type-ahead timer is complete and the typeAheadText is reset. | AutoCompleteComboBox | |||
| This event is dispatched when the type-ahead timer is started. | AutoCompleteComboBox | |||
| This event is dispatched when the type-ahead timer is stopped without completing. | AutoCompleteComboBox | |||
| This event id dispatched when type-ahead text changes. | AutoCompleteComboBox | |||
|
Dispatched when an object has had its commitProperties(),
measure(), and
updateDisplayList() methods called (if needed). | UIComponent | ||
| Dispatched when a component is monitored by a Validator and the validation succeeded. | UIComponent | ||
| Dispatched when values are changed programmatically or by user interaction. | UIComponent | ||
| Style | Description | Defined by | ||
|---|---|---|---|---|
| Type: Array Format: Color CSS Inheritance: yes The set of BackgroundColors for drop-down list rows in an alternating pattern. | ComboBox | ||
| Type: Number Format: Length CSS Inheritance: no Width of the arrow button in pixels. | ComboBox | ||
|
autoCompleteTextInputStyleName
| Type: String CSS Inheritance: yes This style is a pass through style for the AutoComplete TextInput The default value is TextInput. | AutoCompleteComboBox | ||
| 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 | ||
| Type: uint Format: Color CSS Inheritance: no Color of the border. | ComboBox | ||
| Type: Number Format: Length CSS Inheritance: no The thickness of the border of the drop-down list, in pixels. | ComboBox | ||
| Type: String CSS Inheritance: no The vertical distance in pixels from the lower edge of the component to the lower edge of its content area. | UIComponent | ||
| Type: Number Format: Time CSS Inheritance: no The length of the transition when the drop-down list closes, in milliseconds. | ComboBox | ||
| Type: Function CSS Inheritance: no An easing function to control the close transition. | ComboBox | ||
| Type: uint Format: Color CSS Inheritance: yes Color of text in the component, including the component label. | ComboBox | ||
| Type: Number Format: Length CSS Inheritance: no Radius of component corners. | ComboBox | ||
| Type: uint Format: Color CSS Inheritance: yes Color of text in the component if it is disabled. | ComboBox | ||
| Type: uint Format: Color CSS Inheritance: yes The color for the icon in a disabled skin. | 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 | ||
| Type: uint Format: Color CSS Inheritance: yes The color of the border of the ComboBox. | ComboBox | ||
| Type: String CSS Inheritance: no The name of a CSSStyleDeclaration to be used by the drop-down list. | ComboBox | ||
| Type: String CSS Inheritance: no The name of a CSSStyleDeclaration to be used by the drop-down list. | ComboBox | ||
| Type: Class CSS Inheritance: no Name of the class to use as the skin for the background and border when the control is disabled, and the editable
property is true. | ComboBase | ||
| Type: Class CSS Inheritance: no Name of the class to use as the skin for the background and border when the user holds down the mouse button, and the editable
property is true. | ComboBase | ||
| Type: Class CSS Inheritance: no Name of the class to use as the skin for the background and border when the mouse is over the control, and the editable
property is true. | ComboBase | ||
| Type: Class CSS Inheritance: no Name of the class to use as the skin for the background and border when the mouse is not over the control, and the editable
property is true. | ComboBase | ||
| Type: uint Format: Color CSS Inheritance: yes Color of the component highlight when validation fails. | UIComponent | ||
| Type: Array CSS Inheritance: no Alphas used for the background fill of controls. | ComboBox | ||
| Type: Array Format: Color CSS Inheritance: no Colors used to tint the background of the control. | ComboBox | ||
| Type: Number CSS Inheritance: no Specifies the alpha transparency value of the focus skin. | ComboBox | ||
| Type: String CSS Inheritance: no Blend mode used by the focus rectangle. | UIComponent | ||
| Type: String CSS Inheritance: no Specifies which corners of the focus rectangle should be rounded. | 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 | ||
| Type: String CSS Inheritance: yes Sets the antiAliasType property of internal TextFields. | ComboBox | ||
| Type: String CSS Inheritance: yes Name of the font to use. | ComboBox | ||
| Type: String CSS Inheritance: yes Sets the gridFitType property of internal TextFields that represent text in Flex controls. | ComboBox | ||
| Type: Number CSS Inheritance: yes Sets the sharpness property of internal TextFields that represent text in Flex controls. | ComboBox | ||
| Type: Number Format: Length CSS Inheritance: yes Height of the text, in pixels. | ComboBox | ||
| Type: String CSS Inheritance: yes Determines whether the text is italic font. | ComboBox | ||
| Type: Number CSS Inheritance: yes Sets the thickness property of internal TextFields that represent text in Flex controls. | ComboBox | ||
| Type: String CSS Inheritance: yes Determines whether the text is boldface. | ComboBox | ||
| Type: Array CSS Inheritance: no Alpha transparencies used for the highlight fill of controls. | 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: uint Format: Color CSS Inheritance: yes The color for the icon in a skin. | ComboBox | ||
| Type: Boolean CSS Inheritance: yes A Boolean value that indicates whether kerning is enabled ( true) or disabled (false). | ComboBox | ||
| Type: Number Format: Length CSS Inheritance: yes Additional vertical space between lines of text. | ComboBox | ||
| Type: String CSS Inheritance: no The horizontal distance in pixels from the left edge of the component's content area to the left edge of the component. | UIComponent | ||
| Type: Number CSS Inheritance: yes The number of additional pixels to appear between each character. | ComboBox | ||
| Type: Number Format: Time CSS Inheritance: no Length of the transition when the drop-down list opens, in milliseconds. | ComboBox | ||
| Type: Function CSS Inheritance: no An easing function to control the open transition. | 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 | ||
| Type: Number Format: Length CSS Inheritance: no Number of pixels between the control's bottom border and the bottom of its content area. | ComboBox | ||
| Type: Number Format: Length CSS Inheritance: no Number of pixels between the component's left border and the left edge of its content area. | ComboBox | ||
| Type: Number Format: Length CSS Inheritance: no Number of pixels between the component's right border and the right edge of its content area. | ComboBox | ||
| Type: Number Format: Length CSS Inheritance: no Number of pixels between the control's top border and the top of its content area. | ComboBox | ||
| Type: String CSS Inheritance: no The horizontal distance in pixels from the right edge of the component to the right edge of its content area. | UIComponent | ||
| Type: uint Format: Color CSS Inheritance: yes The rollOverColor of the drop-down list. | ComboBox | ||
| Type: uint Format: Color CSS Inheritance: yes The selectionColor of the drop-down list. | ComboBox | ||
| Type: uint Format: Time CSS Inheritance: no The selectionDuration of the drop-down list. | ComboBox | ||
| Type: Function CSS Inheritance: no The selectionEasingFunction of the drop-down list. | ComboBox | ||
| Type: Class CSS Inheritance: no Name of the class to use as the default skin for the background and border. | ComboBase | ||
| Type: String CSS Inheritance: yes Alignment of text within a container. | ComboBox | ||
| Type: String CSS Inheritance: yes Determines whether the text is underlined. | ComboBox | ||
| Type: Number Format: Length CSS Inheritance: yes Offset of first line of text from the left side of the container, in pixels. | ComboBox | ||
| Type: String CSS Inheritance: no The style declaration for the internal TextInput subcomponent that displays the current selection. | ComboBase | ||
| Type: uint Format: Color CSS Inheritance: yes The textRollOverColor of the drop-down list. | ComboBox | ||
| Type: uint Format: Color CSS Inheritance: yes The textSelectedColor of the drop-down list. | ComboBox | ||
| Type: uint Format: Color CSS Inheritance: yes Theme color of a component. | UIComponent | ||
| Type: String CSS Inheritance: no The vertical distance in pixels from the top edge of the control's content area to the top edge of the component. | UIComponent | ||
| Type: Class CSS Inheritance: no Name of the class to use as the skin for the background and border when the mouse is not over the control. | ComboBase | ||
| Type: String CSS Inheritance: no The vertical distance in pixels from the center of the component's content area to the center of the component. | UIComponent | ||
| autoCompleteEnabled | property |
Hide Inherited Public Properties
Show Inherited Public PropertiesautoCompleteEnabled:Boolean [read-write]
This property enables the AutoComplete functionality. If you set it to true it will filter the list of items based on
the user's typed input. It is worth nothing that if this property is set to true, then type-ahead functionality will have
no affect. If this property is set to false, no AutoComplete functionality will be available.
The default value is false.
This property can be used as the source for data binding.
Implementation public function get autoCompleteEnabled():Boolean
public function set autoCompleteEnabled(value:Boolean):void
See also
| autoCompleteFilterFunction | property |
autoCompleteFilterFunction:Function [read-write]
This property defines the filter function used to filter the dataProvider for AutoComplete purposes.
The dataProvider is converted to a ListCollectionView internally.
The default value is autoCompleteFilter.
This property can be used as the source for data binding.
Implementation public function get autoCompleteFilterFunction():Function
public function set autoCompleteFilterFunction(value:Function):void
See also
| autoCompleteHighlightOnFocus | property |
autoCompleteHighlightOnFocus:Boolean [read-write]Use this property if you want to select all characters in the autoCompleteTextInput when it gains focus. If nothing is entered into the input, then nothing will be highlighted. If you are using a prompt and the prompt, then the prompt will be removed when the component gains focus. If nothing is typed or selected, then the prompt will be returned when the component loses focus.
The default value is false.
This property can be used as the source for data binding.
Implementation public function get autoCompleteHighlightOnFocus():Boolean
public function set autoCompleteHighlightOnFocus(value:Boolean):void
| autoCompleteRemoteData | property |
autoCompleteRemoteData:Boolean [read-write]Use this property if you are populating the dataProvider from a remote data source and want to change the dataProvider with each character the user types. It will prevent the drop down from being destroyed and recreated each time the dataProvider changes, which causes display oddities.
The default value is false.
This property can be used as the source for data binding.
Implementation public function get autoCompleteRemoteData():Boolean
public function set autoCompleteRemoteData(value:Boolean):void
| autoCompleteResetIndex | property |
autoCompleteResetIndex:int [read-write]This property allows you to specify a default selectedIndex when the dataProvider is set or reset. When we built this component we made the assumption that the default AutoComplete state would be the unselected state, where selectedIndex = -1, selectedItem = null, and no text is displayed in the AutoComplete input. Just in case you want the AutoComplete to select a default value, this property allows you to do that. Although this is a numerical property, presumably you will only want to set this value to -1 (unselected state) or 0 (first item in dataProvider).
The default value is -1.
This property can be used as the source for data binding.
Implementation public function get autoCompleteResetIndex():int
public function set autoCompleteResetIndex(value:int):void
| autoCompleteSelectOnEnter | property |
autoCompleteSelectOnEnter:Boolean [read-write]Use this property if you want to select the first item in the AutoComplete's filtered drop down list when the user presses the enter key. If enter is pressed and nothing is selected, the first item in the first will not be selected unless you set the autoCompleteSelectOnEnterIfEmpty to true.
The default value is false.
This property can be used as the source for data binding.
Implementation public function get autoCompleteSelectOnEnter():Boolean
public function set autoCompleteSelectOnEnter(value:Boolean):void
See also
| autoCompleteSelectOnEnterIfEmpty | property |
autoCompleteSelectOnEnterIfEmpty:Boolean [read-write]If set to true, the top item in the drop down will be selected when the user presses enter without having entered any text. This is used in conjunction with autoCompleteSelectOnEnter and only has an effect if autoCompleteSelectOnEnter is true.
The default value is false.
This property can be used as the source for data binding.
Implementation public function get autoCompleteSelectOnEnterIfEmpty():Boolean
public function set autoCompleteSelectOnEnterIfEmpty(value:Boolean):void
See also
| autoCompleteSelectOnEqual | property |
autoCompleteSelectOnEqual:Boolean [read-write]Use this property if you want to select an item in the AutoComplete's filtered drop down list if that item is equal to the text you typed. This is a case sensitive comparison by default. If you want to perform case insensitive comparison the autoCompleteSelectOnEqualCaseSensitivity property
The default value is false.
This property can be used as the source for data binding.
Implementation public function get autoCompleteSelectOnEqual():Boolean
public function set autoCompleteSelectOnEqual(value:Boolean):void
See also
| autoCompleteSelectOnEqualCaseSensitivity | property |
autoCompleteSelectOnEqualCaseSensitivity:Boolean [read-write]This controls the case sensitivity of the autoCompleteSelectOnEqual comparison. If set to true the comparison will be case sensitive. IF set to false the comparison will be case insensitive.
The default value is false.
This property can be used as the source for data binding.
Implementation public function get autoCompleteSelectOnEqualCaseSensitivity():Boolean
public function set autoCompleteSelectOnEqualCaseSensitivity(value:Boolean):void
See also
| autoCompleteSelectOnOne | property |
autoCompleteSelectOnOne:Boolean [read-write]Use this property if you want to select an item in the AutoComplete's filtered drop down list if there is only a single item remaining.
The default value is false.
This property can be used as the source for data binding.
Implementation public function get autoCompleteSelectOnOne():Boolean
public function set autoCompleteSelectOnOne(value:Boolean):void
| dataProvider | property |
dataProvider:Object [read-write]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.
Implementation public function get dataProvider():Object
public function set dataProvider(value:Object):void
| downArrowVisible | property |
downArrowVisible:Boolean [read-write]This property will control the visibility of the down arrow. Presumably you'll want to use this in conjunction with AutoComplete to create an AutoCompleteTextInput, as opposed to an AutoCompleteDropDown. Although you can use this if AutoComplete is not enabled, it will most likely cause odd results and we do not recommend it.
The default value is true.
This property can be used as the source for data binding.
Implementation public function get downArrowVisible():Boolean
public function set downArrowVisible(value:Boolean):void
| dropdown | property |
dropdown:ListBase [read-only]A reference to the List control that acts as the drop-down in the ComboBox.
Implementation public function get dropdown():ListBase
| expandDropDownToContent | property |
expandDropDownToContent:Boolean [read-write]
This property specifies whether or not the drop down list will expand its’ width to make sure that none of it’s content will
be truncated. If the drop down does not need to expand to fit the content, it will set itself to the specified width of
the AutoCompleteComboBox. The Drop Down will never be smaller than the width of
the AutoCompleteComboBox. Only makes a change if content in the drop down will be truncated due to
the width of the AutoCompleteComboBox .
The default value is false.
This property can be used as the source for data binding.
Implementation public function get expandDropDownToContent():Boolean
public function set expandDropDownToContent(value:Boolean):void
| rowCount | property |
rowCount:int [read-write]Maximum number of rows visible in the ComboBox control list. If there are fewer items in the dataProvider, the ComboBox shows only as many items as there are in the dataProvider.
This property can be used as the source for data binding.
Implementation public function get rowCount():int
public function set rowCount(value:int):void
| selectedIndex | property |
selectedIndex:int [read-write]
The index in the data provider of the selected item.
If there is a prompt property, the selectedIndex
value can be set to -1 to show the prompt.
If there is no prompt, property then selectedIndex
will be set to 0 once a dataProvider is set.
If the ComboBox control is editable, the selectedIndex
property is -1 if the user types any text
into the text field.
Unlike many other Flex properties that are invalidating (setting
them does not have an immediate effect), the selectedIndex and
selectedItem properties are synchronous; setting one immediately
affects the other.
This property can be used as the source for data binding.
Implementation public function get selectedIndex():int
public function set selectedIndex(value:int):void
| selectedValue | property |
selectedValue:String [read-write]
In HTML select boxes, you have a display piece, or label, and the value, or data. The Flex ComboBox does not provide an
easy way to deal with the value concept of an HTML select. If you want to set the ComboBox to a value you can
use selectedIndex to specify the dataProvider index, or selectedItem to specify the
full object. But, there is no way to select an item using one piece of behind the scenes data. The selectedValue
property is your answer for that. You can use it to drill down to a specific valueField in your dataProvider.
This property can be used as the source for data binding.
Implementation public function get selectedValue():String
public function set selectedValue(value:String):void
See also
| text | property |
text:String [read-write]This property keeps track of the characters in the the AutoComplete input. If you want to acces the characters that are being used to filter the AutoComplete list, look at the typeAheadTextValue property. If an item is selected, the autoComplete filter is removed. In that situation, typeAheadTextValue will return an empty string, but text will return the display text for that item. If autoCompleteEnabled is false; then this property will act just like text property on the the ComboBox.
The default value is "".
This property can be used as the source for data binding.
Implementation public function get text():String
public function set text(value:String):void
See also
| toolTip | property |
toolTip:String [read-write]If you explicitly set a tooltop then it will not be reset when truncateToFit is on and the item is truncated Text to display in the ToolTip.
This property can be used as the source for data binding.
Implementation public function get toolTip():String
public function set toolTip(value:String):void
| truncateToFit | property |
truncateToFit:Boolean [read-write]
If the truncateToFit property is true, and the ComboBox control size is smaller than the
text it needs to display, the text of the Label control is truncated using the text specified by
truncationIndicator. A toolTip is also created with the full text. If this property is false,
text that does not fit is clipped.
The default value is false.
This property can be used as the source for data binding.
Implementation public function get truncateToFit():Boolean
public function set truncateToFit(value:Boolean):void
| truncationIndicator | property |
truncationIndicator:String [read-write]
When the display text is too long for the space it can be showed in, this is the text used to truncate in display piece is too
long for the space, it will be truncated, and the truncationIndicator text appended to the end.
This property works works in
conjunction with truncateToFit.
The default value is '...'.
This property can be used as the source for data binding.
Implementation public function get truncationIndicator():String
public function set truncationIndicator(value:String):void
See also
| typeAheadEnabled | property |
typeAheadEnabled:Boolean [read-write]
This property specifies whether the user can type-ahead with multiple characters. The default ComboBox only supports type-ahead functionality with a single character. If autoCompleteEnabled is set to true, type-ahead functionality will be ignored. Type-ahead and AutoComplete are mutually exclusive.
The default value is false.
This property can be used as the source for data binding.
Implementation public function get typeAheadEnabled():Boolean
public function set typeAheadEnabled(value:Boolean):void
See also
| typeAheadResetDelay | property |
typeAheadResetDelay:int [read-write]
This property specifies the number of milliseconds before the type-ahead text is reset to an empty string.
It has no effect if typeAheadEnabled is set to false.
The default value is 4000.
This property can be used as the source for data binding.
Implementation public function get typeAheadResetDelay():int
public function set typeAheadResetDelay(value:int):void
| typeAheadText | property |
typeAheadText:String [read-write]
This property keeps track of the characters that the user typed. It works with both type-ahead and AutoComplete functionality.
If typeAheadEnabled is set to true, then this will be reset on a timer based on
the typeAheadResetDelay. If autoCompleteEnabled is true, this will be reset when the user
selects an item from the drop down or when the user clears out the text in the AutoComplete input.
You can access this value from an itemRenderer using
AutoCompleteListData(this.listData).typeAheadText, however it will always be an empty string if
AutoCompleteEnabled is false. This value is exposed publicly using the typeAheadTextValue
property.
The default value is ''.
This property can be used as the source for data binding.
Implementation protected function get typeAheadText():String
protected function set typeAheadText(value:String):void
See also
| typeAheadTextValue | property |
typeAheadTextValue:String [read-write]Exposes the type ahead text value that is used in both both typeAhead and AutoComplete functionality. if type ahead functionality is enabled then this will be reset each time the typeAheadResetDelay is counted down If autocompleteEnabled is true, this will not be reset. If you want to reset this value you can use the autoCompleteSetTypeAheadText() method. You can access the type ahead value from an itemRenderer using
AutoCompleteListData(this.listData).typeAheadText
however it will always be an empty string if AutoComplete is not enabled
The default value is ''.
This property can be used as the source for data binding.
Implementation public function get typeAheadTextValue():String
public function set typeAheadTextValue(value:String):void
See also
| valueField | property |
valueField:String [read-write]
This property contaibs the name of the data in the items in the dataProvider Array that will be used for setting or
getting the selectedValue.
It defaults to data. However, if the dataProvider items do not contain a data property,
you can set the valueField property to use a different property.
The default value is data.
This property can be used as the source for data binding.
Implementation public function get valueField():String
public function set valueField(value:String):void
See also
| valueFunction | property |
valueFunction:Function [read-write]
This property represents a user-supplied function to run on each item to determine its value, or data. By default the control uses
a property named data on each dataProvider item to determine its data.
However, some data sets do not have a data property, or do not have another property that can be used for selecting an
item.
The valueFunction takes a single argument which is the item in the dataProvider and returns a String:
myLabelFunction(item:Object):String
This property can be used as the source for data binding.
Implementation public function get valueFunction():Function
public function set valueFunction(value:Function):void
| width | property |
width:Number [read-write]Number that specifies the width of the component, in pixels, in the parent's coordinates. The default value is 0, but this property will contain the actual component width after Flex completes sizing the components in your application.
Note: You can specify a percentage value in the MXML
width attribute, such as width="100%",
but you cannot use a percentage value in the width
property in ActionScript.
Use the percentWidth property instead.
Setting this property causes a resize event to
be dispatched.
See the resize event for details on when
this event is dispatched.
If the component's scaleX property is not 1.0,
the width of the component from its internal coordinates
will not match.
Thus a 100 pixel wide component with a scaleX
of 2 will take 100 pixels in the parent, but will
internally think it is 50 pixels wide.
This property can be used as the source for data binding.
Implementation public function get width():Number
public function set width(value:Number):void
| AutoCompleteComboBox | () | constructor |
public function AutoCompleteComboBox()Constructor.
| autoCompleteFilter | () | method |
protected function autoCompleteFilter(item:Object):BooleanThis is the default filter function for AutoComplete functionality. It uses a regular expression to search through the label text to filter values.
Parametersitem:Object — The item that is going to be investigated for filtering purposes
|
Boolean — true if the item meets the filter criteria, false otherwise.
|
See also
| autoCompleteSetTypeAheadText | () | method |
public function autoCompleteSetTypeAheadText(value:String = ""):voidThis method lets you reset the AutoComplete Type Ahead Text. Using this method will cause the AutoComplete dataProvider to perform its filtering again.
Parametersvalue:String (default = " |
| close | () | method |
public override function close(trigger:Event = null):voidHides the drop-down list.
Parameterstrigger:Event (default = null) |
| itemToData | () | method |
public function itemToData(item:Object):String
Returns a string representing the data parameter, Modeled, conceptually, after itemToLabel
item:Object — The item we want to pull the data out of .
This method checks in the following order to find a value to return:
|
String |
| open | () | method |
public override function open():voidDisplays the drop-down list.
| truncateLabel | () | method |
protected function truncateLabel():Boolean
This method truncates text to make it fit horizontally in the area defined for the control, and append
the trunctationIndicator to the text. By default, the truncationIndicator is an ellipse, three periods (...)
Boolean — true if the text was truncated, false otherwise.
|
| autoCompleteDataProviderFilterBegin | event |
com.flextras.autoCompleteComboBox.AutoCompleteCollectionEvent
com.flextras.autoCompleteComboBox.AutoCompleteCollectionEvent.AUTOCOMPLETE_DATAPROVIDER_FILTER_BEGIN
This event is dispatched before the dataProvider is filtered for AutoComplete Purposes. Conceptually this is similar to the ListCollectionView.collectionChange event where kind=refresh. You should listen to this event if for some reason you want to cancel the filter process.
The AutoCompleteCollectionEvent.AUTOCOMPLETE_DATAPROVIDER_FILTER_BEGIN constant defines the value of the type property of the event object for an event that is dispatched when the AutoCompleteComboBox dataProvider is about to be filtered. If the filterFunction is null, that means that the dataProvider will be reset
The properties of the event object have the following values. Not all properties are meaningful for all kinds of events. See the detailed property descriptions for more information.
| Property | Value |
|---|---|
bubbles | false |
cancelable | true |
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. |
filterFunction | The Function that will be used to filter the dataProvider |
kind | CollectionEventKind.REFRESH |
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 | AutoCompleteCollectionEvent.AUTOCOMPLETE_DATAPROVIDER_FILTER_BEGIN |
See also
| autoCompleteDataProviderFiltered | event |
com.flextras.autoCompleteComboBox.AutoCompleteCollectionEvent
com.flextras.autoCompleteComboBox.AutoCompleteCollectionEvent.AUTOCOMPLETE_DATAPROVIDER_FILTERED
This event is dispatched after the dataProvider is filtered for AutoComplete Purposes. Conceptually this is similar to the ListCollectionView.collectionChange event where kind=refresh. With this event, you know it comes from inside the AutoCompleteComboBox, as opposed to other filtering or sorting mechanisms on your provider. You should listen to autoCompleteDataProviderFilterBegin if for some reason you want to cancel the filter process.
The AutoCompleteCollectionEvent.AUTOCOMPLETE_DATAPROVIDER_FILTER constant defines the value of the type property of the event object for an event that is dispatched when the filtering for the AutoCompleteComboBox dataProvider is complete.
The properties of the event object have the following values. Not all properties are meaningful for all kinds of events. See the detailed property descriptions for more information.
| 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. |
kind | CollectionEventKind.REFRESH |
filterFunction | The function that was used to filter the dataProvider |
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 | AutoCompleteCollectionEvent.AUTOCOMPLETE_DATAPROVIDER_FILTER |
See also
| dropdownHeightExpanded | event |
com.flextras.autoCompleteComboBox.AutoCompleteComboBoxResizeEvent
com.flextras.autoCompleteComboBox.AutoCompleteComboBoxResizeEvent.DROPDOWN_HEIGHT_EXPANDED
This event is dispatched when AutoComplete is enabled and the dataProvider was just filtered, causing a change in the number of dataProvider items, therefore needing an expansion or contraction of the drop down height.
The AutoCompleteComboBoxEvent.DROPDOWN_HEIGHT_EXPANDED constant defines the value of the type property of the event object for an event that is dispatched when the AutoCompleteComboBox autoCompleteEnabled is set to true and we just shrank or expanded the height of the drop down to accommodate filtering, which either removed or added items or added items. Not every filtering action will cause this event to fire.
The properties of the event object have the following values. Not all properties are meaningful for all kinds of events. See the detailed property descriptions for more information.
| 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. |
currentSize | The current height of the drop down |
newSize | The new height of the drop down |
type | AutoCompleteComboBoxResizeEvent.DROPDOWN_HEIGHT_EXPANDED |
See also
| dropdownWidthExpandBegin | event |
com.flextras.autoCompleteComboBox.AutoCompleteComboBoxResizeEvent
com.flextras.autoCompleteComboBox.AutoCompleteComboBoxResizeEvent.DROPDOWN_WIDTH_EXPAND_BEGIN
This event is dispatched when expandDropDownToContent is set to true and we're about to expand the width of the drop down. This event is cancellable. If it is canceled, then the width of the drop down will be set to the width of the AutoCompleteComboBox.
The AutoCompleteComboBoxEvent.DROPDOWN_WIDTH_EXPAND_BEGIN constant defines the value of the type property of the event object for an event that is dispatched when the AutoCompleteComboBox expandDropDownToContent is set to true and we're about to set a new width. If this event is cancelled, the width will be set to the width of the AutoCompleteComboBox instance.
The properties of the event object have the following values. Not all properties are meaningful for all kinds of events. See the detailed property descriptions for more information.
| Property | Value |
|---|---|
bubbles | false |
cancelable | true |
currentSize | The current width of the drop down |
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. |
newSize | The new width we're about to set the drop down to |
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 | AutoCompleteComboBoxResizeEvent.DROPDOWN_WIDTH_EXPAND_BEGIN |
See also
| dropdownWidthExpanded | event |
com.flextras.autoCompleteComboBox.AutoCompleteComboBoxResizeEvent
com.flextras.autoCompleteComboBox.AutoCompleteComboBoxResizeEvent.DROPDOWN_WIDTH_EXPAND_BEGIN
This event is dispatched when expandDropDownToContent is set to true and we just expanded the width of the drop down.
The AutoCompleteComboBoxEvent.DROPDOWN_WIDTH_EXPANDED constant defines the value of the type property of the event object for an event that is dispatched when the AutoCompleteComboBox expandDropDownToContent is set to true and we just expanded the width of the drop down.
The properties of the event object have the following values. Not all properties are meaningful for all kinds of events. See the detailed property descriptions for more information.
| Property | Value |
|---|---|
bubbles | false |
cancelable | false |
currentSize | The current width of the drop down. This will be the same as the newSize |
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. |
newSize | The width the drop down was just set to. |
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 | AutoCompleteComboBoxResizeEvent.DROPDOWN_WIDTH_EXPANDED |
See also
| labelNotTruncated | event |
com.flextras.autoCompleteComboBox.AutoCompleteComboBoxEvent
com.flextras.autoCompleteComboBox.AutoCompleteComboBoxEvent.LABEL_NOT_TRUNCATED
This event is dispatched when truncateToFit is set to true, but there was enough room to display the selectedLabel without shortening it.
The AutoCompleteComboBoxEvent.LABEL_NOT_TRUNCATED constant defines the value of the type property of the event object for an event that is dispatched when the AutoCompleteComboBox truncateToFit is set to true, but there was enough room to display the selectedLabel without truncating it.
The properties of the event object have the following values. Not all properties are meaningful for all kinds of events. See the detailed property descriptions for more information.
| 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. |
text | The untruncated text, same value of the selectedLabel |
newText | The untruncated text, in this case same value of the selectedLabel |
type | AutoCompleteComboBoxEvent.LABEL_TRUNCATED |
See also
| labelTruncated | event |
com.flextras.autoCompleteComboBox.AutoCompleteComboBoxEvent
com.flextras.autoCompleteComboBox.AutoCompleteComboBoxEvent.LABEL_TRUNCATED
This event is dispatched when the display label was truncated. For this to fire, the truncateToFit property must be set to true and the display label must be too large to fit in the width of the AutoCompleteComboBox.
The AutoCompleteComboBoxEvent.LABEL_TRUNCATED constant defines the value of the type property of the event object for an event that is dispatched when the AutoCompleteComboBox truncates the label the label.
The properties of the event object have the following values. Not all properties are meaningful for all kinds of events. See the detailed property descriptions for more information.
| 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. |
text | The untruncated text |
newText | The truncated text |
type | AutoCompleteComboBoxEvent.LABEL_TRUNCATED |
See also
| selectedValueNotFound | event |
flash.events.Event
com.flextras.autoCompleteComboBox.AutoCompleteComboBoxEvent.SELECTED_VALUE_NOT_FOUND
This event is dispatched when the selectedValue was set, but not found in the dataProvider. If this event is cancelled, the selectedValue, selectedIndex, and selectedItem will not change. If not cancelled, the AutoCompleteComboBox will be put into the unselected state where selectedIndex = -1. If you want run code when the selected value is found, listen to the change event.
The AutoCompleteComboBoxEvent.SELECTED_VALUE_NOT_FOUND constant defines the value of the type property of the event object for an event that is dispatched when the AutoCompleteComboBox selectedValue was set, but the value was not found in the dataProvider.
If cancelled, the selectedIndex and selectedItem will not change. If not cancelled, the AutoCompleteComboBox will be put into the unselected state where selectedIndex = -1
The properties of the event object have the following values. Not all properties are meaningful for all kinds of events. See the detailed property descriptions for more information.
| Property | Value |
|---|---|
bubbles | false |
cancelable | true |
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. |
text | The current selected value of the AutoCompleteComboBox |
newText | The value that was not found in the AutoCompleteComboBox |
type | AutoCompleteComboBoxEvent.LABEL_TRUNCATED |
See also
| typeAheadReleaseTimerComplete | event |
com.flextras.autoCompleteComboBox.TypeAheadTimerEvent
com.flextras.autoCompleteComboBox.TypeAheadTimerEvent.TYPEAHEAD_RELEASETIMER_COMPLETE
This event is dispatched when the type-ahead timer is complete and the typeAheadText is reset.
The TypeAheadTimerEvent.TYPEAHEAD_RELEASETIMER_COMPLETE constant defines the value of the type property of the TypeAheadTimerEvent object for an TYPEAHEAD_RELEASETIMER_COMPLETE event, which indicates that the type-ahead timer is complete, therefore setting the typeAheadText property of the AutoCompleteComboBox to an empty string.
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. |
Type | TypeAheadTimerEvent.TYPEAHEAD_RELEASETIMER_COMPLETE |
typeAheadText | Contains the text before the type-ahead string was made empty. |
See also
| typeAheadReleaseTimerStart | event |
com.flextras.autoCompleteComboBox.TypeAheadTimerEvent
com.flextras.autoCompleteComboBox.TypeAheadTimerEvent.TYPEAHEAD_RELEASETIMER_START
This event is dispatched when the type-ahead timer is started. This is caused when the user types a new character.
The TypeAheadTimerEvent.TYPEAHEAD_RELEASETIMER_START constant defines the value of the type property of the TypeAheadTimerEvent object for a TYPEAHEAD_RELEASETIMER_START event. This most likely means that the user has typed a new character and the type-ahead timer has either started, or reset it self.
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. |
Type | TypeAheadTimerEvent.TYPEAHEAD_RELEASETIMER_START |
typeAheadText | Contains the current type-ahead text string |
See also
| typeAheadReleaseTimerStop | event |
com.flextras.autoCompleteComboBox.TypeAheadTimerEvent
com.flextras.autoCompleteComboBox.TypeAheadTimerEvent.TYPEAHEAD_RELEASETIMER_STOP
This event is dispatched when the type-ahead timer is stopped without completing. The most likely cause of this is that the user typed a new key, resetting the count down.
The TypeAheadTimerEvent.TYPEAHEAD_RELEASETIMER_STOP constant defines the value of the type property of the TypeAheadTimerEvent object for an TYPEAHEAD_RELEASETIMER_STOP event, which indicates that the type-ahead timer has been stopped. The most likely cause of this is that the user typed another character and the timer needs to start anew.
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. |
Type | TypeAheadTimerEvent.TYPEAHEAD_RELEASETIMER_STOP |
typeAheadText | Contains the current type-ahead text string. |
See also
| typeAheadTextChanged | event |
com.flextras.autoCompleteComboBox.AutoCompleteComboBoxEvent
com.flextras.autoCompleteComboBox.AutoCompleteComboBoxEvent.TYPE_AHEAD_TEXT_CHANGED
This event id dispatched when type-ahead text changes. This will only be relevant if autoCompleteEnabled or
typeAheadEnabled are set to true.
The AutoCompleteComboBoxEvent.TYPE_AHEAD_TEXT_CHANGED constant defines the value of the type property of the event object for an event that is dispatched when the type-ahead text is changed. This event will trigger if autoCompleteEnabled or typeAheadEnabled are set to true.
The properties of the event object have the following values. Not all properties are meaningful for all kinds of events. See the detailed property descriptions for more information.
| 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. |
text | The old text |
newText | The changed value |
type | AutoCompleteComboBoxEvent.LABEL_TRUNCATED |
See also