| Package | com.adobe.icc.editors.managers |
| Class | public class CategoryManager |
| Inheritance | CategoryManager  EventDispatcher Object |
| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Composer Building Block 10 |
| Runtime Versions: | AIR (unsupported), Flash Player 10.2 |
CategoryManager class helps retrieve and maintain
the list of categories and sub-categories existing in the system.
CategoryManager is a singleton class that acts as
the source of truth for listing the categories in the system. For
performance reasons, all application components should query the
CategoryManager instead of querying the server directly for
categories.
The CategoryManager caches the category and
sub-category and saves redundant server calls. The maintained lists
are auto-updated via LCDS server-push whenever a new category is
added or an existing category is updated locally or on remote clients.
Hide Inherited Public Properties
Show Inherited Public Properties| Property | Defined By | ||
|---|---|---|---|
| allCategories : IList
The aggregated list of all the categories present in the system. | CategoryManager | ||
 | constructor : Object
A reference to the class object or constructor function for a given object instance. | Object | |
| mainCategories : ListCollectionView
The list of categories existing in the system
| CategoryManager | ||
| subCategories : ListCollectionView
The list of sub-categories existing in the system
| CategoryManager | ||
| 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 | |
|
Dispatches an event into the event flow. | EventDispatcher | |
Fetches the categories from the backend server. | CategoryManager | ||
[static]
Gets the single instance of the CategoryManager class. | CategoryManager | ||
|
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 | |
|
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 | |
|
Checks whether an event listener is registered with this EventDispatcher object or any of
its ancestors for the specified event type. | EventDispatcher | |
| 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 the list of categories and subcategories have been successfully fetched from the server. | CategoryManager | |||
allCategories | property |
allCategories:IList| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Composer Building Block 10 |
| Runtime Versions: | AIR (unsupported), Flash Player 10.2 |
The aggregated list of all the categories present in the system. This list includes both categories and sub-categories.
Implementation
public function get allCategories():IList public function set allCategories(value:IList):voidmainCategories | property |
mainCategories:ListCollectionView| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Composer Building Block 10 |
| Runtime Versions: | AIR (unsupported), Flash Player 10.2 |
The list of categories existing in the 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 mainCategories():ListCollectionView public function set mainCategories(value:ListCollectionView):voidsubCategories | property |
subCategories:ListCollectionView| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Composer Building Block 10 |
| Runtime Versions: | AIR (unsupported), Flash Player 10.2 |
The list of sub-categories existing in the 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 subCategories():ListCollectionView public function set subCategories(value:ListCollectionView):voidfetchCategories | () | method |
public function fetchCategories():void| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Composer Building Block 10 |
| Runtime Versions: | AIR (unsupported), Flash Player 10.2 |
Fetches the categories from the backend server.
This method must be explicitly called at least once,
by the user application so as to let the CategoryManager
obtain the list of categories and sub-categories from the server.
Subsequent category updates or creations, either locally or remotely, are automatically pushed to the list properties.
getInstance | () | method |
public static function getInstance():CategoryManager| 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 CategoryManager class. This object manages the category and sub-category lists.
ReturnsCategoryManager — An object of type CategoryManager.
|
fetchComplete | Event |
flash.events.Eventproperty 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 categories and subcategories
have been successfully fetched from the server. The fetch request
can be made by invoking the fetchCategories() method
of this class. This event is dispatched when the asynchronous server
call completes.
Mon Apr 10 2017, 12:28 PM -07:00