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

Package | feathers.core
Class | public class PopUpManager
Inheritance | PopUpManager Object

Adds a display object as a pop-up above all content.

Public Properties

| Property | Defined By
--- | --- | ---
|  | overlayFactory : Function [static] A function that returns a display object to use as an overlay for modal pop-ups. | PopUpManager
|  | root : DisplayObjectContainer [static] The container where pop-ups are added. | PopUpManager

Public Methods

| Method | Defined By
--- | --- | ---
|  | addPopUp(popUp:DisplayObject, isModal:Boolean = true, isCentered:Boolean = true, customOverlayFactory:Function = null):void [static] Adds a pop-up to the stage. | PopUpManager
|  | centerPopUp(popUp:DisplayObject):void [static] Centers a pop-up on the stage. | PopUpManager
|  | defaultOverlayFactory():DisplayObject [static] The default factory that creates overlays for modal pop-ups. | PopUpManager
|  | isPopUp(popUp:DisplayObject):Boolean [static] Determines if a display object is a pop-up. | PopUpManager
|  | isTopLevelPopUp(popUp:DisplayObject):Boolean [static] Determines if a display object is the top-most pop-up. | PopUpManager
|  | removePopUp(popUp:DisplayObject, dispose:Boolean = false):void [static] Removes a pop-up from the stage. | PopUpManager

Property Detail

overlayFactory | property

`public static var overlayFactory:Function`

A function that returns a display object to use as an overlay for modal pop-ups.

This function is expected to have the following signature:

    function():DisplayObject

root | property |

`root:DisplayObjectContainer`

The container where pop-ups are added. If not set manually, defaults to the Starling stage.

Implementation
`public static function get root():DisplayObjectContainer`
`public static function set root(value:DisplayObjectContainer):void`
Method Detail

addPopUp | () | method

`public static function addPopUp(popUp:DisplayObject, isModal:Boolean = true, isCentered:Boolean = true, customOverlayFactory:Function = null):void`

Adds a pop-up to the stage.

Parameters

| `popUp:DisplayObject`
| `isModal:Boolean` (default = `true`)``
| `isCentered:Boolean` (default = `true`)``
| `customOverlayFactory:Function` (default = `null`)``

centerPopUp | () | method |

`public static function centerPopUp(popUp:DisplayObject):void`

Centers a pop-up on the stage.

Parameters

| `popUp:DisplayObject`

defaultOverlayFactory | () | method |

`public static function defaultOverlayFactory():DisplayObject`

The default factory that creates overlays for modal pop-ups.

Returns

| `DisplayObject`

isPopUp | () | method |

`public static function isPopUp(popUp:DisplayObject):Boolean`

Determines if a display object is a pop-up.

Parameters

| `popUp:DisplayObject`

Returns

| `Boolean`

isTopLevelPopUp | () | method |

`public static function isTopLevelPopUp(popUp:DisplayObject):Boolean`

Determines if a display object is the top-most pop-up.

Parameters

| `popUp:DisplayObject`

Returns

| `Boolean`

removePopUp | () | method |

`public static function removePopUp(popUp:DisplayObject, dispose:Boolean = false):void`

Removes a pop-up from the stage.

Parameters

| `popUp:DisplayObject`
| `dispose:Boolean` (default = `false`)``

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