com.adobe.icc.editors.handlers

# DataDictionaryHandler - AS3 Asset Composer

Package | com.adobe.icc.editors.handlers
Class | public class DataDictionaryHandler
Inheritance | DataDictionaryHandler 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 DataDictionary. 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
Hide Inherited Public Properties
Show Inherited Public Properties

| Property | Defined By
--- | --- | ---
|  | assetActions : IList The list of AssetAction objects maintained by this handler. | DataDictionaryHandler
|  | constructor : Object A reference to the class object or constructor function for a given object instance. | Object
|  | currentAction : AssetAction The action that the handler is currently executing. | DataDictionaryHandler
|  | selectedAssets : Array The array of data dictionary value objects currently selected by the user. | DataDictionaryHandler
|  | service : DataDictionaryRegistryService [static] The infrastructure service for handling transfer objects of type Data Dictionary. | DataDictionaryHandler

Public Methods
Hide Inherited Public Methods
Show Inherited Public Methods

| Method | Defined By
--- | --- | ---
|  | DataDictionaryHandler() Constructor. | DataDictionaryHandler
|  | 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
|  | createDataDictionary():void Called internally when this handler is handling an action of type Create. | DataDictionaryHandler
|  | dispatchEvent(event:Event):Boolean Dispatches an event into the event flow. | EventDispatcher
|  | editDataDictionary():void Called internally when this handler is handling an action of type Edit. | DataDictionaryHandler
|  | getAssetType():String Returns the asset type handled by this handler. | DataDictionaryHandler
|  | handleAction(event:AssetActionEvent):void Called the Asset Action is delegated to the handler | DataDictionaryHandler
|  | 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. | DataDictionaryHandler
|  | 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
|  | viewDataDictionary():void Called internally when this handler is handling an action of type View. | DataDictionaryHandler
|  | 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
--- | --- | ---
|  | deleteDataDictionary(showWaring:Boolean = true):mx.rpc:AsyncToken Called internally when this handler is handling an action of type Delete. | DataDictionaryHandler
|  | handleDefaultAction(event:AssetActionEvent):void handles the default Action(AssetActionEvent.ACTIN_DEFAULT) such as Item double click on search results grid. | DataDictionaryHandler
|  | handleImportManagerPopUp(event:AssetActionEvent):void Redispatching the asset action event to show the import Asset Popup | DataDictionaryHandler
|  | handleRevertToLastPublish():void Called internally when this handler is handling an action of type RevertToLastPublish. | DataDictionaryHandler
|  | launchExportPopUp():void Called internally when this handler is handling an action of type ExportPackage. | DataDictionaryHandler
|  | launchImportPopUp():void Called internally when this handler is handling an action of type ImportPackage. | DataDictionaryHandler
|  | markForPublish():void Called internally when this handler is handling action of type MarkForPublish This method modifies the state of asset to Ready to Publish . | DataDictionaryHandler
|  | publish():void Called internally when this handler is handling an action of type Publish. | DataDictionaryHandler
|  | revertToLastPublish(event:CloseEvent):void Called internally when the user selects the button on the Revert To Last Publish Pop up . | DataDictionaryHandler

Events
Click for more information on events
Hide Inherited Events
Show Inherited Events

| Event | Summary | Defined By
--- | --- | --- | ---
|  | activate | [broadcast event] Dispatched when the Flash Player or AIR application gains operating system focus and becomes active. | EventDispatcher
|  | assetActionsChanged | assetActionsChanged event is thrown by the Handler when the selected item in results viewer change and it updates the correct handler selected assets. | DataDictionaryHandler
|  | 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. | DataDictionaryHandler

Public Constants

| Constant | Defined By
--- | --- | ---
|  | ACTION_CREATE : String = "Create" [static] Constant for the name of the action related to creation of an asset. | DataDictionaryHandler
|  | ACTION_DELETE : String = "Delete" [static] Constant for the name of the action related to deletion of an asset. | DataDictionaryHandler
|  | ACTION_EDIT : String = "Edit" [static] Constant for the name of the action related to editing of an asset. | DataDictionaryHandler
|  | ACTION_EXPORTPACKAGE : String = "ExportPackage" [static] Constant for the name of the action related to exporting dependencies of an asset. | DataDictionaryHandler
|  | ACTION_IMPORTPACKAGE : String = "ImportPackage" [static] Constant for the name of the action related to importing dependencies of an asset. | DataDictionaryHandler
|  | ACTION_MARKFORPUBLISH : String = "MarkForPublish" [static] Constant for the name of the action related to activation of an asset. | DataDictionaryHandler
|  | ACTION_PUBLISH : String = "PublishDD" [static] Constant for the name of the action related to markforpublish of an asset. | DataDictionaryHandler
|  | ACTION_REVERTTOLASTPUBLISH : String = "RevertToLastPublish" [static] Constant for the name of the action related to revert to last publish of an asset. | DataDictionaryHandler
|  | ACTION_VIEW : String = "View" [static] Constant for the name of the action related to viewing of an asset. | DataDictionaryHandler
|  | ASSET_TYPE : String = "DataDictionary" [static] Constant for the Asset Type handled by this handler. | DataDictionaryHandler

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`

### currentAction

property

`currentAction:AssetAction`

Language Version: | ActionScript 3.0

Product Version: | Asset Composer Building Block 10.0

Runtime Versions: | AIR (unsupported), Flash Player 10.2

The action that the handler is currently executing. This is useful in cases when the editor needs to know the action that the working asset is being acted upon. For instance, the editor might need to disable some of the fields if it is a view action.

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 currentAction():AssetAction`
`public function set currentAction(value:AssetAction):void`

### 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 data dictionary 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 DataDictionary.

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`

### service

property

`public static var service:DataDictionaryRegistryService`

Language Version: | ActionScript 3.0

Product Version: | Asset Composer Building Block 10.0

Runtime Versions: | AIR (unsupported), Flash Player 10.2

The infrastructure service for handling transfer objects of type Data Dictionary.

Constructor Detail

### DataDictionaryHandler

()
Constructor

`public function DataDictionaryHandler()`

Language Version: | ActionScript 3.0

Product Version: | Asset Composer Building Block 10.0

Runtime Versions: | AIR (unsupported), Flash Player 10.2

Constructor.

Method Detail

### createDataDictionary

()
method

`public function createDataDictionary():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 Create. The default implementation creates a new data dictionary domain object, assigns it as the working asset and dispatches the launchEditor event so that the framework can display the editor window to the user. This method can be extended to override the creation behavior of this handler. For instance, if creation requires some preprocessing or some checks that need to be made, the same can be done by overriding this method.

### deleteDataDictionary

()
method

`protected function deleteDataDictionary(showWaring:Boolean = true):mx.rpc:AsyncToken`

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 Delete. The default implementation deletes s single selected DataDictionary. A confirmation Alert dialog is shown to the user but can be curbed by setting the showWarning flag value to false. The launchEditor event is never dispatched while handling the delete action.

Parameters

| `showWaring:Boolean` (default = `true`)`` — Should the warning be shown before deletion

Returns

| `mx.rpc:AsyncToken` — `AsyncToken` token

### editDataDictionary

()
method

`public function editDataDictionary():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 Edit. The default implementation creates a new data dictionary domain object from the selected data dictionary value object.

### 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

Called the Asset Action is delegated to the handler

Parameters

| `event:AssetActionEvent` — `AssetActionEvent` containing information about the action

### handleDefaultAction

()
method

`protected function handleDefaultAction(event:AssetActionEvent):void`

Language Version: | ActionScript 3.0

Product Version: | Asset Composer Building Block 10.0

Runtime Versions: | AIR (unsupported), Flash Player 10.2

handles the default Action(AssetActionEvent.ACTIN_DEFAULT) such as Item double click on search results grid. If user has edit permission, then asset is opened in edit mode. otherwise if user has view peermission then asset is opened in view mode.

Parameters

| `event:AssetActionEvent` — `AssetActionEvent` containing information about the action

### 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

Redispatching the asset action event to show the import Asset Popup

Parameters

| `event:AssetActionEvent` — `AssetActionEvent` containing information about the import action

### handleRevertToLastPublish

()
method

`protected function handleRevertToLastPublish():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 RevertToLastPublish. This method all the revert to last publish functionality and shows either alert or pop up of all the dependent assets.

### 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 .

### markForPublish

()
method

`protected function markForPublish():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 action of type MarkForPublish This method modifies the state of asset to Ready to Publish .

### publish

()
method

`protected function publish():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 Publish. This method publishes the asset using id of that asset.

### revertToLastPublish

()
method

`protected function revertToLastPublish(event:CloseEvent):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 the user selects the button on the Revert To Last Publish Pop up .

Parameters

| `event:CloseEvent` — `CloseEvent`

### viewDataDictionary

()
method

`public function viewDataDictionary():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 View. The default implementation creates a new data dictionary domain object from the selected data dictionary value object, assigns it as the working asset and dispatches the launchEditor event so that the framework can display the editor window to the user. This method can be extended to override the "view" behavior of this handler. For instance, if viewing action requires some preprocessing or some checks that need to be made, the same can be done by overriding this method.

Event Detail

### 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_CREATE

Constant

`public static const ACTION_CREATE:String = "Create"`

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 creation of an asset.

### ACTION_DELETE

Constant

`public static const ACTION_DELETE:String = "Delete"`

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 deletion of an asset.

### ACTION_EDIT

Constant

`public static const ACTION_EDIT:String = "Edit"`

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 editing of an asset.

### 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.

### ACTION_MARKFORPUBLISH

Constant

`public static const ACTION_MARKFORPUBLISH:String = "MarkForPublish"`

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 activation of an asset.

### ACTION_PUBLISH

Constant

`public static const ACTION_PUBLISH:String = "PublishDD"`

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 markforpublish of an asset.

### ACTION_REVERTTOLASTPUBLISH

Constant

`public static const ACTION_REVERTTOLASTPUBLISH:String = "RevertToLastPublish"`

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 revert to last publish of an asset.

### ACTION_VIEW

Constant

`public static const ACTION_VIEW:String = "View"`

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 viewing of an asset.

### ASSET_TYPE

Constant

`public static const ASSET_TYPE:String = "DataDictionary"`

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.

© 2015 Adobe Systems Incorporated. All rights reserved.
Mon Apr 10 2017, 12:28 PM -07:00