| Package | com.adobe.icc.dc.domain |
| Class | public class ConditionModuleInstance |
| Inheritance | ConditionModuleInstance  BaseModuleInstance EventDispatcher Object |
| Implements | IContainerInstance |
| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Composer Building Block 10.0 |
| Runtime Versions: | AIR (unsupported), Flash Player 10.2 |
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. | BaseModuleInstance | |
| constructor : Object
A reference to the class object or constructor function for a given object instance. | Object | |
| contents : IList [read-only]
List of the contents associated with this Container instance. | ConditionModuleInstance | ||
| contentVariables : IList [read-only]
The set of active variables for the module. | BaseModuleInstance | |
| controlVariables : IList [read-only]
Bindable/Read-only. | ConditionModuleInstance | ||
| 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 | |
| hasContentRemoved : Boolean [read-only]
True if the Condition has one or more content removed from it, than what was originall assigned. | ConditionModuleInstance | ||
| 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 [override] [read-only]
Module type represented by this ModuleInstance: Text,Image,List,Condition
| ConditionModuleInstance | ||
| 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 | |
| open : Boolean [read-only]
True if the container is open to extra content; false if it only allows content that was explicitly assigned to it in the letter. | ConditionModuleInstance | ||
| optional : Boolean [read-only]
True if this module is optional in its container (based on the assignment, not the selected state). | BaseModuleInstance | |
| ordered : Boolean [read-only]
True if the container's contents order is fixed; false if its contents can be re-ordered. | ConditionModuleInstance | ||
| 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 | |
Public Methods
| Method | Defined By | ||
|---|---|---|---|
ConditionModuleInstance(vCondData:ConditionModuleData, vParentContainer:IContainerInstance = null, remod:ReloadModule = null)
Constructor. | ConditionModuleInstance | ||
| 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 | |
Moves the specified item within the list's content one position in the specified direction. | ConditionModuleInstance | ||
|
Indicates whether the specified property exists and is enumerable. | Object | |
|
Refresh should be called when item is selected. | BaseModuleInstance | |
Removes the specified item from the list's collection if the item is found in the collection and is non mandatory
| ConditionModuleInstance | ||
|
Removes a listener from the EventDispatcher object. | EventDispatcher | |
|
Sets the availability of a dynamic property for loop operations. | Object | |
[override]
| ConditionModuleInstance | ||
|
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 | |
Protected Methods
| Method | Defined By | ||
|---|---|---|---|
moduleDataChangeHandler(event:ModuleDataEvent):void [override]
Called when the module content's associated data object changes. | ConditionModuleInstance | ||
Property Detail
contents | property |
contents:IList [read-only] | Language Version: | ActionScript 3.0 |
| Product Version: | Asset Composer Building Block 10.0 |
| Runtime Versions: | AIR (unsupported), Flash Player 10.2 |
List of the contents associated with this Container 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 contents():IListcontrolVariables | property |
controlVariables:IList [read-only] | Language Version: | ActionScript 3.0 |
| Product Version: | Asset Composer Building Block 10.0 |
| Runtime Versions: | AIR (unsupported), Flash Player 10.2 |
Bindable/Read-only. The set of control variables for the Condition.
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 controlVariables():IListhasContentRemoved | property |
hasContentRemoved: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 the Condition has one or more content removed from it, than what was originall assigned. [Relevant when reloading]
Implementation
public function get hasContentRemoved():BooleanmoduleType | property |
moduleType:String [read-only] [override] | 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
override public function get moduleType():StringRelated API Elements
ModuleInstancefactory.MODULETYPE_CONDITION
open | property |
open: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 the container is open to extra content; false if it only allows content that was explicitly assigned to it in the letter.
Implementation
public function get open():Booleanordered | property |
ordered: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 the container's contents order is fixed; false if its contents can be re-ordered.
Implementation
public function get ordered():BooleanConstructor Detail
ConditionModuleInstance | () | Constructor |
public function ConditionModuleInstance(vCondData:ConditionModuleData, vParentContainer:IContainerInstance = null, 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.
ParametersvCondData:ConditionModuleData — ConditionModuleData object represented by this instance.
| |
vParentContainer:IContainerInstance (default = null) | |
remod:ReloadModule (default = null) |
Method Detail
moduleDataChangeHandler | () | method |
override 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.
|
moveContent | () | method |
public function moveContent(sourceModule:IModuleInstance, moveUp:Boolean):void| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Composer Building Block 10.0 |
| Runtime Versions: | AIR (unsupported), Flash Player 10.2 |
Moves the specified item within the list's content one position in the specified direction.
Parameters
sourceModule:IModuleInstance — The item to move.
| |
moveUp:Boolean — True to move up, false to move down.
|
removeContent | () | method |
public function removeContent(sourceModule:IModuleInstance):void| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Composer Building Block 10.0 |
| Runtime Versions: | AIR (unsupported), Flash Player 10.2 |
Removes the specified item from the list's collection if the item is found in the collection and is non mandatory
Parameters
sourceModule:IModuleInstance — The item to be removed.
|
setSkipStyle | () | method |
Thu Dec 6 2018, 01:12 PM -08:00