Manages pop-ups for all children of a root component (usually, all children of a Stage).

Available since

1.0.0

.

See also:

Variables

read onlypopUpCount:Int

The current number of pop-ups.

Available since

1.0.0

.

root:DisplayObjectContainer

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

Available since

1.0.0

.

read onlytopLevelPopUpCount:Int

The current number of top-level pop-ups.

Available since

1.0.0

.

overlayFactory:() ‑> DisplayObject

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

Available since

1.0.0

.

Methods

@:value({ isCentered : true, isModal : true })addPopUp(popUp:DisplayObject, isModal:Bool = true, isCentered:Bool = true, ?customOverlayFactory:() ‑> DisplayObject):DisplayObject

Adds a pop-up.

Available since

1.0.0

.

centerPopUp(popUp:DisplayObject):Void

Centers a pop-up.

Available since

1.0.0

.

getPopUpAt(index:Int):DisplayObject

Gets the pop-up at the specified index.

Available since

1.0.0

.

hasModalPopUps():Bool

Determines if the pop-up manager has any modal pop-ups.

Available since

1.0.0

.

isModal(target:DisplayObject):Bool

Determines if a pop-up is modal.

Available since

1.0.0

.

isPopUp(target:DisplayObject):Bool

Determines if a display object is a pop-up.

Available since

1.0.0

.

isTopLevelPopUp(target:DisplayObject):Bool

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.

Available since

1.0.0

.

removeAllPopUps():Void

Removes all pop-ups that have been added.

Available since

1.0.0

.

removePopUp(popUp:DisplayObject):DisplayObject

Removes a pop-up.

Available since

1.0.0

.