com.adobe.icc.editors.model

# ModuleAssignmentModel - AS3 Asset Composer

Package | com.adobe.icc.editors.model
Class | public class ModuleAssignmentModel
Inheritance | ModuleAssignmentModel EventDispatcher Object

Language Version: | ActionScript 3.0

Product Version: | Asset Composer Building Block 9.5

Runtime Versions: | AIR (unsupported), Flash Player 9, Flash Player 10

The domain class for the module assignments in a Letter's target area assignment.

Related API Elements

com.adobe.icc.editors.model.TargetAreaAssignmentModel

Public Properties
Hide Inherited Public Properties
Show Inherited Public Properties

| Property | Defined By
--- | --- | ---
|  | constructor : Object A reference to the class object or constructor function for a given object instance. | Object
|  | dataModel : ModuleModel The domain object of the module associated with this assignment. | ModuleAssignmentModel
|  | dataModule : DataModule The value object of the module associated with this assignment. | ModuleAssignmentModel
|  | editable : Boolean The editable property of the underlying value object. | ModuleAssignmentModel
|  | indentationLevel : Number The indentationLevel property of the underlying value object. | ModuleAssignmentModel
|  | optional : Boolean The optional property of the underlying value object. | ModuleAssignmentModel
|  | position : int Fetches the position of Module relative to other modules in the target area. | ModuleAssignmentModel
|  | preSelected : Boolean The preSelected property of the underlying value object. | ModuleAssignmentModel
|  | variables : IList [read-only] The list of variables exposed by the module associated with this assignment. | ModuleAssignmentModel
|  | vo : ModuleAssignment The underlying value object for this module assignment. | ModuleAssignmentModel

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
|  | createFromModule(module:*):ModuleAssignmentModel [static] Constructs the domain object from a data module. | ModuleAssignmentModel
|  | createFromVO(vo:ModuleAssignment):ModuleAssignmentModel [static] Constructs the domain object from its value object counterpart. | ModuleAssignmentModel
|  | dispatchEvent(event:Event):Boolean Dispatches an event into the event flow. | EventDispatcher
|  | 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
|  | 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
|  | deactivate | [broadcast event] Dispatched when the Flash Player or AIR application operating loses system focus and is becoming inactive. | EventDispatcher

Property Detail

### dataModel

property

`dataModel:ModuleModel`

Language Version: | ActionScript 3.0

Product Version: | Asset Composer Building Block 9.5

Runtime Versions: | AIR (unsupported), Flash Player 9, Flash Player 10

The domain object of the module associated with this assignment.

Implementation
`public function get dataModel():ModuleModel`
`public function set dataModel(value:ModuleModel):void`

### dataModule

property

`dataModule:DataModule`

Language Version: | ActionScript 3.0

Product Version: | Asset Composer Building Block 9.5

Runtime Versions: | AIR (unsupported), Flash Player 9, Flash Player 10

The value object of the module associated with this assignment.

Implementation
`public function get dataModule():DataModule`
`public function set dataModule(value:DataModule):void`

### editable

property

`editable:Boolean`

Language Version: | ActionScript 3.0

Product Version: | Asset Composer Building Block 9.5

Runtime Versions: | AIR (unsupported), Flash Player 9, Flash Player 10

The editable property of the underlying value object.

Implementation
`public function get editable():Boolean`
`public function set editable(value:Boolean):void`

### indentationLevel

property

`indentationLevel:Number`

Language Version: | ActionScript 3.0

Product Version: | Asset Composer Building Block 9.5

Runtime Versions: | AIR (unsupported), Flash Player 9, Flash Player 10

The indentationLevel property of the underlying value object.

Implementation
`public function get indentationLevel():Number`
`public function set indentationLevel(value:Number):void`

### optional

property

`optional:Boolean`

Language Version: | ActionScript 3.0

Product Version: | Asset Composer Building Block 9.5

Runtime Versions: | AIR (unsupported), Flash Player 9, Flash Player 10

The optional property of the underlying value object.

Implementation
`public function get optional():Boolean`
`public function set optional(value:Boolean):void`

### position

property

`position:int`

Language Version: | ActionScript 3.0

Product Version: | Asset Composer Building Block 10

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

Fetches the position of Module relative to other modules in the target area.

Implementation
`public function get position():int`
`public function set position(value:int):void`

### preSelected

property

`preSelected:Boolean`

Language Version: | ActionScript 3.0

Product Version: | Asset Composer Building Block 9.5

Runtime Versions: | AIR (unsupported), Flash Player 9, Flash Player 10

The preSelected property of the underlying value object.

Implementation
`public function get preSelected():Boolean`
`public function set preSelected(value:Boolean):void`

### variables

property

`variables:IList` [read-only]

Language Version: | ActionScript 3.0

Product Version: | Asset Composer Building Block 9.5

Runtime Versions: | AIR (unsupported), Flash Player 9, Flash Player 10

The list of variables exposed by the module associated with this assignment.

Implementation
`public function get variables():IList`

### vo

property

`vo:ModuleAssignment`

Language Version: | ActionScript 3.0

Product Version: | Asset Composer Building Block 9.5

Runtime Versions: | AIR (unsupported), Flash Player 9, Flash Player 10

The underlying value object for this module assignment.

Implementation
`public function get vo():ModuleAssignment`
`public function set vo(value:ModuleAssignment):void`
Method Detail

### createFromModule

()
method

`public static function createFromModule(module:*):ModuleAssignmentModel`

Language Version: | ActionScript 3.0

Product Version: | Asset Composer Building Block 9.5

Runtime Versions: | AIR (unsupported), Flash Player 9, Flash Player 10

Constructs the domain object from a data module.

Parameters

| `module:*` — The module from which the module assignment needs to be constructed. This parameter could either be the module domain object (com.adobe.icc.editors.model.ModuleModel) or the module value object (com.adobe.icc.vo.DataModule).

Returns

| `ModuleAssignmentModel` — The module assignment domain object.

### createFromVO

()
method

`public static function createFromVO(vo:ModuleAssignment):ModuleAssignmentModel`

Language Version: | ActionScript 3.0

Product Version: | Asset Composer Building Block 9.5

Runtime Versions: | AIR (unsupported), Flash Player 9, Flash Player 10

Constructs the domain object from its value object counterpart.

Parameters

| `vo:ModuleAssignment` — The module assignment value object.

Returns

| `ModuleAssignmentModel` — The module assignment domain object.

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