| Package | mx.managers |
| Class | public class PopUpManager |
| Inheritance | PopUpManager  Object |
| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
The PopUpManager also provides modality, so that windows below the popup cannot receive mouse events, and also provides an event if the user clicks the mouse outside the window so the developer can choose to dismiss the window or warn the user.
More examples
Using the PopUpManager to create a TitleWindow container
Learn more
Pop-up controls in multi-versioned applications
The Spark TitleWindow container
MX TitleWindow layout container
Related API Elements
Hide Inherited Public Properties
Show Inherited Public Properties| Method | Defined By | ||
|---|---|---|---|
addPopUp(window:IFlexDisplayObject, parent:DisplayObject, modal:Boolean = false, childList:String = null, moduleFactory:IFlexModuleFactory = null):void [static]
Pops up a top-level window. | PopUpManager | ||
[static]
Makes sure a popup window is higher than other objects in its child list
The SystemManager does this automatically if the popup is a top level window
and is moused on,
but otherwise you have to take care of this yourself. | PopUpManager | ||
[static]
Centers a popup window over whatever window was used in the call
to the createPopUp() or addPopUp() method. | PopUpManager | ||
createPopUp(parent:DisplayObject, className:Class, modal:Boolean = false, childList:String = null, moduleFactory:IFlexModuleFactory = null):IFlexDisplayObject [static]
Creates a top-level window and places it above other windows in the
z-order. | PopUpManager | ||
 |
Indicates whether an object has a specified property defined. | Object | |
|
Indicates whether an instance of the Object class is in the prototype chain of the object specified
as the parameter. | Object | |
|
Indicates whether the specified property exists and is enumerable. | Object | |
[static]
Removes a popup window popped up by
the createPopUp() or addPopUp() method. | PopUpManager | ||
|
Sets the availability of a dynamic property for loop operations. | Object | |
|
Returns the string representation of this object, formatted according to locale-specific conventions. | Object | |
|
Returns the string representation of the specified object. | Object | |
|
Returns the primitive value of the specified object. | Object | |
addPopUp | () | method |
public static function addPopUp(window:IFlexDisplayObject, parent:DisplayObject, modal:Boolean = false, childList:String = null, moduleFactory:IFlexModuleFactory = null):void| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Pops up a top-level window.
It is good practice to call removePopUp() to remove popups
created by using the addPopUp() method.
If the class implements IFocusManagerContainer, the window will have its
own FocusManager so that, if the user uses the TAB key to navigate between
controls, only the controls in the window will be accessed.
Example
var tw:TitleWindow = new TitleWindow();
tw.title = "My Title";
mx.managers.PopUpManager.addPopUp(tw, pnl, false);
Creates a popup window using the tw instance of the
TitleWindow class and pnl as the Sprite for determining
where to place the popup.
It is defined to be a non-modal window.
Parameters
window:IFlexDisplayObject — The IFlexDisplayObject to be popped up.
| |
parent:DisplayObject — DisplayObject to be used for determining which SystemManager's layers
to use and optionally the reference point for centering the new
top level window. It may not be the actual parent of the popup as all popups
are parented by the SystemManager.
| |
modal:Boolean (default = false)true, the window is modal which means that
the user will not be able to interact with other popups until the window
is removed.
| |
childList:String (default = null)PopUpManagerChildList.APPLICATION,
PopUpManagerChildList.POPUP,
or PopUpManagerChildList.PARENT (default).
| |
moduleFactory:IFlexModuleFactory (default = null) |
Related API Elements
bringToFront | () | method |
public static function bringToFront(popUp:IFlexDisplayObject):void| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Makes sure a popup window is higher than other objects in its child list The SystemManager does this automatically if the popup is a top level window and is moused on, but otherwise you have to take care of this yourself.
Parameters
popUp:IFlexDisplayObject — IFlexDisplayObject representing the popup.
|
centerPopUp | () | method |
public static function centerPopUp(popUp:IFlexDisplayObject):void| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Centers a popup window over whatever window was used in the call
to the createPopUp() or addPopUp() method.
Note that the position of the popup window may not change immediately after this call since Flex may wait to measure and layout the popup window before centering it.
Parameters
popUp:IFlexDisplayObject — IFlexDisplayObject representing the popup.
|
createPopUp | () | method |
public static function createPopUp(parent:DisplayObject, className:Class, modal:Boolean = false, childList:String = null, moduleFactory:IFlexModuleFactory = null):IFlexDisplayObject| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Creates a top-level window and places it above other windows in the
z-order.
It is good practice to call the removePopUp() method
to remove popups created by using the createPopUp() method.
If the class implements IFocusManagerContainer, the window will have its
own FocusManager so that, if the user uses the TAB key to navigate between
controls, only the controls in the window will be accessed.
Example
pop = mx.managers.PopUpManager.createPopUp(pnl, TitleWindow, false);
Creates a popup window based on the TitleWindow class, using pnl as the MovieClip
for determining where to place the popup. It is defined to be a non-modal window
meaning that other windows can receive mouse events
Parameters
parent:DisplayObject — DisplayObject to be used for determining which SystemManager's layers
to use and optionally the reference point for centering the new
top level window. It may not be the actual parent of the popup as all popups
are parented by the SystemManager.
| |
className:Class — Class of object that is to be created for the popup.
The class must implement IFlexDisplayObject.
| |
modal:Boolean (default = false)true, the window is modal which means that
the user will not be able to interact with other popups until the window
is removed.
| |
childList:String (default = null)PopUpManagerChildList.APPLICATION,
PopUpManagerChildList.POPUP,
or PopUpManagerChildList.PARENT (default).
| |
moduleFactory:IFlexModuleFactory (default = null) |
IFlexDisplayObject — Reference to new top-level window.
|
Related API Elements
removePopUp | () | method |
public static function removePopUp(popUp:IFlexDisplayObject):void| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Removes a popup window popped up by
the createPopUp() or addPopUp() method.
Parameters
popUp:IFlexDisplayObject — The IFlexDisplayObject representing the popup window.
|
Mon Nov 28 2011, 06:48 AM -08:00