ActionScript® 3.0 Reference for the Adobe® Flash® Platform
Home  |  Show Packages and Classes List |  Packages  |  Classes  |  What's New  |  Index  |  Appendixes
com.adobe.icc.editors.managers 

DataDictionaryManager  - AS3 Asset Composer

Packagecom.adobe.icc.editors.managers
Classpublic class DataDictionaryManager
InheritanceDataDictionaryManager Inheritance EventDispatcher Inheritance Object

Language Version: ActionScript 3.0
Product Version: Asset Composer Building Block 10
Runtime Versions: AIR (unsupported), Flash Player 10.2

The DataDictionaryManager class helps retrieve and maintain the list of data dictionary names existing in the system.

DataDictionaryManager is a singleton class that acts as the source of truth for listing the data dictionary names in the system. For performance reasons, all application components should query the DataDictionaryManager instead of querying the server directly for data dictionaries.

The DataDictionaryManager caches the data dictionary names and saves redundant server calls. The maintained lists are auto-updated via LCDS server-push whenever a new data dictionary is added or an existing category is updated locally or on remote clients.



Public Properties
 PropertyDefined By
 Inheritedconstructor : Object
A reference to the class object or constructor function for a given object instance.
Object
  dataDictNames : IList
List of all data dictionary names of type non system.
DataDictionaryManager
Public Methods
 MethodDefined By
 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
  
Fetches the data dictionary names from the backend server.
DataDictionaryManager
  
[static] Gets the single instance of the DataDictionaryManager class.
DataDictionaryManager
 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
 Inherited
Indicates whether the specified property exists and is enumerable.
Object
 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
 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
 Inherited[broadcast event] Dispatched when the Flash Player or AIR application operating loses system focus and is becoming inactive.EventDispatcher
  Dispatched when the list of data dictionary names have been successfully fetched from the server.DataDictionaryManager
Property Detail

dataDictNames

property
dataDictNames:IList

Language Version: ActionScript 3.0
Product Version: Asset Composer Building Block 10
Runtime Versions: AIR (unsupported), Flash Player 10.2

List of all data dictionary names of type non system.

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 dataDictNames():IList
    public function set dataDictNames(value:IList):void
Method Detail

fetchDataDictNames

()method
public function fetchDataDictNames():void

Language Version: ActionScript 3.0
Product Version: Asset Composer Building Block 10
Runtime Versions: AIR (unsupported), Flash Player 10.2

Fetches the data dictionary names from the backend server.

This method must be explicitly called at least once, by the user application so as to let the DataDictionaryManager obtain the list of data dictionary names from the server.

Subsequent data dictionary updates or creations, either locally or remotely, are automatically pushed to the dataDictNames property.

getInstance

()method 
public static function getInstance():DataDictionaryManager

Language Version: ActionScript 3.0
Product Version: Asset Composer Building Block 10
Runtime Versions: AIR (unsupported), Flash Player 10.2

Gets the single instance of the DataDictionaryManager class. This object manages the list of data dictionary names.

Returns
DataDictionaryManager — An object of type DataDictionaryManager.
Event Detail

fetchComplete

Event
Event Object Type: flash.events.Event
property Event.type = flash.events.Event

Language Version: ActionScript 3.0
Product Version: Asset Composer Building Block 10
Runtime Versions: AIR (unsupported), Flash Player 10.2

Dispatched when the list of data dictionary names have been successfully fetched from the server. The fetch request can be made by invoking the fetchDataDictNames() method of this class. This event is dispatched when the asynchronous server call completes.