| Package | com.flextras.autoCompleteComboBox |
| Class | public class AutoCompleteCollectionEvent |
| Inheritance | AutoCompleteCollectionEvent CollectionEvent flash.events.Event |
See also
| Property | Defined by | ||
|---|---|---|---|
| filterFunction : Function
The function used to filter the dataProvider for AutoComplete purposes
| AutoCompleteCollectionEvent | ||
![]() | kind : String
Indicates the kind of event that occurred.
| CollectionEvent | |
| Method | Defined 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 | ||
| Constant | Defined 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 | ||
![]() | COLLECTION_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 | |
| filterFunction | property |
filterFunction:Function [read-write]The function used to filter the dataProvider for AutoComplete purposes
The default value is autoCompleteFilter.
public function get filterFunction():Function
public function set filterFunction(value:Function):void
| 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
Parameterstype: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) |
| AUTOCOMPLETE_DATAPROVIDER_FILTER_BEGIN | constant |
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.
| 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
| AUTOCOMPLETE_DATAPROVIDER_FILTERED | constant |
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.
| 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