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

Package | mx.core
Interface | public interface ISWFBridgeGroup extends flash.events.IEventDispatcher
Implementors | SWFBridgeGroup

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

A sandbox bridge group is a group of bridges that represent applications that this application can communicate with. This application can not share memory with, or can not have access to, the other applications in the group, but uses the bridge to communicate with these applications.

Public Properties

| Property | Defined By
--- | --- | ---
|  | parentBridge : IEventDispatcher The bridge that is used to communicate with this group's parent application. | ISWFBridgeGroup

Public Methods

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

Property Detail

parentBridge | property

`parentBridge:IEventDispatcher`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

The bridge that is used to communicate with this group's parent application.

Implementation
`public function get parentBridge():IEventDispatcher`
`public function set parentBridge(value:IEventDispatcher):void`
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