Apache Flex 4.16.0 API Reference | All Packages | All Classes | Index | Frames No Frames |
WindowedSystemManager

Package | mx.managers
Class | public class WindowedSystemManager
Inheritance | WindowedSystemManager flash.display.MovieClip
Implements | ISystemManager

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | AIR 1.1

The WindowedSystemManager class manages any non-Application windows in a Flex-based AIR application. This includes all windows that are instances of the Window component or a Window subclass, but not a WindowedApplication window. For those windows, the WindowedSystemManager serves the same role that a SystemManager serves for a WindowedApplication instance or an Application instance in a browser-based Flex application.

As this comparison suggests, the WindowedSystemManager class serves many roles. For instance, it is the root display object of a Window, and manages tooltips, cursors, popups, and other content for the Window.

See also

mx.managers.SystemManager

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. | WindowedSystemManager
|  | allowInsecureDomainsInNewRSLs : Boolean Controls whether the domains allowed by calls to allowInsecureDomain() are also allowed by RSLs loaded after the call. | WindowedSystemManager
|  | childAllowsParent : Boolean [read-only] | WindowedSystemManager
|  | cursorChildren : IChildList [read-only] An list of the custom cursors being parented by this ISystemManager. | WindowedSystemManager
|  | document : Object A reference to the document object. | WindowedSystemManager
|  | embeddedFontList : Object [read-only] A table of embedded fonts in this application. | WindowedSystemManager
|  | focusPane : Sprite The focus pane associated with this object. | WindowedSystemManager
|  | height : Number [override] [read-only] The height of this object. | WindowedSystemManager
|  | isProxy : Boolean [read-only] True if SystemManager is a proxy and not a root class | WindowedSystemManager
|  | numChildren : int [override] [read-only] The number of non-floating windows. | WindowedSystemManager
|  | numModalWindows : int The number of modal windows. | WindowedSystemManager
|  | parentAllowsChild : Boolean [read-only] | WindowedSystemManager
|  | popUpChildren : IChildList [read-only] An list of the topMost (popup) windows being parented by this ISystemManager. | WindowedSystemManager
|  | rawChildren : IChildList [read-only] A list of all children being parented by this ISystemManager. | WindowedSystemManager
|  | screen : Rectangle [read-only] The size and position of the application window. | WindowedSystemManager
|  | toolTipChildren : IChildList [read-only] A list of the tooltips being parented by this ISystemManager. | WindowedSystemManager
|  | topLevelSystemManager : ISystemManager [read-only] Returns the SystemManager responsible for the application window. | WindowedSystemManager
|  | width : Number [override] [read-only] The width of this object. | WindowedSystemManager

Public Methods

| Method | Defined By
--- | --- | ---
|  | WindowedSystemManager(rootObj:IUIComponent) | WindowedSystemManager
|  | callInContext(fn:Function, thisArg:Object, argArray:Array, returns:Boolean = true):* This method should not be called on WindowedSystemManager. | WindowedSystemManager
|  | create(... params):Object This method is overridden in the autogenerated subclass. | WindowedSystemManager
|  | deployMouseShields(deploy:Boolean):void Deploy or remove mouse shields. | WindowedSystemManager
|  | getDefinitionByName(name:String):Object Converts the given String to a Class or package-level Function. | WindowedSystemManager
|  | getFocus():InteractiveObject Return the object the player sees as having focus. | WindowedSystemManager
|  | getSandboxRoot():DisplayObject Go up our parent chain to get the top level system manager in this SecurityDomain | WindowedSystemManager
|  | getTopLevelRoot():DisplayObject Go up our parent chain to get the top level system manager. | WindowedSystemManager
|  | getVisibleApplicationRect(bounds:Rectangle = null, skipToSandboxRoot:Boolean = false):Rectangle | WindowedSystemManager
|  | invalidateParentSizeAndDisplayList():void Attempts to notify the parent SWFLoader that the Application's size has may have changed. | WindowedSystemManager
|  | isFontFaceEmbedded(textFormat: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. | WindowedSystemManager
|  | isTopLevel():Boolean Returns true if this ISystemManager is responsible for an application window, and false if this application has been loaded into another application. | WindowedSystemManager
|  | isTopLevelRoot():Boolean | WindowedSystemManager
|  | isTopLevelWindow(object:DisplayObject):Boolean Returns true if the given DisplayObject is the top-level window. | WindowedSystemManager

Property Detail

allowDomainsInNewRSLs | property

`allowDomainsInNewRSLs: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 `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`

childAllowsParent | property |

`childAllowsParent:Boolean` [read-only]

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | 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 : | 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 : | 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 : | 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`

focusPane | property |

`focusPane:Sprite`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | 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` [read-only] [override]

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | 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`

isProxy | property |

`isProxy:Boolean` [read-only]

True if SystemManager is a proxy and not a root class

Implementation
`public function get isProxy():Boolean`

numChildren | property |

`numChildren:int` [read-only] [override]

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | 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 : | 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`

parentAllowsChild | property |

`parentAllowsChild:Boolean` [read-only]

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | 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 : | 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`

rawChildren | property |

`rawChildren:IChildList` [read-only]

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | 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 : | 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`

toolTipChildren | property |

`toolTipChildren:IChildList` [read-only]

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | 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 : | 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` [read-only] [override]

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | 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`
Constructor Detail

WindowedSystemManager | () | Constructor

`public function WindowedSystemManager(rootObj:IUIComponent)`

Parameters

| `rootObj:IUIComponent`

Method Detail

callInContext | () | method

`public function callInContext(fn:Function, thisArg:Object, argArray:Array, returns:Boolean = true):*`

This method should not be called on WindowedSystemManager. It is here as part of the contract for IFlexModuleFactory.

Parameters

| `fn:Function`
| `thisArg:Object`
| `argArray:Array`
| `returns:Boolean` (default = `true`)``

Returns

| `*`

create | () | method |

`public function create(... params):Object`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | AIR 1.1

This method is overridden in the autogenerated subclass.

Parameters

| `... params`

Returns

| `Object`

deployMouseShields | () | method |

`public function deployMouseShields(deploy:Boolean):void`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | 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 : | 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.

getFocus | () | method |

`public function getFocus():InteractiveObject`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | AIR 1.1

Return the object the player sees as having focus.

Returns

| `InteractiveObject` — An object of type InteractiveObject that the player sees as having focus. If focus is currently in a sandbox the caller does not have access to null will be returned.

getSandboxRoot | () | method |

`public function getSandboxRoot():DisplayObject`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | AIR 1.1

Go up our parent chain to get the top level system manager in this SecurityDomain

Returns

| `DisplayObject`

getTopLevelRoot | () | method |

`public function getTopLevelRoot():DisplayObject`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | AIR 1.1

Go up our parent chain to get the top level system manager. returns null if we are not on the display list or we don't have access to the top level system manager.

Returns

| `DisplayObject`

getVisibleApplicationRect | () | method |

`public function getVisibleApplicationRect(bounds:Rectangle = null, skipToSandboxRoot:Boolean = false):Rectangle`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | AIR 1.1

Parameters

| `bounds:Rectangle` (default = `null`)``
| `skipToSandboxRoot:Boolean` (default = `false`)``

Returns

| `Rectangle`

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 may have changed. Not needed for WindowedSystemManager so does nothing

isFontFaceEmbedded | () | method |

`public function isFontFaceEmbedded(textFormat:TextFormat):Boolean`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | 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 : | 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 : | AIR 1.1

Returns

| `Boolean`

isTopLevelWindow | () | method |

`public function isTopLevelWindow(object:DisplayObject):Boolean`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | AIR 1.1

Returns `true` if the given DisplayObject is the top-level window.

Parameters

| `object:DisplayObject`

Returns

| `Boolean` — `true` if the given DisplayObject is the top-level window.

Sun Mar 5 2017, 03:42 PM +11:00