| Package | com.adobe.icc.dc.domain |
| Class | public class BaseModuleInstance |
| Inheritance | BaseModuleInstance  EventDispatcher Object |
| Implements | IModuleInstance |
| Subclasses | ConditionModuleInstance, ImageModuleInstance, ListModuleInstance, TextModuleInstance |
| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Composer Building Block 10.0 |
| Runtime Versions: | AIR (unsupported), Flash Player 10.2 |
Hide Inherited Public Properties
Show Inherited Public Properties| Property | Defined By | ||
|---|---|---|---|
| assignedPosition : int [read-only]
The assigned position of the module within its container. | BaseModuleInstance | ||
 | constructor : Object
A reference to the class object or constructor function for a given object instance. | Object | |
| contentVariables : IList [read-only]
The set of active variables for the module. | BaseModuleInstance | ||
| description : String [read-only]
Description associated with this ModuleInstance. | BaseModuleInstance | ||
| editable : Boolean [read-only]
True if this module is editable in its container (based on the assignment). | BaseModuleInstance | ||
| extra : Boolean [read-only]
The flag indicating if this module was not assigned while creating the letter. | BaseModuleInstance | ||
| hasConflict : Boolean [read-only]
The flag indicating if this module is conflicting with its latest version. | BaseModuleInstance | ||
| id : String [read-only]
Unique identification associated with this ModuleInstance. | BaseModuleInstance | ||
| indentationLevel : Number
The level of indentation of the module with respect to the container holding the module instance. | BaseModuleInstance | ||
| moduleType : String [read-only]
Module type represented by this ModuleInstance: Text,Image,List,Condition
| BaseModuleInstance | ||
| moduleVo : DataModule [read-only]
The instance of DataModule associated with this module instance. | BaseModuleInstance | ||
| name : String [read-only]
Name associated with this ModuleInstance. | BaseModuleInstance | ||
| 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. | BaseModuleInstance | ||
| 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. | BaseModuleInstance | ||
| occur : int
The occurrence index of this content within its parent container. | BaseModuleInstance | ||
| optional : Boolean [read-only]
True if this module is optional in its container (based on the assignment, not the selected state). | BaseModuleInstance | ||
| parentContainer : IContainerInstance [read-only]
Parent container instance containing this ModuleInstance
| BaseModuleInstance | ||
| preSelected : Boolean [read-only]
True if this module is pre-selected/removable in its container (based on the assignment, not the selected state). | BaseModuleInstance | ||
| selected : Boolean
Is the module is selected to be included in letter
| BaseModuleInstance | ||
| selectedPosition : int
Position of the content in it's container among all the selected contents of the container. | BaseModuleInstance | ||
| skipStyle : Boolean [read-only]
Skip Style of the module. | BaseModuleInstance | ||
| tooltip : String [read-only]
Tooltip associated with this ModuleInstance. | BaseModuleInstance | ||
| valid : Boolean [read-only]
Boolean indicating whether the content is valid
| BaseModuleInstance | ||
| Method | Defined By | ||
|---|---|---|---|
BaseModuleInstance(remod:ReloadModule = null)
Constructor. | BaseModuleInstance | ||
| 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 | |
|
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 | |
Refresh should be called when item is selected. | BaseModuleInstance | ||
|
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 | |
| Method | Defined By | ||
|---|---|---|---|
moduleDataChangeHandler(event:ModuleDataEvent):void
Called when the module content's associated data object changes. | BaseModuleInstance | ||
assignedPosition | property |
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():IListdescription | property |
editable | property |
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():BooleanhasConflict | 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():Booleanid | property |
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):voidmoduleType | property |
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():DataModulename | 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():StringnewMandatory | 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():BooleannonEditableOverride | 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():Booleanoccur | 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):voidoptional | 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():BooleanparentContainer | 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():IContainerInstancepreSelected | 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():Booleanselected | 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):voidselectedPosition | 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):voidskipStyle | 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():Booleantooltip | property |
valid | property |
valid:Boolean [read-only] | Language Version: | ActionScript 3.0 |
| Product Version: | Asset Composer Building Block 10.0 |
| Runtime Versions: | AIR (unsupported), Flash Player 10.2 |
Boolean indicating whether the content is valid
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 valid():BooleanBaseModuleInstance | () | Constructor |
public function BaseModuleInstance(remod:ReloadModule = null)| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Composer Building Block 10.0 |
| Runtime Versions: | AIR (unsupported), Flash Player 10.2 |
Constructor.
Parametersremod:ReloadModule (default = null) |
moduleDataChangeHandler | () | method |
protected function moduleDataChangeHandler(event:ModuleDataEvent):void| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Composer Building Block 10.0 |
| Runtime Versions: | AIR (unsupported), Flash Player 10.2 |
Called when the module content's associated data object changes.
Note: Do not add moduleDataChangeHandler at instantiation of BaseModuleInstance because moduleData value may not yet been set.
Plug this handler in sub class initialization.
Parameters
event:ModuleDataEvent — The ModuleDataEvent event dispatched on module data change.
|
refresh | () | method |
public function refresh():void| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Composer Building Block 10.0 |
| Runtime Versions: | AIR (unsupported), Flash Player 10.2 |
Refresh should be called when item is selected. This is useful in case when the the item is deselcted. In that case, if there is any change in variable value/ field value etc., those changes may not be propagated to module.
Thu Dec 6 2018, 01:12 PM -08:00