class PopUpListView
package feathers.controls
extends FeathersControl › MeasureSprite › ValidatingSprite
implements IStageFocusDelegate, IDataSelector<Dynamic>, IIndexSelector
Displays a Button that may be triggered to display a ListView as a
pop-up. The list view may be customized to display in different ways, such
as a drop-down, inside a Callout, or as a modal overlay.
The following example creates a pop-up list, gives it a data provider, tells the item renderer how to interpret the data, and listens for when the selection changes:
var popUpListView = new PopUpListView();
popUpListView.dataProvider = new ArrayCollection([
{ text: "Milk" },
{ text: "Eggs" },
{ text: "Bread" },
{ text: "Steak" },
]);
popUpListView.itemToText = (item:Dynamic) -> {
return item.text;
};
popUpListView.addEventListener(Event.CHANGE, (event:Event) -> {
var popUpListView = cast(event.currentTarget, PopUpListView);
trace("PopUpListView changed: " + popUpListView.selectedIndex + " " + popUpListView.selectedItem.text);
});
this.addChild(popUpListView);Events:
openfl.events.Event.CHANGE | Dispatched when either
|
|---|---|
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. |
1.0.0
.See also:
Static variables
staticfinalread onlyCHILD_VARIANT_BUTTON:String = "popUpListView_button"
The variant used to style the Button child component in a theme.
To override this default variant, set the
PopUpListView.customButtonVariant property.
1.0.0
.See also:
staticfinalread onlyCHILD_VARIANT_LIST_VIEW:String = "popUpListView_listView"
The variant used to style the ListView child component in a theme.
To override this default variant, set the
PopUpListView.customListViewVariant property.
1.0.0
.See also:
Constructor
new(?dataProvider:IFlatCollection<Dynamic>, ?changeListener:Event ‑> Void)
Creates a new PopUpListView object.
1.0.0
.Variables
buttonFactory:AbstractDisplayObjectFactory<Dynamic, Button>
Creates the button, which must be of type feathers.controls.Button.
In the following example, a custom button factory is provided:
popUpListView.buttonFactory = () ->
{
return new Button();
};1.0.0
.See also:
customButtonVariant:String
A custom variant to set on the button, instead of
PopUpListView.CHILD_VARIANT_BUTTON.
The customButtonVariant will be not be used if the result of
buttonFactory already has a variant set.
1.0.0
.See also:
customListViewVariant:String
A custom variant to set on the pop-up list view, instead of
PopUpListView.CHILD_VARIANT_LIST_VIEW.
The customListViewVariant will be not be used if the result of
listViewFactory already has a variant set.
1.0.0
.See also:
dataProvider:IFlatCollection<Dynamic>
The collection of data displayed by the list view.
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:
popUpListView.dataProvider = new ArrayCollection([
{ text: "Milk" },
{ text: "Eggs" },
{ text: "Bread" },
{ text: "Chicken" },
]);
popUpListView.itemToText = (item:Dynamic) -> {
return item.text;
};1.0.0
.See also:
itemRendererRecycler:AbstractDisplayObjectRecycler<Dynamic, ListViewItemState, DisplayObject>
Manages item renderers used by the pop-up list view.
In the following example, the pop-up list view uses a custom item renderer class:
popUpListView.itemRendererRecycler = DisplayObjectRecycler.withClass(CustomItemRenderer);1.0.0
.See also:
listViewFactory: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:
popUpListView.listViewFactory = () ->
{
return new ListView();
};1.0.0
.See also:
read onlyopen:Bool
Indicates if the list view pop-up is open or closed.
1.0.0
.See also:
popUpAdapter:IPopUpAdapter
Manages how the list view is displayed when it is opened and closed.
In the following example, a custom pop-up adapter is provided:
popUpListView.popUpAdapter = new DropDownPopUpAdapter();1.0.0
.prompt:String
The text displayed by the button when no item is selected.
The following example sets the pop-up list view's prompt:
popUpListView.prompt = "Select an item";1.0.0
.Methods
closeListView():Void
Closes the pop-up list, if it is open.
The following example closes the pop-up list:
if(popUpListView.open)
{
popUpListView.closeListView();
}When the pop-up list closes, the component will dispatch an event of
type Event.CLOSE.
1.0.0
.See also:
dynamicitemToEnabled(data:Dynamic):Bool
Determines if an item should be enabled or disabled. By default, all
items are enabled, unless the PopUpListView is disabled. This method
may be replaced to provide a custom value for enabled.
For example, consider the following item:
{ text: "Example Item", disable: true }If the PopUpListView should disable an item if the disable field is
true, a custom implementation of itemToEnabled() might look like
this:
popUpListView.itemToEnabled = (item:Dynamic) -> {
return !item.disable;
};1.2.0
.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:
popUpListView.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(!popUpListView.open)
{
popUpListView.openListView();
}When the pop-up list opens, the component will dispatch an event of type
Event.OPEN.
1.0.0
.See also: