GODPAPER | All Packages | All Classes | Index | Frames No Frames |
ScreenNavigatorItem

Package | feathers.controls
Class | public class ScreenNavigatorItem
Inheritance | ScreenNavigatorItem Object

Data for an individual screen that will be used by a `ScreenNavigator` object.

See also

http://wiki.starling-framework.org/feathers/screen-navigator
feathers.controls.ScreenNavigator

Public Properties

| Property | Defined By
--- | --- | ---
|  | events : Object A hash of events to which the ScreenNavigator will listen. | ScreenNavigatorItem
|  | properties : Object A hash of properties to set on the screen. | ScreenNavigatorItem
|  | screen : Object A Starling DisplayObject, a Class that may be instantiated to create a DisplayObject, or a Function that returns a DisplayObject. | ScreenNavigatorItem

Public Methods

| Method | Defined By
--- | --- | ---
|  | ScreenNavigatorItem(screen:Object = null, events:Object = null, properties:Object = null) Constructor. | ScreenNavigatorItem
|  | getScreen():DisplayObject Creates and instance of the screen type (or uses the screen directly if it isn't a class). | ScreenNavigatorItem

Property Detail

events | property

`public var events:Object`

A hash of events to which the ScreenNavigator will listen. Keys in the hash are event types (or the property name of an `ISignal`), and values are one of two possible types. If the value is a `String`, it must refer to a screen ID for the `ScreenNavigator` to display. If the value is a `Function`, it must be a listener for the screen's event or `ISignal`.

properties | property |

`public var properties:Object`

A hash of properties to set on the screen.

screen | property |

`public var screen:Object`

A Starling DisplayObject, a Class that may be instantiated to create a DisplayObject, or a Function that returns a DisplayObject.

Constructor Detail

ScreenNavigatorItem | () | Constructor

`public function ScreenNavigatorItem(screen:Object = null, events:Object = null, properties:Object = null)`

Constructor.

Parameters

| `screen:Object` (default = `null`)``
| `events:Object` (default = `null`)``
| `properties:Object` (default = `null`)``

Method Detail

getScreen | () | method

`public function getScreen():DisplayObject`

Creates and instance of the screen type (or uses the screen directly if it isn't a class).

Returns

| `DisplayObject`

Thu Jan 16 2014, 01:11 PM +08:00