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.
* * @see PopUpManagerChildList * * @langversion 3.0 * @playerversion Flash 9 * @playerversion AIR 1.1 * @productversion Flex 3 */ public class PopUpManager { include "../core/Version.as"; //-------------------------------------------------------------------------- // // Class variables // //-------------------------------------------------------------------------- /** * @private * Linker dependency on implementation class. */ private static var implClassDependency:PopUpManagerImpl; /** * @private * Storage for the impl getter. * This gets initialized on first access, * not at static initialization time, in order to ensure * that the Singleton registry has already been initialized. */ private static var _impl:IPopUpManager; /** * @private * The singleton instance of PopUpManagerImpl which was * registered as implementing the IPopUpManager interface. */ private static function get impl():IPopUpManager { if (!_impl) { _impl = IPopUpManager( Singleton.getInstance("mx.managers::IPopUpManager")); } return _impl; } //-------------------------------------------------------------------------- // // Class methods // //-------------------------------------------------------------------------- /** * Creates a top-level window and places it above other windows in the * z-order. * It is good practice to call theremovePopUp() 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
true, the window is modal which means that
* the user will not be able to interact with other popups until the window
* is removed.
*
* @param childList The child list in which to add the popup.
* One of PopUpManagerChildList.APPLICATION,
* PopUpManagerChildList.POPUP,
* or PopUpManagerChildList.PARENT (default).
*
* @param moduleFactory The moduleFactory where this pop-up should look for
* its embedded fonts and style manager.
*
* @return Reference to new top-level window.
*
* @see PopUpManagerChildList
*
* @langversion 3.0
* @playerversion Flash 9
* @playerversion AIR 1.1
* @productversion Flex 3
*/
public static function createPopUp(parent:DisplayObject,
className:Class,
modal:Boolean = false,
childList:String = null,
moduleFactory:IFlexModuleFactory = null):IFlexDisplayObject
{
return impl.createPopUp(parent, className, modal, childList, moduleFactory);
}
/**
* 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.
true, the window is modal which means that
* the user will not be able to interact with other popups until the window
* is removed.
*
* @param childList The child list in which to add the pop-up.
* One of PopUpManagerChildList.APPLICATION,
* PopUpManagerChildList.POPUP,
* or PopUpManagerChildList.PARENT (default).
*
* @param moduleFactory The moduleFactory where this pop-up should look for
* its embedded fonts and style manager.
*
* @see PopUpManagerChildList
*
* @langversion 3.0
* @playerversion Flash 9
* @playerversion AIR 1.1
* @productversion Flex 3
*/
public static function addPopUp(window:IFlexDisplayObject,
parent:DisplayObject,
modal:Boolean = false,
childList:String = null,
moduleFactory:IFlexModuleFactory = null):void
{
impl.addPopUp(window, parent, modal, childList, moduleFactory);
}
/**
* 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.
* * @param The IFlexDisplayObject representing the popup. * * @langversion 3.0 * @playerversion Flash 9 * @playerversion AIR 1.1 * @productversion Flex 3 */ public static function centerPopUp(popUp:IFlexDisplayObject):void { impl.centerPopUp(popUp); } /** * Removes a popup window popped up by * thecreatePopUp() or addPopUp() method.
*
* @param window The IFlexDisplayObject representing the popup window.
*
* @langversion 3.0
* @playerversion Flash 9
* @playerversion AIR 1.1
* @productversion Flex 3
*/
public static function removePopUp(popUp:IFlexDisplayObject):void
{
impl.removePopUp(popUp);
}
/**
* 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.
*
* @param The IFlexDisplayObject representing the popup.
*
* @langversion 3.0
* @playerversion Flash 9
* @playerversion AIR 1.1
* @productversion Flex 3
*/
public static function bringToFront(popUp:IFlexDisplayObject):void
{
impl.bringToFront(popUp);
}
} // class
} // package