The default IStyleProvider for all StackScreenNavigator components.

The default value is null.

See also

Determines if the swipe gesture to pop the current screen is enabled.

In the following example, swiping to go back is enabled:

navigator.isSwipeToPopEnabled = true;

The default value is false.

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

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

scroller.minimumDragDistance = 0.1;

The default value is 0.04.

See also

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.

See also

Sets the first screen at the bottom of the stack, or the root screen. When this screen is shown, there will be no transition.

If the stack contains screens when you set this property, they will be removed from the stack. In other words, setting this property will clear the stack, erasing the current history.

In the following example, the root screen is set:

navigator.rootScreenID = "someScreen";

See also

The size (in inches) of the region near the left edge of the content that can be dragged when isSwipeToPopEnabled is true.

In the following example, the swipe-to-pop gesture edge size is customized:

drawers.swipeToPopGestureEdgeSize = 0.25;

The default value is 0.1.

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 pushScreen().

Parameters

See also

Returns the StackScreenNavigatorItem instance with the specified identifier.

Parameters

Pops all screens from the stack, leaving the StackScreenNavigator empty.

An optional transition may be specified. If null, the popTransition property will be used instead.

Parameters

See also

Pops the current screen from the top of the stack, returning to the previous screen.

An optional transition may be specified. If null the popTransition 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

Returns to the root screen, at the bottom of the stack.

An optional transition may be specified. If null, the popToRootTransition or popTransition 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

Returns to the root screen, at the bottom of the stack, but replaces it with a new root screen.

An optional transition may be specified. If null, the popToRootTransition or popTransition 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

Pushes a screen onto the top of the stack.

A set of key-value pairs representing properties on the previous screen may be passed in. If the new screen is popped, these values may be used to restore the previous screen's state.

An optional transition may be specified. If null the pushTransition 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

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

Parameters

See also

Replaces the current screen on the top of the stack with a new screen. May be used in the case where you want to navigate from screen A to screen B and then to screen C, but when popping screen C, you want to skip screen B and return to screen A.

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.

An optional transition may be specified. If null the pushTransition property will be used instead.

Parameters

See also

Typically used to provide some kind of animation or visual effect, a function that is called when the screen navigator clears its stack, to show the first screen that was pushed onto the stack.

If this property is null, the value of the popTransition property will be used instead.

In the following example, a custom pop to root transition is passed to the screen navigator:

navigator.popToRootTransition = 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 screen 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 screen navigator that the transition is cancelled.

The default value is null.

See also

Typically used to provide some kind of animation or visual effect, this function that is called when the screen navigator pops a screen from the top of the stack.

In the following example, the screen navigator is given a pop transition that slides the screens to the right:

navigator.popTransition = Slide.createSlideRightTransition();

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 screen 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 screen navigator that the transition is cancelled.

The default value is null.

See also

Typically used to provide some kind of animation or visual effect, this function that is called when the screen navigator pushes a new screen onto the stack.

In the following example, the screen navigator is given a push transition that slides the screens to the left:

navigator.pushTransition = Slide.createSlideLeftTransition();

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 screen 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 screen navigator that the transition is cancelled.

The default value is null.

See also