com.adobe.icc.editors.managers

# EditorConfigurationManager - AS3 Asset Composer

Package | com.adobe.icc.editors.managers
Class | public class EditorConfigurationManager
Inheritance | EditorConfigurationManager EventDispatcher Object

Language Version: | ActionScript 3.0

Product Version: | Asset Composer Building Block 10

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

The `EditorConfigurationManager` is the one-stop singleton for loading all kinds of configurations required for the CM Application to run correctly.

Public Properties
Hide Inherited Public Properties
Show Inherited Public Properties

| Property | Defined By
--- | --- | ---
|  | configProvider : XMLConfigProvider The TBX config provider. | EditorConfigurationManager
|  | constructor : Object A reference to the class object or constructor function for a given object instance. | Object
|  | flexConfiguration : FlexConfiguration The Flex configuration provider | EditorConfigurationManager
|  | postProcesses : IList The List of Post Processes | EditorConfigurationManager

Public Methods
Hide Inherited Public Methods
Show Inherited Public Methods

| Method | Defined By
--- | --- | ---
|  | 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
|  | getInstance(loadPostProcess:Boolean = true):EditorConfigurationManager [static] Gets the single instance of the EditorConfigurationManager class. | EditorConfigurationManager
|  | 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
|  | 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
|  | loadFlexConfiguration(reload:Boolean = false):void Loads the flex configuration from the server. | EditorConfigurationManager
|  | loadPostProcesses(reload:Boolean = false):void Loads list of processes for the Letter from the server. | EditorConfigurationManager
|  | loadTBXConfiguration():void Loads the xml configuration required by the Text Editor. | EditorConfigurationManager
|  | 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

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
|  | configFetched | Dispatched when the Text Editor's configuration is successfully loaded from the server. | EditorConfigurationManager
|  | deactivate | [broadcast event] Dispatched when the Flash Player or AIR application operating loses system focus and is becoming inactive. | EventDispatcher
|  | flexConfigurationFetched | Dispatched when the FlexConfiguration is successfully loaded from the server. | EditorConfigurationManager
|  | postProcessesFetched | Dispatched when the Post Processes List is loaded from the server. | EditorConfigurationManager

Property Detail

### configProvider

property

`configProvider:XMLConfigProvider`

Language Version: | ActionScript 3.0

Product Version: | Asset Composer Building Block 10

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

The TBX config provider.

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

Implementation
`public function get configProvider():XMLConfigProvider`
`public function set configProvider(value:XMLConfigProvider):void`

### flexConfiguration

property

`flexConfiguration:FlexConfiguration`

Language Version: | ActionScript 3.0

Product Version: | Asset Composer Building Block 10

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

The Flex configuration provider

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

Implementation
`public function get flexConfiguration():FlexConfiguration`
`public function set flexConfiguration(value:FlexConfiguration):void`

### postProcesses

property

`postProcesses:IList`

Language Version: | ActionScript 3.0

Product Version: | Asset Composer Building Block 10

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

The List of Post Processes

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

Implementation
`public function get postProcesses():IList`
`public function set postProcesses(value:IList):void`
Method Detail

### getInstance

()
method

`public static function getInstance(loadPostProcess:Boolean = true):EditorConfigurationManager`

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 EditorConfigurationManager class. This object helps you load various configuration required by the CM application.

Parameters

| `loadPostProcess:Boolean` (default = `true`)`` — The boolean value specifying if any post process is loaded.

Returns

| `EditorConfigurationManager` — An object of type EditorConfigurationManager.

### loadFlexConfiguration

()
method

`public function loadFlexConfiguration(reload:Boolean = false):void`

Language Version: | ActionScript 3.0

Product Version: | Asset Composer Building Block 10

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

Loads the flex configuration from the server.

Parameters

| `reload:Boolean` (default = `false`)`` — The boolean value specifying if the letter is being reloaded or not.

### loadPostProcesses

()
method

`public function loadPostProcesses(reload:Boolean = false):void`

Language Version: | ActionScript 3.0

Product Version: | Asset Composer Building Block 10

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

Loads list of processes for the Letter from the server.

Parameters

| `reload:Boolean` (default = `false`)`` — The flag indicating whether to reload the post processes from the server.

### loadTBXConfiguration

()
method

`public function loadTBXConfiguration():void`

Language Version: | ActionScript 3.0

Product Version: | Asset Composer Building Block 10

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

Loads the xml configuration required by the Text Editor.

Event Detail

### configFetched

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 Text Editor's configuration is successfully loaded from the server. The load request can be made by invoking the `loadTBXConfiguration()` method of this class. This event is dispatched when the asynchronous server call completes.

### flexConfigurationFetched

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 `FlexConfiguration` is successfully loaded from the server. The load request can be made by invoking the `loadFlexConfiguration()` method of this class. This event is dispatched when the asynchronous server call completes.

### postProcessesFetched

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 Post Processes List is loaded from the server. The load request can be made by invoking the `loadPostProcesses()` method of this class. This event is dispatched when the asynchronous server call completes.

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