Packagefeathers.data
Interfacepublic interface IAutoCompleteSource extends IFeathersEventDispatcher
Implementors LocalAutoCompleteSource, URLAutoCompleteSource

Product Version : Feathers 2.1.0

A source of items to display in the pop-up list of an AutoComplete component.

See also

feathers.controls.AutoComplete

Public Methods
 MethodDefined By
 Inherited
addEventListener(type:String, listener:Function):void
Adds a listener for an event type.
IFeathersEventDispatcher
 Inherited
dispatchEvent(event:Event):void
Dispatches an event to all listeners added for the specified event type.
IFeathersEventDispatcher
 Inherited
dispatchEventWith(type:String, bubbles:Boolean = false, data:Object = null):void
Dispatches an event from the pool with the specified to all listeners for the specified event type.
IFeathersEventDispatcher
 Inherited
hasEventListener(type:String, listener:Function = null):Boolean
Checks if a listener has been added for the specified event type.
IFeathersEventDispatcher
  
load(textToMatch:String, suggestionsResult:IListCollection = null):void
Loads suggestions based on the text entered into an AutoComplete component.
IAutoCompleteSource
 Inherited
removeEventListener(type:String, listener:Function):void
Removes a listener for an event type.
IFeathersEventDispatcher
 Inherited
removeEventListeners(type:String = null):void
Removes all listeners for an event type.
IFeathersEventDispatcher
Events
 Event Summary Defined By
  
complete
Dispatched when the suggestions finish loading.IAutoCompleteSource
Method Detail
load()method
public function load(textToMatch:String, suggestionsResult:IListCollection = null):void

Loads suggestions based on the text entered into an AutoComplete component.

If an existing ListCollection is passed in as the result, all items will be removed before new items are added.

Parameters

textToMatch:String
 
suggestionsResult:IListCollection (default = null)

Event Detail
complete Event
Event Object Type: starling.events.Event
Event.type property = starling.events.Event.COMPLETE

Dispatched when the suggestions finish loading.

The properties of the event object have the following values:

PropertyValue
bubblesfalse
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.
dataA ListCollection containing the suggestions to display.
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.





Sat Jun 18 2022, 02:58 PM -07:00