| Package | feathers.controls |
| Class | public class ScreenNavigator |
| Inheritance | ScreenNavigator  FeathersControl Sprite DisplayObjectContainer DisplayObject EventDispatcher Object |
See also
| Property | Defined By | ||
|---|---|---|---|
| activeScreen : DisplayObject [read-only]
A reference to the currently active screen. | ScreenNavigator | ||
| activeScreenID : String [read-only]
The string identifier for the currently active screen. | ScreenNavigator | ||
 | alpha : Number The opacity of the object. | DisplayObject | |
| 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. | ScreenNavigator | ||
| clipRect : Rectangle [override] | FeathersControl | |
| 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 | |
| filter : FragmentFilter The filter that is attached to the display object. | DisplayObject | |
| focusManager : IFocusManager
The current focus manager for this component. | FeathersControl | |
| hasVisibleArea : Boolean [read-only] Indicates if an object occupies any visible area. | DisplayObject | |
| height : Number [override]
The height of the component, in pixels. | FeathersControl | |
| includeInLayout : Boolean
Determines if the ILayout should use this object or ignore it. | FeathersControl | |
| isEnabled : Boolean
Indicates whether the control is interactive or not. | FeathersControl | |
| isFlattened : Boolean [read-only] Indicates if the sprite was flattened. | Sprite | |
| isFocusEnabled : Boolean
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 | |
| layoutData : ILayoutData
Extra parameters associated with this display object that will be
used by the layout algorithm. | FeathersControl | |
| 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 | |
| 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 | |
| name : String [override]
The concatenated nameList, with each name separated by
spaces. | FeathersControl | |
| nameList : TokenList [read-only]
Contains a list of all "names" assigned to this control. | FeathersControl | |
| nextTabFocus : IFocusDisplayObject
The next object that will receive focus when the tab key is pressed. | 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 | |
| root : DisplayObject [read-only] The root object the display object is connected to (i.e. | DisplayObject | |
| rotation : Number The rotation of the object in radians. | DisplayObject | |
| scaleX : Number The horizontal scale factor. | DisplayObject | |
| scaleY : Number The vertical scale factor. | DisplayObject | |
| 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 | |
| touchable : Boolean Indicates if this object (and its children) will receive touch events. | DisplayObject | |
| transformationMatrix : Matrix The transformation matrix of the object relative to its parent. | DisplayObject | |
| transition : Function
A function that is called when the ScreenNavigator is
changing screens. | ScreenNavigator | ||
| 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. | ScreenNavigator | ||
| 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] | DisplayObject | |
addScreen(id:String, item:ScreenNavigatorItem):void
Registers a new screen by its identifier. | ScreenNavigator | ||
| alignPivot(hAlign:String = center, vAlign: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(type:String, data:Object = null):void Dispatches an event with the given parameters on all children (recursively). | DisplayObjectContainer | |
clearScreen():void
Removes the current screen, leaving the ScreenNavigator
empty. | ScreenNavigator | ||
| 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. | Sprite | |
| flatten():void Optimizes the sprite for optimal rendering performance. | Sprite | |
| getBounds(targetSpace:DisplayObject, resultRect:Rectangle = null):Rectangle [override] Returns a rectangle that completely encloses the object as it appears in another
coordinate system. | Sprite | |
| 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 | |
| getClipRect(targetSpace:DisplayObject, resultRect:Rectangle = null):Rectangle Returns the bounds of the container's clipRect in the given coordinate space, or
null if the sprite doens't have a clipRect. | Sprite | |
getScreen(id:String):ScreenNavigatorItem
Returns the ScreenNavigatorItem instance with the
specified identifier. | ScreenNavigator | ||
getScreenIDs(result:Vector.<String> = null):Vector.<String>
Returns a list of the screen identifiers that have been added. | ScreenNavigator | ||
| getTransformationMatrix(targetSpace:DisplayObject, resultMatrix:Matrix = null):Matrix Creates a matrix that represents the transformation from the local coordinate system
to another. | DisplayObject | |
| globalToLocal(globalPoint:Point, resultPoint:Point = null):Point Transforms a point from global (stage) coordinates to the local coordinate system. | DisplayObject | |
| hasEventListener(type:String):Boolean Returns if there are listeners registered for a certain event type. | EventDispatcher | |
hasScreen(id:String):Boolean
Determines if the specified screen identifier has been added. | ScreenNavigator | ||
| hitTest(localPoint:Point, forTouch:Boolean = false):DisplayObject [override] Returns the object that is found topmost beneath a point in local coordinates, or nil if
the test fails. | Sprite | |
| 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 | |
| localToGlobal(localPoint:Point, resultPoint:Point = null):Point Transforms a point from the local coordinate system to global (stage) coordinates. | DisplayObject | |
| 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] | DisplayObject | |
| removeEventListeners(type:String = null):void [override] | DisplayObject | |
| removeFromParent(dispose:Boolean = false):void Removes the object from its parent, if it has one, and optionally disposes it. | DisplayObject | |
removeScreen(id:String):void
Removes an existing screen using its identifier. | ScreenNavigator | ||
| render(support:RenderSupport, parentAlpha:Number):void [override] Renders the display object with the help of a support object. | Sprite | |
| setChildIndex(child:DisplayObject, index:int):void Moves a child to a certain index. | DisplayObjectContainer | |
| setSize(width:Number, height:Number):void
Sets both the width and the height of the control. | FeathersControl | |
showScreen(id:String):DisplayObject
Displays a screen and returns a reference to it. | ScreenNavigator | ||
| sortChildren(compareFunction:Function):void Sorts the children according to a given function (that works just like the sort function
of the Vector class). | DisplayObjectContainer | |
| Swaps the indexes of two children. | DisplayObjectContainer | |
| swapChildrenAt(index1:int, index2:int):void Swaps the indexes of two children. | DisplayObjectContainer | |
| unflatten():void Removes the rendering optimizations that were created when flattening the sprite. | Sprite | |
| validate():void
Immediately validates the control, which triggers a redraw, if one
is pending. | FeathersControl | |
| Method | Defined By | ||
|---|---|---|---|
[static]
The default transition function. | ScreenNavigator | ||
| draw():void
Override to customize layout and to adjust properties of children. | FeathersControl | |
| 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. | FeathersControl | |
| setSizeInternal(width:Number, height:Number, canInvalidate:Boolean):Boolean
Sets the width and height of the control, with the option of
invalidating or not. | FeathersControl | |
| Event | Summary | Defined By | ||
|---|---|---|---|---|
| Dispatched when an object is added to a parent. | DisplayObject | ||
| Dispatched when an object is connected to the stage (directly or indirectly). | DisplayObject | ||
| Dispatched when the active screen changes. | ScreenNavigator | |||
| Dispatched when the current screen is removed and there is no active screen. | ScreenNavigator | |||
| Dispatched once every frame on every object that is connected to the stage. | DisplayObject | ||
| Dispatched on all children when the object is flattened. | Sprite | ||
| Dispatched after initialize() has been called, but before the first time that draw() has been called. | FeathersControl | ||
| Dispatched when a key on the keyboard is pressed. | DisplayObject | ||
| Dispatched when a key on the keyboard is released. | DisplayObject | ||
| Dispatched when an object is removed from its parent. | DisplayObject | ||
| Dispatched when an object is removed from the stage and won't be rendered any longer. | DisplayObject | ||
| Dispatched when the width or height of the control changes. | FeathersControl | ||
| Dispatched when an object is touched. | DisplayObject | ||
| Dispatched when the transition between screens has completed. | ScreenNavigator | |||
| Dispatched when the transition between screens begins. | ScreenNavigator | |||
| activeScreen | property |
Hide Inherited Public Properties
Show Inherited Public PropertiesactiveScreen:DisplayObject [read-only] A reference to the currently active screen.
public function get activeScreen():DisplayObject| activeScreenID | property |
activeScreenID:String [read-only] The string identifier for the currently active screen.
public function get activeScreenID():String| clipContent | property |
clipContent:BooleanDetermines if the navigator's content should be clipped to the width and height.
public function get clipContent():Boolean public function set clipContent(value:Boolean):void| transition | property |
public var transition:Function
A function that is called when the ScreenNavigator is
changing screens.
| ScreenNavigator | () | Constructor |
public function ScreenNavigator()Constructor.
| addScreen | () | method |
public function addScreen(id:String, item:ScreenNavigatorItem):voidRegisters a new screen by its identifier.
Parameters
id:String | |
item:ScreenNavigatorItem |
| clearScreen | () | method |
public function clearScreen():void
Removes the current screen, leaving the ScreenNavigator
empty.
| defaultTransition | () | method |
protected static function defaultTransition(oldScreen:DisplayObject, newScreen:DisplayObject, completeHandler:Function):voidThe default transition function.
Parameters
oldScreen:DisplayObject | |
newScreen:DisplayObject | |
completeHandler:Function |
| getScreen | () | method |
public function getScreen(id:String):ScreenNavigatorItem
Returns the ScreenNavigatorItem instance with the
specified identifier.
Parameters
id:String |
ScreenNavigatorItem |
| getScreenIDs | () | method |
public function getScreenIDs(result:Vector.<String> = null):Vector.<String>Returns a list of the screen identifiers that have been added.
Parameters
result:Vector.<String> (default = null) |
Vector.<String> |
| hasScreen | () | method |
public function hasScreen(id:String):BooleanDetermines if the specified screen identifier has been added.
Parameters
id:String |
Boolean |
| removeScreen | () | method |
public function removeScreen(id:String):voidRemoves an existing screen using its identifier.
Parameters
id:String |
| showScreen | () | method |
public function showScreen(id:String):DisplayObjectDisplays a screen and returns a reference to it. If a previous transition is running, the new screen will be queued, and no reference will be returned.
Parameters
id:String |
DisplayObject |
| change | Event |
starling.events.Eventstarling.events.Event.CHANGEDispatched when the active screen changes.
An event type to be utilized in custom events. Not used by Starling right now.| clear | Event |
starling.events.Eventfeathers.events.FeathersEventType.CLEARDispatched when the current screen is removed and there is no active screen.
TheFeathersEventType.CLEAR event type is a generic
event type for when something is "cleared".
| transitionComplete | Event |
starling.events.Eventfeathers.events.FeathersEventType.TRANSITION_COMPLETEDispatched when the transition between screens has completed.
TheFeathersEventType.TRANSITION_COMPLETE event type is
used by the ScreenNavigator to indicate when a
transition between screens ends.
| transitionStart | Event |
starling.events.Eventfeathers.events.FeathersEventType.TRANSITION_STARTDispatched when the transition between screens begins.
TheFeathersEventType.TRANSITION_START event type is
used by the ScreenNavigator to indicate when a
transition between screens begins.