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

AssetHandlerRegistry  - AS3 Asset Manager
Packagecom.adobe.livecycle.assetmanager.client.handler
Classpublic class AssetHandlerRegistry
InheritanceAssetHandlerRegistry Inheritance EventDispatcher Inheritance Object
Deprecated: Deprecated

Language Version: ActionScript 3.0
Product Version: Asset Manager Building Block 9.5
Runtime Versions: AIR 1.0, Flash Player 9, Flash Player 10

The central registry for all the available handlers in the system. A client application registers its handler here against an assetType, which is called when the user clicks an asset.


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
  
AssetHandlerRegistry()
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
dispatchEvent(event:Event):Boolean
Dispatches an event into the event flow.
EventDispatcher
  
getInstance():AssetHandlerRegistry
[static] A singleton that retrieves an AssetHandlerRegistry event.
AssetHandlerRegistry
 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
  
isRegistered(assetType:String):Boolean
Checks whether a handler is registered for a specified assetType.
AssetHandlerRegistry
  
lookup(assetType:String):IAssetHandler
Returns the assetHandler that corresponds to the specified assetType.
AssetHandlerRegistry
 Inherited
propertyIsEnumerable(name:String):Boolean
Indicates whether the specified property exists and is enumerable.
Object
  
register(handler:IAssetHandler):void
A singleton registry that is used to register an asset handler.
AssetHandlerRegistry
 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
  
start():void
Starts the registry that calls the initialize function of individual handlers.
AssetHandlerRegistry
 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
  
assetActionComplete
An event that is thrown when AssetHandler has completed the assetAction initiated by the user via the user interface.AssetHandlerRegistry
 Inherited
deactivate
[broadcast event] Dispatched when the Flash Player or AIR application operating loses system focus and is becoming inactive.EventDispatcher
  
disableUserInteraction
An event that is thrown when the handler is processing and wants the application to disable user interaction.AssetHandlerRegistry
  
enableUserInteraction
An event thrown when the handler is done processing and wants the application to reenable user interaction.AssetHandlerRegistry
  
launchEditor
The launchEditor event is thrown by the handler when the handler has prepared the working asset to be displayed in the corresponding editor.AssetHandlerRegistry
Public Constants
 ConstantDefined By
  DISABLE_USER_INTERACTION_EVENT : String = "disableUserInteraction"
[static] Defines a constant for an event type that disables user interaction with the application.
AssetHandlerRegistry
  ENABLE_USER_INTERACTION_EVENT : String = "enableUserInteraction"
[static] Defines a constant for an event type that enables users to interact with the application.
AssetHandlerRegistry
Constructor Detail

AssetHandlerRegistry

()Constructor
public function AssetHandlerRegistry()

Language Version: ActionScript 3.0
Product Version: Asset Manager Building Block 9.5
Runtime Versions: AIR 1.0, Flash Player 9, Flash Player 10

Constructor.

Method Detail

getInstance

()method
public static function getInstance():AssetHandlerRegistry

Language Version: ActionScript 3.0
Product Version: Asset Manager Building Block 9.5
Runtime Versions: AIR 1.0, Flash Player 9, Flash Player 10

A singleton that retrieves an AssetHandlerRegistry event.

Returns
AssetHandlerRegistry —

isRegistered

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

Language Version: ActionScript 3.0
Product Version: Asset Manager Building Block 9.5
Runtime Versions: AIR 1.0, Flash Player 9, Flash Player 10

Checks whether a handler is registered for a specified assetType.

Parameters

assetType:String — The asset to check.

Returns
Boolean — Specifies whether the handler is registered. If the value is true, it is registered.

lookup

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

Language Version: ActionScript 3.0
Product Version: Asset Manager Building Block 9.5
Runtime Versions: AIR 1.0, Flash Player 9, Flash Player 10

Returns the assetHandler that corresponds to the specified assetType.

Parameters

assetType:String — The asset type for which the assetHandler is required.

Returns
IAssetHandler — An interface implemented by all asset handlers.

register

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

Language Version: ActionScript 3.0
Product Version: Asset Manager Building Block 9.5
Runtime Versions: AIR 1.0, Flash Player 9, Flash Player 10

A singleton registry that is used to register an asset handler.

Parameters

handler:IAssetHandler — The handler to register.

start

()method 
public function start():void

Language Version: ActionScript 3.0
Product Version: Asset Manager Building Block 9.5
Runtime Versions: AIR 1.0, Flash Player 9, Flash Player 10

Starts the registry that calls the initialize function of individual handlers.

Event Detail

assetActionComplete

 Event
Event Object Type: com.adobe.livecycle.assetmanager.client.event.AssetActionCompleteEvent

Language Version: ActionScript 3.0
Product Version: Asset Manager Building Block 9.5
Runtime Versions: AIR 1.0, Flash Player 9, Flash Player 10

An event that is thrown when AssetHandler has completed the assetAction initiated by the user via the user interface.

disableUserInteraction

 Event  
Event Object Type: mx.events.FlexEvent

Language Version: ActionScript 3.0
Product Version: Asset Manager Building Block 9.5
Runtime Versions: AIR 1.0, Flash Player 9, Flash Player 10

An event that is thrown when the handler is processing and wants the application to disable user interaction.

enableUserInteraction

 Event  
Event Object Type: mx.events.FlexEvent

Language Version: ActionScript 3.0
Product Version: Asset Manager Building Block 9.5
Runtime Versions: AIR 1.0, Flash Player 9, Flash Player 10

An event thrown when the handler is done processing and wants the application to reenable user interaction.

launchEditor

 Event  
Event Object Type: mx.events.FlexEvent

Language Version: ActionScript 3.0
Product Version: Asset Manager Building Block 9.5
Runtime Versions: AIR 1.0, Flash Player 9, Flash Player 10

The launchEditor event is thrown by the handler when the handler has prepared the working asset to be displayed in the corresponding editor.

Constant Detail

DISABLE_USER_INTERACTION_EVENT

Constant
public static const DISABLE_USER_INTERACTION_EVENT:String = "disableUserInteraction"

Language Version: ActionScript 3.0
Product Version: Asset Manager Building Block 9.5
Runtime Versions: AIR 1.0, Flash Player 9, Flash Player 10

Defines a constant for an event type that disables user interaction with the application.

ENABLE_USER_INTERACTION_EVENT

Constant 
public static const ENABLE_USER_INTERACTION_EVENT:String = "enableUserInteraction"

Language Version: ActionScript 3.0
Product Version: Asset Manager Building Block 9.5
Runtime Versions: AIR 1.0, Flash Player 9, Flash Player 10

Defines a constant for an event type that enables users to interact with the application.




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

 

Legal Notices | Online Privacy Policy