| Package | com.flextras.autoCompleteComboBox |
| Class | public class TypeAheadTimerEvent |
| Inheritance | TypeAheadTimerEvent  flash.events.TimerEvent |
TypeAheadTimerEvent class represents time events related to the type-ahead functionality of the AutoCompleteComboBox.
See also
| Property | Defined by | ||
|---|---|---|---|
| typeAheadText : String
The
typeAheadText property contains the text the user typed. | TypeAheadTimerEvent | ||
| Method | Defined by | ||
|---|---|---|---|
|
TypeAheadTimerEvent(argTypeAheadText:String, type:String, bubbles:Boolean = false, cancelable:Boolean = false)
constructor
| TypeAheadTimerEvent | ||
| Constant | Defined by | ||
|---|---|---|---|
| TYPEAHEAD_RELEASETIMER_COMPLETE : String = "typeAheadReleaseTimerComplete" [static]
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. | TypeAheadTimerEvent | ||
| TYPEAHEAD_RELEASETIMER_START : String = "typeAheadReleaseTimerStart" [static]
The
TypeAheadTimerEvent.TYPEAHEAD_RELEASETIMER_START constant defines the value of the type property of the TypeAheadTimerEvent object for a TYPEAHEAD_RELEASETIMER_START event. | TypeAheadTimerEvent | ||
| TYPEAHEAD_RELEASETIMER_STOP : String = "typeAheadReleaseTimerStop" [static]
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. | TypeAheadTimerEvent | ||
| typeAheadText | property |
typeAheadText:String [read-write]
The typeAheadText property contains the text the user typed. If we're at the TYPEAHEAD_RELEASETIMER_START event, it contains the current typeAheadText. If we're at TYPEAHEAD_RELEASETIMER_COMPLETE, it is the text before the string was emptied.
public function get typeAheadText():String
public function set typeAheadText(value:String):void
| TypeAheadTimerEvent | () | constructor |
public function TypeAheadTimerEvent(argTypeAheadText:String, type:String, bubbles:Boolean = false, cancelable:Boolean = false)constructor
ParametersargTypeAheadText:String |
|
type:String |
|
bubbles:Boolean (default = false) |
|
cancelable:Boolean (default = false) |
| TYPEAHEAD_RELEASETIMER_COMPLETE | constant |
public static const TYPEAHEAD_RELEASETIMER_COMPLETE:String = "typeAheadReleaseTimerComplete"
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
| TYPEAHEAD_RELEASETIMER_START | constant |
public static const TYPEAHEAD_RELEASETIMER_START:String = "typeAheadReleaseTimerStart"
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
| TYPEAHEAD_RELEASETIMER_STOP | constant |
public static const TYPEAHEAD_RELEASETIMER_STOP:String = "typeAheadReleaseTimerStop"
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