scaffold.libs_as.feathers.data.IAutoCompleteSource.as Maven / Gradle / Ivy

Go to download

/*
Feathers
Copyright 2012-2015 Bowler Hat LLC. All Rights Reserved.

This program is free software. You can redistribute and/or modify it in
accordance with the terms of the accompanying license agreement.
*/
package feathers.data
{
	import feathers.core.IFeathersEventDispatcher;

	/**
	 * Dispatched when the suggestions finish loading.
	 *
	 * The properties of the event object have the following values:
	 * 
	 * 
	 * 
	 * 
	 * 
	 * 
	 * Property Value
bubbles 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.
data A ListCollection containing
	 *   the suggestions to display.
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.
	 *
	 * @eventType starling.events.Event.COMPLETE
	 */
	[Event(name="complete",type="starling.events.Event")]

	/**
	 * A source of items to display in the pop-up list of an
	 * AutoComplete component.
	 *
	 * @see feathers.controls.AutoComplete
	 */
	public interface IAutoCompleteSource extends IFeathersEventDispatcher
	{
		/**
		 * 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.
		 */
		function load(textToMatch:String, suggestionsResult:ListCollection = null):void;
	}
}

Property	Value
`bubbles`	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`.
`data`	A `ListCollection` containing * the suggestions to display.
`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.