class ComboBox
package feathers.controls
extends FeathersControl › MeasureSprite › ValidatingSprite
implements IFocusObject, IDataSelector<Dynamic>, IIndexSelector
Displays a control consisting of a TextInput and Button that allows an
item from a collection to be selected. When the button is triggered, a list
box of items is displayed as a pop-up. The text input allows filtering, or
(optionally) choosing custom items.
The following example creates a ComboBox, gives it a data provider, tells
the item renderer how to interpret the data, and listens for when the
selection changes:
var comboBox = new ComboBox();
comboBox.dataProvider = new ArrayCollection([
{ text: "Milk" },
{ text: "Eggs" },
{ text: "Bread" },
{ text: "Steak" },
]);
comboBox.itemToText = (item:Dynamic) -> {
return item.text;
};
comboBox.addEventListener(Event.CHANGE, (event:Event) -> {
var comboBox = cast(event.currentTarget, ComboBox);
trace("ComboBox changed: " + comboBox.selectedIndex + " " + comboBox.selectedItem.text);
});
this.addChild(comboBox);1.0.0
.See also:
Static variables
staticfinalread onlyCHILD_VARIANT_BUTTON:String = "comboBox_button"
staticfinalread onlyCHILD_VARIANT_LIST_VIEW:String = "comboBox_listView"
staticfinalread onlyCHILD_VARIANT_TEXT_INPUT:String = "comboBox_textInput"
Constructor
Variables
dataProvider:IFlatCollection<Dynamic>
The collection of data displayed by the list.
The following example passes in a data provider and tells the item renderer how to interpret the data:
comboBox.dataProvider = new ArrayCollection([
{ text: "Milk" },
{ text: "Eggs" },
{ text: "Bread" },
{ text: "Chicken" },
]);
comboBox.itemToText = (item:Dynamic) -> {
return item.text;
};1.0.0
.See also:
itemRendererRecycler:DisplayObjectRecycler<Dynamic, ListViewItemState, DisplayObject>
Manages item renderers used by the list view.
In the following example, the pop-up list view uses a custom item renderer class:
comboBox.itemRendererRecycler = DisplayObjectRecycler.withClass(CustomItemRenderer);1.0.0
.popUpAdapter:IPopUpAdapter
Manages how the pop-up list is displayed when it is opened and closed.
In the following example, a custom pop-up adapter is provided:
comboBox.popUpAdapter = new DropDownPopUpAdapter();1.0.0
.buttonFactory:() ‑> Button
Creates the button, which must be of type feathers.controls.Button.
In the following example, a custom button factory is provided:
comboBox.buttonFactory = () ->
{
return new Button();
};1.0.0
.See also:
listViewFactory:() ‑> ListView
Creates the list view that is displayed as a pop-up. The list view must
be of type feathers.controls.ListView.
In the following example, a custom list view factory is provided:
comboBox.listViewFactory = () ->
{
return new ListView();
};1.0.0
.See also:
textInputFactory:() ‑> TextInput
Creates the text input, which must be of type feathers.controls.TextInput.
In the following example, a custom text input factory is provided:
comboBox.textInputFactory = () ->
{
return new Button();
};1.0.0
.See also:
Methods
closeListView():Void
Closes the pop-up list, if it is open.
The following example closes the pop-up list:
if(comboBox.open)
{
comboBox.closeListView();
}When the pop-up list closes, the component will dispatch an event of
type Event.CLOSE.
1.0.0
.See also:
openfl.events.Event.CLOSE
dynamicitemToText(data:Dynamic):String
Converts an item to text to display within the pop-up ListView, or
within the Button, if the item is selected. By default, the
toString() method is called to convert an item to text. This method
may be replaced to provide custom text.
For example, consider the following item:
{ text: "Example Item" }If the ListView should display the text "Example Item", a custom
implementation of itemToText() might look like this:
comboBox.itemToText = (item:Dynamic) -> {
return item.text;
};1.0.0
.openListView():Void
Opens the pop-up list, if it is not already open.
The following example opens the pop-up list:
if(!comboBox.open)
{
comboBox.openListView();
}When the pop-up list opens, the component will dispatch an event of type
Event.OPEN.
1.0.0
.See also:
openfl.events.Event.OPEN