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

AssetHandlerRegistry  - AS3 ADEP Content

Packagecom.adobe.ep.ux.content.handlers
Classpublic class AssetHandlerRegistry
InheritanceAssetHandlerRegistry Inheritance EventDispatcher Inheritance Object

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Experience Services - Content 10
Runtime Versions: Flash Player 10.2, AIR (unsupported)

This is the central registry for all the available handlers in the system. A client application can register it's handler here against an assetType, which will be called when a asset is clicked.



Public Properties
 PropertyDefined By
 Inheritedconstructor : Object
A reference to the class object or constructor function for a given object instance.
Object
Public Methods
 MethodDefined By
  
Constructor
AssetHandlerRegistry
 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
 Inherited
Dispatches an event into the event flow.
EventDispatcher
  
[static] Singleton to get AssetHandlerRegistry.
AssetHandlerRegistry
 Inherited
Checks whether the EventDispatcher object has any listeners registered for a specific type of event.
EventDispatcher
 Inherited
Indicates whether an object has a specified property defined.
Object
 Inherited
Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.
Object
  
Checks whether a handler is registered for give assetType.
AssetHandlerRegistry
  
returns the assetHandler corresponding to given assetType
AssetHandlerRegistry
 Inherited
Indicates whether the specified property exists and is enumerable.
Object
  
Register an Asset Handler in this Singleton registry.
AssetHandlerRegistry
 Inherited
removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void
Removes a listener from the EventDispatcher object.
EventDispatcher
 Inherited
Sets the availability of a dynamic property for loop operations.
Object
  
Start the registry which calls the initialize function of individual handlers.
AssetHandlerRegistry
 Inherited
Returns the string representation of this object, formatted according to locale-specific conventions.
Object
 Inherited
Returns the string representation of the specified object.
Object
 Inherited
Returns the primitive value of the specified object.
Object
 Inherited
Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type.
EventDispatcher
Events
 Event Summary Defined By
 Inherited[broadcast event] Dispatched when the Flash Player or AIR application gains operating system focus and becomes active.EventDispatcher
  assetActionComplete event thrown when AssetHandler has completed the assetAction taken by user through ui.AssetHandlerRegistry
  assetActionsChanged event is thrown by the Handler when the selected item in results viewer change and it updates the correct handler selected assets.AssetHandlerRegistry
 Inherited[broadcast event] Dispatched when the Flash Player or AIR application operating loses system focus and is becoming inactive.EventDispatcher
  Event thrown when handler is doing some processing and it wants Application to disable user interactionAssetHandlerRegistry
  Event thrown when handler has done processing and it wants Application to re-enable user interactionAssetHandlerRegistry
  launchEditor event is thrown by the Handler when handler has prepared the working asset to dispaly that in corresponding editorAssetHandlerRegistry
Public Constants
 ConstantDefined By
  ASSET_ACTIONS_CHANGED : String = "assetActionsChanged"
[static] This constant specifies the event that the asset actions have changed
AssetHandlerRegistry
  DISABLE_USER_INTERACTION_EVENT : String = "disableUserInteraction"
[static] This constant specifies the event which disables the user interaction
AssetHandlerRegistry
  ENABLE_USER_INTERACTION_EVENT : String = "enableUserInteraction"
[static] This constant specifies the type of event which enables the user interaction
AssetHandlerRegistry
Constructor Detail

AssetHandlerRegistry

()Constructor
public function AssetHandlerRegistry()

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Experience Services - Content 10
Runtime Versions: Flash Player 10.2, AIR (unsupported)

Constructor

Method Detail

getInstance

()method
public static function getInstance():AssetHandlerRegistry

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Experience Services - Content 10
Runtime Versions: Flash Player 10.2, AIR (unsupported)

Singleton to get AssetHandlerRegistry.

Returns
AssetHandlerRegistry — An instance of Asset Handler Registry to manage the registry of Asset Handlers

isRegistered

()method 
public function isRegistered(assetType:String):Boolean

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Experience Services - Content 10
Runtime Versions: Flash Player 10.2, AIR (unsupported)

Checks whether a handler is registered for give assetType.

Parameters

assetType:String — The type of Asset

Returns
Boolean — True if the asset handler is registered else return false

lookup

()method 
public function lookup(assetType:String):IAssetHandler

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Experience Services - Content 10
Runtime Versions: Flash Player 10.2, AIR (unsupported)

returns the assetHandler corresponding to given assetType

Parameters

assetType:String — The type of asset for which the handler is required

Returns
IAssetHandler — The handler registered for given parameter

register

()method 
public function register(handler:IAssetHandler):void

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Experience Services - Content 10
Runtime Versions: Flash Player 10.2, AIR (unsupported)

Register an Asset Handler in this Singleton registry.

Parameters

handler:IAssetHandler — The Handler to register

start

()method 
public function start():void

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Experience Services - Content 10
Runtime Versions: Flash Player 10.2, AIR (unsupported)

Start the registry which calls the initialize function of individual handlers.

Event Detail

assetActionComplete

Event
Event Object Type: com.adobe.ep.ux.content.event.AssetActionCompleteEvent

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Experience Services - Content 10
Runtime Versions: Flash Player 10.2, AIR (unsupported)

assetActionComplete event thrown when AssetHandler has completed the assetAction taken by user through ui.

assetActionsChanged

Event  
Event Object Type: com.adobe.ep.ux.content.event.AssetActionsChangeEvent

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Experience Services - Content 10
Runtime Versions: Flash Player 10.2, AIR (unsupported)

assetActionsChanged event is thrown by the Handler when the selected item in results viewer change and it updates the correct handler selected assets. It is redispatched by the AssetHandlerRegistry and finally handled by AssetManagerView

disableUserInteraction

Event  
Event Object Type: mx.events.FlexEvent

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Experience Services - Content 10
Runtime Versions: Flash Player 10.2, AIR (unsupported)

Event thrown when handler is doing some processing and it wants Application to disable user interaction

enableUserInteraction

Event  
Event Object Type: mx.events.FlexEvent

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Experience Services - Content 10
Runtime Versions: Flash Player 10.2, AIR (unsupported)

Event thrown when handler has done processing and it wants Application to re-enable user interaction

launchEditor

Event  
Event Object Type: mx.events.FlexEvent

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Experience Services - Content 10
Runtime Versions: Flash Player 10.2, AIR (unsupported)

launchEditor event is thrown by the Handler when handler has prepared the working asset to dispaly that in corresponding editor

Constant Detail

ASSET_ACTIONS_CHANGED

Constant
public static const ASSET_ACTIONS_CHANGED:String = "assetActionsChanged"

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Experience Services - Content 10
Runtime Versions: Flash Player 10.2, AIR (unsupported)

This constant specifies the event that the asset actions have changed

DISABLE_USER_INTERACTION_EVENT

Constant 
public static const DISABLE_USER_INTERACTION_EVENT:String = "disableUserInteraction"

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Experience Services - Content 10
Runtime Versions: Flash Player 10.2, AIR (unsupported)

This constant specifies the event which disables the user interaction

ENABLE_USER_INTERACTION_EVENT

Constant 
public static const ENABLE_USER_INTERACTION_EVENT:String = "enableUserInteraction"

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Experience Services - Content 10
Runtime Versions: Flash Player 10.2, AIR (unsupported)

This constant specifies the type of event which enables the user interaction