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

In the following example, the overlay factory is changed:

PopUpManager.overlayFactory = function():DisplayObject
{
    var overlay:Quad = new Quad( 100, 100, 0x000000 );
    overlay.alpha = 0.75;
    return overlay;
};

The current number of pop-ups.

In the following example, we check the number of pop-ups:

if( PopUpManager.popUpCount > 0 )
{
    // do something
}

A function that creates a pop-up manager.

This function is expected to have the following signature:

function():IPopUpManager

In the following example, the overlay factory is changed:

PopUpManager.popUpManagerFactory = function():IPopUpManager
{
    var popUpManager:DefaultPopUpManager = new DefaultPopUpManager();
    popUpManager.overlayFactory = function():DisplayObject
    {
        var overlay:Quad = new Quad( 100, 100, 0x000000 );
        overlay.alpha = 0.75;
        return overlay;
    };
    return popUpManager;
};

See also

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

In the following example, the next tab focus is changed:

PopUpManager.root = someSprite;

The default value is null.

Adds a pop-up to the stage.

The pop-up may be modal, meaning that an overlay will be displayed between the pop-up and everything under the pop-up manager, and the overlay will block touches. The default overlay used for modal pop-ups is created by PopUpManager.overlayFactory. A custom overlay factory may be passed to PopUpManager.addPopUp() to create an overlay that is different from the default one.

A pop-up may be centered globally on the Starling stage. If the stage or the pop-up resizes, the pop-up will be repositioned to remain in the center. To position a pop-up in the center once, specify a value of false when calling PopUpManager.addPopUp() and call PopUpManager.centerPopUp() manually.

Note: The pop-up manager can only detect if Feathers components have been resized in order to reposition them to remain centered. Regular Starling display objects do not dispatch a proper resize event that the pop-up manager can listen to.

Parameters

Centers a pop-up on the stage. Unlike the isCentered argument passed to PopUpManager.addPopUp(), the pop-up will only be positioned once. If the stage or the pop-up resizes, PopUpManager.centerPopUp() will need to be called again if it should remain centered.

In the following example, we center a pop-up:

PopUpManager.centerPopUp( displayObject );

Parameters

The default factory that creates overlays for modal pop-ups. Creates an invisible Quad.

See also

The default factory that creates a pop-up manager.

See also

Returns the IPopUpManager associated with the specified Starling instance. If a pop-up manager hasn't been created yet, it will be created using PopUpManager.popUpManagerFactory.

In the following example, a pop-up is added:

PopUpManager.forStarling( Starling.current ).addPopUp( popUp );

Parameters

See also

Determines if a display object is a pop-up.

In the following example, we check if a display object is a pop-up:

if( PopUpManager.isPopUp( displayObject ) )
{
    // do something
}

Parameters

Determines if a display object is above the highest modal overlay. If there are no modals overlays, determines if a display object is a pop-up.

Parameters

Removes all pop-ups from the stage.

Parameters

Removes a pop-up from the stage.

Parameters