ActionScript® 3.0 Reference for the Adobe® Flash® Platform
Home  |  Show Packages and Classes List |  Packages  |  Classes  |  What's New  |  Index  |  Appendixes
com.adobe.gravity.framework 

IApplicationDomainManager  - AS3 ADEP Client Component
Packagecom.adobe.gravity.framework
Interfacepublic interface IApplicationDomainManager

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Experience Services - Client Component Framework 10
Runtime Versions: AIR 1.1, Flash Player 9

The IApplicationDomainManager interface provides a mechanism to create ApplicationDomains such that they can be tracked, primarily for debugging purposes. Note that only ApplicationDomain objects that were returned from IApplicationDomainManager can be passed back in, since ApplicationDomain object are not necessarily persistent in the runtime (the runtime may create them as needed). Which is to say that ApplicationDomain.currentDomain may not return the same ApplicationDomain object that code was loaded into.


Public Methods
 MethodDefined By
  
addRef(applicationDomain:ApplicationDomain):void
Increment the reference count on the ApplicationDomain.
IApplicationDomainManager
  
create(parent:ApplicationDomain, name:String):ApplicationDomain
Create an ApplicationDomain with the given parent.
IApplicationDomainManager
  
decRef(applicationDomain:ApplicationDomain):void
Decrement the reference count on the ApplicationDomain.
IApplicationDomainManager
  
findObject(applicationDomain:ApplicationDomain, keyObject:Object):*
Find a tracked value object by ApplicationDomain and key object.
IApplicationDomainManager
  
getByName(name:String):ApplicationDomain
Return the ApplicationDomain for the provided name.
IApplicationDomainManager
  
getChildren(applicationDomain:ApplicationDomain):Array
Return the child ApplicationDomains of the provided ApplicationDomain.
IApplicationDomainManager
  
getName(applicationDomain:ApplicationDomain):String
Return the name of the provided ApplicationDomain.
IApplicationDomainManager
  
getParent(applicationDomain:ApplicationDomain):ApplicationDomain
Return the parent ApplicationDomain for the provided ApplicationDomain, or null if it didn't have one.
IApplicationDomainManager
  
getTopLevels():Array
Return the list of all top-level ApplicationDomains.
IApplicationDomainManager
  
register(domain:ApplicationDomain, parent:ApplicationDomain, name:String):void
Register an existing ApplicationDomain.
IApplicationDomainManager
  
trackObject(applicationDomain:ApplicationDomain, keyObject:Object, valueObject:Object):void
Track a value object by ApplicationDomain and a key object, using weak references.
IApplicationDomainManager
  
untrackObject(applicationDomain:ApplicationDomain, keyObject:Object):void
Stop tracking a value object by ApplicationDomain and key object.
IApplicationDomainManager
Method Detail

addRef

()method
public function addRef(applicationDomain:ApplicationDomain):void

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Experience Services - Client Component Framework 10
Runtime Versions: AIR 1.1, Flash Player 9

Increment the reference count on the ApplicationDomain. Use the decRef method to decrement the count. When the count reaches 0, the ApplicationDomain will be removed from tracking. Note that if the ApplicationDomain becomes unreferenced, it will be garbage collected regardless of the reference count.

Parameters

applicationDomain:ApplicationDomain — The ApplicationDomain for which to increment the reference count.

create

()method 
public function create(parent:ApplicationDomain, name:String):ApplicationDomain

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Experience Services - Client Component Framework 10
Runtime Versions: AIR 1.1, Flash Player 9

Create an ApplicationDomain with the given parent.

Parameters

parent:ApplicationDomain — The parent ApplicationDomain. May be null, in which case the ApplicationDomain is a top-level ApplicationDomain.
 
name:String — A name to associate with the ApplicationDomain. Specify null for an anonymous ApplicationDomain.

Returns
ApplicationDomain — The new ApplicationDomain.

decRef

()method 
public function decRef(applicationDomain:ApplicationDomain):void

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Experience Services - Client Component Framework 10
Runtime Versions: AIR 1.1, Flash Player 9

Decrement the reference count on the ApplicationDomain. Use the addRef method to decrement the count. When the count reaches 0, the ApplicationDomain will be removed from tracking. Note that if the ApplicationDomain becomes unreferenced, it will be garbage collected regardless of the reference count.

Parameters

applicationDomain:ApplicationDomain — The ApplicationDomain for which to decrement the reference count.

findObject

()method 
public function findObject(applicationDomain:ApplicationDomain, keyObject:Object):*

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Experience Services - Client Component Framework 10
Runtime Versions: AIR 1.1, Flash Player 9

Find a tracked value object by ApplicationDomain and key object.

Parameters

applicationDomain:ApplicationDomain — The applicationDomain key.
 
keyObject:Object — The key object.

Returns
* — The value object or null if not found.

getByName

()method 
public function getByName(name:String):ApplicationDomain

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Experience Services - Client Component Framework 10
Runtime Versions: AIR 1.1, Flash Player 9

Return the ApplicationDomain for the provided name.

Parameters

name:String — The name of the ApplicationDomain to retrieve.

Returns
ApplicationDomain — The ApplicationDomain with the specified name, or null if not present.

getChildren

()method 
public function getChildren(applicationDomain:ApplicationDomain):Array

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Experience Services - Client Component Framework 10
Runtime Versions: AIR 1.1, Flash Player 9

Return the child ApplicationDomains of the provided ApplicationDomain.

Parameters

applicationDomain:ApplicationDomain — The ApplicationDomain for which to retrieve the child ApplicationDomains.

Returns
Array — An Array containing the child ApplicationDomains.

getName

()method 
public function getName(applicationDomain:ApplicationDomain):String

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Experience Services - Client Component Framework 10
Runtime Versions: AIR 1.1, Flash Player 9

Return the name of the provided ApplicationDomain.

Parameters

applicationDomain:ApplicationDomain — The ApplicationDomain for which to retrieve the name.

Returns
String — The name provided when the domain was registered, or null if not present.

getParent

()method 
public function getParent(applicationDomain:ApplicationDomain):ApplicationDomain

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Experience Services - Client Component Framework 10
Runtime Versions: AIR 1.1, Flash Player 9

Return the parent ApplicationDomain for the provided ApplicationDomain, or null if it didn't have one.

Parameters

applicationDomain:ApplicationDomain — The ApplicationDomain for which to retrieve the parent.

Returns
ApplicationDomain — The parent ApplicationDomain.

getTopLevels

()method 
public function getTopLevels():Array

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Experience Services - Client Component Framework 10
Runtime Versions: AIR 1.1, Flash Player 9

Return the list of all top-level ApplicationDomains.

Returns
Array — An Array of ApplicationDomain objects.

register

()method 
public function register(domain:ApplicationDomain, parent:ApplicationDomain, name:String):void

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Experience Services - Client Component Framework 10
Runtime Versions: AIR 1.1, Flash Player 9

Register an existing ApplicationDomain.

Parameters

domain:ApplicationDomain — The ApplicationDomain to register.
 
parent:ApplicationDomain — The parent ApplicationDomain for the domain parameter, if it has one. Specify null if the domain parameter is a top-level ApplicationDomain.
 
name:String — A name to associate with the ApplicationDomain. The name must not already be registered, and must not be null.

trackObject

()method 
public function trackObject(applicationDomain:ApplicationDomain, keyObject:Object, valueObject:Object):void

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Experience Services - Client Component Framework 10
Runtime Versions: AIR 1.1, Flash Player 9

Track a value object by ApplicationDomain and a key object, using weak references.

Parameters

applicationDomain:ApplicationDomain — The applicationDomain key.
 
keyObject:Object — The key object.
 
valueObject:Object — The value object.

untrackObject

()method 
public function untrackObject(applicationDomain:ApplicationDomain, keyObject:Object):void

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Experience Services - Client Component Framework 10
Runtime Versions: AIR 1.1, Flash Player 9

Stop tracking a value object by ApplicationDomain and key object.

Parameters

applicationDomain:ApplicationDomain — The applicationDomain key.
 
keyObject:Object — The key object.



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

 

Legal Notices | Online Privacy Policy