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 9.5 |
Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
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 |
Method | Defined By | ||
---|---|---|---|
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 | ||
Called internally when this handler is handling an action of type Create. | DataDictionaryHandler | ||
Dispatches an event into the event flow. | EventDispatcher | ||
Called internally when this handler is handling an action of type Edit. | DataDictionaryHandler | ||
Returns the asset type handled by this handler. | DataDictionaryHandler | ||
This method is invoked by the Asset Manager framework whenever the user requests an action
on an object of type Data Dictionary. | DataDictionaryHandler | ||
Checks whether the EventDispatcher object has any listeners registered for a specific type
of event. | EventDispatcher | ||
Indicates whether an object has a specified property defined. | Object | ||
Called by the Asset Manager framework to give the handlers time to initialize. | DataDictionaryHandler | ||
Indicates whether an instance of the Object class is in the prototype chain of the object specified
as the parameter. | Object | ||
Indicates whether the specified property exists and is enumerable. | Object | ||
Removes a listener from the EventDispatcher object. | EventDispatcher | ||
Sets the availability of a dynamic property for loop operations. | Object | ||
Returns the string representation of this object, formatted according to locale-specific conventions. | Object | ||
Returns the string representation of the specified object. | Object | ||
Returns the primitive value of the specified object. | Object | ||
Called internally when this handler is handling an action of type View. | DataDictionaryHandler | ||
Checks whether an event listener is registered with this EventDispatcher object or any of
its ancestors for the specified event type. | EventDispatcher |
Method | Defined By | ||
---|---|---|---|
Called internally when this handler is handling an action of type Delete. | DataDictionaryHandler | ||
Handles the default Action, that is, AssetActionEvent.ACTIN_DEFAULT. | DataDictionaryHandler |
Event | Summary | Defined By | ||
---|---|---|---|---|
[broadcast event] Dispatched when the Flash Player or AIR application gains operating system focus and becomes active. | EventDispatcher | |||
[broadcast event] Dispatched when the Flash Player or AIR application operating loses system focus and is becoming inactive. | EventDispatcher | |||
Dispatched when an action handled by this handler requires an editor window to be launched. | DataDictionaryHandler |
Constant | Defined By | ||
---|---|---|---|
ACTION_CREATE : String = "Create" [static]
Specifies the name of the action related to the creation of an asset. | DataDictionaryHandler | ||
ACTION_DELETE : String = "Delete" [static]
Specifies the name of the action related to the deletion of an asset. | DataDictionaryHandler | ||
ACTION_EDIT : String = "Edit" [static]
Specifies the name of the action related to editing an asset. | DataDictionaryHandler | ||
ACTION_VIEW : String = "View" [static]
Specifies the name of the action related to viewing an asset. | DataDictionaryHandler | ||
ASSET_TYPE : String = "DataDictionary" [static]
Specifies the asset type handled by this handler. | DataDictionaryHandler |
assetActions | property |
assetActions:IList
Language Version: | ActionScript 3.0 |
Product Version: | Asset Composer Building Block 9.5 |
Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
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 which action to enable. The handler updates the flags every time 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 9.5 |
Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
The action that the handler is currently executing. This is useful when the editor needs to know the action that the working asset is being acted upon. For instance, for a view action, the editor needs to disable some of the fields.
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 9.5 |
Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
The array of data dictionary value objects currently selected by the user. This is set by the Asset Manager framework every time 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 9.5 |
Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
The infrastructure service for handling transfer objects of type Data Dictionary.
DataDictionaryHandler | () | Constructor |
public function DataDictionaryHandler()
Language Version: | ActionScript 3.0 |
Product Version: | Asset Composer Building Block 9.5 |
Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
Constructor.
createDataDictionary | () | method |
public function createDataDictionary():void
Language Version: | ActionScript 3.0 |
Product Version: | Asset Composer Building Block 9.5 |
Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
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 example, if creation requires some preprocessing or some checks need to be made.
deleteDataDictionary | () | method |
protected function deleteDataDictionary(showWaring:Boolean = true):mx.rpc:AsyncToken
Language Version: | ActionScript 3.0 |
Product Version: | Asset Composer Building Block 9.5 |
Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
Called internally when this handler is handling an action of type Delete. The default implementation deletes a single selected DataDictionary. A confirmation Alert dialog box is displayed to the user. To prevent this dialog box from being displayed, set the showWarning flag value to false. The launchEditor event is never dispatched while handling the delete action.
Parameters
showWaring:Boolean (default = true ) — Specifies whether the user is prompted to confirm a deletion.
|
mx.rpc:AsyncToken — The AsyncToken associated with the operation.
|
editDataDictionary | () | method |
public function editDataDictionary():void
Language Version: | ActionScript 3.0 |
Product Version: | Asset Composer Building Block 9.5 |
Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
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 9.5 |
Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
Returns the asset type handled by this handler. This is used by the Asset Manager framework to route actions to the appropriate handlers.
ReturnsString — A string that represents the asset type.
|
handleAction | () | method |
public function handleAction(event:AssetActionEvent):void
Language Version: | ActionScript 3.0 |
Product Version: | Asset Composer Building Block 9.5 |
Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
This method is invoked by the Asset Manager framework whenever the user requests an action on an object of type Data Dictionary. This method is called for all of the actions requested by the user. This method internally routes action handling to the appropriate templatized method, such as createDataDictionary() or editDataDictionary().
Parameters
event:AssetActionEvent — The event object of type AssetActionEvent that is raised by the Asset Manager framework.
|
handleDefaultAction | () | method |
protected function handleDefaultAction(event:AssetActionEvent):void
Language Version: | ActionScript 3.0 |
Product Version: | Asset Composer Building Block 9.5 |
Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
Handles the default Action, that is, AssetActionEvent.ACTIN_DEFAULT. For example, double-clicking an item in the search results grid. If the user has edit permission, the asset opens in edit mode. If user has view permission, the asset opens in view mode.
Parameters
event:AssetActionEvent — The event object of type AssetActionEvent that is dispatched by the Asset Manager framework.
|
initialize | () | method |
public function initialize():void
Language Version: | ActionScript 3.0 |
Product Version: | Asset Composer Building Block 9.5 |
Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
Called by the Asset Manager framework to give the handlers time to initialize.
viewDataDictionary | () | method |
public function viewDataDictionary():void
Language Version: | ActionScript 3.0 |
Product Version: | Asset Composer Building Block 9.5 |
Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
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 example, if the viewing action requires some preprocessing or some checks need to be made.
launchEditor | Event |
mx.events.FlexEvent
Dispatched when an action handled by this handler requires an editor window to be launched. The actions that require the editor window to be displayed are Create, View, Edit, and Copy.
ACTION_CREATE | Constant |
public static const ACTION_CREATE:String = "Create"
Language Version: | ActionScript 3.0 |
Product Version: | Asset Composer Building Block 9.5 |
Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
Specifies the name of the action related to the 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 9.5 |
Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
Specifies the name of the action related to the 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 9.5 |
Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
Specifies the name of the action related to editing an asset.
ACTION_VIEW | Constant |
public static const ACTION_VIEW:String = "View"
Language Version: | ActionScript 3.0 |
Product Version: | Asset Composer Building Block 9.5 |
Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
Specifies the name of the action related to viewing an asset.
ASSET_TYPE | Constant |
public static const ASSET_TYPE:String = "DataDictionary"
Language Version: | ActionScript 3.0 |
Product Version: | Asset Composer Building Block 9.5 |
Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
Specifies the asset type handled by this handler.
Wed Nov 21 2018, 06:34 AM -08:00