class GroupListView
package feathers.controls
extends BaseScrollContainer › FeathersControl › MeasureSprite › ValidatingSprite
implements IFocusContainer, IDataSelector<Dynamic>
Displays a list of items divided into groups or sections. Accepts a
hierarchical tree of items, similar to TreeView, but limits the display to
two levels of hierarchy at most. Supports scrolling, custom item renderers,
and custom layouts.
The following example creates a group list, gives it a data provider, tells the item renderer how to interpret the data, and listens for when the selection changes:
var groupListView = new GroupListView();
groupListView.dataProvider = new ArrayHierarchicalCollection([
{
text: "Group A",
children: [
{text: "Node A1"},
{text: "Node A2"},
{text: "Node A3"},
{text: "Node A4"}
]
},
{
text: "Group B",
children: [
{text: "Node B1"},
{text: "Node B2"},
{text: "Node B3"}
]
},
{
text: "Group C",
children: [
{text: "Node C1"}
]
}
], (item:Dynamic) -> item.children);
groupListView.itemToText = (item:Dynamic) -> {
return item.text;
};
groupListView.addEventListener(Event.CHANGE, (event:Event) -> {
var groupListView = cast(event.currentTarget, GroupListView);
trace("GroupListView changed: " + groupListView.selectedLocation + " " + groupListView.selectedItem.text);
});
this.addChild(groupListView);Events:
openfl.events.Event.CHANGE | Dispatched when either
|
|---|---|
feathers.events.GroupListViewEvent.ITEM_TRIGGER | Dispatched when the user taps or clicks an item renderer in the 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_HEADER_RENDERER:String = "groupListView_headerRenderer"
The variant used to style the group headers in a theme.
To override this default variant, set the
GroupListView.customHeaderRendererVariant property.
1.0.0
.See also:
staticfinalread onlyCHILD_VARIANT_ITEM_RENDERER:String = "groupListView_itemRenderer"
The variant used to style the group list view's item renderers in a theme.
To override this default variant, set the
GroupListView.customItemRendererVariant property.
1.0.0
.See also:
staticfinalread onlyVARIANT_BORDER:String = "border"
A variant used to style the group list view with a border. This variant is used by default on desktop.
The following example uses this variant:
var groupListView = new GroupListView();
groupListView.variant = GroupListView.VARIANT_BORDER;1.0.0
.See also:
staticfinalread onlyVARIANT_BORDERLESS:String = "borderless"
A variant used to style the group list view without a border. The variant is used by default on mobile.
The following example uses this variant:
var groupListView = new GroupListView();
groupListView.variant = GroupListView.VARIANT_BORDERLESS;1.0.0
.See also:
Constructor
new(?dataProvider:IHierarchicalCollection<Dynamic>, ?changeListener:Event ‑> Void)
Creates a new GroupListView object.
1.0.0
.Variables
customHeaderRendererVariant:String
A custom variant to set on all header renderers, instead of
GroupListView.CHILD_VARIANT_HEADER_RENDERER.
The customHeaderRendererVariant will be not be used if the result of
headerRendererRecycler.create() already has a variant set.
1.0.0
.See also:
customItemRendererVariant:String
A custom variant to set on all item renderers, instead of
GroupListView.CHILD_VARIANT_ITEM_RENDERER.
The customItemRendererVariant will be not be used if the result of
itemRendererRecycler.create() already has a variant set.
1.0.0
.See also:
dataProvider:IHierarchicalCollection<Dynamic>
The collection of data displayed by the group 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:
groupListView.dataProvider = new ArrayHierarchicalCollection([
{
text: "Group A",
children: [
{text: "Node A1"},
{text: "Node A2"},
{text: "Node A3"},
{text: "Node A4"}
]
},
{
text: "Group B",
children: [
{text: "Node B1"},
{text: "Node B2"},
{text: "Node B3"}
]
},
{
text: "Group C",
children: [
{text: "Node C1"}
]
}
], (item:Dynamic) -> item.children);
groupListView.itemToText = (item:Dynamic) -> {
return item.text;
};1.0.0
.forceItemStateUpdate:Bool
Forces the itemRendererRecycler.update() and
headerRendererRecycler.update() methods to be called with the
GroupListViewItemState when the group list view validates, even if the
item or header's state has not changed since the previous validation.
Before Feathers UI 1.2, update() was called more frequently, and this
property is provided to enable backwards compatibility, temporarily, to
assist in migration from earlier versions of Feathers UI.
In general, when this property needs to be enabled, its often because of
a missed call to dataProvider.updateAt() (preferred) or
dataProvider.updateAll() (less common).
The forceItemStateUpdate property may be removed in a future major
version, so it is best to avoid relying on it as a long-term solution.
1.2.0
.headerRendererRecycler:AbstractDisplayObjectRecycler<Dynamic, GroupListViewItemState, DisplayObject>
Manages header renderers used by the group list view.
In the following example, the group list view uses a custom header renderer class:
groupListView.headerRendererRecycler = DisplayObjectRecycler.withClass(CustomHeaderRenderer);1.0.0
.See also:
itemRendererRecycler:AbstractDisplayObjectRecycler<Dynamic, GroupListViewItemState, DisplayObject>
Manages item renderers used by the group list view.
In the following example, the group list view uses a custom item renderer class:
groupListView.itemRendererRecycler = DisplayObjectRecycler.withClass(CustomItemRenderer);1.0.0
.See also:
layout:ILayout
The layout algorithm used to position and size the group list view's items.
By default, if no layout is provided by the time that the group list view initializes, a default layout that displays items vertically will be created.
The following example tells the group list view to use a horizontal layout:
var layout = new HorizontalListLayout();
layout.gap = 20.0;
layout.padding = 20.0;
groupListView.layout = layout;1.0.0
.pointerSelectionEnabled:Bool = true
Indicates if selection is changed with MouseEvent.CLICK or
TouchEvent.TOUCH_TAP when the item renderer does not implement the
IToggle interface. If set to false, all item renderers must control
their own selection manually (not only ones that implement IToggle).
The following example disables pointer selection:
groupListView.pointerSelectionEnabled = false;1.0.0
.selectable:Bool
Determines if items in the group list view may be selected. By default, only a single item may be selected at any given time. In other words, if item A is already selected, and the user selects item B, item A will be deselected automatically.
The following example disables selection of items in the group list view:
groupListView.selectable = false;1.0.0
.See also:
selectedLocation:Array<Int>
The currently selected location. Returns null if no location is
selected.
The following example selects a specific location:
groupListView.selectedLocation = [2, 0];The following example clears the currently selected location:
groupListView.selectedLocation = null;The following example listens for when the selection changes, and it prints the new selected location to the debug console:
var groupListView = new GroupListView();
function changeHandler(event:Event):Void
{
var groupListView = cast(event.currentTarget, GroupListView);
trace("selection change: " + groupListView.selectedLocation);
}
groupListView.addEventListener(Event.CHANGE, changeHandler);1.0.0
.virtualLayout:Bool
Indicates if the group list view's layout is allowed to virtualize items or not.
The following example disables virtual layouts:
groupListView.virtualLayout = false;1.0.0
.headerRendererRecyclerIDFunction:(state:GroupListViewItemState) ‑> String
When a list view requires multiple header renderer types, this function
is used to determine which type of header renderer is required for a
specific header. Returns the ID of the header renderer recycler to use
for the header, or null if the default headerRendererRecycler should
be used.
The following example provides an headerRendererRecyclerIDFunction:
var regularHeaderRecycler = DisplayObjectRecycler.withClass(ItemRenderer);
var firstHeaderRecycler = DisplayObjectRecycler.withClass(MyCustomHeaderRenderer);
groupListView.setHeaderRendererRecycler("regular-header", regularHeaderRecycler);
groupListView.setHeaderRendererRecycler("first-header", firstHeaderRecycler);
groupListView.headerRendererRecyclerIDFunction = function(state:GroupListViewItemState):String {
if(state.location[0] == 0) {
return "first-header";
}
return "regular-header";
};1.0.0
.See also:
`GroupListView.headerRendererRecycler
itemRendererRecyclerIDFunction:(state:GroupListViewItemState) ‑> String
When a list view requires multiple item renderer types, this function is
used to determine which type of item renderer is required for a specific
item. Returns the ID of the item renderer recycler to use for the item,
or null if the default itemRendererRecycler should be used.
The following example provides an itemRendererRecyclerIDFunction:
var regularItemRecycler = DisplayObjectRecycler.withClass(ItemRenderer);
var firstItemRecycler = DisplayObjectRecycler.withClass(MyCustomItemRenderer);
groupListView.setItemRendererRecycler("regular-item", regularItemRecycler);
groupListView.setItemRendererRecycler("first-item", firstItemRecycler);
groupListView.itemRendererRecyclerIDFunction = function(state:ListViewItemState):String {
if(state.index == 0) {
return "first-item";
}
return "regular-item";
};1.0.0
.See also:
`GroupListView.itemRendererRecycler
Methods
getHeaderRendererRecycler(id:String):DisplayObjectRecycler<Dynamic, GroupListViewItemState, DisplayObject>
Returns the header renderer recycler associated with a specific ID.
Returns null if no recycler is associated with the ID.
1.0.0
.See also:
getItemRendererRecycler(id:String):DisplayObjectRecycler<Dynamic, GroupListViewItemState, DisplayObject>
Returns the item renderer recycler associated with a specific ID.
Returns null if no recycler is associated with the ID.
1.0.0
.See also:
itemRendererToItem(itemRenderer:DisplayObject):Dynamic
Returns the current item from the data provider that is rendered by a specific item renderer.
1.0.0
.dynamicitemToEnabled(data:Dynamic):Bool
Determines if an item should be enabled or disabled. By default, all
items are enabled, unless the GroupListView 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 GroupListView should disable an item if the disable field is
true, a custom implementation of itemToEnabled() might look like
this:
groupListView.itemToEnabled = (item:Dynamic) -> {
return !item.disable;
};1.2.0
.dynamicitemToHeaderText(data:Dynamic):String
Converts an group to text to display within a group list view header. 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 Section" }If the GroupListView should display the text "Example Item", a custom
implementation of itemToHeaderText() might look like this:
groupListView.itemToHeaderText = (item:Dynamic) -> {
return item.text;
};1.0.0
.itemToItemRenderer(item:Dynamic):DisplayObject
Returns the current item renderer used to render a specific item from
the data provider. May return null if an item doesn't currently have
an item renderer.
Note: Most list views use "virtual" layouts, which means that only the currently-visible subset of items will have an item renderer. As the list view scrolls, the items with item renderers will change, and item renderers may even be re-used to display different items.
1.0.0
.itemToItemState(item:Dynamic):GroupListViewItemState
Returns a GroupListViewItemState representing a specific item.
1.3.0
.dynamicitemToText(data:Dynamic):String
Converts an item to text to display within group list view. 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 GroupListView should display the text "Example Item", a custom
implementation of itemToText() might look like this:
groupListView.itemToText = (item:Dynamic) -> {
return item.text;
};1.0.0
.locationToItemRenderer(location:Array<Int>):DisplayObject
Returns the current item renderer used to render the item at the
specified location in the data provider. May return null if an item
doesn't currently have an item renderer.
Note: Most list views use "virtual" layouts, which means that only the currently-visible subset of items will have an item renderer. As the list view scrolls, the items with item renderers will change, and item renderers may even be re-used to display different items.
1.0.0
.scrollToLocation(location:Array<Int>, ?animationDuration:Float):Void
Scrolls the list view so that the specified item renderer is completely visible. If the item renderer is already completely visible, does not update the scroll position.
A custom animation duration may be specified. To update the scroll
position without animation, pass a value of 0.0 for the duration.
1.0.0
.setHeaderRendererRecycler(id:String, recycler:AbstractDisplayObjectRecycler<Dynamic, GroupListViewItemState, DisplayObject>):Void
Associates an header renderer recycler with an ID to allow multiple types
of header renderers may be displayed in the group list view. A custom
headerRendererRecyclerIDFunction may be specified to return the ID of
the recycler to use for a specific header in the data provider.
To clear a recycler, pass in null for the value.
1.0.0
.See also:
setItemRendererRecycler(id:String, recycler:AbstractDisplayObjectRecycler<Dynamic, GroupListViewItemState, DisplayObject>):Void
Associates an item renderer recycler with an ID to allow multiple types
of item renderers may be displayed in the list view. A custom
itemRendererRecyclerIDFunction may be specified to return the ID of
the recycler to use for a specific item in the data provider.
To clear a recycler, pass in null for the value.
1.0.0
.See also: