class CascadeListView

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

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

See also:

• CascadeListView.customButtonVariant

• feathers.style.IVariantStyleObject.variant

• Feathers UI User Manual: Themes

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

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

See also:

• CascadeListView.customListViewVariant

• feathers.style.IVariantStyleObject.variant

• Feathers UI User Manual: Themes

Creates a new CascadeListView object.

Creates the button, which must be of type feathers.controls.Button.

In the following example, a custom button factory is provided:

cascadeListView.buttonFactory = () ->
{
	return new Button();
};

See also:

• feathers.controls.Button

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

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

See also:

• CascadeListView.CHILD_VARIANT_BUTTON

• feathers.style.IVariantStyleObject.variant

A custom variant to set on the cascading list views, instead of CascadeListView.CHILD_VARIANT_LIST_VIEW.

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

See also:

• CascadeListView.CHILD_VARIANT_LIST_VIEW

• feathers.style.IVariantStyleObject.variant

The collection of data displayed by the cascading 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:

var collection = new ArrayHierarchicalCollection([
	{
		text: "Node 1",
		children: [
			{
				text: "Node 1A",
				children: [
					{text: "Node 1A-I"},
					{text: "Node 1A-II"},
					{text: "Node 1A-III"},
					{text: "Node 1A-IV"}
				]
			},
			{text: "Node 1B"},
			{text: "Node 1C"}
		]
	},
	{
		text: "Node 2",
		children: [
			{text: "Node 2A"},
			{text: "Node 2B"},
			{text: "Node 2C"}
		]
	},
	{text: "Node 3"},
	{
		text: "Node 4",
		children: [
			{text: "Node 4A"},
			{text: "Node 4B"},
			{text: "Node 4C"},
			{text: "Node 4D"},
			{text: "Node 4E"}
		]
	}
]);
collection.itemToChildren = (item:Dynamic) -> {
	return item.children;
};
cascadeListView.dataProvider = collection;

cascadeListView.itemToText = (item:Dynamic) -> {
	return item.text;
};

Manages item renderers used by the cascading list view.

In the following example, the cascading list uses a custom item renderer class:

cascadeListView.itemRendererRecycler = DisplayObjectRecycler.withClass(CustomItemRenderer);

See also:

• feathers.controls.dataRenderers.ItemRenderer

• feathers.controls.dataRenderers.LayoutGroupItemRenderer

Creates the cascading list views that are displayed as pop-ups. The list views must be of type feathers.controls.ListView.

In the following example, a custom list view factory is provided:

cascadeListView.listViewFactory = () ->
{
	return new ListView();
};

See also:

• feathers.controls.ListView

Indicates if the cascading list view pop-ups are open or closed.

See also:

• CascadeListView.openListView()

• CascadeListView.closeListView()

Manages how the cascading list views are displayed when it is opened and closed.

In the following example, a custom pop-up adapter is provided:

cascadeListView.popUpAdapter = new DropDownPopUpAdapter();

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

The following example sets the button's prompt:

cascadegListView.prompt = "Select an item";

See also:

• feathers.core.IDataSelector.selectedItem

The currently selected location. Returns null if no location is selected.

The following example selects a specific location:

cascadeListView.selectedLocation = [2, 0];

The following example clears the currently selected location:

cascadeListView.selectedLocation = null;

The following example listens for when the selection changes, and it prints the new selected location to the debug console:

var cascadeListView = new CascadeListView();
function changeHandler(event:Event):Void
{
	var cascadeListView = cast(event.currentTarget, CascadeListView);
	trace("selection change: " + cascadeListView.selectedLocation);
}
cascadeListView.addEventListener(Event.CHANGE, changeHandler);

Closes the pop-up lists, if they are open.

The following example closes the pop-up lists:

if(cascadeListView.open)
{
	cascadeListView.closeListView();
}

When the pop-up lists close, the component will dispatch an event of type Event.CLOSE.

See also:

• CascadeListView.open

• CascadeListView.openListView()

• openfl.events.Event.CLOSE

Determines if an item should be enabled or disabled. By default, all items are enabled, unless the CascadeListView 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 CascadeListView should disable an item if the disable field is true, a custom implementation of itemToEnabled() might look like this:

cascadeListView.itemToEnabled = (item:Dynamic) -> {
	return !item.disable;
};

Converts an item to text to display 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 Button should display the text "Example Item", a custom implementation of itemToText() might look like this:

cascadeListView.itemToText = (item:Dynamic) -> {
	return item.text;
};

Opens the pop-up lists, if they are not already open.

The following example opens the pop-up lists:

if(!cascadeListView.open)
{
	cascadeListView.openListView();
}

When the pop-up lists open, the component will dispatch an event of type Event.OPEN.

See also:

• CascadeListView.open

• CascadeListView.closeListView()

• openfl.events.Event.OPEN