Displays a hierarchical tree of items. Supports scrolling, custom item renderers, and custom layouts.

The following example creates a tree, gives it a data provider, tells the item renderer how to interpret the data, and listens for when the selection changes:

var treeView = new TreeView();

treeView.dataProvider = new TreeCollection([
	new TreeNode({text: "Node 1"}, [
		new TreeNode({text: "Node 1A"}, [
			new TreeNode({text: "Node 1A-I"}),
			new TreeNode({text: "Node 1A-II"}),
			new TreeNode({text: "Node 1A-III"}),
			new TreeNode({text: "Node 1A-IV"})
		]),
		new TreeNode({text: "Node 1B"}),
		new TreeNode({text: "Node 1C"})
	]),
	new TreeNode({text: "Node 2"}, [
		new TreeNode({text: "Node 2A"}),
		new TreeNode({text: "Node 2B"}),
		new TreeNode({text: "Node 2C"})
	]),
	new TreeNode({text: "Node 3"}),
	new TreeNode({text: "Node 4"}, [
		new TreeNode({text: "Node 4A"}),
		new TreeNode({text: "Node 4B"}),
		new TreeNode({text: "Node 4C"}),
		new TreeNode({text: "Node 4D"}),
		new TreeNode({text: "Node 4E"})
	])
]);

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

treeView.addEventListener(Event.CHANGE, (event:Event) -> {
	var treeView = cast(event.currentTarget, TreeView);
	trace("TreeView changed: " + treeView.selectedLocation + " " + treeView.selectedItem.text);
});

this.addChild(treeView);
Available since

1.0.0

.

See also:

Static variables

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

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

The following example uses this variant:

var treeView = new TreeView();
treeView.variant = TreeView.VARIANT_BORDER;
Available since

1.0.0

.

See also:

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

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

The following example uses this variant:

var treeView = new TreeView();
treeView.variant = TreeView.VARIANT_BORDERLESS;
Available since

1.0.0

.

See also:

Constructor

new()

Creates a new TreeView object.

Available since

1.0.0

.

Variables

@:value(null)dataProvider:IHierarchicalCollection<Dynamic> = null

The collection of data displayed by the tree view.

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

treeView.dataProvider = new TreeCollection([
	new TreeNode({text: "Node 1"}, [
		new TreeNode({text: "Node 1A"}, [
			new TreeNode({text: "Node 1A-I"}),
			new TreeNode({text: "Node 1A-II"}),
			new TreeNode({text: "Node 1A-III"}),
			new TreeNode({text: "Node 1A-IV"})
		]),
		new TreeNode({text: "Node 1B"}),
		new TreeNode({text: "Node 1C"})
	]),
	new TreeNode({text: "Node 2"}, [
		new TreeNode({text: "Node 2A"}),
		new TreeNode({text: "Node 2B"}),
		new TreeNode({text: "Node 2C"})
	]),
	new TreeNode({text: "Node 3"}),
	new TreeNode({text: "Node 4"}, [
		new TreeNode({text: "Node 4A"}),
		new TreeNode({text: "Node 4B"}),
		new TreeNode({text: "Node 4C"}),
		new TreeNode({text: "Node 4D"}),
		new TreeNode({text: "Node 4E"})
	])
]);

treeView.itemToText = (item:Dynamic) -> {
	return item.text;
};
Available since

1.0.0

.

@:value(DisplayObjectRecycler.withClass(TreeViewItemRenderer))itemRendererRecycler:DisplayObjectRecycler<Dynamic, TreeViewItemState, DisplayObject> = DisplayObjectRecycler.withClass(TreeViewItemRenderer)

Manages item renderers used by the tree view.

In the following example, the tree view uses a custom item renderer class:

treeView.itemRendererRecycler = DisplayObjectRecycler.withClass(CustomItemRenderer);
Available since

1.0.0

.

@:value(null)@:stylelayout:ILayout = null

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

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

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

var layout = new HorizontalListLayout();
layout.gap = 20.0;
layout.padding = 20.0;
treeView.layout = layout;
Available since

1.0.0

.

@:value(true)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:

treeView.pointerSelectionEnabled = false;
Available since

1.0.0

.

@:value(true)selectable:Bool = true

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

treeView.selectable = false;

See also:

@:value(null)@:isVarselectedItem:Dynamic = null

@:value(null)@:isVarselectedLocation:Array<Int> = null

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

The following example selects a specific location:

treeView.selectedLocation = [2, 0];

The following example clears the currently selected location:

treeView.selectedLocation = null;

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

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

1.0.0

.

@:value(true)virtualLayout:Bool = true

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

The following example disables virtual layouts:

treeView.virtualLayout = false;
Available since

1.0.0

.

Methods

dynamicitemToText(data:Dynamic):String

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

treeView.itemToText = (item:Dynamic) -> {
	return item.text;
};
Available since

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.

@since 1.0.0

Inherited Variables

Defined by BaseScrollContainer

@:value(true)@:styleautoHideScrollBars:Bool = true

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.

Available since

1.0.0

.

@:value(null)@:stylebackgroundSkin:DisplayObject = null

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:

@:value(null)@:styledisabledBackgroundSkin:DisplayObject = null

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:

@:value(true)@:styleelasticEdges:Bool = true

Determines if the scrolling can go beyond the edges of the viewport when dragging with a touch.

In the following example, elastic edges are disabled:

container.elasticEdges = false;
Available since

1.0.0

.

@:value(false)@:stylefixedScrollBars:Bool = false

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;
Available since

1.0.0

.

@:value(0.2)@:stylehideScrollBarDuration:Float = 0.2

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

.

@:value(Quart.easeOut)@:stylehideScrollBarEase:IEasing = Quart.easeOut

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

.

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

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

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

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

@:value(0.0)@:stylepaddingBottom:Float = 0.0

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

.

@:value(0.0)@:stylepaddingLeft:Float = 0.0

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

.

@:value(0.0)@:stylepaddingRight:Float = 0.0

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

.

@:value(0.0)@:stylepaddingTop:Float = 0.0

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

.

@:value(defaultScrollBarXFactory)scrollBarXFactory:() ‑> IScrollBar = defaultScrollBarXFactory

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:

@:value(BOTTOM)@:stylescrollBarXPosition:RelativePosition = BOTTOM

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:

@:value(defaultScrollBarYFactory)scrollBarYFactory:() ‑> IScrollBar = defaultScrollBarYFactory

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:

@:value(RIGHT)@:stylescrollBarYPosition:RelativePosition = RIGHT

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:

@:value(AUTO)scrollPolicyX:ScrollPolicy = AUTO

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:

@:value(AUTO)scrollPolicyY:ScrollPolicy = AUTO

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:

@:value(0.0)@:isVarscrollStepX:Float = 0.0

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

.

@:value(0.0)@:isVarscrollStepY:Float = 0.0

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

.

scrollX:Float

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

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:

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

@:value(false)@:stylesimulateTouch:Bool = false

When simulating touch, mouse events are treated as if they were mouse events instead, allowing the user to click and drag the container with momentum scrolling using the mouse instead of touch.

Generally, this is intended for testing during development and should not be used in production.

container.simulateTouch = true;
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

.

Defined by FeathersControl

@:value(false)read onlycreated:Bool = false

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:

@:value(true)@:isVarenabled:Bool = true

@:value(true)@:isVarfocusEnabled:Bool = true

@:value(null)@:isVar@stylefocusRectSkin:DisplayObject = null

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

Available since

1.0.0

.

@:value(false)read onlyinitialized:Bool = false

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:

read 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

.

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

@:value(null)variant:String = null

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

@:value(null)@:isVarexplicitHeight:Null<Float> = null

@:value(null)@:isVarexplicitMaxHeight:Null<Float> = null

@:value(null)@:isVarexplicitMaxWidth:Null<Float> = null

@:value(null)@:isVarexplicitMinHeight:Null<Float> = null

@:value(null)@:isVarexplicitMinWidth:Null<Float> = null

@:value(null)@:isVarexplicitWidth:Null<Float> = null

@:flash.propertymaxWidth:Float

@:flash.propertyminWidth:Float

Defined by ValidatingSprite

@:value(-1)read onlydepth:Int = -1

Inherited Methods

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

@:value({ flag : null })isInvalid(?flag:String):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

.

@:value({ flag : null })setInvalid(?flag:String):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:String):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

.