ActionScript® 3.0 Reference for the Adobe® Flash® Platform
Home  |  Show Packages and Classes List |  Packages  |  Classes  |  What's New  |  Index  |  Appendixes
mx.core 

SWFBridgeGroup  - AS3 Flex
Packagemx.core
Classpublic class SWFBridgeGroup
InheritanceSWFBridgeGroup Inheritance EventDispatcher Inheritance 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
 PropertyDefined By
 Inheritedconstructor : 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
Public Methods
 MethodDefined By
  
SWFBridgeGroup(owner:ISystemManager)
Constructor.
SWFBridgeGroup
  
addChildBridge(bridge:IEventDispatcher, bridgeProvider:ISWFBridgeProvider):void
Adds a new bridge to the pod.
SWFBridgeGroup
 Inherited
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
 Inherited
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
 Inherited
hasEventListener(type:String):Boolean
Checks whether the EventDispatcher object has any listeners registered for a specific type of event.
EventDispatcher
 Inherited
hasOwnProperty(name:String):Boolean
Indicates whether an object has a specified property defined.
Object
 Inherited
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
 Inherited
propertyIsEnumerable(name:String):Boolean
Indicates whether the specified property exists and is enumerable.
Object
  
removeChildBridge(bridge:IEventDispatcher):void
Removes the child bridge.
SWFBridgeGroup
 Inherited
removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void
Removes a listener from the EventDispatcher object.
EventDispatcher
 Inherited
setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void
Sets the availability of a dynamic property for loop operations.
Object
 Inherited
toLocaleString():String
Returns the string representation of this object, formatted according to locale-specific conventions.
Object
 Inherited
toString():String
Returns the string representation of the specified object.
Object
 Inherited
valueOf():Object
Returns the primitive value of the specified object.
Object
 Inherited
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
 Event Summary Defined By
 Inherited
activate
[broadcast event] Dispatched when the Flash Player or AIR application gains operating system focus and becomes active.EventDispatcher
 Inherited
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.



© 2014 Adobe Systems Incorporated. All rights reserved.
Thu Dec 4 2014, 05:50 PM -08:00
 

 

Legal Notices | Online Privacy Policy