The SystemManager class manages an application window.
Every application that runs on the desktop or in a browser
has an area where the visuals of the application are
displayed.
It may be a window in the operating system
or an area within the browser. That area is an application window
and different from an instance of mx.core.Application, which
is the main, or top-level, window within an application.
Every application has a SystemManager.
The SystemManager 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 things within the
application like the main mx.core.Application instance and all popups,
tooltips, cursors, and so on. Any object parented by the SystemManager is
considered to be a top-level window, even tooltips and cursors.
The SystemManager 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 SystemManager, making it a good place to monitor activity should you need
to do so.
If an application is loaded into another application, a SystemManager
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 SystemManager 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 simply examine the numChildren property or
call the getChildAt() method on the SystemManager, 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.
The SystemManager is the first display class created within an application.
It is responsible for creating an mx.preloaders.Preloader that displays and
mx.preloaders.SparkDownloadProgressBar while the application finishes loading,
then creates the mx.core.Application instance.
[read-only]
The measuredHeight is the explicit or measuredHeight of
the main mx.core.Application window
or the starting height of the SWF if the main window
has not yet been created or does not exist.
[read-only]
The measuredWidth is the explicit or measuredWidth of
the main mx.core.Application window,
or the starting width of the SWF if the main window
has not yet been created or does not exist.
Calls Security.allowInsecureDomain() for the SWF associated with this SystemManager
plus all the SWFs assocatiated with RSLs preloaded by this SystemManager.
Controls whether the domains allowed by calls to allowDomain()
are also allowed by RSLs loaded after the call. Additional RSLs
may be loaded into this module factory by sub-applications or modules.
Implementation public function get allowDomainsInNewRSLs():Boolean public function set allowDomainsInNewRSLs(value:Boolean):void
allowInsecureDomainsInNewRSLs
property
allowInsecureDomainsInNewRSLs:Boolean
Language Version :
ActionScript 3.0
Product Version :
Flex 4.5
Runtime Versions :
Flash Player 10.2, AIR 2.6
Controls whether the domains allowed by calls to allowInsecureDomain()
are also allowed by RSLs loaded after the call. Additional RSLs
may be added to this module factory by sub-applications or modules.
Implementation public function get allowInsecureDomainsInNewRSLs():Boolean public function set allowInsecureDomainsInNewRSLs(value:Boolean):void
The application parented by this SystemManager.
SystemManagers create an instance of an Application
even if they are loaded into another Application.
Thus, this may not match mx.core.Application.application
if the SWF has been loaded into another application.
Note that this property is not typed as mx.core.Application
because of load-time performance considerations
but can be coerced into an mx.core.Application.
Implementation public function get application():IUIComponent
childAllowsParent
property
childAllowsParent:Boolean [read-only]
Language Version :
ActionScript 3.0
Product Version :
Flex 3
Runtime Versions :
Flash Player 9, AIR 1.1
Implementation public function get childAllowsParent():Boolean
An list of the custom cursors
being parented by this ISystemManager.
An ISystemManager has various types of children,
such as the Application, popups, top-most windows,
tooltips, and custom cursors.
You can access the custom cursors through
the cursorChildren property.
The IChildList object has methods like getChildAt()
and properties like numChildren.
For example, cursorChildren.numChildren gives
the number of custom cursors (which will be either 0 or 1)
and, if a custom cursor exists, you can access it as
cursorChildren.getChildAt(0).
Implementation public function get cursorChildren():IChildList
document
property
document:Object
Language Version :
ActionScript 3.0
Product Version :
Flex 3
Runtime Versions :
Flash Player 9, AIR 1.1
A reference to the document object.
A document object is an Object at the top of the hierarchy of a
Flex application, MXML component, or AS component.
Implementation public function get document():Object public function set document(value:Object):void
embeddedFontList
property
embeddedFontList:Object [read-only]
Language Version :
ActionScript 3.0
Product Version :
Flex 3
Runtime Versions :
Flash Player 9, AIR 1.1
A table of embedded fonts in this application. The
object is a table indexed by the font name.
Implementation public function get embeddedFontList():Object
explicitHeight
property
explicitHeight:Number
Language Version :
ActionScript 3.0
Product Version :
Flex 3
Runtime Versions :
Flash Player 9, AIR 1.1
The explicit width of this object. For the SystemManager
this should always be NaN unless the application was loaded
into another application. If the application was not loaded
into another application, setting this value has no effect.
Implementation public function get explicitHeight():Number public function set explicitHeight(value:Number):void
explicitWidth
property
explicitWidth:Number
Language Version :
ActionScript 3.0
Product Version :
Flex 3
Runtime Versions :
Flash Player 9, AIR 1.1
The explicit width of this object. For the SystemManager
this should always be NaN unless the application was loaded
into another application. If the application was not loaded
into another application, setting this value has no effect.
Implementation public function get explicitWidth():Number public function set explicitWidth(value:Number):void
focusPane
property
focusPane:Sprite
Language Version :
ActionScript 3.0
Product Version :
Flex 3
Runtime Versions :
Flash Player 9, AIR 1.1
The focus pane associated with this object.
An object has a focus pane when one of its children has focus.
Implementation public function get focusPane():Sprite public function set focusPane(value:Sprite):void
height
property
height:Number[override]
Language Version :
ActionScript 3.0
Product Version :
Flex 3
Runtime Versions :
Flash Player 9, AIR 1.1
The height of this object. For the SystemManager
this should always be the width of the stage unless the application was loaded
into another application. If the application was not loaded
into another application, setting this value has no effect.
Implementation public function get height():Number public function set height(value:Number):void
isProxy
property
isProxy:Boolean [read-only]
True if SystemManager is a proxy and not a root class
Implementation public function get isProxy():Boolean
measuredHeight
property
measuredHeight:Number [read-only]
Language Version :
ActionScript 3.0
Product Version :
Flex 3
Runtime Versions :
Flash Player 9, AIR 1.1
The measuredHeight is the explicit or measuredHeight of
the main mx.core.Application window
or the starting height of the SWF if the main window
has not yet been created or does not exist.
Implementation public function get measuredHeight():Number
measuredWidth
property
measuredWidth:Number [read-only]
Language Version :
ActionScript 3.0
Product Version :
Flex 3
Runtime Versions :
Flash Player 9, AIR 1.1
The measuredWidth is the explicit or measuredWidth of
the main mx.core.Application window,
or the starting width of the SWF if the main window
has not yet been created or does not exist.
Implementation public function get measuredWidth():Number
numChildren
property
numChildren:int [read-only] [override]
Language Version :
ActionScript 3.0
Product Version :
Flex 3
Runtime Versions :
Flash Player 9, AIR 1.1
The number of non-floating windows. This is the main application window
plus any other windows added to the SystemManager that are not popups,
tooltips or cursors.
Implementation public function get numChildren():int
numModalWindows
property
numModalWindows:int
Language Version :
ActionScript 3.0
Product Version :
Flex 3
Runtime Versions :
Flash Player 9, AIR 1.1
The number of modal windows. Modal windows don't allow
clicking in another windows which would normally
activate the FocusManager in that window. The PopUpManager
modifies this count as it creates and destroys modal windows.
Implementation public function get numModalWindows():int public function set numModalWindows(value:int):void
Override parent property to handle the case where the parent is in
a differnt sandbox. If the parent is in the same sandbox it is returned.
If the parent is in a diffent sandbox, then null is returned.
Implementation public function get parent():DisplayObjectContainer
parentAllowsChild
property
parentAllowsChild:Boolean [read-only]
Language Version :
ActionScript 3.0
Product Version :
Flex 3
Runtime Versions :
Flash Player 9, AIR 1.1
Tests if the parent allows its child to access its display objects or listen
to messages that originate in the parent.
true if access if allowed; otherwise false.
Implementation public function get parentAllowsChild():Boolean
An list of the topMost (popup)
windows being parented by this ISystemManager.
An ISystemManager has various types of children,
such as the Application, popups,
tooltips, and custom cursors.
You can access the top-most windows through
the popUpChildren property.
The IChildList object has methods like getChildAt()
and properties like numChildren.
For example, popUpChildren.numChildren gives
the number of topmost windows and you can access them as
popUpChildren.getChildAt(i).
Implementation public function get popUpChildren():IChildList
preloadedRSLs
property
preloadedRSLs:Dictionary [read-only]
The RSLs loaded by this SystemManager or FlexModuleFactory before the
application starts. This dictionary may also include RSLs loaded into this
module factory's application domain by other modules or
sub-applications. When a new dictionary entry is added by a child module
factory an RSLEvent.RSL_ADD_PRELOADED event is dispatched
by module factory owning the dictionary.
Information about preloadedRSLs is stored in a Dictionary. The key is
the RSL's LoaderInfo. The value is the a Vector of RSLData where the
first element is the primary RSL and the remaining elements are
failover RSLs.
Implementation public function get preloadedRSLs():Dictionary
preloaderBackgroundAlpha
property
preloaderBackgroundAlpha:Number [read-only]
Language Version :
ActionScript 3.0
Product Version :
Flex 3
Runtime Versions :
Flash Player 9, AIR 1.1
The background alpha used by the child of the preloader.
Implementation public function get preloaderBackgroundAlpha():Number
preloaderBackgroundColor
property
preloaderBackgroundColor:uint [read-only]
Language Version :
ActionScript 3.0
Product Version :
Flex 3
Runtime Versions :
Flash Player 9, AIR 1.1
The background color used by the child of the preloader.
Implementation public function get preloaderBackgroundColor():uint
preloaderBackgroundImage
property
preloaderBackgroundImage:Object [read-only]
Language Version :
ActionScript 3.0
Product Version :
Flex 3
Runtime Versions :
Flash Player 9, AIR 1.1
The background color used by the child of the preloader.
Implementation public function get preloaderBackgroundImage():Object
preloaderBackgroundSize
property
preloaderBackgroundSize:String [read-only]
Language Version :
ActionScript 3.0
Product Version :
Flex 3
Runtime Versions :
Flash Player 9, AIR 1.1
The background size used by the child of the preloader.
Implementation public function get preloaderBackgroundSize():String
A list of all children
being parented by this ISystemManager.
An ISystemManager has various types of children,
such as the Application, popups,
tooltips, and custom cursors.
The IChildList object has methods like getChildAt()
and properties like numChildren.
Implementation public function get rawChildren():IChildList
screen
property
screen:Rectangle [read-only]
Language Version :
ActionScript 3.0
Product Version :
Flex 3
Runtime Versions :
Flash Player 9, AIR 1.1
The size and position of the application window.
The Rectangle object contains x, y,
width, and height properties.
The Rectangle is in sandbox root coordinates.
Implementation public function get screen():Rectangle
A list of the tooltips
being parented by this ISystemManager.
An ISystemManager has various types of children,
such as the Application, popups, topmost windows,
tooltips, and custom cursors.
The IChildList object has methods like getChildAt()
and properties like numChildren.
For example, toolTipChildren.numChildren gives
the number of tooltips (which will be either 0 or 1)
and, if a tooltip exists, you can access it as
toolTipChildren.getChildAt(0).
Implementation public function get toolTipChildren():IChildList
Returns the SystemManager responsible for the application window. This will be
the same SystemManager unless this application has been loaded into another
application.
Implementation public function get topLevelSystemManager():ISystemManager
width
property
width:Number[override]
Language Version :
ActionScript 3.0
Product Version :
Flex 3
Runtime Versions :
Flash Player 9, AIR 1.1
The width of this object. For the SystemManager
this should always be the width of the stage unless the application was loaded
into another application. If the application was not loaded
into another application, setting this value will have no effect.
Implementation public function get width():Number public function set width(value:Number):void
Constructor Detail
SystemManager
()
Constructor
public function SystemManager()
Language Version :
ActionScript 3.0
Product Version :
Flex 3
Runtime Versions :
Flash Player 9, AIR 1.1
Constructor.
This is the starting point for all Flex applications.
This class is set to be the root class of a Flex SWF file.
Flash Player instantiates an instance of this class,
causing this constructor to be called.
Method Detail
addPreloadedRSL
()
method
public function addPreloadedRSL(loaderInfo:LoaderInfo, rsl:Vector.<RSLData>):void
Language Version :
ActionScript 3.0
Product Version :
Flex 4.5
Runtime Versions :
Flash Player 9, AIR 1.1
Adds an RSL to the preloadedRSLs list. This method is called by child
module factories when they add load an RSL into this module factory's
application domain.
You do not call this method directly. This method is called by child
module factories when they add load an RSL into this module factory's
application domain.
Parameters
loaderInfo:LoaderInfo — The loaderInfo of the loaded RSL.
rsl:Vector.<RSLData> — The RSL's configuration information. A Vector of RSLData.
The first element in the array is the primary RSL. The remaining
elements are failover RSLs.
allowDomain
()
method
public function allowDomain(... domains):void
Calls Security.allowDomain() for the SWF associated with this SystemManager
plus all the SWFs assocatiated with RSLs preloaded by this SystemManager.
Parameters
... domains
allowInsecureDomain
()
method
public function allowInsecureDomain(... domains):void
Calls Security.allowInsecureDomain() for the SWF associated with this SystemManager
plus all the SWFs assocatiated with RSLs preloaded by this SystemManager.
Parameters
... domains
create
()
method
public function create(... params):Object
Language Version :
ActionScript 3.0
Product Version :
Flex 3
Runtime Versions :
Flash Player 9, AIR 1.1
A factory method that requests an instance of a
definition known to the module.
You can provide an optional set of parameters to let building
factories change what they create based on the
input. Passing null indicates that the default definition
is created, if possible.
This method is overridden in the autogenerated subclass.
Parameters
... params — An optional list of arguments. You can pass
any number of arguments, which are then stored in an Array
called parameters.
Returns
Object — An instance of the module, or null.
deployMouseShields
()
method
public function deployMouseShields(deploy:Boolean):void
Language Version :
ActionScript 3.0
Product Version :
Flex 3
Runtime Versions :
Flash Player 9, AIR 1.1
Deploy or remove mouse shields. Mouse shields block mouse input to untrusted
applications. The reason you would want to block mouse input is because
when you are dragging over an untrusted application you would normally not
receive any mouse move events. The Flash Player does not send events
across trusted/untrusted boundries due to security concerns. By covering
the untrusted application with a mouse shield (assuming you are its parent)
you can get mouse move message and the drag operation will work as expected.
Parameters
deploy:Boolean — true to deploy the mouse shields, false
to remove the mouse shields.
getDefinitionByName
()
method
public function getDefinitionByName(name:String):Object
Language Version :
ActionScript 3.0
Product Version :
Flex 3
Runtime Versions :
Flash Player 9, AIR 1.1
Converts the given String to a Class or package-level Function.
Calls the appropriate ApplicationDomain.getDefinition()
method based on
whether you are loaded into another application or not.
Parameters
name:String — Name of class, for example "mx.video.VideoManager".
Returns
Object — The Class represented by the name, or null.
getExplicitOrMeasuredHeight
()
method
public function getExplicitOrMeasuredHeight():Number
Language Version :
ActionScript 3.0
Product Version :
Flex 3
Runtime Versions :
Flash Player 9, AIR 1.1
A convenience method for determining whether to use the
explicit or measured height.
Returns
Number — A Number that is the explicitHeight if defined,
or the measuredHeight property if not.
getExplicitOrMeasuredWidth
()
method
public function getExplicitOrMeasuredWidth():Number
Language Version :
ActionScript 3.0
Product Version :
Flex 3
Runtime Versions :
Flash Player 9, AIR 1.1
A convenience method for determining whether to use the
explicit or measured width.
Returns
Number — A Number that is the explicitWidth if defined,
or the measuredWidth property if not.
getSandboxRoot
()
method
public function getSandboxRoot():DisplayObject
Language Version :
ActionScript 3.0
Product Version :
Flex 3
Runtime Versions :
Flash Player 9, AIR 1.1
Go up the parent chain to get the top level system manager in this
SecurityDomain.
Returns
DisplayObject — The root system manager in this SecurityDomain.
getSWFRoot
()
method
public static function getSWFRoot(object:Object):DisplayObject
Language Version :
ActionScript 3.0
Product Version :
Flex 3
Runtime Versions :
Flash Player 9, AIR 1.1
Returns the root DisplayObject of the SWF that contains the code
for the given object.
Parameters
object:Object — Any Object.
Returns
DisplayObject — The root DisplayObject
getTopLevelRoot
()
method
public function getTopLevelRoot():DisplayObject
Language Version :
ActionScript 3.0
Product Version :
Flex 3
Runtime Versions :
Flash Player 9, AIR 1.1
Go up the parent chain to get the top level system manager.
Returns null if not on the display list or we don't have
access to the top-level system manager.
Returns
DisplayObject — The root system manager.
getVisibleApplicationRect
()
method
public function getVisibleApplicationRect(bounds:Rectangle = null, skipToSandboxRoot:Boolean = false):Rectangle
Language Version :
ActionScript 3.0
Product Version :
Flex 3
Runtime Versions :
Flash Player 9, AIR 1.1
Get the bounds of the loaded application that are visible to the user
on the screen.
Parameters
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)
Returns
Rectangle — a Rectangle including the visible portion of the this
object. The rectangle is in global coordinates.
invalidateParentSizeAndDisplayList
()
method
public function invalidateParentSizeAndDisplayList():void
Language Version :
ActionScript 3.0
Product Version :
Flex 4
Runtime Versions :
Flash Player 10, AIR 1.5
Attempts to notify the parent SWFLoader that the
Application's size has changed.
isFontFaceEmbedded
()
method
public function isFontFaceEmbedded(textFormat:TextFormat):Boolean
Language Version :
ActionScript 3.0
Product Version :
Flex 3
Runtime Versions :
Flash Player 9, AIR 1.1
Returns true if the required font face is embedded
in this application, or has been registered globally by using the
Font.registerFont() method.
Parameters
textFormat:TextFormat — The TextFormat class representing character formatting information.
Returns
Boolean — true if the required font face is embedded
in this application, or has been registered globally by using the
Font.registerFont() method.
isTopLevel
()
method
public function isTopLevel():Boolean
Language Version :
ActionScript 3.0
Product Version :
Flex 3
Runtime Versions :
Flash Player 9, AIR 1.1
Returns true if this ISystemManager is responsible
for an application window, and false if this
application has been loaded into another application.
Returns
Boolean — true if this ISystemManager is responsible
for an application window.
isTopLevelRoot
()
method
public function isTopLevelRoot():Boolean
Language Version :
ActionScript 3.0
Product Version :
Flex 3
Runtime Versions :
Flash Player 9, AIR 1.1
Tests if this system manager is the root of all
top level system managers.
Returns
Boolean — true if the SystemManager
is the root of all SystemManagers on the display list,
and false otherwise.
isTopLevelWindow
()
method
public function isTopLevelWindow(object:DisplayObject):Boolean
Language Version :
ActionScript 3.0
Product Version :
Flex 3
Runtime Versions :
Flash Player 9, AIR 1.1
Determines if the given DisplayObject is the
top-level window.
Parameters
object:DisplayObject — The DisplayObject to test.
Returns
Boolean — true if the given DisplayObject is the
top-level window.
move
()
method
public function move(x:Number, y:Number):void
Language Version :
ActionScript 3.0
Product Version :
Flex 3
Runtime Versions :
Flash Player 9, AIR 1.1
Calling the move() method
has no effect as it is directly mapped
to the application window or the loader.
Parameters
x:Number — The new x coordinate.
y:Number — The new y coordinate.
setActualSize
()
method
public function setActualSize(newWidth:Number, newHeight:Number):void
Language Version :
ActionScript 3.0
Product Version :
Flex 3
Runtime Versions :
Flash Player 9, AIR 1.1
Calling the setActualSize() method
has no effect if it is directly mapped
to the application window and if it is the top-level window.
Otherwise attempts to resize itself, clipping children if needed.
Dispatched when the application has finished initializing
The FlexEvent.APPLICATION_COMPLETE constant defines the value of the
type property of the event object for a applicationComplete event.
The properties of the event object have the following values:
Property
Value
bubbles
false
cancelable
false
currentTarget
The Object that defines the
event listener that handles the event. For example, if you use
myButton.addEventListener() to register an event listener,
myButton is the value of the currentTarget.
target
The Object that dispatched the event;
it is not always the Object listening for the event.
Use the currentTarget property to always access the
Object listening for the event.
Dispatched every 100 milliseconds when there has been no keyboard
or mouse activity for 1 second.
The FlexEvent.IDLE constant defines the value of the
type property of the event object for a idle event.
The properties of the event object have the following values:
Property
Value
bubbles
false
cancelable
false
currentTarget
The Object that defines the
event listener that handles the event. For example, if you use
myButton.addEventListener() to register an event listener,
myButton is the value of the currentTarget.
target
The Object that dispatched the event;
it is not always the Object listening for the event.
Use the currentTarget property to always access the
Object listening for the event.
flash.display.MovieClip