com.adobe.icc.dc.domain

# IModuleInstance - AS3 Asset Composer

Package | com.adobe.icc.dc.domain
Interface | public interface IModuleInstance extends IValidation , IEventDispatcher
Implementors | BaseModuleInstance

Language Version: | ActionScript 3.0

Product Version: | Asset Composer Building Block 10

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

Domain model Interface corresponding to all data modules

Public Properties
Hide Inherited Public Properties
Show Inherited Public Properties

| Property | Defined By
--- | --- | ---
|  | assignedPosition : int [read-only] The assigned position of the module within its container. | IModuleInstance
|  | contentVariables : IList [read-only] The set of active variables for the module. | IModuleInstance
|  | description : String [read-only] Description associated with this ModuleInstance. | IModuleInstance
|  | editable : Boolean [read-only] True if this module is editable in its container (based on the assignment). | IModuleInstance
|  | extra : Boolean [read-only] The flag indicating if this module was not assigned while creating the letter. | IModuleInstance
|  | hasConflict : Boolean [read-only] The flag indicating if this module is conflicting with its latest version. | IModuleInstance
|  | id : String [read-only] Unique identification associated with this ModuleInstance. | IModuleInstance
|  | indentationLevel : Number The level of indentation of the module with respect to the container holding the module instance. | IModuleInstance
|  | moduleType : String [read-only] Module type represented by this ModuleInstance: Text,Image,List,Condition | IModuleInstance
|  | moduleVo : DataModule [read-only] The instance of DataModule associated with this module instance. | IModuleInstance
|  | name : String [read-only] Name associated with this ModuleInstance. | IModuleInstance
|  | newMandatory : Boolean [read-only] The flag indicating if this module was not mandatory earlier but is now mandatory when considering the latest version of the module instance. | IModuleInstance
|  | nonEditableOverride : Boolean [read-only] The flag indicating if this module was editable earlier but is now non-editable when considering the latest version of the module instance. | IModuleInstance
|  | occur : int The occurrence index of this content within its parent container. | IModuleInstance
|  | optional : Boolean [read-only] True if this module is optional in its container (based on the assignment, not the selected state). | IModuleInstance
|  | parentContainer : IContainerInstance [read-only] Parent container instance containing this ModuleInstance | IModuleInstance
|  | preSelected : Boolean [read-only] True if this module is pre-selected/removable in its container (based on the assignment, not the selected state). | IModuleInstance
|  | selected : Boolean Is the module is selected to be included in letter | IModuleInstance
|  | selectedPosition : int Position of the content in it's container among all the selected contents of the container. | IModuleInstance
|  | skipStyle : Boolean [read-only] Skip Style of the module. | IModuleInstance
|  | tooltip : String [read-only] Tooltip associated with this ModuleInstance. | IModuleInstance
|  | valid : Boolean [read-only] Boolean indicating whether the content is valid | IValidation

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. | IEventDispatcher
|  | dispatchEvent(event:Event):Boolean Dispatches an event into the event flow. | IEventDispatcher
|  | hasEventListener(type:String):Boolean Checks whether the EventDispatcher object has any listeners registered for a specific type of event. | IEventDispatcher
|  | refresh():void Refresh should be called when item is selected. | IValidation
|  | removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void Removes a listener from the EventDispatcher object. | IEventDispatcher
|  | 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. | IEventDispatcher

Property Detail

### assignedPosition

property

`assignedPosition:int` [read-only]

Language Version: | ActionScript 3.0

Product Version: | Asset Composer Building Block 10.0

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

The assigned position of the module within its container.

Implementation
`public function get assignedPosition():int`

### contentVariables

property

`contentVariables:IList` [read-only]

Language Version: | ActionScript 3.0

Product Version: | Asset Composer Building Block 10.0

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

The set of active variables for the module. Empty if there are none.

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 contentVariables():IList`

### description

property

`description:String` [read-only]

Language Version: | ActionScript 3.0

Product Version: | Asset Composer Building Block 10.0

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

Description associated with this ModuleInstance.

Implementation
`public function get description():String`

### editable

property

`editable:Boolean` [read-only]

Language Version: | ActionScript 3.0

Product Version: | Asset Composer Building Block 10.0

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

True if this module is editable in its container (based on the assignment).

Implementation
`public function get editable():Boolean`

### extra

property

`extra:Boolean` [read-only]

Language Version: | ActionScript 3.0

Product Version: | Asset Composer Building Block 10.0

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

The flag indicating if this module was not assigned while creating the letter. For e.g a module added to the letter through Library access will have extra attribute as true.

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 extra():Boolean`

### hasConflict

property

`hasConflict:Boolean` [read-only]

Language Version: | ActionScript 3.0

Product Version: | Asset Composer Building Block 10.0

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

The flag indicating if this module is conflicting with its latest version.

Implementation
`public function get hasConflict():Boolean`

### id

property

`id:String` [read-only]

Language Version: | ActionScript 3.0

Product Version: | Asset Composer Building Block 10.0

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

Unique identification associated with this ModuleInstance.

Implementation
`public function get id():String`

### indentationLevel

property

`indentationLevel:Number`

Language Version: | ActionScript 3.0

Product Version: | Asset Composer Building Block 10.0

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

The level of indentation of the module with respect to the container holding the module instance.

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 indentationLevel():Number`
`public function set indentationLevel(value:Number):void`

### moduleType

property

`moduleType:String` [read-only]

Language Version: | ActionScript 3.0

Product Version: | Asset Composer Building Block 10.0

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

Module type represented by this ModuleInstance: Text,Image,List,Condition

Implementation
`public function get moduleType():String`

Related API Elements

com.adobe.icc.dc.domain.ModuleInstancefactory

### moduleVo

property

`moduleVo:DataModule` [read-only]

Language Version: | ActionScript 3.0

Product Version: | Asset Composer Building Block 10.0

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

The instance of DataModule associated with this module instance.

Implementation
`public function get moduleVo():DataModule`

### name

property

`name:String` [read-only]

Language Version: | ActionScript 3.0

Product Version: | Asset Composer Building Block 10.0

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

Name associated with this ModuleInstance.

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 name():String`

### newMandatory

property

`newMandatory:Boolean` [read-only]

Language Version: | ActionScript 3.0

Product Version: | Asset Composer Building Block 10.0

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

The flag indicating if this module was not mandatory earlier but is now mandatory when considering the latest version of the module instance.

Implementation
`public function get newMandatory():Boolean`

### nonEditableOverride

property

`nonEditableOverride:Boolean` [read-only]

Language Version: | ActionScript 3.0

Product Version: | Asset Composer Building Block 10.0

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

The flag indicating if this module was editable earlier but is now non-editable when considering the latest version of the module instance.

Implementation
`public function get nonEditableOverride():Boolean`

### occur

property

`occur:int`

Language Version: | ActionScript 3.0

Product Version: | Asset Composer Building Block 10.0

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

The occurrence index of this content within its parent container. If there are multiple instances of the module in the container, each module content instance (for those assigned module instances) will get a unique occurrence index. Once assigned, the occurrence should be retained to idenfity instances of a particular module occurrence (e.g. text module tm is assigned twice to the same target/list therefore each occurrence will be identified as tm0 and tm1, respectfully, but note that if tm1 is cloned 4 times, it remains tm1 in the container's selection as instances of the original tm1 occurrence).

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 occur():int`
`public function set occur(value:int):void`

### optional

property

`optional:Boolean` [read-only]

Language Version: | ActionScript 3.0

Product Version: | Asset Composer Building Block 10.0

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

True if this module is optional in its container (based on the assignment, not the selected state).

Implementation
`public function get optional():Boolean`

### parentContainer

property

`parentContainer:IContainerInstance` [read-only]

Language Version: | ActionScript 3.0

Product Version: | Asset Composer Building Block 10.0

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

Parent container instance containing this `ModuleInstance`

Implementation
`public function get parentContainer():IContainerInstance`

### preSelected

property

`preSelected:Boolean` [read-only]

Language Version: | ActionScript 3.0

Product Version: | Asset Composer Building Block 10.0

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

True if this module is pre-selected/removable in its container (based on the assignment, not the selected state).

Implementation
`public function get preSelected():Boolean`

### selected

property

`selected:Boolean`

Language Version: | ActionScript 3.0

Product Version: | Asset Composer Building Block 10.0

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

Is the module is selected to be included in letter

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 selected():Boolean`
`public function set selected(value:Boolean):void`

### selectedPosition

property

`selectedPosition:int`

Language Version: | ActionScript 3.0

Product Version: | Asset Composer Building Block 10.0

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

Position of the content in it's container among all the selected contents of the container. -1 if the content is not selected.

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 selectedPosition():int`
`public function set selectedPosition(value:int):void`

### skipStyle

property

`skipStyle:Boolean` [read-only]

Language Version: | ActionScript 3.0

Product Version: | Asset Composer Building Block 10.0

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

Skip Style of the module. If this is a List or Condition, the `skipChildren` option would decide whether or not to skip the child modules or not.

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 skipStyle():Boolean`

### tooltip

property

`tooltip:String` [read-only]

Language Version: | ActionScript 3.0

Product Version: | Asset Composer Building Block 10.0

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

Tooltip associated with this ModuleInstance.

Implementation
`public function get tooltip():String`

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