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

Package | mx.managers
Interface | public interface IMarshalSystemManager

Language Version : | ActionScript 3.0

Product Version : | Flex 4

Runtime Versions : | Flash Player 10, AIR 1.5

The IMarshalSystemManager interface defines the methods and properties that classes must implement if they want to access, add, and remove bridges to other applications in a cross-versioned configuration.

Public Properties

| Property | Defined By
--- | --- | ---
|  | swfBridgeGroup : ISWFBridgeGroup Contains all the bridges to other applications that this application is connected to. | IMarshalSystemManager

Public Methods

| Method | Defined By
--- | --- | ---
|  | addChildBridge(bridge:IEventDispatcher, owner:DisplayObject):void Adds a child bridge to the system manager. | IMarshalSystemManager
|  | addChildToSandboxRoot(layer:String, child:DisplayObject):void Adds the specified child to the sandbox root in the layer requested. | IMarshalSystemManager
|  | dispatchEventFromSWFBridges(event:Event, skip:IEventDispatcher = null, trackClones:Boolean = false, toOtherSystemManagers:Boolean = false):void Dispatch a message to all parent and child applications in this SystemManager's SWF bridge group, regardless of whether they are in the same SecurityDomain or not. | IMarshalSystemManager
|  | isDisplayObjectInABridgedApplication(displayObject:DisplayObject):Boolean Tests if a display object is in a child application that is loaded in compatibility mode or in an untrusted sandbox. | IMarshalSystemManager
|  | removeChildBridge(bridge:IEventDispatcher):void Adds a child bridge to the system manager. | IMarshalSystemManager
|  | removeChildFromSandboxRoot(layer:String, child:DisplayObject):void Removes the specified child from the sandbox root in the layer requested. | IMarshalSystemManager
|  | useSWFBridge():Boolean Determines if the caller using this system manager should should communicate directly with other managers or if it should communicate with a bridge. | IMarshalSystemManager

Property Detail

swfBridgeGroup | property

`swfBridgeGroup:ISWFBridgeGroup`

Language Version : | ActionScript 3.0

Product Version : | Flex 4

Runtime Versions : | Flash Player 10, AIR 1.5

Contains all the bridges to other applications that this application is connected to.

Implementation
`public function get swfBridgeGroup():ISWFBridgeGroup`
`public function set swfBridgeGroup(value:ISWFBridgeGroup):void`
Method Detail

addChildBridge | () | method

`public function addChildBridge(bridge:IEventDispatcher, owner:DisplayObject):void`

Language Version : | ActionScript 3.0

Product Version : | Flex 4

Runtime Versions : | Flash Player 10, AIR 1.5

Adds a child bridge to the system manager. Each child bridge represents components in another sandbox or compiled with a different version of Flex.

Parameters

| `bridge:IEventDispatcher` — The bridge for the child.
| `owner:DisplayObject` — The SWFLoader for the child.

addChildToSandboxRoot | () | method |

`public function addChildToSandboxRoot(layer:String, child:DisplayObject):void`

Language Version : | ActionScript 3.0

Product Version : | Flex 4

Runtime Versions : | Flash Player 10, AIR 1.5

Adds the specified child to the sandbox root in the layer requested.

Parameters

| `layer:String` — The name of IChildList in SystemManager.
| `child:DisplayObject` — The DisplayObject to add.

dispatchEventFromSWFBridges | () | method |

`public function dispatchEventFromSWFBridges(event:Event, skip:IEventDispatcher = null, trackClones:Boolean = false, toOtherSystemManagers:Boolean = false):void`

Language Version : | ActionScript 3.0

Product Version : | Flex 4

Runtime Versions : | Flash Player 10, AIR 1.5

Dispatch a message to all parent and child applications in this SystemManager's SWF bridge group, regardless of whether they are in the same SecurityDomain or not. You can optionally exclude an application with this method's parameters.

Parameters

| `event:Event` — The event to dispatch.
| `skip:IEventDispatcher` (default = `null`)`` — Specifies an IEventDispatcher that you do not want to dispatch a message to. This is typically used to skip the IEventDispatcher that originated the event.
| `trackClones:Boolean` (default = `false`)`` — Whether to keep a reference to the events as they are dispatched.
| `toOtherSystemManagers:Boolean` (default = `false`)`` — Whether to dispatch the event to other top-level SystemManagers in AIR.

isDisplayObjectInABridgedApplication | () | method |

`public function isDisplayObjectInABridgedApplication(displayObject:DisplayObject):Boolean`

Language Version : | ActionScript 3.0

Product Version : | Flex 4

Runtime Versions : | Flash Player 10, AIR 1.5

Tests if a display object is in a child application that is loaded in compatibility mode or in an untrusted sandbox.

Parameters

| `displayObject:DisplayObject` — The DisplayObject to test.

Returns

| `Boolean` — `true` if `displayObject` is in a child application that is loaded in compatibility mode or in an untrusted sandbox, and `false` otherwise.

removeChildBridge | () | method |

`public function removeChildBridge(bridge:IEventDispatcher):void`

Language Version : | ActionScript 3.0

Product Version : | Flex 4

Runtime Versions : | Flash Player 10, AIR 1.5

Adds a child bridge to the system manager. Each child bridge represents components in another sandbox or compiled with a different version of Flex.

Parameters

| `bridge:IEventDispatcher` — The bridge for the child.

removeChildFromSandboxRoot | () | method |

`public function removeChildFromSandboxRoot(layer:String, child:DisplayObject):void`

Language Version : | ActionScript 3.0

Product Version : | Flex 4

Runtime Versions : | Flash Player 10, AIR 1.5

Removes the specified child from the sandbox root in the layer requested.

Parameters

| `layer:String` — The name of IChildList in SystemManager.
| `child:DisplayObject` — The DisplayObject to add.

useSWFBridge | () | method |

`public function useSWFBridge():Boolean`

Language Version : | ActionScript 3.0

Product Version : | Flex 4

Runtime Versions : | Flash Player 10, AIR 1.5

Determines if the caller using this system manager should should communicate directly with other managers or if it should communicate with a bridge.

Returns

| `Boolean` — `true` if the caller using this system manager should communicate using sandbox bridges. If `false` the system manager may directly call other managers directly via references.

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