class PopUpGridView

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

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

See also:

• PopUpGridView.customButtonVariant

• feathers.style.IVariantStyleObject.variant

• Feathers UI User Manual: Themes

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

To override this default variant, set the PopUpGridView.customGridViewVariant property.

See also:

• PopUpGridView.customGridViewVariant

• feathers.style.IVariantStyleObject.variant

• Feathers UI User Manual: Themes

Creates a new PopUpGridView object.

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

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

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

See also:

• feathers.controls.Button

Manages cell renderers used by the pop-up grid view.

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

popUpGridView.cellRendererRecycler = DisplayObjectRecycler.withClass(CustomItemRenderer);

See also:

• feathers.controls.dataRenderers.ItemRenderer

• feathers.controls.dataRenderers.LayoutGroupItemRenderer

Defines the set of columns to display for each item in the grid view's data provider. If null, the 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:

popUpGridView.dataProvider = new ArrayCollection([
	{ 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" }
]);
popUpGridView.columns = new ArrayCollection([
	new GridViewColumn("Item", (data) -> data.item),
	new GridViewColumn("Department", (data) -> data.dept),
	new GridViewColumn("Price", (data) -> data.price)
]);

See also:

• PopUpGridView.dataProvider

• feathers.controls.GridViewColumn

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

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

See also:

• PopUpGridView.CHILD_VARIANT_BUTTON

• feathers.style.IVariantStyleObject.variant

A custom variant to set on the pop-up grid view, instead of PopUpGridView.CHILD_VARIANT_GRID_VIEW.

The customGridViewVariant will be not be used if the result of gridViewFactory already has a variant set.

See also:

• PopUpGridView.CHILD_VARIANT_GRID_VIEW

• feathers.style.IVariantStyleObject.variant

The collection of data displayed by the 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 item renderer how to interpret the data:

popUpGridView.dataProvider = new ArrayCollection([
	{ text: "Milk" },
	{ text: "Eggs" },
	{ text: "Bread" },
	{ text: "Chicken" },
]);

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

See also:

• feathers.data.ArrayCollection

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

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

popUpGridView.gridViewFactory = () ->
{
	return new GridView();
};

See also:

• feathers.controls.GridView

See also:

• feathers.core.IIndexSelector.maxSelectedIndex

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

See also:

• PopUpGridView.openGridView()

• PopUpGridView.closeGridView()

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

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

popUpGridView.popUpAdapter = new DropDownPopUpAdapter();

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

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

popUpGridView.prompt = "Select an item";

See also:

• feathers.core.IIndexSelector.selectedIndex

See also:

• feathers.core.IDataSelector.selectedItem

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

The following example closes the pop-up grid:

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

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

See also:

• PopUpGridView.open

• PopUpGridView.openGridView()

• 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:

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

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

The following example opens the pop-up grid:

if(!popUpGridView.open)
{
	popUpGridView.openGridView();
}

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

See also:

• PopUpGridView.open

• PopUpGridView.closeGridView()

• openfl.events.Event.OPEN