Determines if a display object returned by getScreen() can be disposed or not when a screen is no longer active.

The optional icon to display on the tab.

The label to display on the tab.

A set of key-value pairs representing properties to be set on the screen when it is shown. A pair's key is the name of the screen's property, and a pair's value is the value to be passed to the screen's property.

A Class that may be instantiated to create a DisplayObject instance to display when the associated tab is selected. A new instance of the screen will be instantiated every time that it is shown by the TabNavigator. The screen's state will not be saved automatically, but it may be saved in properties, if needed.

The default value is null.

See also

A display object to be displayed by the TabNavigator when the associted tab is selected. The same instance will be reused every time that it is shown by the TabNavigator. Whe the screen is hidden and shown again, its state will remain the same as when it was hidden. However, the screen will also be kept in memory even when it isn't displayed, limiting the resources that are available for other views.

Using screenClass or screenFunction instead of screenDisplayObject is the recommended best practice. In general, screenDisplayObject should only be used in rare situations where instantiating a new screen would be extremely expensive.

The default value is null.

See also

A Function that may be called to return a DisplayObject instance to display when the associated tab is selected. A new instance of the screen will be instantiated every time that it is shown by the TabNavigator. The screen's state will not be saved automatically, but it may be saved in properties, if needed.

The default value is null.

See also

A custom transition for this screen only. If null, the default transition defined by the TabNavigator will be used.

In the following example, the tab navigator item is given a custom transition:

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

Constructor.

Returns a display object instance of this screen.