mx.core.SWFBridgeGroup - Adobe® Flex® 4 Language Reference (Flex 4)

Package	mx.core
Class	public class SWFBridgeGroup
Inheritance	SWFBridgeGroup EventDispatcher Object
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

Hide Inherited Public Properties

Show Inherited Public Properties

	Property		Defined By
		constructor : Object A reference to the class object or constructor function for a given object instance.	Object
		parentBridge : IEventDispatcher Allows communication with the parent if the parent is in a different sandbox.	SWFBridgeGroup
		prototype : Object [static] A reference to the prototype object of a class or function object.	Object

Public Methods

Hide Inherited Public Methods

Show Inherited Public Methods

	Method		Defined By
		SWFBridgeGroup(owner:ISystemManager) Constructor.	SWFBridgeGroup
		addChildBridge(bridge:IEventDispatcher, bridgeProvider:ISWFBridgeProvider):void Adds a new bridge to the pod.	SWFBridgeGroup
		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
		containsBridge(bridge:IEventDispatcher):Boolean Tests if the given bridge is one of the sandbox bridges in this group.	SWFBridgeGroup
		dispatchEvent(event:Event):Boolean Dispatches an event into the event flow.	EventDispatcher
		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
		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
		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
		propertyIsEnumerable(name:String):Boolean Indicates whether the specified property exists and is enumerable.	Object
		removeChildBridge(bridge:IEventDispatcher):void Removes the child bridge.	SWFBridgeGroup
		removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void Removes a listener from the EventDispatcher object.	EventDispatcher
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Sets the availability of a dynamic property for loop operations.	Object
		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

	Event		Summary	Defined By
		activate	[broadcast event] Dispatched when the Flash Player or AIR application gains operating system focus and becomes active.	EventDispatcher
		deactivate	[broadcast event] Dispatched when the Flash Player or AIR application operating loses system focus and is becoming inactive.	EventDispatcher

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.