| Package | feathers.controls |
| Class | public class StackScreenNavigator |
| Inheritance | StackScreenNavigator  BaseScreenNavigator FeathersControl Sprite DisplayObjectContainer DisplayObject EventDispatcher Object |
| Subclasses | StackScreenNavigatorApplication |
| Product Version : | Feathers 2.1.0 |
The following example creates a screen navigator, adds a screen and displays it:
var navigator:StackScreenNavigator = new StackScreenNavigator(); navigator.addScreen( "mainMenu", new StackScreenNavigatorItem( MainMenuScreen ) ); this.addChild( navigator ); navigator.rootScreenID = "mainMenu";
See also
| Property | Defined By | ||
|---|---|---|---|
 | activeScreen : DisplayObject [read-only]
A reference to the currently active screen. | BaseScreenNavigator | |
| activeScreenID : String [read-only]
The string identifier for the currently active screen. | BaseScreenNavigator | |
| addedEffect : Function
An optional effect that is activated when the component is added to
the stage. | FeathersControl | |
| alpha : Number The opacity of the object. | DisplayObject | |
| autoSizeMode : String
Determines how the screen navigator will set its own size when its
dimensions (width and height) aren't set explicitly. | BaseScreenNavigator | |
| base : DisplayObject [read-only] The topmost object in the display tree the object is part of. | DisplayObject | |
| blendMode : String The blend mode determines how the object is blended with the objects underneath. | DisplayObject | |
| bounds : Rectangle [read-only] The bounds of the object relative to the local coordinates of the parent. | DisplayObject | |
| clipContent : Boolean
Determines if the navigator's content should be clipped to the width
and height. | BaseScreenNavigator | |
| defaultTextEditorFactory : Function [static]
A function used by all UI controls that support text editor to
create an ITextEditor instance. | FeathersControl | |
| defaultTextRendererFactory : Function [static]
A function used by all UI controls that support text renderers to
create an ITextRenderer instance. | FeathersControl | |
| depth : int [read-only]
The component's depth in the display list, relative to the stage. | FeathersControl | |
| effectsSuspended : Boolean [read-only]
Indicates if effects have been suspended. | FeathersControl | |
| explicitHeight : Number [read-only]
The height value explicitly set by passing a value to the
height setter or by calling the setSize()
function. | FeathersControl | |
| explicitMaxHeight : Number [read-only]
The maximum height value explicitly set by passing a value to the
maxHeight setter. | FeathersControl | |
| explicitMaxWidth : Number [read-only]
The maximum width value explicitly set by passing a value to the
maxWidth setter. | FeathersControl | |
| explicitMinHeight : Number [read-only]
The minimum height value explicitly set by passing a value to the
minHeight setter. | FeathersControl | |
| explicitMinWidth : Number [read-only]
The minimum width value explicitly set by passing a value to the
minWidth setter. | FeathersControl | |
| explicitWidth : Number [read-only]
The width value explicitly set by passing a value to the
width setter or to the setSize() method. | FeathersControl | |
| filter : FragmentFilter The filter that is attached to the display object. | DisplayObject | |
| focusInEffect : Function
An optional effect that is activated when the component receives
focus. | FeathersControl | |
| focusManager : IFocusManager
The implementation of this property is provided for convenience,
but it cannot be used unless a subclass implements the
IFocusDisplayObject interface.
The current focus manager for this component. | FeathersControl | |
| focusOutEffect : Function
An optional effect that is activated when the component loses focus. | FeathersControl | |
| focusOwner : IFocusDisplayObject
The implementation of this property is provided for convenience,
but it cannot be used unless a subclass implements the
IFocusDisplayObject interface.
Used for associating focusable display objects that are not direct
children with an "owner" focusable display object, such as pop-ups. | FeathersControl | |
| globalStyleProvider : IStyleProvider [static]
The default IStyleProvider for all StackScreenNavigator
components. | StackScreenNavigator | ||
| height : Number [override]
The height of the component, in pixels. | FeathersControl | |
| hideEffect : Function
An optional effect that is activated when the component is hidden. | FeathersControl | |
| includeInLayout : Boolean
Determines if the ILayout should use this object or ignore it. | FeathersControl | |
| is3D : Boolean [read-only] Indicates if this object or any of its parents is a 'Sprite3D' object. | DisplayObject | |
| isCreated : Boolean [read-only]
Determines if the component has been initialized and validated for
the first time. | FeathersControl | |
| isEnabled : Boolean
Indicates whether the control is interactive or not. | FeathersControl | |
| isFocusEnabled : Boolean
The implementation of this property is provided for convenience,
but it cannot be used unless a subclass implements the
IFocusDisplayObject interface.
Determines if this component can receive focus. | FeathersControl | |
| isInitialized : Boolean [read-only]
Determines if the component has been initialized yet. | FeathersControl | |
| isQuickHitAreaEnabled : Boolean
Similar to mouseChildren on the classic display list. | FeathersControl | |
| isShowingFocus : Boolean [read-only]
The implementation of this method is provided for convenience, but
it cannot be used unless a subclass implements the
IFocusDisplayObject interface.
Indicates if the showFocus() method has been called on
the object when it has focus. | FeathersControl | |
| isSwipeToPopEnabled : Boolean
Determines if the swipe gesture to pop the current screen is enabled. | StackScreenNavigator | ||
| isTransitionActive : Boolean [read-only]
Indicates whether the screen navigator is currently transitioning
between screens. | BaseScreenNavigator | |
| layoutData : ILayoutData
Extra parameters associated with this display object that will be
used by the layout algorithm. | FeathersControl | |
| maintainTouchFocus : Boolean [read-only]
The implementation of this method is provided for convenience, but
it cannot be used unless a subclass implements the
IFocusDisplayObject interface.
If true, the display object should remain in focus,
even if something else is touched. | FeathersControl | |
| mask : DisplayObject The display object that acts as a mask for the current object. | DisplayObject | |
| maskInverted : Boolean Indicates if the masked region of this object is set to be inverted. | DisplayObject | |
| maxHeight : Number
The maximum recommended height to be used for self-measurement and,
optionally, by any code that is resizing this component. | FeathersControl | |
| maxWidth : Number
The maximum recommended width to be used for self-measurement and,
optionally, by any code that is resizing this component. | FeathersControl | |
| minHeight : Number
The minimum recommended height to be used for self-measurement and,
optionally, by any code that is resizing this component. | FeathersControl | |
| minimumDragDistance : Number
The minimum physical distance (in inches) that a touch must move
before a drag gesture begins when isSwipeToPopEnabled
is true. | StackScreenNavigator | ||
| minimumSwipeVelocity : Number
The minimum physical velocity (in inches per second) that a touch
must move before a swipe is detected. | StackScreenNavigator | ||
| minTouchHeight : Number
If using isQuickHitAreaEnabled, and the hit area's
height is smaller than this value, it will be expanded. | FeathersControl | |
| minTouchWidth : Number
If using isQuickHitAreaEnabled, and the hit area's
width is smaller than this value, it will be expanded. | FeathersControl | |
| minWidth : Number
The minimum recommended width to be used for self-measurement and,
optionally, by any code that is resizing this component. | FeathersControl | |
| moveEffect : Function
An optional effect that is activated when the component is moved to
a new position. | FeathersControl | |
| name : String The name of the display object (default: null). | DisplayObject | |
| nextDownFocus : IFocusDisplayObject
The implementation of this property is provided for convenience,
but it cannot be used unless a subclass implements the
IFocusDisplayObject interface.
The next object that will receive focus when
Keyboard.DOWN is pressed at
KeyLocation.D_PAD and a focus manager is enabled. | FeathersControl | |
| nextLeftFocus : IFocusDisplayObject
The implementation of this property is provided for convenience,
but it cannot be used unless a subclass implements the
IFocusDisplayObject interface.
The next object that will receive focus when
Keyboard.LEFT is pressed at
KeyLocation.D_PAD and a focus manager is enabled. | FeathersControl | |
| nextRightFocus : IFocusDisplayObject
The implementation of this property is provided for convenience,
but it cannot be used unless a subclass implements the
IFocusDisplayObject interface.
The next object that will receive focus when
Keyboard.RIGHT is pressed at
KeyLocation.D_PAD and a focus manager is enabled. | FeathersControl | |
| nextTabFocus : IFocusDisplayObject
The implementation of this property is provided for convenience,
but it cannot be used unless a subclass implements the
IFocusDisplayObject interface.
The next object that will receive focus when the tab key is pressed
when a focus manager is enabled. | FeathersControl | |
| nextUpFocus : IFocusDisplayObject
The implementation of this property is provided for convenience,
but it cannot be used unless a subclass implements the
IFocusDisplayObject interface.
The next object that will receive focus when
Keyboard.UP is pressed at
KeyLocation.D_PAD and a focus manager is enabled. | FeathersControl | |
| numChildren : int [read-only] The number of children of this container. | DisplayObjectContainer | |
| parent : DisplayObjectContainer [read-only] The display object container that contains this display object. | DisplayObject | |
| pivotX : Number The x coordinate of the object's origin in its own coordinate space (default: 0). | DisplayObject | |
| pivotY : Number The y coordinate of the object's origin in its own coordinate space (default: 0). | DisplayObject | |
| previousTabFocus : IFocusDisplayObject
The implementation of this property is provided for convenience,
but it cannot be used unless a subclass implements the
IFocusDisplayObject interface.
The previous object that will receive focus when the tab key is
pressed while holding shift when a focus manager is enabled. | FeathersControl | |
| requiresRedraw : Boolean [read-only] Indicates if the object needs to be redrawn in the upcoming frame, i.e. | DisplayObject | |
| resizeEffect : Function
An optional effect that is activated when the component is resized
with new dimensions. | FeathersControl | |
| root : DisplayObject [read-only] The root object the display object is connected to (i.e. | DisplayObject | |
| rootScreenID : String
Sets the first screen at the bottom of the stack, or the root screen. | StackScreenNavigator | ||
| rotation : Number The rotation of the object in radians. | DisplayObject | |
| scale : Number Sets both 'scaleX' and 'scaleY' to the same value. | DisplayObject | |
| scaleX : Number The horizontal scale factor. | DisplayObject | |
| scaleY : Number The vertical scale factor. | DisplayObject | |
| showEffect : Function
An optional effect that is activated when the component is shown. | FeathersControl | |
| skewX : Number The horizontal skew angle in radians. | DisplayObject | |
| skewY : Number The vertical skew angle in radians. | DisplayObject | |
| stage : Stage [read-only] The stage the display object is connected to, or null if it is not connected
to the stage. | DisplayObject | |
| styleName : String
The concatenated styleNameList, with values separated
by spaces. | FeathersControl | |
| styleNameList : TokenList [read-only]
Contains a list of all "styles" assigned to this control. | FeathersControl | |
| styleProvider : IStyleProvider
When a component initializes, a style provider may be used to set
properties that affect the component's visual appearance. | FeathersControl | |
| swipeToPopGestureEdgeSize : Number
The size (in inches) of the region near the left edge of the content
that can be dragged when isSwipeToPopEnabled is
true. | StackScreenNavigator | ||
| toolTip : String
Text to display in a tool tip to when hovering over this component,
if the ToolTipManager is enabled. | FeathersControl | |
| touchable : Boolean Indicates if this object (and its children) will receive touch events. | DisplayObject | |
| touchGroup : Boolean If a container is a 'touchGroup', it will act as a single touchable object. | DisplayObjectContainer | |
| transformationMatrix : Matrix The transformation matrix of the object relative to its parent. | DisplayObject | |
| transformationMatrix3D : Matrix3D [read-only] The 3D transformation matrix of the object relative to its parent. | DisplayObject | |
| useHandCursor : Boolean Indicates if the mouse cursor should transform into a hand while it's over the sprite. | DisplayObject | |
| visible : Boolean The visibility of the object. | DisplayObject | |
| width : Number [override]
The width of the component, in pixels. | FeathersControl | |
| x : Number The x coordinate of the object relative to the local coordinates of the parent. | DisplayObject | |
| y : Number The y coordinate of the object relative to the local coordinates of the parent. | DisplayObject | |
| Method | Defined By | ||
|---|---|---|---|
Constructor. | StackScreenNavigator | ||
| Adds a child to the container. | DisplayObjectContainer | |
| Adds a child to the container at a certain index. | DisplayObjectContainer | |
| addEventListener(type:String, listener:Function):void [override] Registers an event listener at a certain object. | DisplayObject | |
addScreen(id:String, item:StackScreenNavigatorItem):void
Registers a new screen with a string identifier that can be used
to reference the screen in other calls, like removeScreen()
or pushScreen(). | StackScreenNavigator | ||
| alignPivot(horizontalAlign:String = center, verticalAlign:String = center):void Moves the pivot point to a certain position within the local coordinate system
of the object. | DisplayObject | |
| broadcastEvent(event:Event):void Dispatches an event on all children (recursively). | DisplayObjectContainer | |
| broadcastEventWith(eventType:String, data:Object = null):void Dispatches an event with the given parameters on all children (recursively). | DisplayObjectContainer | |
| contains(child:DisplayObject):Boolean Determines if a certain object is a child of the container (recursively). | DisplayObjectContainer | |
| dispatchEvent(event:Event):void Dispatches an event to all objects that have registered listeners for its type. | EventDispatcher | |
| dispatchEventWith(type:String, bubbles:Boolean = false, data:Object = null):void Dispatches an event with the given parameters to all objects that have registered
listeners for the given type. | EventDispatcher | |
| dispose():void [override] Disposes the resources of all children. | DisplayObjectContainer | |
| drawToBitmapData(out:BitmapData = null, color:uint = 0x0, alpha:Number = 0.0):BitmapData Draws the object into a BitmapData object. | DisplayObject | |
| getBounds(targetSpace:DisplayObject, resultRect:Rectangle = null):Rectangle [override]
Feathers components use an optimized getBounds()
implementation that may sometimes behave differently than regular
Starling display objects. | FeathersControl | |
| getChildAt(index:int):DisplayObject Returns a child object at a certain index. | DisplayObjectContainer | |
| getChildByName(name:String):DisplayObject Returns a child object with a certain name (non-recursively). | DisplayObjectContainer | |
| getChildIndex(child:DisplayObject):int Returns the index of a child within the container, or "-1" if it is not found. | DisplayObjectContainer | |
getScreen(id:String):StackScreenNavigatorItem
Returns the StackScreenNavigatorItem instance with the
specified identifier. | StackScreenNavigator | ||
| getScreenIDs(result:Vector.<String> = null):Vector.<String>
Returns a list of the screen identifiers that have been added. | BaseScreenNavigator | |
| getTransformationMatrix(targetSpace:DisplayObject, out:Matrix = null):Matrix Creates a matrix that represents the transformation from the local coordinate system
to another. | DisplayObject | |
| getTransformationMatrix3D(targetSpace:DisplayObject, out:Matrix3D = null):Matrix3D Creates a matrix that represents the transformation from the local coordinate system
to another. | DisplayObject | |
| globalToLocal(globalPoint:Point, out:Point = null):Point Transforms a point from global (stage) coordinates to the local coordinate system. | DisplayObject | |
| globalToLocal3D(globalPoint:Point, out:Vector3D = null):Vector3D Transforms a point from global (stage) coordinates to the 3D local coordinate system. | DisplayObject | |
| hasEventListener(type:String, listener:Function = null):Boolean If called with one argument, figures out if there are any listeners registered for
the given event type. | EventDispatcher | |
| hasScreen(id:String):Boolean
Determines if the specified screen identifier has been added with
addScreen(). | BaseScreenNavigator | |
| hideFocus():void
The implementation of this method is provided for convenience, but
it cannot be used unless a subclass implements the
IFocusDisplayObject interface.
| FeathersControl | |
| hitTest(localPoint:Point):DisplayObject [override] Returns the object that is found topmost beneath a point in local coordinates, or nil
if the test fails. | DisplayObjectContainer | |
| hitTestMask(localPoint:Point):Boolean Checks if a certain point is inside the display object's mask. | DisplayObject | |
| initializeNow():void
If the component has not yet initialized, initializes immediately. | FeathersControl | |
| invalidate(flag:String):void
Call this function to tell the UI control that a redraw is pending. | FeathersControl | |
| isInvalid(flag:String = null):Boolean
Indicates whether the control is pending validation or not. | FeathersControl | |
| local3DToGlobal(localPoint:Vector3D, out:Point = null):Point Transforms a 3D point from the local coordinate system to global (stage) coordinates. | DisplayObject | |
| localToGlobal(localPoint:Point, out:Point = null):Point Transforms a point from the local coordinate system to global (stage) coordinates. | DisplayObject | |
| move(x:Number, y:Number):void
Sets both the x and the y positions of the control in a single
function call. | FeathersControl | |
popAll(transition:Function = null):void
Pops all screens from the stack, leaving the
StackScreenNavigator empty. | StackScreenNavigator | ||
popScreen(transition:Function = null):DisplayObject
Pops the current screen from the top of the stack, returning to the
previous screen. | StackScreenNavigator | ||
popToRootScreen(transition:Function = null):DisplayObject
Returns to the root screen, at the bottom of the stack. | StackScreenNavigator | ||
popToRootScreenAndReplace(id:String, transition:Function = null):DisplayObject
Returns to the root screen, at the bottom of the stack, but replaces
it with a new root screen. | StackScreenNavigator | ||
pushScreen(id:String, savedPreviousScreenProperties:Object = null, transition:Function = null):DisplayObject
Pushes a screen onto the top of the stack. | StackScreenNavigator | ||
| removeAllScreens():void
Removes all screens that were added with addScreen(). | BaseScreenNavigator | |
| Removes a child from the container. | DisplayObjectContainer | |
| removeChildAt(index:int, dispose:Boolean = false):DisplayObject Removes a child at a certain index. | DisplayObjectContainer | |
| removeChildren(beginIndex:int = 0, endIndex:int = -1, dispose:Boolean = false):void Removes a range of children from the container (endIndex included). | DisplayObjectContainer | |
| removeEventListener(type:String, listener:Function):void [override] Removes an event listener from the object. | DisplayObject | |
| removeEventListeners(type:String = null):void [override] Removes all event listeners with a certain type, or all of them if type is null. | DisplayObject | |
| removeFromParent(dispose:Boolean = false):void Removes the object from its parent, if it has one, and optionally disposes it. | DisplayObject | |
| removeFromParentWithEffect(effect:Function, dispose:Boolean = false):void
Plays an effect before removing the component from its parent. | FeathersControl | |
removeScreen(id:String):StackScreenNavigatorItem
Removes an existing screen using the identifier assigned to it in the
call to addScreen(). | StackScreenNavigator | ||
| [override] Renders the display object with the help of a painter object. | DisplayObjectContainer | |
replaceScreen(id:String, transition:Function = null):DisplayObject
Replaces the current screen on the top of the stack with a new
screen. | StackScreenNavigator | ||
| resetStyleProvider():void
Resets the styleProvider property to its default value,
which is usually the global style provider for the component. | FeathersControl | |
| resumeEffects():void
Indicates that effects should be re-activated after being suspended. | FeathersControl | |
| setChildIndex(child:DisplayObject, index:int):void Moves a child to a certain index. | DisplayObjectContainer | |
| setRequiresRedraw():void Forces the object to be redrawn in the next frame. | DisplayObject | |
| setSize(width:Number, height:Number):void
Sets both the width and the height of the control in a single
function call. | FeathersControl | |
| showFocus():void
The implementation of this method is provided for convenience, but
it cannot be used unless a subclass implements the
IFocusDisplayObject interface.
| FeathersControl | |
| sortChildren(compareFunction:Function):void Sorts the children according to a given function (that works just like the sort function
of the Vector class). | DisplayObjectContainer | |
| suspendEffects():void
Indicates that effects should not be activated temporarily. | FeathersControl | |
| Swaps the indexes of two children. | DisplayObjectContainer | |
| swapChildrenAt(index1:int, index2:int):void Swaps the indexes of two children. | DisplayObjectContainer | |
| validate():void
Immediately validates the display object, if it is invalid. | FeathersControl | |
| Style | Description | Defined By | ||
|---|---|---|---|---|
| Type: starling.display.DisplayObject If this component supports focus, this optional skin will be displayed above the component when showFocus() is called.See also | FeathersControl | ||
| Type: Number Quickly sets all focus padding properties to the same value. See also | FeathersControl | ||
| Type: Number The minimum space, in pixels, between the object's bottom edge and the bottom edge of the focus indicator skin. See also | FeathersControl | ||
| Type: Number The minimum space, in pixels, between the object's left edge and the left edge of the focus indicator skin. See also | FeathersControl | ||
| Type: Number The minimum space, in pixels, between the object's right edge and the right edge of the focus indicator skin. See also | FeathersControl | ||
| Type: Number The minimum space, in pixels, between the object's top edge and the top edge of the focus indicator skin. See also | FeathersControl | ||
popToRootTransition | Type: Function 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 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 The function(cancelTransition:Boolean = false):void The first argument defaults to null.See also | StackScreenNavigator | ||
popTransition | Type: Function 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 The function(cancelTransition:Boolean = false):void The first argument defaults to null.See also | StackScreenNavigator | ||
pushTransition | Type: Function 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 The function(cancelTransition:Boolean = false):void The first argument defaults to null.See also | StackScreenNavigator | ||
| globalStyleProvider | property |
Hide Inherited Public Properties
Show Inherited Public Propertiespublic static var globalStyleProvider:IStyleProvider
The default IStyleProvider for all StackScreenNavigator
components.
The default value is null.
See also
| isSwipeToPopEnabled | property |
isSwipeToPopEnabled:BooleanDetermines 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.
public function get isSwipeToPopEnabled():Boolean public function set isSwipeToPopEnabled(value:Boolean):void| minimumDragDistance | property |
minimumDragDistance:Number
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.
public function get minimumDragDistance():Number public function set minimumDragDistance(value:Number):voidSee also
| minimumSwipeVelocity | property |
minimumSwipeVelocity:NumberThe 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.
public function get minimumSwipeVelocity():Number public function set minimumSwipeVelocity(value:Number):voidSee also
| rootScreenID | property |
rootScreenID:StringSets 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"; public function get rootScreenID():String public function set rootScreenID(value:String):voidSee also
| swipeToPopGestureEdgeSize | property |
swipeToPopGestureEdgeSize:Number
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.
public function get swipeToPopGestureEdgeSize():Number public function set swipeToPopGestureEdgeSize(value:Number):voidSee also
| StackScreenNavigator | () | Constructor |
public function StackScreenNavigator()Constructor.
| addScreen | () | method |
public function addScreen(id:String, item:StackScreenNavigatorItem):void
Registers a new screen with a string identifier that can be used
to reference the screen in other calls, like removeScreen()
or pushScreen().
Parameters
id:String | |
item:StackScreenNavigatorItem |
See also
| getScreen | () | method |
public function getScreen(id:String):StackScreenNavigatorItem
Returns the StackScreenNavigatorItem instance with the
specified identifier.
Parameters
id:String |
StackScreenNavigatorItem |
| popAll | () | method |
public function popAll(transition:Function = null):void
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
transition:Function (default = null) |
See also
| popScreen | () | method |
public function popScreen(transition:Function = null):DisplayObjectPops 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
transition:Function (default = null) |
DisplayObject |
See also
| popToRootScreen | () | method |
public function popToRootScreen(transition:Function = null):DisplayObjectReturns 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
transition:Function (default = null) |
DisplayObject |
See also
| popToRootScreenAndReplace | () | method |
public function popToRootScreenAndReplace(id:String, transition:Function = null):DisplayObjectReturns 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
id:String | |
transition:Function (default = null) |
DisplayObject |
See also
| pushScreen | () | method |
public function pushScreen(id:String, savedPreviousScreenProperties:Object = null, transition:Function = null):DisplayObjectPushes 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
id:String | |
savedPreviousScreenProperties:Object (default = null) | |
transition:Function (default = null) |
DisplayObject |
See also
| removeScreen | () | method |
public function removeScreen(id:String):StackScreenNavigatorItem
Removes an existing screen using the identifier assigned to it in the
call to addScreen().
Parameters
id:String |
StackScreenNavigatorItem |
See also
| replaceScreen | () | method |
public function replaceScreen(id:String, transition:Function = null):DisplayObjectReplaces 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
id:String | |
transition:Function (default = null) |
DisplayObject |
See also