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);

Events:

openfl.events.Event.CHANGE

Dispatched when either ComboBox.selectedItem or ComboBox.selectedIndex changes.

openfl.events.Event.OPEN

Dispatched when the pop-up list view is opened.

openfl.events.Event.CLOSE

Dispatched when the pop-up list view is closed.

feathers.events.ListViewEvent.ITEM_TRIGGER

Dispatched when the user taps or clicks an item renderer in the pop-up list view. The pointer must remain within the bounds of the item renderer on release, and the list view cannot scroll before release, or the gesture will be ignored.

Available since

1.0.0

.

See also:

Static variables

@:value("comboBox_button")staticfinalread onlyCHILD_VARIANT_BUTTON:String = "comboBox_button"

The variant used to style the Button child component in a theme.

To override this default variant, set the ComboBox.customButtonVariant property.

Available since

1.0.0

.

See also:

@:value("comboBox_listView")staticfinalread onlyCHILD_VARIANT_LIST_VIEW:String = "comboBox_listView"

The variant used to style the ListView child component in a theme.

To override this default variant, set the ComboBox.customListViewVariant property.

Available since

1.0.0

.

See also:

@:value("comboBox_textInput")staticfinalread onlyCHILD_VARIANT_TEXT_INPUT:String = "comboBox_textInput"

The variant used to style the TextInput child component in a theme.

To override this default variant, set the ComboBox.customTextInputVariant property.

Available since

1.0.0

.

See also:

Constructor

new(?dataProvider:IFlatCollection<Dynamic>)

Creates a new ComboBox object.

Available since

1.0.0

.

Variables

@:flash.propertyallowCustomUserValue:Bool

Allows the user to type a custom value into the text input. If a custom value is selected, the selectedIndex property will be -1, but the selectedItem property will contain the custom value.

Available since

1.0.0

.

@:flash.propertybuttonFactory:AbstractDisplayObjectFactory<Dynamic, 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();
};
Available since

1.0.0

.

See also:

@:style@:flash.propertycustomButtonVariant:String

A custom variant to set on the button, instead of ComboBox.CHILD_VARIANT_BUTTON.

The customButtonVariant will be not be used if the result of buttonFactory already has a variant set.

Available since

1.0.0

.

See also:

@:style@:flash.propertycustomListViewVariant:String

A custom variant to set on the pop-up list view, instead of ComboBox.CHILD_VARIANT_LIST_VIEW.

The customListViewVariant will be not be used if the result of listViewFactory already has a variant set.

Available since

1.0.0

.

See also:

@:style@:flash.propertycustomTextInputVariant:String

A custom variant to set on the text input, instead of ComboBox.CHILD_VARIANT_TEXT_INPUT.

The customTextInputVariant will be not be used if the result of textInputFactory already has a variant set.

Available since

1.0.0

.

See also:

@:flash.propertydataProvider:IFlatCollection<Dynamic>

The collection of data displayed by the list.

Items in the collection must be class instances or anonymous structures. Do not add primitive values (such as strings, booleans, or numeric values) directly to the collection.

Additionally, all items in the collection must be unique object instances. Do not add the same instance to the collection more than once because a runtime exception will be thrown.

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;
};
Available since

1.0.0

.

See also:

@:flash.propertyitemRendererRecycler: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);
Available since

1.0.0

.

@:flash.propertylistViewFactory:AbstractDisplayObjectFactory<Dynamic, 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();
};
Available since

1.0.0

.

See also:

@:flash.propertyread onlymaxSelectedIndex:Int

See also:

  • feathers.core.IndexSelector.maxSelectedIndex

@:flash.propertyread onlyopen:Bool

Indicates if the pop-up list is open or closed.

Available since

1.0.0

.

See also:

@:value(false)openListViewOnFocus:Bool = false

Determines if the pop-up list should automatically open when the combo box receives focus, or if the user is required to click the open button.

Available since

1.0.0

.

@:style@:flash.propertypopUpAdapter: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();
Available since

1.0.0

.

@:flash.propertyprompt:String

The text displayed by the text input when no item is selected.

The following example sets the combo box's prompt:

comboBox.prompt = "Select an item";
Available since

1.0.0

.

@:flash.propertyselectedIndex:Int

See also:

  • feathers.core.IIndexSelector.selectedIndex Note: If the selectedIndex is -1, it's still possible for the selectedItem to not be null. This can happen when a custom value is entered into the text input by the user.

@:flash.propertyselectedItem:Dynamic

See also:

@:flash.propertyread onlystageFocusTarget:InteractiveObject

@:flash.propertytextInputFactory:AbstractDisplayObjectFactory<Dynamic, 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 TextInput();
};
Available since

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.

Available since

1.0.0

.

See also:

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.

This function is not called if the item is already a string.

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;
};
Available since

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.

Available since

1.0.0

.

See also:

dynamictextToItem(text:String):Dynamic

Called when none of the items in the data provider match the custom text typed by the user. By default, returns the original string, without any changes.

For example, consider the following item type:

{ text: "Example Item" }

A custom implementation of textToItem() might look like this:

comboBox.textToItem = (customText:String) -> {
	return { text: customText };
};
Available since

1.0.0

.

See also:

Inherited Variables

Defined by FeathersControl

@:flash.propertyread onlycreated:Bool

Determines if the component has been initialized and validated for the first time.

In the following example, we check if the component is created or not, and we listen for an event if it isn't:

if(!control.created)
{
	control.addEventListener(FeathersEventType.CREATION_COMPLETE, creationCompleteHandler);
}

See also:

@:flash.propertyenabled:Bool

@style@:flash.propertyfocusPaddingBottom:Float

Optional padding outside the bottom edge of this UI component when the focusRectSkin is visible.

Available since

1.0.0

.

@style@:flash.propertyfocusPaddingLeft:Float

Optional padding outside the left edge of this UI component when the focusRectSkin is visible.

Available since

1.0.0

.

@style@:flash.propertyfocusPaddingRight:Float

Optional padding outside the right edge of this UI component when the focusRectSkin is visible.

Available since

1.0.0

.

@style@:flash.propertyfocusPaddingTop:Float

Optional padding outside the top edge of this UI component when the focusRectSkin is visible.

Available since

1.0.0

.

@style@:flash.propertyfocusRectSkin:DisplayObject

An optional skin to display when an IFocusObject component receives focus.

Available since

1.0.0

.

@:flash.propertyread onlyinitialized:Bool

Determines if the component has been initialized yet. The initialize() function is called one time only, when the Feathers UI control is added to the display list for the first time.

In the following example, we check if the component is initialized or not, and we listen for an event if it isn't initialized:

if(!control.initialized)
{
	control.addEventListener(FeathersEvent.INITIALIZE, initializeHandler);
}
Available since

1.0.0

.

See also:

@:flash.propertyread onlystyleContext:Class<IStyleObject>

The class used as the context for styling the component. If a subclass of a component should have different styles than its superclass, it should override the get_styleContext getter. However, if a subclass should continue using the same styles as its superclass, it happens automatically.

Available since

1.0.0

.

@:flash.propertystyleProvider:IStyleProvider

When a component initializes, a style provider may be used to set properties that affect the component's visual appearance.

You can set or replace an existing style provider at any time before a component initializes without immediately affecting the component's visual appearance. After the component initializes, the style provider may still be changed, and any properties that were set by the previous style provider will be reset to their default values before applying the new style provider.

Available since

1.0.0

.

See also:

@:flash.propertytoolTip:String

@:flash.propertyvariant:String

May be used to provide multiple different variations of the same UI component, each with a different appearance.

Available since

1.0.0

.

Defined by MeasureSprite

@:flash.propertyexplicitWidth:Null<Float>

@:flash.propertymaxWidth:Float

@:flash.propertyminWidth:Float

Defined by ValidatingSprite

@:flash.propertyread onlydepth:Int

Inherited Methods

Defined by FeathersControl

private@:dox(show)initialize():Void

Called the first time that the UI control is added to the stage, and you should override this function to customize the initialization process. Do things like create children and set up event listeners. After this function is called, Event.INIT is dispatched.

The following example overrides initialization:

override private function initialize():Void {
	super.initialize();

}
Available since

1.0.0

.

move(x:Float, y:Float):Void

Sets both the x and y positions of the control in a single function call.

Available since

1.0.0

.

See also:

  • DisplayObject.x

  • DisplayObject.y

setFocusPadding(value:Float):Void

setSize(width:Float, height:Float):Void

Sets both the width and height dimensions of the control in a single function call.

Available since

1.0.0

.

See also:

  • DisplayObject.width

  • DisplayObject.height

private@:dox(show)setStyle(styleName:String, ?state:EnumValue):Bool

Determines if a style may be changed, and restricts the style from being changed in the future, if necessary.

Available since

1.0.0

.

Defined by MeasureSprite

private@:value({ minHeight : 0.0, minWidth : 0.0 })@:dox(show)saveMeasurements(width:Float, height:Float, minWidth:Float = 0.0, minHeight:Float = 0.0, ?maxWidth:Float, ?maxHeight:Float):Bool

Saves the calculated dimensions for the component, replacing any values that haven't been set explicitly. Returns true if the reported values have changed and Event.RESIZE was dispatched.

Available since

1.0.0

.

Defined by ValidatingSprite

isInvalid(?flag:InvalidationFlag):Bool

Indicates whether the control is pending validation or not. By default, returns true if any invalidation flag has been set. If you pass in a specific flag, returns true only if that flag has been set (others may be set too, but it checks the specific flag only. If all flags have been marked as invalid, always returns true.

The following example invalidates a component:

component.setInvalid();
trace(component.isInvalid()); // true
Available since

1.0.0

.

runWithoutInvalidation(callback:() ‑> Void):Void

Calls a function that temporarily disables invalidation. In other words, calls to setInvalid() will be ignored until the function returns.

Available since

1.0.0

.

setInvalid(?flag:InvalidationFlag):Void

Call this function to tell the UI control that a redraw is pending. The redraw will happen immediately before OpenFL renders the UI control to the screen. The validation system exists to ensure that multiple properties can be set together without redrawing multiple times in between each property change.

If you cannot wait until later for the validation to happen, you can call validate() to redraw immediately. As an example, you might want to validate immediately if you need to access the correct width or height values of the UI control, since these values are calculated during validation.

The following example invalidates a component:

component.setInvalid();
trace(component.isInvalid()); // true
Available since

1.0.0

.

private@:dox(show)setInvalidationFlag(flag:InvalidationFlag):Void

Sets an invalidation flag. This will not add the component to the validation queue. It only sets the flag. A subclass might use this function during draw() to manipulate the flags that its superclass sees.

Available since

1.0.0

.

See also:

private@:dox(show)update():Void

Override to customize layout and to adjust properties of children. Called when the component validates, if any flags have been marked to indicate that validation is pending.

The following example overrides updating after invalidation:

override private function update():Void {
	super.update();

}
Available since

1.0.0

.