BaseAssetHandler

Package	com.adobe.icc.editors.handlers
Class	public class BaseAssetHandler
Inheritance	BaseAssetHandler EventDispatcher Object
Implements	IAssetHandler

Language Version:

ActionScript 3.0

Product Version:

Asset Composer Building Block 10

Runtime Versions:

AIR (unsupported), Flash Player 10.2

The Handler for the actions requested for asset of type Text. Handlers are registered with the AssetHandlerRegistry and come into picture when an action is requested on assets that the handlers associate themselves with.

Public Properties

	Property		Defined By
		assetActions : IList The list of AssetAction objects maintained by this handler.	BaseAssetHandler
		assetType : String The type of asset being handled by this handler.	BaseAssetHandler
		constructor : Object A reference to the class object or constructor function for a given object instance.	Object
		selectedAssets : Array The array of text value objects currently selected by the user.	BaseAssetHandler

Public Methods

	Method		Defined By
		BaseAssetHandler(assetType:String) Constructor.	BaseAssetHandler
		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
		dispatchEvent(event:Event):Boolean Dispatches an event into the event flow.	EventDispatcher
		getAssetType():String Returns the asset type handled by this handler.	BaseAssetHandler
		handleAction(event:AssetActionEvent):void This method is invoked by the asset manager framework whenever user requests an action on an object of type dataModule and then it delegates call to its respective handler.	BaseAssetHandler
		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
		initialize():void Called by the asset manager framework giving the handlers a chance to initialize themselves.	BaseAssetHandler
		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
		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

Protected Methods

	Method		Defined By
		handleImportManagerPopUp(event:AssetActionEvent):void Dispatch Asset Action Event thrown by the export manager so that i could be listened in the Amapplication.as	BaseAssetHandler
		launchExportPopUp():void Called internally when this handler is handling an action of type ExportPackage.	BaseAssetHandler
		launchImportPopUp():void Called internally when this handler is handling an action of type ImportPackage.	BaseAssetHandler

Events

Click for more information on events

	Summary	Defined By
activate	[broadcast event] Dispatched when the Flash Player or AIR application gains operating system focus and becomes active.	EventDispatcher
assetActionComplete	Dispatched when the handling of an action is complete.	BaseAssetHandler
assetActionsChanged	assetActionsChanged event is thrown by the Handler when the selected item in results viewer change and it updates the correct handler selected assets.	BaseAssetHandler
deactivate	[broadcast event] Dispatched when the Flash Player or AIR application operating loses system focus and is becoming inactive.	EventDispatcher
launchEditor	Dispatched when an action handled by this handler requires an editor window to be launched.	BaseAssetHandler

Public Constants

	Constant		Defined By
		ACTION_EXPORTPACKAGE : String = "ExportPackage" [static] Constant for the name of the action related to exporting dependencies of an asset.	BaseAssetHandler
		ACTION_IMPORTPACKAGE : String = "ImportPackage" [static] Constant for the name of the action related to importing dependencies of an asset.	BaseAssetHandler
		ASSET_TYPE : String = "Asset" [static] Constant for the Asset Type handled by this handler.	BaseAssetHandler
		DATA_ASSET_TYPE : String = "DataModule" [static] Constant for the Data Module handled by this handler	BaseAssetHandler

Property Detail

assetActions

property

assetActions:IList

Language Version:

ActionScript 3.0

Product Version:

Asset Composer Building Block 10.0

Runtime Versions:

AIR (unsupported), Flash Player 10.2

The list of AssetAction objects maintained by this handler. This list is used by the asset manager framework to determine which action to enable. The asset manager framework looks for the value of the enabled flag in the AssetAction object to determine the same and handler updates the flags everytime the list of selected assets changes.

This property can be used as the source for data binding. When this property is modified, it dispatches the propertyChange event.

Implementation
public function get assetActions():IList
public function set assetActions(value:IList):void

assetType

property

public var assetType:String

Language Version:

ActionScript 3.0

Product Version:

Asset Composer Building Block 10.0

Runtime Versions:

AIR (unsupported), Flash Player 10.2

The type of asset being handled by this handler.

selectedAssets

property

selectedAssets:Array

Language Version:

ActionScript 3.0

Product Version:

Asset Composer Building Block 10.0

Runtime Versions:

AIR (unsupported), Flash Player 10.2

The array of text value objects currently selected by the user. This is set by the asset manager framework everytime a user selects or deselects an item of type text.

This property can be used as the source for data binding. When this property is modified, it dispatches the propertyChange event.

Implementation
public function get selectedAssets():Array
public function set selectedAssets(value:Array):void

Constructor Detail

BaseAssetHandler

()

Constructor

public function BaseAssetHandler(assetType:String)

Language Version:

ActionScript 3.0

Product Version:

Asset Composer Building Block 10.0

Runtime Versions:

AIR (unsupported), Flash Player 10.2

Constructor.

Parameters

assetType:String — Asset Type associated with the handler

Method Detail

getAssetType

()

method

public function getAssetType():String

Language Version:

ActionScript 3.0

Product Version:

Asset Composer Building Block 10.0

Runtime Versions:

AIR (unsupported), Flash Player 10.2

Returns the asset type handled by this handler. This is used by the asset manager framework to route actions to appropriate handlers.

Returns

String — the asset type handled by this handler

handleAction

()

method

public function handleAction(event:AssetActionEvent):void

Language Version:

ActionScript 3.0

Product Version:

Asset Composer Building Block 10.0

Runtime Versions:

AIR (unsupported), Flash Player 10.2

This method is invoked by the asset manager framework whenever user requests an action on an object of type dataModule and then it delegates call to its respective handler. This method is called for all the actions requested by the user. The action handling is internally routed to the correcting templatized methods like createImage(), editImage() etc.

Parameters

event:AssetActionEvent — The event object of type AssetActionEvent that is raised by the asset manager framework

handleImportManagerPopUp

()

method

protected function handleImportManagerPopUp(event:AssetActionEvent):void

Language Version:

ActionScript 3.0

Product Version:

Asset Composer Building Block 10.0

Runtime Versions:

AIR (unsupported), Flash Player 10.2

Dispatch Asset Action Event thrown by the export manager so that i could be listened in the Amapplication.as

Parameters

event:AssetActionEvent — AssetActionEvent containing information about the import action

initialize

()

method

public function initialize():void

Language Version:

ActionScript 3.0

Product Version:

Asset Composer Building Block 10.0

Runtime Versions:

AIR (unsupported), Flash Player 10.2

Called by the asset manager framework giving the handlers a chance to initialize themselves.

launchExportPopUp

()

method

protected function launchExportPopUp():void

Language Version:

ActionScript 3.0

Product Version:

Asset Composer Building Block 10.0

Runtime Versions:

AIR (unsupported), Flash Player 10.2

Called internally when this handler is handling an action of type ExportPackage. This method launches the export Pop up to display all the assets to be exported .

launchImportPopUp

()

method

protected function launchImportPopUp():void

Language Version:

ActionScript 3.0

Product Version:

Asset Composer Building Block 10.0

Runtime Versions:

AIR (unsupported), Flash Player 10.2

Called internally when this handler is handling an action of type ImportPackage. This method launches the import Pop up to display all the assets to be imported .

Event Detail

assetActionComplete

Event

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

Language Version:

ActionScript 3.0

Product Version:

Asset Composer Building Block 10

Runtime Versions:

AIR (unsupported), Flash Player 10.2

Dispatched when the handling of an action is complete. This can be used by the framework or the application to perform any additional activities e.g. display of a toast, alert box etc.

assetActionsChanged

Event

Event Object Type: com.adobe.livecycle.assetmanager.client.event.AssetActionsChangeEvent
property AssetActionsChangeEvent.type = com.adobe.livecycle.assetmanager.client.event.AssetActionsChangeEvent

Language Version:

ActionScript 3.0

Product Version:

Asset Composer Building Block 10

Runtime Versions:

AIR (unsupported), Flash Player 10.2

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

launchEditor

Event

Event Object Type: com.adobe.livecycle.assetmanager.client.event.AssetActionEvent
property AssetActionEvent.type = com.adobe.livecycle.assetmanager.client.event.AssetActionEvent

Language Version:

ActionScript 3.0

Product Version:

Asset Composer Building Block 10

Runtime Versions:

AIR (unsupported), Flash Player 10.2

Dispatched when an action handled by this handler requires an editor window to be launched. Create/View/Edit/Copy are the actions that require displaying the editor window to the user.

Constant Detail

ACTION_EXPORTPACKAGE

Constant

public static const ACTION_EXPORTPACKAGE:String = "ExportPackage"

Language Version:

ActionScript 3.0

Product Version:

Asset Composer Building Block 10.0

Runtime Versions:

AIR (unsupported), Flash Player 10.2

Constant for the name of the action related to exporting dependencies of an asset.

ACTION_IMPORTPACKAGE

Constant

public static const ACTION_IMPORTPACKAGE:String = "ImportPackage"

Language Version:

ActionScript 3.0

Product Version:

Asset Composer Building Block 10.0

Runtime Versions:

AIR (unsupported), Flash Player 10.2

Constant for the name of the action related to importing dependencies of an asset.

ASSET_TYPE

Constant

public static const ASSET_TYPE:String = "Asset"

Language Version:

ActionScript 3.0

Product Version:

Asset Composer Building Block 10.0

Runtime Versions:

AIR (unsupported), Flash Player 10.2

Constant for the Asset Type handled by this handler.

DATA_ASSET_TYPE

Constant

public static const DATA_ASSET_TYPE:String = "DataModule"

Language Version:

ActionScript 3.0

Product Version:

Asset Composer Building Block 10.0

Runtime Versions:

AIR (unsupported), Flash Player 10.2

Constant for the Data Module handled by this handler

Legal Notices | Online Privacy Policy

BaseAssetHandler - AS3 Asset Composer

Classes x

assetActions

assetType

selectedAssets

BaseAssetHandler

getAssetType

handleAction

handleImportManagerPopUp

initialize

launchExportPopUp

launchImportPopUp

assetActionComplete

assetActionsChanged

launchEditor

ACTION_EXPORTPACKAGE

ACTION_IMPORTPACKAGE

ASSET_TYPE

DATA_ASSET_TYPE