| Package | com.adobe.icc.editors.model |
| Class | public class ModuleModel |
| Inheritance | ModuleModel  AssetModel EventDispatcher Object |
| Subclasses | ConditionModel, ImageModel, ListModel, TextModel |
| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Composer Building Block 9.5 |
| Runtime Versions: | AIR (unsupported), Flash Player 9, Flash Player 10 |
It contains several properties and methods pulled up from the concrete classes. In case, a new module is introduced in the system and a domain class needs to be written for it, this class should be extended even though it's not mandatory.
Hide Inherited Public Properties
Show Inherited Public Properties| Property | Defined By | ||
|---|---|---|---|
 | activeEndDate : Date
The activeEndDate of the underlying value object. | AssetModel | |
| activeStartDate : Date
The activeStartDate date of the underlying value object. | AssetModel | |
| category : Category
The Category of the underlying value object. | AssetModel | |
| comment : String
The comment of the underlying value object. | AssetModel | |
| constructor : Object
A reference to the class object or constructor function for a given object instance. | Object | |
| crxVersion : String
The crx version of the underlying value object. | AssetModel | |
| dataDictionary : DataDictionary
The typed DataDictionary object being used by this module. | ModuleModel | ||
| dataDictionaryName : String
The name of the data dictionary being used by this module. | ModuleModel | ||
| description : String
The description of the underlying value object. | AssetModel | |
| extendedProperties : Object
The extended properties of the underlying value object. | AssetModel | |
| id : String
The GUID of the underlying value object. | AssetModel | |
| isNew : Boolean
Indicates if this Asset is new. | AssetModel | |
| lastChangeBy : String
The lastChangeBy property of the underlying value object. | AssetModel | |
| name : String
The name of the underlying value object. | AssetModel | |
| prototype : Object [static]
A reference to the prototype object of a class or function object. | Object | |
| shallow : Boolean
Flag to indicate if the underlying value object is shallow. | ModuleModel | ||
| state : int
The state of the underlying value object. | AssetModel | |
| subCategory : Category
The Sub-Category of the underlying value object. | AssetModel | |
| variables : IList [read-only]
The variables defined within this module. | ModuleModel | ||
| version : int
The version of the underlying value object. | AssetModel | |
| vo : *
The value object which this asset domain object is built atop. | AssetModel | |
| 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 | |
[static]
Fetches a module by the given id and constructs the domain module object on top of it. | ModuleModel | ||
|
Dispatches an event into the event flow. | EventDispatcher | |
Fetches the complete value object via remoting call. | ModuleModel | ||
|
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 if the underlying value object is shallow. | ModuleModel | ||
|
Indicates whether the specified property exists and is enumerable. | Object | |
|
Removes a listener from the EventDispatcher object. | EventDispatcher | |
|
Saves the user edits for any asset. | AssetModel | |
Sets the data dictionary name to the one specified and also fetches the corresponding
DataDictionary object from the server. | ModuleModel | ||
[static]
This method lets you inject a custom implementation of the infrastructure data dictionary service. | ModuleModel | ||
|
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 | |
Runs the client validations and raises events of the type
AssetValidationEvent for notifying validation result. | ModuleModel | ||
|
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 | |
| Method | Defined By | ||
|---|---|---|---|
Fetches the data dictionary corresponding to the name specified. | ModuleModel | ||
| 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 this Module is completely fetched from the server. | ModuleModel | |||
dataDictionary | property |
dataDictionary:DataDictionary| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Composer Building Block 9.5 |
| Runtime Versions: | AIR (unsupported), Flash Player 9, Flash Player 10 |
The typed DataDictionary object being used by this module.
Assigning a value to this property updated the dataDictionaryName
as well but not the other way round.
This property can be used as the source for data binding. When this property is modified, it dispatches the ddChange event.
Implementation
public function get dataDictionary():DataDictionary public function set dataDictionary(value:DataDictionary):voiddataDictionaryName | property |
dataDictionaryName:String| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Composer Building Block 9.5 |
| Runtime Versions: | AIR (unsupported), Flash Player 9, Flash Player 10 |
The name of the data dictionary being used by this module.
Merely setting this property wouldn't cause the dataDictionary
to be retrieved. If the dataDictionary needs to be updated,
setDataDictionaryName() method must be used instead.
This property can be used as the source for data binding. When this property is modified, it dispatches the ddNameChange event.
Implementation
public function get dataDictionaryName():String public function set dataDictionaryName(value:String):voidRelated API Elements
shallow | property |
shallow:Boolean| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Composer Building Block 9.5 |
| Runtime Versions: | AIR (unsupported), Flash Player 9, Flash Player 10 |
Flag to indicate if the underlying value object is shallow.
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 shallow():Boolean public function set shallow(value:Boolean):voidvariables | property |
createFromId | () | method |
public static function createFromId(moduleId:String):ModuleModel| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Composer Building Block 9.5 |
| Runtime Versions: | AIR (unsupported), Flash Player 9, Flash Player 10 |
Fetches a module by the given id and constructs the domain module object on top of it.
Parameters
moduleId:String — The GUID of the module the domain object for which needs to be created.
|
ModuleModel — The module domain object.
|
fetchComplete | () | method |
public function fetchComplete():void| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Composer Building Block 9.5 |
| Runtime Versions: | AIR (unsupported), Flash Player 9, Flash Player 10 |
Fetches the complete value object via remoting call. This should be called when the underlying value object is shallow.
fetchDataDictionary | () | method |
protected function fetchDataDictionary():void| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Composer Building Block 9.5 |
| Runtime Versions: | AIR (unsupported), Flash Player 9, Flash Player 10 |
Fetches the data dictionary corresponding to the name specified.
isShallow | () | method |
public function isShallow():Boolean| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Composer Building Block 9.5 |
| Runtime Versions: | AIR (unsupported), Flash Player 9, Flash Player 10 |
Indicates if the underlying value object is shallow.
ReturnsBoolean — boolean indicating if the underlying value object is shallow.
|
setDataDictionaryName | () | method |
public function setDataDictionaryName(ddName:String, fetchDataDictionary:Boolean = true):void| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Composer Building Block 9.5 |
| Runtime Versions: | AIR (unsupported), Flash Player 9, Flash Player 10 |
Sets the data dictionary name to the one specified and also fetches the corresponding DataDictionary object from the server.
Parameters
ddName:String — Name of the data dictionary
| |
fetchDataDictionary:Boolean (default = true) |
setDataDictRegistryService | () | method |
public static function setDataDictRegistryService(value:DataDictionaryRegistryService):void| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Composer Building Block 9.5 |
| Runtime Versions: | AIR (unsupported), Flash Player 9, Flash Player 10 |
This method lets you inject a custom implementation of the infrastructure data dictionary service.
By default, the class DataDictionaryRegistryServiceImpl is used as the infrastructure service.
Parameters
value:DataDictionaryRegistryService — An implementation for DataDictionaryRegistryService.
|
validate | () | method |
public function validate():void| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Composer Building Block 9.5 |
| Runtime Versions: | AIR (unsupported), Flash Player 9, Flash Player 10 |
Runs the client validations and raises events of the type
AssetValidationEvent for notifying validation result.
This method is always called implicitly whenever the save()
method is invoked on any of the concrete module domain classes.
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 this Module is completely fetched from the server. Modules are often kept shallow in the Asset Manager and fetched completely only when necessary. The fetchComplete event is dispatched when the Module has been retrieved completely from the server.
Mon Nov 28 2011, 06:48 AM -08:00