Packagecom.flextras.autoCompleteComboBox
Classpublic class AutoCompleteCollectionEvent
InheritanceAutoCompleteCollectionEvent Inheritance CollectionEvent Inheritance flash.events.Event

The AutoCompleteCollectionEvent represents events associated with the AutoComplete filtering functionality of the AutoCompleteComboBox.

See also

com.flextras.autoCompleteComboBox.AutoCompleteComboBox


Public Properties
 PropertyDefined by
  filterFunction : Function
The function used to filter the dataProvider for AutoComplete purposes
AutoCompleteCollectionEvent
 Inheritedkind : String
Indicates the kind of event that occurred.
CollectionEvent
Public Methods
 MethodDefined by
  
AutoCompleteCollectionEvent(type:String, argFilterFunction:Function = null, bubbles:Boolean = false, cancelable:Boolean = false, kind:String, location:int = -1, oldLocation:int = -1, items:Array = null)
constructor
AutoCompleteCollectionEvent
Public Constants
 ConstantDefined by
  AUTOCOMPLETE_DATAPROVIDER_FILTER_BEGIN : String = "autoCompleteDataProviderFilterBegin"
[static] 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.
AutoCompleteCollectionEvent
  AUTOCOMPLETE_DATAPROVIDER_FILTERED : String = "autoCompleteDataProviderFiltered"
[static] 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.
AutoCompleteCollectionEvent
 InheritedCOLLECTION_CHANGE : String = "collectionChange"
[static] The CollectionEvent.COLLECTION_CHANGE constant defines the value of the type property of the event object for an event that is dispatched when a collection has changed.
CollectionEvent
Property detail
filterFunctionproperty
filterFunction:Function  [read-write]

The function used to filter the dataProvider for AutoComplete purposes

The default value is autoCompleteFilter.

Implementation
    public function get filterFunction():Function
    public function set filterFunction(value:Function):void
Constructor detail
AutoCompleteCollectionEvent()constructor
public function AutoCompleteCollectionEvent(type:String, argFilterFunction:Function = null, bubbles:Boolean = false, cancelable:Boolean = false, kind:String, location:int = -1, oldLocation:int = -1, items:Array = null)

constructor

Parameters
type:String
 
argFilterFunction:Function (default = null)
 
bubbles:Boolean (default = false)
 
cancelable:Boolean (default = false)
 
kind:String
 
location:int (default = -1)
 
oldLocation:int (default = -1)
 
items:Array (default = null)
Constant detail
AUTOCOMPLETE_DATAPROVIDER_FILTER_BEGINconstant
public static const AUTOCOMPLETE_DATAPROVIDER_FILTER_BEGIN:String = "autoCompleteDataProviderFilterBegin"

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.

PropertyValue
bubblesfalse
cancelabletrue
currentTargetThe 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.
filterFunctionThe Function that will be used to filter the dataProvider
kindCollectionEventKind.REFRESH
targetThe 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.
typeAutoCompleteCollectionEvent.AUTOCOMPLETE_DATAPROVIDER_FILTER_BEGIN

See also

AUTOCOMPLETE_DATAPROVIDER_FILTEREDconstant 
public static const AUTOCOMPLETE_DATAPROVIDER_FILTERED:String = "autoCompleteDataProviderFiltered"

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.

PropertyValue
bubblesfalse
cancelablefalse
currentTargetThe 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.
kindCollectionEventKind.REFRESH
filterFunctionThe function that was used to filter the dataProvider
targetThe 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.
typeAutoCompleteCollectionEvent.AUTOCOMPLETE_DATAPROVIDER_FILTER

See also