mx.managers.SystemManager - Adobe® Flex® 4 Language Reference (Flex 4)

Package	mx.managers
Class	public class SystemManager
Inheritance	SystemManager MovieClip Sprite DisplayObjectContainer InteractiveObject DisplayObject EventDispatcher Object
Implements	IChildList, IFlexDisplayObject, IFlexModuleFactory, ISystemManager

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

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.

See also

About the SystemManager class

Public Properties

Hide Inherited Public Properties

Show Inherited Public Properties

	Property		Defined By
		accessibilityImplementation : AccessibilityImplementation The current accessibility implementation (AccessibilityImplementation) for this InteractiveObject instance.	InteractiveObject
		accessibilityProperties : AccessibilityProperties The current accessibility options for this display object.	DisplayObject
		alpha : Number Indicates the alpha transparency value of the object specified.	DisplayObject
		application : IUIComponent [read-only] The application parented by this SystemManager.	SystemManager
		blendMode : String A value from the BlendMode class that specifies which blend mode to use.	DisplayObject
		blendShader : Shader [write-only] Sets a shader that is used for blending the foreground and background.	DisplayObject
		buttonMode : Boolean Specifies the button mode of this sprite.	Sprite
		cacheAsBitmap : Boolean If set to true, Flash Player or Adobe AIR caches an internal bitmap representation of the display object.	DisplayObject
		childAllowsParent : Boolean [read-only]	SystemManager
		constructor : Object A reference to the class object or constructor function for a given object instance.	Object
		contextMenu : NativeMenu Specifies the context menu associated with this object.	InteractiveObject
		currentFrame : int [read-only] Specifies the number of the frame in which the playhead is located in the timeline of the MovieClip instance.	MovieClip
		currentFrameLabel : String [read-only] The label at the current frame in the timeline of the MovieClip instance.	MovieClip
		currentLabel : String [read-only] The current label in which the playhead is located in the timeline of the MovieClip instance.	MovieClip
		currentLabels : Array [read-only] Returns an array of FrameLabel objects from the current scene.	MovieClip
		currentScene : Scene [read-only] The current scene in which the playhead is located in the timeline of the MovieClip instance.	MovieClip
		cursorChildren : IChildList [read-only] An list of the custom cursors being parented by this ISystemManager.	SystemManager
		document : Object A reference to the document object.	SystemManager
		doubleClickEnabled : Boolean Specifies whether the object receives doubleClick events.	InteractiveObject
		dropTarget : DisplayObject [read-only] Specifies the display object over which the sprite is being dragged, or on which the sprite was dropped.	Sprite
		embeddedFontList : Object [read-only] A table of embedded fonts in this application.	SystemManager
		enabled : Boolean A Boolean value that indicates whether a movie clip is enabled.	MovieClip
		explicitHeight : Number The explicit width of this object.	SystemManager
		explicitWidth : Number The explicit width of this object.	SystemManager
		filters : Array An indexed array that contains each filter object currently associated with the display object.	DisplayObject
		focusPane : Sprite The focus pane associated with this object.	SystemManager
		focusRect : Object Specifies whether this object displays a focus rectangle.	InteractiveObject
		framesLoaded : int [read-only] The number of frames that are loaded from a streaming SWF file.	MovieClip
		graphics : Graphics [read-only] Specifies the Graphics object that belongs to this sprite where vector drawing commands can occur.	Sprite
		height : Number [override] The height of this object.	SystemManager
		hitArea : Sprite Designates another sprite to serve as the hit area for a sprite.	Sprite
		isProxy : Boolean [read-only] True if SystemManager is a proxy and not a root class	SystemManager
		loaderInfo : LoaderInfo [read-only] Returns a LoaderInfo object containing information about loading the file to which this display object belongs.	DisplayObject
		mask : DisplayObject The calling display object is masked by the specified mask object.	DisplayObject
		measuredHeight : Number [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.	SystemManager
		measuredWidth : Number [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.	SystemManager
		mouseChildren : Boolean Determines whether or not the children of the object are mouse enabled.	DisplayObjectContainer
		mouseEnabled : Boolean Specifies whether this object receives mouse messages.	InteractiveObject
		mouseX : Number [read-only] Indicates the x coordinate of the mouse position, in pixels.	DisplayObject
		mouseY : Number [read-only] Indicates the y coordinate of the mouse position, in pixels.	DisplayObject
		name : String Indicates the instance name of the DisplayObject.	DisplayObject
		numChildren : int [override] [read-only] The number of non-floating windows.	SystemManager
		numModalWindows : int The number of modal windows.	SystemManager
		opaqueBackground : Object Specifies whether the display object is opaque with a certain background color.	DisplayObject
		parent : DisplayObjectContainer [override] [read-only] Override parent property to handle the case where the parent is in a differnt sandbox.	SystemManager
		parentAllowsChild : Boolean [read-only]	SystemManager
		popUpChildren : IChildList [read-only] An list of the topMost (popup) windows being parented by this ISystemManager.	SystemManager
		preloadedRSLs : Dictionary [read-only] The RSLs loaded by this SystemManager before the application starts.	SystemManager
		preloaderBackgroundAlpha : Number [read-only] The background alpha used by the child of the preloader.	SystemManager
		preloaderBackgroundColor : uint [read-only] The background color used by the child of the preloader.	SystemManager
		preloaderBackgroundImage : Object [read-only] The background color used by the child of the preloader.	SystemManager
		preloaderBackgroundSize : String [read-only] The background size used by the child of the preloader.	SystemManager
		prototype : Object [static] A reference to the prototype object of a class or function object.	Object
		rawChildren : IChildList [read-only] A list of all children being parented by this ISystemManager.	SystemManager
		root : DisplayObject [read-only] For a display object in a loaded SWF file, the root property is the top-most display object in the portion of the display list's tree structure represented by that SWF file.	DisplayObject
		rotation : Number Indicates the rotation of the DisplayObject instance, in degrees, from its original orientation.	DisplayObject
		rotationX : Number Indicates the x-axis rotation of the DisplayObject instance, in degrees, from its original orientation relative to the 3D parent container.	DisplayObject
		rotationY : Number Indicates the y-axis rotation of the DisplayObject instance, in degrees, from its original orientation relative to the 3D parent container.	DisplayObject
		rotationZ : Number Indicates the z-axis rotation of the DisplayObject instance, in degrees, from its original orientation relative to the 3D parent container.	DisplayObject
		scale9Grid : Rectangle The current scaling grid that is in effect.	DisplayObject
		scaleX : Number Indicates the horizontal scale (percentage) of the object as applied from the registration point.	DisplayObject
		scaleY : Number Indicates the vertical scale (percentage) of an object as applied from the registration point of the object.	DisplayObject
		scaleZ : Number Indicates the depth scale (percentage) of an object as applied from the registration point of the object.	DisplayObject
		scenes : Array [read-only] An array of Scene objects, each listing the name, the number of frames, and the frame labels for a scene in the MovieClip instance.	MovieClip
		screen : Rectangle [read-only] The size and position of the application window.	SystemManager
		scrollRect : Rectangle The scroll rectangle bounds of the display object.	DisplayObject
		soundTransform : flash.media:SoundTransform Controls sound within this sprite.	Sprite
		stage : Stage [read-only] The Stage of the display object.	DisplayObject
		tabChildren : Boolean Determines whether the children of the object are tab enabled.	DisplayObjectContainer
		tabEnabled : Boolean Specifies whether this object is in the tab order.	InteractiveObject
		tabIndex : int Specifies the tab ordering of objects in a SWF file.	InteractiveObject
		textSnapshot : flash.text:TextSnapshot [read-only] Returns a TextSnapshot object for this DisplayObjectContainer instance.	DisplayObjectContainer
		toolTipChildren : IChildList [read-only] A list of the tooltips being parented by this ISystemManager.	SystemManager
		topLevelSystemManager : ISystemManager [read-only] Returns the SystemManager responsible for the application window.	SystemManager
		totalFrames : int [read-only] The total number of frames in the MovieClip instance.	MovieClip
		trackAsMenu : Boolean Indicates whether other display objects that are SimpleButton or MovieClip objects can receive mouse release events.	MovieClip
		transform : flash.geom:Transform An object with properties pertaining to a display object's matrix, color transform, and pixel bounds.	DisplayObject
		useHandCursor : Boolean A Boolean value that indicates whether the pointing hand (hand cursor) appears when the mouse rolls over a sprite in which the buttonMode property is set to true.	Sprite
		visible : Boolean Whether or not the display object is visible.	DisplayObject
		width : Number [override] The width of this object.	SystemManager
		x : Number Indicates the x coordinate of the DisplayObject instance relative to the local coordinates of the parent DisplayObjectContainer.	DisplayObject
		y : Number Indicates the y coordinate of the DisplayObject instance relative to the local coordinates of the parent DisplayObjectContainer.	DisplayObject
		z : Number Indicates the z coordinate position along the z-axis of the DisplayObject instance relative to the 3D parent container.	DisplayObject

Public Methods

Hide Inherited Public Methods

Show Inherited Public Methods

	Method		Defined By
		SystemManager() Constructor.	SystemManager
		addChild(child:DisplayObject):DisplayObject Adds a child DisplayObject instance to this DisplayObjectContainer instance.	DisplayObjectContainer
		addChildAt(child:DisplayObject, index:int):DisplayObject Adds a child DisplayObject instance to this DisplayObjectContainer instance.	DisplayObjectContainer
		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.	EventDispatcher
		allowDomain(... domains):void Calls Security.allowDomain() for the SWF associated with this SystemManager plus all the SWFs assocatiated with RSLs preloaded by this SystemManager.	SystemManager
		allowInsecureDomain(... domains):void Calls Security.allowInsecureDomain() for the SWF associated with this SystemManager plus all the SWFs assocatiated with RSLs preloaded by this SystemManager.	SystemManager
		areInaccessibleObjectsUnderPoint(point:Point):Boolean Indicates whether the security restrictions would cause any display objects to be omitted from the list returned by calling the DisplayObjectContainer.getObjectsUnderPoint() method with the specified point point.	DisplayObjectContainer
		contains(child:DisplayObject):Boolean Determines whether the specified display object is a child of the DisplayObjectContainer instance or the instance itself.	DisplayObjectContainer
		create(... params):Object A factory method that requests an instance of a definition known to the module.	SystemManager
		deployMouseShields(deploy:Boolean):void Deploy or remove mouse shields.	SystemManager
		dispatchEvent(event:Event):Boolean Dispatches an event into the event flow.	EventDispatcher
		getBounds(targetCoordinateSpace:DisplayObject):Rectangle Returns a rectangle that defines the area of the display object relative to the coordinate system of the targetCoordinateSpace object.	DisplayObject
		getChildAt(index:int):DisplayObject Returns the child display object instance that exists at the specified index.	DisplayObjectContainer
		getChildByName(name:String):DisplayObject Returns the child display object that exists with the specified name.	DisplayObjectContainer
		getChildIndex(child:DisplayObject):int Returns the index position of a child DisplayObject instance.	DisplayObjectContainer
		getDefinitionByName(name:String):Object Converts the given String to a Class or package-level Function.	SystemManager
		getExplicitOrMeasuredHeight():Number A convenience method for determining whether to use the explicit or measured height.	SystemManager
		getExplicitOrMeasuredWidth():Number A convenience method for determining whether to use the explicit or measured width.	SystemManager
		getObjectsUnderPoint(point:Point):Array Returns an array of objects that lie under the specified point and are children (or grandchildren, and so on) of this DisplayObjectContainer instance.	DisplayObjectContainer
		getRect(targetCoordinateSpace:DisplayObject):Rectangle Returns a rectangle that defines the boundary of the display object, based on the coordinate system defined by the targetCoordinateSpace parameter, excluding any strokes on shapes.	DisplayObject
		getSandboxRoot():DisplayObject Go up the parent chain to get the top level system manager in this SecurityDomain.	SystemManager
		getSWFRoot(object:Object):DisplayObject [static] Returns the root DisplayObject of the SWF that contains the code for the given object.	SystemManager
		getTopLevelRoot():DisplayObject Go up the parent chain to get the top level system manager.	SystemManager
		getVisibleApplicationRect(bounds:Rectangle = null):Rectangle Get the bounds of the loaded application that are visible to the user on the screen.	SystemManager
		globalToLocal(point:Point):Point Converts the point object from the Stage (global) coordinates to the display object's (local) coordinates.	DisplayObject
		globalToLocal3D(point:Point):Vector3D Converts a two-dimensional point from the Stage (global) coordinates to a three-dimensional display object's (local) coordinates.	DisplayObject
		gotoAndPlay(frame:Object, scene:String = null):void Starts playing the SWF file at the specified frame.	MovieClip
		gotoAndStop(frame:Object, scene:String = null):void Brings the playhead to the specified frame of the movie clip and stops it there.	MovieClip
		hasEventListener(type:String):Boolean Checks whether the EventDispatcher object has any listeners registered for a specific type of event.	EventDispatcher
		hasOwnProperty(name:String):Boolean Indicates whether an object has a specified property defined.	Object
		hitTestObject(obj:DisplayObject):Boolean Evaluates the bounding box of the display object to see if it overlaps or intersects with the bounding box of the obj display object.	DisplayObject
		hitTestPoint(x:Number, y:Number, shapeFlag:Boolean = false):Boolean Evaluates the display object to see if it overlaps or intersects with the point specified by the x and y parameters.	DisplayObject
		invalidateParentSizeAndDisplayList():void Attempts to notify the parent SWFLoader that the Application's size has changed.	SystemManager
		isFontFaceEmbedded(textFormat: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.	SystemManager
		isPrototypeOf(theClass:Object):Boolean Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.	Object
		isTopLevel():Boolean Returns true if this ISystemManager is responsible for an application window, and false if this application has been loaded into another application.	SystemManager
		isTopLevelRoot():Boolean Tests if this system manager is the root of all top level system managers.	SystemManager
		isTopLevelWindow(object:DisplayObject):Boolean Determines if the given DisplayObject is the top-level window.	SystemManager
		local3DToGlobal(point3d:Vector3D):Point Converts a three-dimensional point of the three-dimensional display object's (local) coordinates to a two-dimensional point in the Stage (global) coordinates.	DisplayObject
		localToGlobal(point:Point):Point Converts the point object from the display object's (local) coordinates to the Stage (global) coordinates.	DisplayObject
		move(x:Number, y:Number):void Calling the move() method has no effect as it is directly mapped to the application window or the loader.	SystemManager
		nextFrame():void Sends the playhead to the next frame and stops it.	MovieClip
		nextScene():void Moves the playhead to the next scene of the MovieClip instance.	MovieClip
		play():void Moves the playhead in the timeline of the movie clip.	MovieClip
		prevFrame():void Sends the playhead to the previous frame and stops it.	MovieClip
		prevScene():void Moves the playhead to the previous scene of the MovieClip instance.	MovieClip
		propertyIsEnumerable(name:String):Boolean Indicates whether the specified property exists and is enumerable.	Object
		removeChild(child:DisplayObject):DisplayObject Removes the specified child DisplayObject instance from the child list of the DisplayObjectContainer instance.	DisplayObjectContainer
		removeChildAt(index:int):DisplayObject Removes a child DisplayObject from the specified index position in the child list of the DisplayObjectContainer.	DisplayObjectContainer
		removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void Removes a listener from the EventDispatcher object.	EventDispatcher
		setActualSize(newWidth:Number, newHeight:Number):void Calling the setActualSize() method has no effect if it is directly mapped to the application window and if it is the top-level window.	SystemManager
		setChildIndex(child:DisplayObject, index:int):void Changes the position of an existing child in the display object container.	DisplayObjectContainer
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Sets the availability of a dynamic property for loop operations.	Object
		startDrag(lockCenter:Boolean = false, bounds:Rectangle = null):void Lets the user drag the specified sprite.	Sprite
		stop():void Stops the playhead in the movie clip.	MovieClip
		stopDrag():void Ends the startDrag() method.	Sprite
		swapChildren(child1:DisplayObject, child2:DisplayObject):void Swaps the z-order (front-to-back order) of the two specified child objects.	DisplayObjectContainer
		swapChildrenAt(index1:int, index2:int):void Swaps the z-order (front-to-back order) of the child objects at the two specified index positions in the child list.	DisplayObjectContainer
		toLocaleString():String Returns the string representation of this object, formatted according to locale-specific conventions.	Object
		toString():String Returns the string representation of the specified object.	Object
		valueOf():Object Returns the primitive value of the specified object.	Object
		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.	EventDispatcher

Events

Click for more information on events

Hide Inherited Events

Show Inherited Events

	Summary	Defined By
activate	[broadcast event] Dispatched when the Flash Player or AIR application gains operating system focus and becomes active.	EventDispatcher
added	Dispatched when a display object is added to the display list.	DisplayObject
addedToStage	Dispatched when a display object is added to the on stage display list, either directly or through the addition of a sub tree in which the display object is contained.	DisplayObject
applicationComplete	Dispatched when the application has finished initializing	SystemManager
clear	Dispatched when the user selects 'Clear' (or 'Delete') from the text context menu.	InteractiveObject
click	Dispatched when a user presses and releases the main button of the user's pointing device over the same InteractiveObject.	InteractiveObject
contextMenu	Dispatched when a user gesture triggers the context menu associated with this interactive object in an AIR application.	InteractiveObject
copy	Dispatched when the user activates the platform specific accelerator key combination for a copy operation or selects 'Copy' from the text context menu.	InteractiveObject
cut	Dispatched when the user activates the platform specific accelerator key combination for a cut operation or selects 'Cut' from the text context menu.	InteractiveObject
deactivate	[broadcast event] Dispatched when the Flash Player or AIR application operating loses system focus and is becoming inactive.	EventDispatcher
doubleClick	Dispatched when a user presses and releases the main button of a pointing device twice in rapid succession over the same InteractiveObject when that object's doubleClickEnabled flag is set to true.	InteractiveObject
enterFrame	[broadcast event] Dispatched when the playhead is entering a new frame.	DisplayObject
exitFrame	[broadcast event] Dispatched when the playhead is exiting the current frame.	DisplayObject
focusIn	Dispatched after a display object gains focus.	InteractiveObject
focusOut	Dispatched after a display object loses focus.	InteractiveObject
frameConstructed	[broadcast event] Dispatched after the constructors of frame display objects have run but before frame scripts have run.	DisplayObject
idle	Dispatched every 100 milliseconds when there has been no keyboard or mouse activity for 1 second.	SystemManager
keyDown	Dispatched when the user presses a key.	InteractiveObject
keyFocusChange	Dispatched when the user attempts to change focus by using keyboard navigation.	InteractiveObject
keyUp	Dispatched when the user releases a key.	InteractiveObject
middleClick	Dispatched when a user presses and releases the middle button of the user's pointing device over the same InteractiveObject.	InteractiveObject
middleMouseDown	Dispatched when a user presses the middle pointing device button over an InteractiveObject instance.	InteractiveObject
middleMouseUp	Dispatched when a user releases the pointing device button over an InteractiveObject instance.	InteractiveObject
mouseDown	Dispatched when a user presses the pointing device button over an InteractiveObject instance.	InteractiveObject
mouseFocusChange	Dispatched when the user attempts to change focus by using a pointer device.	InteractiveObject
mouseMove	Dispatched when a user moves the pointing device while it is over an InteractiveObject.	InteractiveObject
mouseOut	Dispatched when the user moves a pointing device away from an InteractiveObject instance.	InteractiveObject
mouseOver	Dispatched when the user moves a pointing device over an InteractiveObject instance.	InteractiveObject
mouseUp	Dispatched when a user releases the pointing device button over an InteractiveObject instance.	InteractiveObject
mouseWheel	Dispatched when a mouse wheel is spun over an InteractiveObject instance.	InteractiveObject
nativeDragComplete	Dispatched by the drag initiator InteractiveObject when the user releases the drag gesture.	InteractiveObject
nativeDragDrop	Dispatched by the target InteractiveObject when a dragged object is dropped on it and the drop has been accepted with a call to DragManager.acceptDragDrop().	InteractiveObject
nativeDragEnter	Dispatched by an InteractiveObject when a drag gesture enters its boundary.	InteractiveObject
nativeDragExit	Dispatched by an InteractiveObject when a drag gesture leaves its boundary.	InteractiveObject
nativeDragOver	Dispatched by an InteractiveObject continually while a drag gesture remains within its boundary.	InteractiveObject
nativeDragStart	Dispatched at the beginning of a drag operation by the InteractiveObject that is specified as the drag initiator in the DragManager.doDrag() call.	InteractiveObject
nativeDragUpdate	Dispatched during a drag operation by the InteractiveObject that is specified as the drag initiator in the DragManager.doDrag() call.	InteractiveObject
paste	Dispatched when the user activates the platform specific accelerator key combination for a paste operation or selects 'Paste' from the text context menu.	InteractiveObject
removed	Dispatched when a display object is about to be removed from the display list.	DisplayObject
removedFromStage	Dispatched when a display object is about to be removed from the display list, either directly or through the removal of a sub tree in which the display object is contained.	DisplayObject
render	[broadcast event] Dispatched when the display list is about to be updated and rendered.	DisplayObject
resize	Dispatched when the Stage is resized.	SystemManager
rightClick	Dispatched when a user presses and releases the right button of the user's pointing device over the same InteractiveObject.	InteractiveObject
rightMouseDown	Dispatched when a user presses the pointing device button over an InteractiveObject instance.	InteractiveObject
rightMouseUp	Dispatched when a user releases the pointing device button over an InteractiveObject instance.	InteractiveObject
rollOut	Dispatched when the user moves a pointing device away from an InteractiveObject instance.	InteractiveObject
rollOver	Dispatched when the user moves a pointing device over an InteractiveObject instance.	InteractiveObject
selectAll	Dispatched when the user activates the platform specific accelerator key combination for a select all operation or selects 'Select All' from the text context menu.	InteractiveObject
tabChildrenChange	Dispatched when the value of the object's tabChildren flag changes.	InteractiveObject
tabEnabledChange	Dispatched when the object's tabEnabled flag changes.	InteractiveObject
tabIndexChange	Dispatched when the value of the object's tabIndex property changes.	InteractiveObject
textInput	Dispatched when a user enters one or more characters of text.	InteractiveObject

Property Detail

application

property

application:IUIComponent [read-only]

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

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

cursorChildren

property

cursorChildren:IChildList [read-only]

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

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

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
override public function get height():Number
override 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
override 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

parent

property

parent:DisplayObjectContainer [read-only] [override]

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

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
override 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

Implementation
public function get parentAllowsChild():Boolean

popUpChildren

property

popUpChildren:IChildList [read-only]

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

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 before the application starts. RSLs loaded by the application are not included in this list. Information about preloadedRSLs is stored in a Dictionary. The key is the RSL's LoaderInfo. The value is the url the RSL was loaded from.

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

rawChildren

property

rawChildren:IChildList [read-only]

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

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.

Implementation
public function get screen():Rectangle

toolTipChildren

property

toolTipChildren:IChildList [read-only]

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

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

topLevelSystemManager

property

topLevelSystemManager:ISystemManager [read-only]

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

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
override public function get width():Number
override 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

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):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.

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:flash.text: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:flash.text: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.

Parameters

	`newWidth:Number` — The new width.

	`newHeight:Number` — The new height.

Event Detail

applicationComplete

Event

Event Object Type: mx.events.FlexEvent
property FlexEvent.type = mx.events.FlexEvent.APPLICATION_COMPLETE

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

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.

idle

Event

Event Object Type: mx.events.FlexEvent
property FlexEvent.type = mx.events.FlexEvent.IDLE

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

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.

resize

Event

Event Object Type: flash.events.Event
property Event.type = flash.events.Event.RESIZE

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

Dispatched when the Stage is resized.

The Event.RESIZE constant defines the value of the type property of a resize event object.

This event has the following properties:

Property	Value
`bubbles`	`false`
`cancelable`	`false`; there is no default behavior to cancel.
`currentTarget`	The object that is actively processing the Event object with an event listener.
`target`	The Stage object.