The default IStyleProvider for all TabNavigator components.

The default value is null.

See also

Determines if the swipe gesture to switch between tabs is enabled.

In the following example, swiping between tabs is enabled:

navigator.isSwipeEnabled = true;

The default value is false.

The minimum physical distance (in inches) that a touch must move before a drag gesture begins.

In the following example, the minimum drag distance is customized:

scroller.minimumDragDistance = 0.1;

The default value is 0.04.

The minimum physical velocity (in inches per second) that a touch must move before a swipe is detected. Otherwise, it will settle which screen to navigate to based on which one is closer when the touch ends.

In the following example, the minimum swipe velocity is customized:

navigator.minimumSwipeVelocity = 2;

The default value is 5.

The index of the currently selected tab. Returns -1 if no tab is selected.

In the following example, the tab navigator's selected index is changed:

navigator.selectedIndex = 2;

The following example listens for when selection changes and requests the selected index:

function navigator_changeHandler( event:Event ):void
{
    var navigator:TabNavigator = TabNavigator( event.currentTarget );
    var index:int = navigator.selectedIndex;
}
navigator.addEventListener( Event.CHANGE, navigator_changeHandler );

The default value is -1.

A function used to generate the navigator's tab bar sub-component. The tab bar must be an instance of TabBar (or a subclass). This factory can be used to change properties on the tab bar when it is first created. For instance, if you are skinning Feathers components without a theme, you might use this factory to set skins and other styles on the tab bar.

The function should have the following signature:

function():TabBar

In the following example, a custom tab bar factory is passed to the navigator:

navigator.tabBarFactory = function():TabBar
{
    var tabs:TabBar = new TabBar();
    tabs.distributeTabSizes = true;
    return tabs;
};

The default value is null.

See also

The value added to the styleNameList of the tab bar. This variable is protected so that sub-classes can customize the tab bar style name in their constructors instead of using the default style name defined by DEFAULT_CHILD_STYLE_NAME_TAB_BAR.

To customize the tab bar style name without subclassing, see customTabBarStyleName.

See also

Constructor.

Registers a new screen with a string identifier that can be used to reference the screen in other calls, like removeScreen() or showScreen().

Parameters

See also

Registers a new screen with a string identifier that can be used to reference the screen in other calls, like removeScreen() or showScreen().

Parameters

See also

Creates and adds the tabBar sub-component and removes the old instance, if one exists.

Meant for internal use, and subclasses may override this function with a custom implementation.

See also

Returns the TabNavigatorItem instance with the specified identifier.

Parameters

Removes an existing screen using the identifier assigned to it in the call to addScreen() or addScreenAt().

Parameters

See also

Removes an existing screen using the identifier assigned to it in the call to addScreen().

Parameters

See also

Displays the screen with the specified id. An optional transition may be passed in. If null the transition property will be used instead.

Returns a reference to the new screen, unless a transition is currently active. In that case, the new screen will be queued until the transition has completed, and no reference will be returned.

Parameters

See also

Dispatched when the user starts a swipe gesture to switch tabs.

The properties of the event object have the following values:

See also

Dispatched when the user stops a swipe gesture. If the user interaction has also triggered an animation, the content may continue moving after this event is dispatched.

The properties of the event object have the following values:

Depending on the control, the result of the interaction may continue after the interaction ends. For instance, a Scroller may be "thrown", and the scrolling will continue animating after the user has finished interacting with it.

See also

Dispatched when one of the tabs is triggered. The data property of the event contains the TabNavigatorItem that is associated with the tab that was triggered.

The properties of the event object have the following values:

Typically used to provide some kind of animation or visual effect, this function is called when a new screen is shown.

In the following example, the tab navigator is given a transition that fades in the new screen on top of the old screen:

navigator.transition = Fade.createFadeInTransition();

A number of animated transitions may be found in the feathers.motion package. However, you are not limited to only these transitions. It's possible to create custom transitions too.

A custom transition function should have the following signature:

function(oldScreen:DisplayObject, newScreen:DisplayObject, completeCallback:Function):void

Either of the oldScreen and newScreen arguments may be null, but never both. The oldScreen argument will be null when the first screen is displayed or when a new screen is displayed after clearing the screen. The newScreen argument will be null when clearing the screen.

The completeCallback function must be called when the transition effect finishes.This callback indicate to the tab navigator that the transition has finished. This function has the following signature:

function(cancelTransition:Boolean = false):void

The first argument defaults to false, meaning that the transition completed successfully. In most cases, this callback may be called without arguments. If a transition is cancelled before completion (perhaps through some kind of user interaction), and the previous screen should be restored, pass true as the first argument to the callback to inform the tab navigator that the transition is cancelled.

The default value is null.

See also

The location of the tab bar.

The following example positions the tab bar on the top of the navigator:

navigator.tabBarPosition = RelativePosition.TOP;

The default value is feathers.layout.RelativePosition.BOTTOM.

See also

The easing function used with the animation for a swipe gesture.

In the following example, the ease of the animation for a swipe gesture is customized:

navigator.swipeEase = Transitions.EASE_IN_OUT;

The default value is starling.animation.Transitions.EASE_OUT.

See also

The duration, in seconds, of the animation for a swipe gesture.

In the following example, the duration of the animation for a swipe gesture is set to 500 milliseconds:

navigator.swipeDuration = 0.5;

The default value is 0.25.

See also

A style name to add to the navigator's tab bar sub-component. Typically used by a theme to provide different styles to different navigators.

In the following example, a custom tab bar style name is passed to the navigator:

navigator.customTabBarStyleName = "my-custom-tab-bar";

In your theme, you can target this sub-component style name to provide different styles than the default:

getStyleProviderForClass( TabBar ).setFunctionForStyleName( "my-custom-tab-bar", setCustomTabBarStyles );

The default value is null.

See also

The default value added to the styleNameList of the tab bar.

See also