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

Package | mx.core
Class | public class SWFBridgeGroup
Inheritance | SWFBridgeGroup flash.events.EventDispatcher
Implements | ISWFBridgeGroup

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

A SWFBridgeGroup represents all of the sandbox bridges that an application needs to communicate with its parent and children.

Public Properties

| Property | Defined By
--- | --- | ---
|  | parentBridge : IEventDispatcher Allows communication with the parent if the parent is in a different sandbox. | SWFBridgeGroup

Public Methods

| Method | Defined By
--- | --- | ---
|  | SWFBridgeGroup(owner:ISystemManager) Constructor. | SWFBridgeGroup
|  | addChildBridge(bridge:IEventDispatcher, bridgeProvider:ISWFBridgeProvider):void Adds a new bridge to the pod. | SWFBridgeGroup
|  | containsBridge(bridge:IEventDispatcher):Boolean Tests if the given bridge is one of the sandbox bridges in this group. | SWFBridgeGroup
|  | getChildBridgeProvider(bridge:IEventDispatcher):ISWFBridgeProvider Gets the owner of a bridge and also the DisplayObject that loaded the child. | SWFBridgeGroup
|  | getChildBridges():Array Gets all of the child bridges in this group. | SWFBridgeGroup
|  | removeChildBridge(bridge:IEventDispatcher):void Removes the child bridge. | SWFBridgeGroup

Property Detail

parentBridge | property

`parentBridge:IEventDispatcher`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

Allows communication with the parent if the parent is in a different sandbox. May be `null` if the parent is in the same sandbox or this is the top-level root application.

Implementation
`public function get parentBridge():IEventDispatcher`
`public function set parentBridge(value:IEventDispatcher):void`
Constructor Detail

SWFBridgeGroup | () | Constructor

`public function SWFBridgeGroup(owner:ISystemManager)`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

Constructor.

Parameters

| `owner:ISystemManager` — The DisplayObject that owns this group. This should be the SystemManager of an application.

Method Detail

addChildBridge | () | method

`public function addChildBridge(bridge:IEventDispatcher, bridgeProvider:ISWFBridgeProvider):void`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

Adds a new bridge to the pod.

Parameters

| `bridge:IEventDispatcher` — The bridge to communicate with the child content.
| `bridgeProvider:ISWFBridgeProvider` — The DisplayObject that loaded the content represented by the bridge. Usually this is will be an instance of the SWFLoader class.

containsBridge | () | method |

`public function containsBridge(bridge:IEventDispatcher):Boolean`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

Tests if the given bridge is one of the sandbox bridges in this group.

Parameters

| `bridge:IEventDispatcher` — The bridge to test.

Returns

| `Boolean` — `true` if the handle is found; otherwise `false`.

getChildBridgeProvider | () | method |

`public function getChildBridgeProvider(bridge:IEventDispatcher):ISWFBridgeProvider`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

Gets the owner of a bridge and also the DisplayObject that loaded the child. This method is useful when an event is received and the `event.target` is the bridge. The bridge can then be converted into the owning DisplayObject.

Parameters

| `bridge:IEventDispatcher` — The target bridge.

Returns

| `ISWFBridgeProvider` — The object that loaded the child.

getChildBridges | () | method |

`public function getChildBridges():Array`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

Gets all of the child bridges in this group.

Returns

| `Array` — An array of all the child bridges in this group. Each object in the array is of type `IEventDispatcher`.

removeChildBridge | () | method |

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

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

Removes the child bridge.

Parameters

| `bridge:IEventDispatcher` — The bridge to remove.

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