View source

class PopUpManager

package feathers.core

@:directlyUsed

Adds a display object as a pop-up above all other content on the stage.

Available since

1.0.0

.

Static variables

staticread onlypopUpCount:Int

Returns the total number of pop-ups added to all pop up managers.

To get the number of pop-ups for a specific pop up manager, use PopUpManager.forStage(stage).popUpCount instead.

Available since

1.0.0

.

staticwrite onlyroot:DisplayObjectContainer

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

Available since

1.0.0

.

staticpopUpManagerFactory:(stage:Stage) ‑> IPopUpManager

Creates an IPopUpManager for the specified container.

Available since

1.0.0

.

Static methods

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

A convenience method for PopUpManager.forStage(stage).addPopUp(). Attempts to use owner.stage, but throws an error if owner.stage is null.

Available since

1.0.0

.

staticbringToFront(target:DisplayObject):Void

A convenience method for PopUpManager.forStage(stage).bringToFront(). Attempts to use target.stage, but throws an error if target.stage is null.

Available since

1.0.0

.

staticcenterPopUp(target:DisplayObject):Void

A convenience method for PopUpManager.forStage(stage).centerPopUp(). Attempts to use target.stage, but throws an error if target.stage is null.

Available since

1.0.0

.

staticdispose():Void

Removes all IPopUpManager instances created by calling PopUpManager.forStage().

Available since

1.0.0

.

staticforStage(stage:Stage):IPopUpManager

Returns the IPopUpManager instance associated with the specified Stage instance. If a pop-up manager hasn't been created for this stage yet, one will be created automatically using PopUpManager.popUpManagerFactory.

Available since

1.0.0

.

See also:

staticisModal(target:DisplayObject):Bool

A convenience method for PopUpManager.forStage(stage).isModal(). Attempts to use target.stage, but returns false if target.stage is null.

Available since

1.0.0

.

staticisPopUp(target:DisplayObject):Bool

A convenience method for PopUpManager.forStage(stage).isPopUp(). Attempts to use target.stage, but returns false if target.stage is null.

Available since

1.0.0

.

staticisTopLevelPopUp(target:DisplayObject):Bool

A convenience method for PopUpManager.forStage(stage).isTopLevelPopUp(). Attempts to use target.stage, but returns false if target.stage is null.

Available since

1.0.0

.

staticremoveAllPopUps():Void

Removes all pop-ups added to all pop up managers.

Available since

1.0.0

.

staticremovePopUp(popUp:DisplayObject):DisplayObject

A convenience method for PopUpManager.forStage(stage).removePopUp().

Available since

1.0.0

.