PopUpManager

public class
feathers.core.PopUpManager

Description

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

API overview

Constructor

PopUpManager ()

Attributes

Public attributes

overlayFactory: Function static

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

root: DisplayObjectContainer static

The container where pop-ups are added

Functions

Public functions

addPopUp ( popUp: DisplayObject , isModal: Boolean = true , isCentered: Boolean = true , customOverlayFactory: Function = null ): Void static

Adds a pop-up to the stage

centerPopUp ( popUp: DisplayObject ): Void static

Centers a pop-up on the stage

defaultOverlayFactory (): DisplayObject static

The default factory that creates overlays for modal pop-ups

isPopUp ( popUp: DisplayObject ): Boolean static

Determines if a display object is a pop-up

isTopLevelPopUp ( popUp: DisplayObject ): Boolean static

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

removePopUp ( popUp: DisplayObject , dispose: Boolean = false ): Void static

Removes a pop-up from the stage

Constructor

PopUpManager ()

Attributes

overlayFactory: Function

static

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: DisplayObjectContainer

static

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

Functions

addPopUp ( popUp: DisplayObject , isModal: Boolean = true , isCentered: Boolean = true , customOverlayFactory: Function = null ): Void

static

Adds a pop-up to the stage.

Parameters

popUp: DisplayObject
isModal: Boolean = true
isCentered: Boolean = true
customOverlayFactory: Function = null


centerPopUp ( popUp: DisplayObject ): Void

static

Centers a pop-up on the stage.

Parameters

popUp: DisplayObject


defaultOverlayFactory (): DisplayObject

static

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



getFullTypeName (): String
Inherited from Object

native

Gets the fully qualified type name of the Object. The fully qualified type name includes the package of the type.


Returns

String fully qualified type name of the Object.

getType (): Type
Inherited from Object

native

Gets the Type that describes the Object.


Returns

Type The Type that describes the object.

getTypeName (): String
Inherited from Object

native

Gets the type name of the Object.


Returns

String type name of the Object.

isPopUp ( popUp: DisplayObject ): Boolean

static

Determines if a display object is a pop-up.

Parameters

popUp: DisplayObject


isTopLevelPopUp ( popUp: DisplayObject ): Boolean

static

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

Parameters

popUp: DisplayObject


removePopUp ( popUp: DisplayObject , dispose: Boolean = false ): Void

static

Removes a pop-up from the stage.

Parameters

popUp: DisplayObject
dispose: Boolean = false


toString (): String
Inherited from Object

native

Returns a String that describes the Object. This can be overriden to provide extra details when printing objects using trace().


Returns

String String that described the Object.

: