class PopUpTreeGridView

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

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

See also:

• PopUpTreeGridView.customButtonVariant

• feathers.style.IVariantStyleObject.variant

• Feathers UI User Manual: Themes

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

To override this default variant, set the PopUpTreeGridView.customTreeGridViewVariant property.

See also:

• PopUpTreeGridView.customTreeGridViewVariant

• feathers.style.IVariantStyleObject.variant

• Feathers UI User Manual: Themes

Creates a new PopUpTreeGridView object.

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

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

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

See also:

• feathers.controls.Button

Manages cell renderers used by the pop-up tree grud view.

In the following example, the pop-up tree grid view uses a custom item renderer class:

popUpTreeGridView.itemRendererRecycler = DisplayObjectRecycler.withClass(CustomItemRenderer);

See also:

• feathers.controls.dataRenderers.HierarchicalItemRenderer

• feathers.controls.dataRenderers.LayoutGroupItemRenderer

Defines the set of columns to display for each item in the pop-up tree grid view's data provider. If null, the tree grid view will attempt to populate the columns automatically using reflection.

The following example passes in a data provider and tells the columns how to interpret the data:

popUpTreeGridView.dataProvider = new ArrayHierarchicalCollection([
	{ item: "Chicken breast", dept: "Meat", price: "5.90" },
	{ item: "Butter", dept: "Dairy", price: "4.69" },
	{ item: "Broccoli", dept: "Produce", price: "2.99" },
	{ item: "Whole Wheat Bread", dept: "Bakery", price: "2.49" }
]);
popUpTreeGridView.columns = new ArrayCollection([
	new TreeGridViewColumn("Item", (data) -> data.item),
	new TreeGridViewColumn("Department", (data) -> data.dept),
	new TreeGridViewColumn("Price", (data) -> data.price)
]);

See also:

• PopUpTreeGridView.dataProvider

• feathers.controls.TreeGridViewColumn

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

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

See also:

• PopUpTreeGridView.CHILD_VARIANT_BUTTON

• feathers.style.IVariantStyleObject.variant

A custom variant to set on the pop-up tree grid view, instead of PopUpTreeGridView.CHILD_VARIANT_TREE_GRID_VIEW.

The customTreeGridViewVariant will be not be used if the result of treeGridViewFactory already has a variant set.

See also:

• PopUpTreeGridView.CHILD_VARIANT_TREE_GRID_VIEW

• feathers.style.IVariantStyleObject.variant

The collection of data displayed by the pop-up tree grid 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 columns how to interpret the data:

popUpTreeGridView.dataProvider = new ArrayHierarchicalCollection([
	{ item: "Chicken breast", dept: "Meat", price: "5.90" },
	{ item: "Butter", dept: "Dairy", price: "4.69" },
	{ item: "Broccoli", dept: "Produce", price: "2.99" },
	{ item: "Whole Wheat Bread", dept: "Bakery", price: "2.49" }
]);
popUpTreeGridView.columns = new ArrayCollection([
	new TreeGridViewColumn("Item", (data) -> data.item),
	new TreeGridViewColumn("Department", (data) -> data.dept),
	new TreeGridViewColumn("Price", (data) -> data.price)
]);

See also:

• feathers.data.ArrayHierarchicalCollection

Indicates if the tree grid view pop-up is open or closed.

See also:

• PopUpTreeGridView.openTreeGridView()

• PopUpTreeGridView.closeTreeGridView()

Manages how the tree grid view is displayed when it is opened and closed.

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

popUpTreeGridView.popUpAdapter = new DropDownPopUpAdapter();

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

The following example sets the pop-up tree grid view's prompt:

popUpTreeGridView.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:

popUpTreeGridView.selectedLocation = [2, 0];

The following example clears the currently selected location:

popUpTreeGridView.selectedLocation = null;

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

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

Creates the tree grid view that is displayed as a pop-up. The tree grid view must be of type feathers.controls.TreeGridView.

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

popUpTreeGridView.treeGridViewFactory = () ->
{
	return new TreeGridView();
};

See also:

• feathers.controls.TreeGridView

Closes the pop-up tree grid, if it is open.

The following example closes the pop-up tree grid:

if(popUpTreeGridView.open)
{
	popUpTreeGridView.closeGridView();
}

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

See also:

• PopUpTreeGridView.open

• PopUpTreeGridView.openTreeGridView()

• openfl.events.Event.CLOSE

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:

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

Opens the pop-up tree grid, if it is not already open.

The following example opens the pop-up tree grid:

if(!popUpTreeGridView.open)
{
	popUpTreeGridView.openTreeGridView();
}

When the pop-up tree grid opens, the component will dispatch an event of type Event.OPEN.

See also:

• popUpTreeGridView.open

• popUpTreeGridView.closeTreeGridView()

• openfl.events.Event.OPEN