ISystemManager - BETA ActionScript® 3 (AS3 Flex) Reference for the Adobe® Flash® Platform API Reference

(Preview)

Package	mx.managers
Interface	public interface ISystemManager extends IEventDispatcher , IChildList , IFlexModuleFactory
Implementors	SystemManager, WindowedSystemManager

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

An ISystemManager manages an "application window". Every application that runs on the desktop or in a browser has an area where the visuals of the application will be displayed. It may be a window in the operating system or an area within the browser. That is an "application window" and different from an instance of mx.core.Application, which is the main "top-level" window within an application.

Every application has an ISystemManager. The ISystemManager sends an event if the size of the application window changes (you cannot change it from within the application, but only through interaction with the operating system window or browser). It parents all displayable items within the application, such as the main mx.core.Application instance and all popups, tooltips, cursors, an so on. Any object parented by the ISystemManager is considered to be a "top-level" window, even tooltips and cursors.

The ISystemManager also switches focus between top-level windows if there are more than one IFocusManagerContainer displayed and users are interacting with components within the IFocusManagerContainers.

All keyboard and mouse activity that is not expressly trapped is seen by the ISystemManager, making it a good place to monitor activity should you need to do so.

If an application is loaded into another application, an ISystemManager will still be created, but will not manage an "application window", depending on security and domain rules. Instead, it will be the content of the Loader that loaded it and simply serve as the parent of the sub-application

The ISystemManager maintains multiple lists of children, one each for tooltips, cursors, popup windows. This is how it ensures that popup windows "float" above the main application windows and that tooltips "float" above that and cursors above that. If you examine the numChildren property or getChildAt() method on the ISystemManager you are accessing the main application window and any other windows that aren't popped up. To get the list of all windows, including popups, tooltips and cursors, use the rawChildren property.

Public Properties

Hide Inherited Public Properties

Show Inherited Public Properties

	Property		Defined By
		allowDomainsInNewRSLs : Boolean Controls whether the domains allowed by calls to allowDomain() are also allowed by RSLs loaded after the call.	IFlexModuleFactory
		allowInsecureDomainsInNewRSLs : Boolean Controls whether the domains allowed by calls to allowInsecureDomain() are also allowed by RSLs loaded after the call.	IFlexModuleFactory
		cursorChildren : IChildList [read-only] An list of the custom cursors being parented by this ISystemManager.	ISystemManager
		document : Object A reference to the document object.	ISystemManager
		focusPane : Sprite A single Sprite shared among components used as an overlay for drawing focus.	ISystemManager
		isProxy : Boolean [read-only] True if the ISystemManager is a proxy and not a root class.	ISystemManager
		loaderInfo : LoaderInfo [read-only] The LoaderInfo object that represents information about the application.	ISystemManager
		numChildren : int [read-only] The number of children in this child list.	IChildList
		numModalWindows : int The number of modal windows.	ISystemManager
		popUpChildren : IChildList [read-only] An list of the topMost (popup) windows being parented by this ISystemManager.	ISystemManager
		preloadedRSLs : Dictionary [read-only] The RSLs loaded by this SystemManager or FlexModuleFactory before the application starts.	IFlexModuleFactory
		rawChildren : IChildList [read-only] A list of all children being parented by this ISystemManager.	ISystemManager
		screen : Rectangle [read-only] The size and position of the application window.	ISystemManager
		stage : Stage [read-only] The flash.display.Stage that represents the application window mapped to this SystemManager	ISystemManager
		toolTipChildren : IChildList [read-only] A list of the tooltips being parented by this ISystemManager.	ISystemManager
		topLevelSystemManager : ISystemManager [read-only] The ISystemManager responsible for the application window.	ISystemManager

Public Methods

Hide Inherited Public Methods

Show Inherited Public Methods

	Method		Defined By
		addChild(child:DisplayObject):DisplayObject Adds a child DisplayObject after the end of this child list.	IChildList
		addChildAt(child:DisplayObject, index:int):DisplayObject Adds a child DisplayObject to this child list at the index specified.	IChildList
		addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void Registers an event listener object with an EventDispatcher object so that the listener receives notification of an event.	IEventDispatcher
		addPreloadedRSL(loaderInfo:LoaderInfo, rsl:Vector.<RSLData>):void Adds an RSL to the preloadedRSLs list.	IFlexModuleFactory
		allowDomain(... domains):void Calls the Security.allowDomain() method for the SWF associated with this IFlexModuleFactory plus all the SWFs associated with RSLs preloaded by this IFlexModuleFactory.	IFlexModuleFactory
		allowInsecureDomain(... domains):void Calls the Security.allowInsecureDomain() method for the SWF associated with this IFlexModuleFactory plus all the SWFs associated with RSLs preloaded by this IFlexModuleFactory.	IFlexModuleFactory
		callInContext(fn:Function, thisArg:Object, argArray:Array, returns:Boolean = true):* A way to call a method in this IFlexModuleFactory's context	IFlexModuleFactory
		contains(child:DisplayObject):Boolean Determines if a DisplayObject is in this child list, or is a descendant of an child in this child list.	IChildList
		create(... parameters):Object A factory method that requests an instance of a definition known to the module.	IFlexModuleFactory
		deployMouseShields(deploy:Boolean):void Deploy or remove mouse shields.	ISystemManager
		dispatchEvent(event:Event):Boolean Dispatches an event into the event flow.	IEventDispatcher
		getChildAt(index:int):DisplayObject Gets the child DisplayObject at the specified index in this child list.	IChildList
		getChildByName(name:String):DisplayObject Gets the child DisplayObject with the specified name in this child list.	IChildList
		getChildIndex(child:DisplayObject):int Gets the index of a specific child in this child list.	IChildList
		getDefinitionByName(name:String):Object Converts the given String to a Class or package-level Function.	ISystemManager
		getImplementation(interfaceName:String):Object Get the implementation for an interface.	IFlexModuleFactory
		getObjectsUnderPoint(point:Point):Array Returns an array of DisplayObjects that lie under the specified point and are in this child list.	IChildList
		getSandboxRoot():DisplayObject Gets the system manager that is the root of all top level system managers in this SecurityDomain.	ISystemManager
		getTopLevelRoot():DisplayObject Attempts to get the system manager that is the in the main application.	ISystemManager
		getVisibleApplicationRect(bounds:Rectangle = null, skipToSandboxRoot:Boolean = false):Rectangle Get the bounds of the loaded application that are visible to the user on the screen.	ISystemManager
		hasEventListener(type:String):Boolean Checks whether the EventDispatcher object has any listeners registered for a specific type of event.	IEventDispatcher
		info():Object Returns a block of key/value pairs that hold static data known to the module.	IFlexModuleFactory
		invalidateParentSizeAndDisplayList():void Attempt to notify the parent SWFLoader that the application's size may have changed.	ISystemManager
		isFontFaceEmbedded(tf:flash.text:TextFormat):Boolean Returns true if the required font face is embedded in this application, or has been registered globally by using the Font.registerFont() method.	ISystemManager
		isTopLevel():Boolean Returns true if this ISystemManager is responsible for an application window, and false if this application has been loaded into another application.	ISystemManager
		isTopLevelRoot():Boolean Tests if this system manager is the root of all top level system managers.	ISystemManager
		registerImplementation(interfaceName:String, impl:Object):void Register an implementation for an interface.	IFlexModuleFactory
		removeChild(child:DisplayObject):DisplayObject Removes the specified child DisplayObject from this child list.	IChildList
		removeChildAt(index:int):DisplayObject Removes the child DisplayObject at the specified index from this child list.	IChildList
		removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void Removes a listener from the EventDispatcher object.	IEventDispatcher
		setChildIndex(child:DisplayObject, newIndex:int):void Changes the index of a particular child in this child list.	IChildList
		willTrigger(type:String):Boolean Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type.	IEventDispatcher

Property Detail

Method Detail

[an error occurred while processing this directive]

Legal Notices | Online Privacy Policy

ISystemManager - AS3 Flex

Packagesx

Language Elements

Appendixes

Package mx.managers

cursorChildren

document

focusPane

isProxy

loaderInfo

numModalWindows

popUpChildren

rawChildren

screen

stage

toolTipChildren

topLevelSystemManager

deployMouseShields

getDefinitionByName

getSandboxRoot

getTopLevelRoot

getVisibleApplicationRect

invalidateParentSizeAndDisplayList

isFontFaceEmbedded

isTopLevel

isTopLevelRoot

	`bounds:Rectangle` (default = `null`) — Optional. The starting bounds for the visible rect. The bounds are in global coordinates. If `bounds` is null the starting bounds is defined by the `screen` property of the system manager.

	`skipToSandboxRoot:Boolean` (default = `false`)