A line of tabs, where one may be selected at a time.

The following example sets the data provider, tells the tabs how to interpret the data, selects the second tab, and listens for when the selection changes:

var tabs = new TabBar();
tabs.dataProvider = new ArrayCollection([
	{ text: "Latest Posts" },
	{ text: "Profile" },
	{ text: "Settings" }
]);

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

tabs.selectedIndex = 1;

tabs.addEventListener(Event.CHANGE, tabs_changeHandler);

this.addChild(tabs);

Events:

openfl.events.Event.CHANGE

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

feathers.events.TabBarEvent.ITEM_TRIGGER

Dispatched when the user taps or clicks a tab. The pointer must remain within the bounds of the tab on release, or the gesture will be ignored.

Available since

1.0.0

.

See also:

Static variables

@:value("tabBar_tab")staticfinalread onlyCHILD_VARIANT_TAB:String = "tabBar_tab"

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

To override this default variant, set the TabBar.customTabVariant property.

Available since

1.0.0

.

See also:

Constructor

new(?dataProvider:IFlatCollection<Dynamic>, ?changeListener:Event ‑> Void)

Creates a new TabBar object.

Available since

1.0.0

.

Variables

@:style@:flash.propertybackgroundSkin:DisplayObject

The default background skin to display behind the tabs.

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

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

1.0.0

.

See also:

@:style@:flash.propertycustomTabVariant:String

A custom variant to set on all tabs, instead of TabBar.CHILD_VARIANT_TAB.

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

Available since

1.0.0

.

See also:

dataProvider:IFlatCollection<Dynamic>

The collection of data displayed by the tab bar.

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

tabBar.dataProvider = new ArrayCollection([
	{ text: "Latest Posts" },
	{ text: "Profile" },
	{ text: "Settings" }
]);

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

1.0.0

.

See also:

@:style@:flash.propertydisabledBackgroundSkin:DisplayObject

A background skin to display behind the tabs when the tab bar is disabled.

The following example gives the tab bar a disabled background skin:

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

1.0.0

.

See also:

forceItemStateUpdate:Bool

Forces the tabRecycler.update() method to be called with the TabBarItemState when the tab bar validates, even if the item's state has not changed since the previous validation.

Before Feathers UI 1.2, update() was called more frequently, and this property is provided to enable backwards compatibility, temporarily, to assist in migration from earlier versions of Feathers UI.

In general, when this property needs to be enabled, its often because of a missed call to dataProvider.updateAt() (preferred) or dataProvider.updateAll() (less common).

The forceItemStateUpdate property may be removed in a future major version, so it is best to avoid relying on it as a long-term solution.

Available since

1.2.0

.

@:style@:flash.propertylayout:ILayout

The layout algorithm used to position and size the tabs.

By default, if no layout is provided by the time that the tab bar initializes, a default layout that displays items horizontally will be created.

The following example tells the tab bar to use a custom layout:

var layout = new HorizontalDistributedLayout();
layout.maxItemWidth = 300.0;
tabBar.layout = layout;
Available since

1.0.0

.

@:bindable("change")selectedItem:Dynamic

tabRecycler:AbstractDisplayObjectRecycler<Dynamic, TabBarItemState, ToggleButton>

Manages tabs used by the tab bar.

In the following example, the tab bar uses a custom tab renderer class:

tabBar.tabRecycler = DisplayObjectRecycler.withClass(ToggleButton);
Available since

1.0.0

.

tabRecyclerIDFunction:(state:TabBarItemState) ‑> String

When a tab bar requires multiple tab styles, this function is used to determine which style of tab is required for a specific item. Returns the ID of the tab recycler to use for the item, or null if the default tabRecycler should be used.

The following example provides an tabRecyclerIDFunction:

var regularTabRecycler = DisplayObjectRecycler.withClass(ToggleButton);
var firstTabRecycler = DisplayObjectRecycler.withClass(MyCustomToggleButton);

tabBar.setTabRecycler("regular-tab", regularTabRecycler);
tabBar.setTabRecycler("first-tab", firstTabRecycler);

tabBar.tabRecyclerIDFunction = function(state:TabBarItemState):String {
	if(state.index == 0) {
		return "first-tab";
	}
	return "regular-tab";
};
Available since

1.0.0

.

See also:

Methods

getTabRecycler(id:String):DisplayObjectRecycler<Dynamic, TabBarItemState, ToggleButton>

Returns the tab recycler associated with a specific ID. Returns null if no recycler is associated with the ID.

Available since

1.0.0

.

See also:

indexToTab(index:Int):ToggleButton

Returns the current tab used to render the item at the specified index in the data provider. May return null if an item doesn't currently have a tab.

Available since

1.0.0

.

dynamicitemToEnabled(data:Dynamic):Bool

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

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

1.2.0

.

itemToTab(item:Dynamic):ToggleButton

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

Available since

1.0.0

.

dynamicitemToText(data:Dynamic):String

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

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

1.0.0

.

setTabRecycler(id:String, recycler:AbstractDisplayObjectRecycler<Dynamic, TabBarItemState, ToggleButton>):Void

Associates an tab recycler with an ID to allow multiple types of tabs to be displayed in the tab bar. A custom tabRecyclerIDFunction may be specified to return the ID of the recycler to use for a specific item in the data provider.

To clear a recycler, pass in null as the value.

Available since

1.0.0

.

See also:

Inherited Variables

Defined by FeathersControl

@:bindable("creationComplete")read 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:

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

When disabledAlpha is not null, sets the alpha property to this value when the the enabled property is set to false.

Available since

1.0.0

.

@stylefocusPaddingBottom:Float

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

Available since

1.0.0

.

@stylefocusPaddingLeft:Float

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

Available since

1.0.0

.

@stylefocusPaddingRight:Float

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

Available since

1.0.0

.

@stylefocusPaddingTop:Float

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

Available since

1.0.0

.

@stylefocusRectSkin:DisplayObject

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

Available since

1.0.0

.

@:bindable("layoutDataChange")includeInLayout:Bool

@:bindable("initialize")read 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:

@style@:bindable("layoutDataChange")layoutData:ILayoutData

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

Typically used by the theme to provide styles to each component, but a custom style provider may be provided that will take precedence over the theme's style provider.

When a component initializes, its style provider sets properties that affect the component's visual appearance. If the style provider dispatches StyleProviderEvent.STYLES_CHANGE after the component has initialized, the original properties set by the style provider will be reset to their default values and before applying the new property values.

Setting the style provider or replacing an existing style provider before a component initializes will queue up the style changes until after initialization. Once a component initializes, the style provider may be changed, but the changes will be applied immediately. Similarly to when a style provider dispatcches StyleProviderEvent.STYLES_CHANGE, any properties that were set by the previous style provider will be reset to their default values before applying the new style provider.

If the themeEnabled property is false, the current theme's style provider will be ignored. However, if a custom style provider was provided from outside of the theme, it will still be used.

Available since

1.0.0

.

See also:

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

Defined by ValidatingSprite

read onlyvalidating:Bool

Indicates if the display object is currently validating.

Available since

1.0.0

.

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, `FeathersEvent.INITIALIZE is dispatched.

The following example overrides initialization:

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

}
Available since

1.0.0

.

See also:

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

setFocusPadding(value:Float):Void

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

.

runWithInvalidationFlagsOnly(callback:() ‑> Void):Void

Calls a function that temporarily limits setInvalid() calls to setting invalidation flags only, and the control will not be added to the validation queue. In other words, setInvalid() calls will work similarly to setInvalidationFlag() instead.

Typically, this method should be called only during validation. If called outside of update(), the component's validation may be delayed until a future call to setInvalid().

Available since

1.2.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

.