Displays a list of items as a table. Each item is rendered as a row, divided into columns for each of the item's fields. Supports scrolling, custom cell, sorting columns, resizing columns, and drag and drop re-ordering of columns.

The following example creates a grid view, gives it a data provider, tells the columns how to interpret the data, and listens for when the selection changes:

var gridView = new GridView();

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

gridView.addEventListener(Event.CHANGE, (event:Event) -> {
	var gridView = cast(event.currentTarget, GridView);
	trace("GridView changed: " + gridView.selectedIndex + " " + gridView.selectedItem.item);
});

this.addChild(gridView);

Events:

openfl.events.Event.CHANGE

Dispatched when either GridView.selectedItem or GridView.selectedIndex changes.

feathers.events.GridViewEvent.CELL_TRIGGER

Dispatched when the user taps or clicks a cell renderer in the grid view. The pointer must remain within the bounds of the cell renderer on release, and the grid view cannot scroll before release, or the gesture will be ignored.

feathers.events.GridViewEvent.HEADER_TRIGGER

Dispatched when the user taps or clicks a header renderer in the grid view. The pointer must remain within the bounds of the header renderer on release, and the grid view cannot scroll before release, or the gesture will be ignored.

Available since

1.0.0

.

See also:

Static variables

@:value("gridView_cellRenderer")staticfinalread onlyCHILD_VARIANT_CELL_RENDERER:String = "gridView_cellRenderer"

The variant used to style the cell renderers in a theme.

Available since

1.0.0

.

See also:

@:value("gridView_columnDivider")staticfinalread onlyCHILD_VARIANT_COLUMN_DIVIDER:String = "gridView_columnDivider"

The variant used to style the column view port dividers in a theme.

Available since

1.0.0

.

See also:

@:value(CHILD_VARIANT_HEADER_RENDERER)staticfinalread onlyCHILD_VARIANT_HEADER:String = CHILD_VARIANT_HEADER_RENDERER

Deprecated: "GridView.CHILD_VARIANT_HEADER is deprecated. Use GridView.CHILD_VARIANT_HEADER_RENDERER instead."

@:value("gridView_headerDivider")staticfinalread onlyCHILD_VARIANT_HEADER_DIVIDER:String = "gridView_headerDivider"

The variant used to style the column header dividers in a theme.

Available since

1.0.0

.

See also:

@:value("gridView_headerRenderer")staticfinalread onlyCHILD_VARIANT_HEADER_RENDERER:String = "gridView_headerRenderer"

The variant used to style the column header renderers in a theme.

Available since

1.0.0

.

See also:

@:value("border")staticfinalread onlyVARIANT_BORDER:String = "border"

A variant used to style the grid view with a border. This variant is used by default on desktop.

The following example uses this variant:

var gridView = new GridView();
gridView.variant = GridView.VARIANT_BORDER;
Available since

1.0.0

.

See also:

@:value("borderless")staticfinalread onlyVARIANT_BORDERLESS:String = "borderless"

A variant used to style the grid view without a border. The variant is used by default on mobile.

The following example uses this variant:

var gridView = new GridView();
gridView.variant = GridView.VARIANT_BORDERLESS;
Available since

1.0.0

.

See also:

Constructor

new(?dataProvider:IFlatCollection<Dynamic>)

Creates a new GridView object.

Available since

1.0.0

.

Variables

@:flash.propertyallowMultipleSelection:Bool

Determines if multiple items may be selected at the same time. Has no effect if selectable is false.

In the following example, multiple selection is enabled:

gridView.allowMultipleSelection = true;
Available since

1.0.0

.

See also:

@:flash.propertycellRendererRecycler:DisplayObjectRecycler<Dynamic, GridViewCellState, DisplayObject>

Manages cell renderers used by the grid view.

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

gridView.cellRendererRecycler = DisplayObjectRecycler.withClass(CustomCellRenderer);
Available since

1.0.0

.

See also:

@:style@:flash.propertycolumnDividerFactory:DisplayObjectFactory<Dynamic, DisplayObject>

Manages the dividers between the grid view's columns.

In the following example, the grid view uses a custom column divider class:

gridView.columnDividerFactory = DisplayObjectFactory.withClass(CustomColumnDivider);
Available since

1.0.0

.

@:style@:flash.propertycolumnResizeSkin:DisplayObject

The skin to display when a column is being resized.

Available since

1.0.0

.

See also:

@:flash.propertycolumns:IFlatCollection<GridViewColumn>

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:

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

1.0.0

.

See also:

@:style@:flash.propertycustomColumnDividerVariant:String

A custom variant to set on all column dividers, instead of GridView.CHILD_VARIANT_COLUMN_DIVIDER.

The customColumnDividerVariant will be not be used if the result of columnDividerFactory.create() already has a variant set.

Available since

1.0.0

.

See also:

  • `GridView.CHILD_VARIANT_COLUMN_DIVIDER

@:style@:flash.propertycustomHeaderDividerVariant:String

A custom variant to set on all header dividers, instead of GridView.CHILD_VARIANT_HEADER_DIVIDER.

The customHeaderDividerVariant will be not be used if the result of headerDividerFactory.create() already has a variant set.

Available since

1.0.0

.

See also:

  • `GridView.CHILD_VARIANT_HEADER_DIVIDER

@:style@:flash.propertycustomHeaderRendererVariant:String

A custom variant to set on all header renderers, instead of GridView.CHILD_VARIANT_HEADER_RENDERER.

The customHeaderRendererVariant will be not be used if the result of headerRendererRecycler.create() already has a variant set.

Available since

1.0.0

.

See also:

  • `GridView.CHILD_VARIANT_HEADER_RENDERER

@:flash.propertydataProvider:IFlatCollection<Dynamic>

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 columns how to interpret the data:

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

1.0.0

.

See also:

@:style@:flash.propertyextendedScrollBarY:Bool

Determines if the vertical scroll bar will start from the top of the headers, instead of starting below them.

Available since

1.0.0

.

@:style@:flash.propertyheaderDividerFactory:DisplayObjectFactory<Dynamic, InteractiveObject>

Manages the dividers between the grid view's headers.

In the following example, the grid view uses a custom header divider class:

gridView.headerDividerFactory = DisplayObjectFactory.withClass(CustomHeaderDivider);
Available since

1.0.0

.

@:flash.propertyheaderRendererRecycler:DisplayObjectRecycler<Dynamic, GridViewHeaderState, DisplayObject>

Manages header renderers used by the grid view.

In the following example, the grid view uses a custom header renderer class:

gridView.headerRendererRecycler = DisplayObjectRecycler.withClass(CustomHeaderRenderer);
Available since

1.0.0

.

@:style@:flash.propertylayout:ILayout

The layout algorithm used to position and size the grid view's items.

By default, if no layout is provided by the time that the grid view initializes, a default layout that displays items vertically will be created.

The following example tells the list view to use a horizontal layout:

var layout = new VerticalListLayout();
layout.requestedRowCount = 5.0;
layout.gap = 20.0;
layout.padding = 20.0;
listView.layout = layout;
Available since

1.0.0

.

@:flash.propertyresizableColumns:Bool

Determines if the grid view's columns may be resized by mouse/touch.

The following example enables column resizing:

gridView.resizableColumns = true;

See also:

@:flash.propertyselectable:Bool

Determines if items in the grid 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 grid view:

gridView.selectable = false;

See also:

@:flash.propertyselectedIndices:Array<Int>

Contains all of the indices that are currently selected. The most recently selected index will appear at the beginning of the array. In other words, the indices are in the reverse order that they were selected by the user.

When the selectedIndices array contains multiple items, the selectedIndex property will return the first item from selectedIndices.

Available since

1.0.0

.

See also:

@:flash.propertyselectedItems:Array<Dynamic>

Contains all of the items that are currently selected. The most recently selected item will appear at the beginning of the array. In other words, the items are in the reverse order that they were selected by the user.

When the selectedItems array contains multiple items, the selectedItem property will return the first item from selectedItems.

Available since

1.0.0

.

See also:

@:style@:flash.propertyshowHeaderDividersOnlyWhenResizable:Bool

Determines if header dividers are visible only when resizableColumns is true.

@:flash.propertysortOrder:SortOrder

Indicates the sort order of sortedColumn, if sortedColumn is not null. Otherwise, returns SortOrder.NONE.

Available since

1.0.0

.

See also:

@:flash.propertysortableColumns:Bool

Determines if the data grid's columns may be sorted by triggering the column headers. If a column does not provide a custom sortCompareFunction, the default behavior will compare the strings returned byitemToText(). A custom sortCompareFunction is recommended for comparing numeric values.

The following example enables column sorting:

gridView.sortableColumns = true;

See also:

@:flash.propertysortedColumn:GridViewColumn

The currently sorted column, or null, if no columns have been sorted.

Available since

1.0.0

.

@:flash.propertyvirtualLayout:Bool

Indicates if the grid view's layout is allowed to virtualize items or not.

The following example disables virtual layouts:

gridView.virtualLayout = false;
Available since

1.0.0

.

Methods

columnToHeaderRenderer(column:GridViewColumn):DisplayObject

Returns the current header renderer used to render a specific column.

Available since

1.0.0

.

See also:

headerRendererToColumn(headerRenderer:DisplayObject):GridViewColumn

Returns the current column that is rendered by a specific header renderer.

Available since

1.0.0

.

See also:

itemAndColumnToCellRenderer(item:Dynamic, column:GridViewColumn):DisplayObject

Returns the current cell renderer used to render a specific column from an item from the data provider. May return null if an item and column doesn't currently have a cell renderer.

Note: Most grid views use "virtual" layouts, which means that only the currently-visible subset of items will have cell renderers. As the grid view scrolls, the items with cell renderers will change, and cell renderers may even be re-used to display different items.

Available since

1.0.0

.

scrollToRowIndex(rowIndex:Int, ?animationDuration:Float):Void

Scrolls the grid view so that the specified row is completely visible. If the row 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.

Available since

1.0.0

.

Inherited Variables

Defined by BaseScrollContainer

@:style@:flash.propertyautoHideScrollBars:Bool

Determines if the scroll bars should be automatically hidden after scrolling has ended, whether it was through user interaction or animation.

In the following example, scroll bar auto-hiding is disabled:

container.autoHideScrollBars = false;

This property has no effect if fixedScrollBars is true. Fixed scroll bars are always visible. Similarly, if showScrollBars is false, then the scroll bars are always hidden.

Available since

1.0.0

.

@:style@:flash.propertybackgroundSkin:DisplayObject

The default background skin to display behind all content added to the group. The background skin is resized to fill the complete width and height of the group.

The following example passes a bitmap for the container to use as a background skin:

group.backgroundSkin = new Bitmap(bitmapData);
Available since

1.0.0

.

See also:

@:style@:flash.propertydisabledBackgroundSkin:DisplayObject

The default background skin to display behind all content added to the group. The background skin is resized to fill the complete width and height of the group.

The following example gives the group a disabled background skin:

group.disabledBackgroundSkin = new Bitmap(bitmapData);
group.enabled = false;
Available since

1.0.0

.

See also:

@:style@:flash.propertyfixedScrollBars:Bool

Determines if the scroll bars are fixed to the edges of the container, without overlapping the container's content, or if the scroll bars are floating above the container's content.

In the following example, the scroll bars are fixed:

container.fixedScrollBars = true;

This property has no effect if showScrollBars is false.

Available since

1.0.0

.

@:style@:flash.propertyhideScrollBarDuration:Float

The duration, measured in seconds, of the animation when a scroll bar fades out.

In the following example, the duration of the animation that hides the scroll bars is set to 500 milliseconds:

container.hideScrollBarDuration = 0.5;
Available since

1.0.0

.

@:style@:flash.propertyhideScrollBarEase:IEasing

The easing function used for hiding the scroll bars, if applicable.

In the following example, the ease of the animation that hides the scroll bars is customized:

container.hideScrollBarEase = Elastic.easeOut;
Available since

1.0.0

.

@:style@:flash.propertymaskSkin:DisplayObject

A skin to mask the content of the container. The skin is resized to the full dimensions of the container. It is passed to the mask property.

This property masks the entire container, including any chrome such as scroll bars or headers and footers. To mask only the scrollable region, use viewPortMaskSkin instead.

The following example passes a RectangleSkin with a cornerRadius for the container's mask skin:

var maskSkin = new RectangleSkin();
maskSkin.fill = SolidColor(0xff0000);
maskSkin.cornerRadius = 10.0;
container.maskSkin = maskSkin;
Available since

1.0.0

.

See also:

@:flash.propertyread onlymaxScrollX:Float

The number of pixels the container may be scrolled horizontally in the rightward direction. This value is automatically calculated based on the bounds of the container's viewport.

The scrollX property may have a higher value than the maximum if the elasticEdges property is enabled. However, once the user stops interacting with the container, it will automatically animate back to the maximum position.

Available since

1.0.0

.

See also:

@:flash.propertyread onlymaxScrollY:Float

The number of pixels the container may be scrolled vertically in the downward direction. This value is automatically calculated based on the bounds of the container's viewport.

The scrollY property may have a higher value than the maximum if the elasticEdges property is enabled. However, once the user stops interacting with the container, it will automatically animate back to the maximum position.

Available since

1.0.0

.

See also:

@:flash.propertyread onlyminScrollX:Float

The number of pixels the container may be scrolled horizontally in the leftward direction. This value is automatically calculated based on the bounds of the container's viewport.

The scrollX property may have a lower value than the minimum if the elasticEdges property is enabled. However, once the user stops interacting with the container, it will automatically animate back to the minimum position.

Available since

1.0.0

.

See also:

@:flash.propertyread onlyminScrollY:Float

The number of pixels the container may be scrolled vertically in the upward direction. This value is automatically calculated based on the bounds of the container's viewport.

The scrollY property may have a lower value than the minimum if the elasticEdges property is enabled. However, once the user stops interacting with the container, it will automatically animate back to the minimum position.

Available since

1.0.0

.

See also:

@:style@:flash.propertypaddingBottom:Float

The minimum space, in pixels, between the container's bottom edge and the container's content.

In the following example, the container's bottom padding is set to 20 pixels:

container.paddingBottom = 20.0;
Available since

1.0.0

.

@:style@:flash.propertypaddingLeft:Float

The minimum space, in pixels, between the container's left edge and the container's content.

In the following example, the container's left padding is set to 20 pixels:

container.paddingLeft = 20.0;
Available since

1.0.0

.

@:style@:flash.propertypaddingRight:Float

The minimum space, in pixels, between the container's right edge and the container's content.

In the following example, the container's right padding is set to 20 pixels:

container.paddingRight = 20.0;
Available since

1.0.0

.

@:style@:flash.propertypaddingTop:Float

The minimum space, in pixels, between the container's top edge and the container's content.

In the following example, the container's top padding is set to 20 pixels:

container.paddingTop = 20.0;
Available since

1.0.0

.

restrictedScrollX:Float

Setting scrollX will clamp the value between minScrollX and maxScrollX, but setting unrestrictedScrollX will allow values outside of that range.

Available since

1.0.0

.

See also:

restrictedScrollY:Float

Setting restrictedScrollY will clamp the value to the range between minScrollY and maxScrollY.

Available since

1.0.0

.

See also:

@:flash.propertyscrollBarXFactory:() ‑> IScrollBar

Creates the horizontal scroll bar. The horizontal scroll bar may be any implementation of IScrollBar, but typically, the feathers.controls.HScrollBar component is used.

In the following example, a custom horizontal scroll bar factory is passed to the container:

scroller.scrollBarXFactory = () ->
{
	return new HScrollBar();
};
Available since

1.0.0

.

See also:

@:style@:flash.propertyscrollBarXPosition:RelativePosition

Determines the edge of the container where the horizontal scroll bar will be positioned (either on the top or the bottom).

In the following example, the horizontal scroll bar is positioned on the top edge of the container:

container.scrollBarXPosition = TOP;
Available since

1.0.0

.

See also:

@:flash.propertyscrollBarYFactory:() ‑> IScrollBar

Creates the vertical scroll bar. The vertical scroll bar may be any implementation of IScrollBar, but typically, the feathers.controls.VScrollBar component is used.

In the following example, a custom vertical scroll bar factory is passed to the container:

scroller.scrollBarYFactory = () ->
{
	return new VScrollBar();
};
Available since

1.0.0

.

See also:

@:style@:flash.propertyscrollBarYPosition:RelativePosition

Determines the edge of the container where the vertical scroll bar will be positioned (either on the left or the right).

In the following example, the vertical scroll bar is positioned on the left edge of the container:

container.scrollBarYPosition = LEFT;
Available since

1.0.0

.

See also:

@:flash.propertyscrollMode:ScrollMode

Determines how scrolling is rendered by the container.

In the following example, scroll mode is changed to use a mask:

container.scrollMode = MASK;
Available since

1.0.0

.

@:style@:flash.propertyscrollPixelSnapping:Bool

If enabled, the scroll position will always be adjusted to the nearest pixel in stage coordinates.

In the following example, the scroll position is snapped to pixels:

container.scrollPixelSnapping = true;
Available since

1.0.0

.

@:flash.propertyscrollPolicyX:ScrollPolicy

Determines whether the container may scroll horizontally (on the x-axis) or not.

In the following example, horizontal scrolling is disabled:

container.scrollPolicyX = OFF;
Available since

1.0.0

.

See also:

@:flash.propertyscrollPolicyY:ScrollPolicy

Determines whether the container may scroll vertically (on the y-axis) or not.

In the following example, vertical scrolling is disabled:

container.scrollPolicyY = OFF;
Available since

1.0.0

.

See also:

@:flash.propertyscrollStepX:Float

The number of pixels the horizontal scroll position can be adjusted by a step (such as with the left/right keyboard arrow keys, or a step button on the horizontal scroll bar).

In the following example, the horizontal scroll step is set to 20 pixels:

container.scrollStepX = 20.0;
Available since

1.0.0

.

@:flash.propertyscrollStepY:Float

The number of pixels the vertical scroll position can be adjusted by a step (such as with the up/down keyboard arrow keys, or a step button on the vertical scroll bar).

In the following example, the vertical scroll step is set to 20 pixels:

container.scrollStepY = 20.0;
Available since

1.0.0

.

@:flash.propertyscrollX:Float

The number of pixels the container has been scrolled horizontally (on the x-axis).

When setting scrollX, the new value will be automatically clamped to the range between minScrollX and maxScrollX. To programmatically set a scrollX to a value outside of that range, set unrestrictedScrollX instead.

When the value of scrollX changes, the container dispatches an event of type ScrollEvent.SCROLL. This event is dispatched when other scroll position properties change too.

In the following example, the horizontal scroll position is modified immediately, without being animated:

container.scrollX = 100.0;
Available since

1.0.0

.

See also:

@:flash.propertyscrollY:Float

The number of pixels the container has been scrolled vertically (on the y-axis).

When the value of scrollY changes, the container dispatches an event of type ScrollEvent.SCROLL. This event is dispatched when other scroll position properties change too.

In the following example, the vertical scroll position is modified immediately, without being animated:

container.scrollY = 100.0;
Available since

1.0.0

.

See also:

@:flash.propertyscrollerFactory:() ‑> Scroller

Creates the Scroller utility that manages touch and mouse wheel scrolling.

In the following example, a custom scroller factory is passed to the container:

scroller.scrollBarYFactory = () ->
{
	var scroller = new Scroller();
	scroller.elasticEdges = false;
	return scroller;
};
Available since

1.0.0

.

@:style@:flash.propertyshowScrollBarMinimumDuration:Float

The minimum time, in seconds, that the scroll bars will be shown, if autoHideScrollBars is enabled.

In the following example, the minimum duration to show scroll bars is increased:

container.showScrollBarMinimumDuration = 1.0;
Available since

1.0.0

.

See also:

@:style@:flash.propertyshowScrollBars:Bool

Determines if scroll bars are displayed or not.

In the following example, the scroll bars are hidden:

container.showScrollBars = false;
Available since

1.0.0

.

private@:dox(show)viewPort:IViewPort

The display object rendered and scrolled within the container, provided by a subclass of BaseScrollContainer.

Available since

1.0.0

.

@:style@:flash.propertyviewPortMaskSkin:DisplayObject

A skin to mask the view port (the scrollable region) of the container. The skin is resized to the dimensions of the view port only, and it does not affect any other chrome, such as scroll bars or a header or footer. It is passed to the mask property.

The following example passes a RectangleSkin with a cornerRadius for the container view port's mask skin:

var maskSkin = new RectangleSkin();
maskSkin.fill = SolidColor(0xff0000);
maskSkin.cornerRadius = 10.0;
container.viewPortMaskSkin = maskSkin;
Available since

1.0.0

.

See also:

Defined by FeathersControl

@:flash.propertyread onlycreated:Bool

Determines if the component has been initialized and validated for the first time.

In the following example, we check if the component is created or not, and we listen for an event if it isn't:

if(!control.created)
{
	control.addEventListener(FeathersEventType.CREATION_COMPLETE, creationCompleteHandler);
}

See also:

@:flash.propertyenabled:Bool

@style@:flash.propertyfocusPaddingBottom:Float

Optional padding outside the bottom edge of this UI component when the focusRectSkin is visible.

Available since

1.0.0

.

@style@:flash.propertyfocusPaddingLeft:Float

Optional padding outside the left edge of this UI component when the focusRectSkin is visible.

Available since

1.0.0

.

@style@:flash.propertyfocusPaddingRight:Float

Optional padding outside the right edge of this UI component when the focusRectSkin is visible.

Available since

1.0.0

.

@style@:flash.propertyfocusPaddingTop:Float

Optional padding outside the top edge of this UI component when the focusRectSkin is visible.

Available since

1.0.0

.

@style@:flash.propertyfocusRectSkin:DisplayObject

An optional skin to display when an IFocusObject component receives focus.

Available since

1.0.0

.

@:flash.propertyread onlyinitialized:Bool

Determines if the component has been initialized yet. The initialize() function is called one time only, when the Feathers UI control is added to the display list for the first time.

In the following example, we check if the component is initialized or not, and we listen for an event if it isn't initialized:

if(!control.initialized)
{
	control.addEventListener(FeathersEvent.INITIALIZE, initializeHandler);
}
Available since

1.0.0

.

See also:

@:flash.propertyread onlystyleContext:Class<IStyleObject>

The class used as the context for styling the component. If a subclass of a component should have different styles than its superclass, it should override the get_styleContext getter. However, if a subclass should continue using the same styles as its superclass, it happens automatically.

Available since

1.0.0

.

@:flash.propertystyleProvider:IStyleProvider

When a component initializes, a style provider may be used to set properties that affect the component's visual appearance.

You can set or replace an existing style provider at any time before a component initializes without immediately affecting the component's visual appearance. After the component initializes, the style provider may still be changed, and any properties that were set by the previous style provider will be reset to their default values before applying the new style provider.

Available since

1.0.0

.

See also:

@:flash.propertytoolTip:String

@:flash.propertyvariant:String

May be used to provide multiple different variations of the same UI component, each with a different appearance.

Available since

1.0.0

.

Defined by MeasureSprite

@:flash.propertyexplicitWidth:Null<Float>

@:flash.propertymaxWidth:Float

@:flash.propertyminWidth:Float

Defined by ValidatingSprite

@:flash.propertyread onlydepth:Int

Inherited Methods

Defined by BaseScrollContainer

@:value({ result : null })getViewPortVisibleBounds(?result:Rectangle):Rectangle

Returns the visible bounds of the view port within the container's local coordinate system.

Available since

1.0.0

.

setPadding(value:Float):Void

Defined by FeathersControl

private@:dox(show)initialize():Void

Called the first time that the UI control is added to the stage, and you should override this function to customize the initialization process. Do things like create children and set up event listeners. After this function is called, Event.INIT is dispatched.

The following example overrides initialization:

override private function initialize():Void {
	super.initialize();

}
Available since

1.0.0

.

move(x:Float, y:Float):Void

Sets both the x and y positions of the control in a single function call.

Available since

1.0.0

.

See also:

  • DisplayObject.x

  • DisplayObject.y

setSize(width:Float, height:Float):Void

Sets both the width and height dimensions of the control in a single function call.

Available since

1.0.0

.

See also:

  • DisplayObject.width

  • DisplayObject.height

private@:dox(show)setStyle(styleName:String, ?state:EnumValue):Bool

Determines if a style may be changed, and restricts the style from being changed in the future, if necessary.

Available since

1.0.0

.

Defined by MeasureSprite

private@:value({ minHeight : 0.0, minWidth : 0.0 })@:dox(show)saveMeasurements(width:Float, height:Float, minWidth:Float = 0.0, minHeight:Float = 0.0, ?maxWidth:Float, ?maxHeight:Float):Bool

Saves the calculated dimensions for the component, replacing any values that haven't been set explicitly. Returns true if the reported values have changed and Event.RESIZE was dispatched.

Available since

1.0.0

.

Defined by ValidatingSprite

isInvalid(?flag:InvalidationFlag):Bool

Indicates whether the control is pending validation or not. By default, returns true if any invalidation flag has been set. If you pass in a specific flag, returns true only if that flag has been set (others may be set too, but it checks the specific flag only. If all flags have been marked as invalid, always returns true.

The following example invalidates a component:

component.setInvalid();
trace(component.isInvalid()); // true
Available since

1.0.0

.

runWithoutInvalidation(callback:() ‑> Void):Void

Calls a function that temporarily disables invalidation. In other words, calls to setInvalid() will be ignored until the function returns.

Available since

1.0.0

.

setInvalid(?flag:InvalidationFlag):Void

Call this function to tell the UI control that a redraw is pending. The redraw will happen immediately before OpenFL renders the UI control to the screen. The validation system exists to ensure that multiple properties can be set together without redrawing multiple times in between each property change.

If you cannot wait until later for the validation to happen, you can call validate() to redraw immediately. As an example, you might want to validate immediately if you need to access the correct width or height values of the UI control, since these values are calculated during validation.

The following example invalidates a component:

component.setInvalid();
trace(component.isInvalid()); // true
Available since

1.0.0

.

private@:dox(show)setInvalidationFlag(flag:InvalidationFlag):Void

Sets an invalidation flag. This will not add the component to the validation queue. It only sets the flag. A subclass might use this function during draw() to manipulate the flags that its superclass sees.

Available since

1.0.0

.

See also:

private@:dox(show)update():Void

Override to customize layout and to adjust properties of children. Called when the component validates, if any flags have been marked to indicate that validation is pending.

The following example overrides updating after invalidation:

override private function update():Void {
	super.update();

}
Available since

1.0.0

.