ActionScript® 3.0 Reference for the Adobe® Flash® Platform
Home  |  Show Packages and Classes List |  Packages  |  Classes  |  What's New  |  Index  |  Appendixes
com.adobe.icc.dc.domain 

ConditionModuleInstance  - AS3 Asset Composer

Packagecom.adobe.icc.dc.domain
Classpublic class ConditionModuleInstance
InheritanceConditionModuleInstance Inheritance BaseModuleInstance Inheritance EventDispatcher Inheritance Object
Implements IContainerInstance

Language Version: ActionScript 3.0
Product Version: Asset Composer Building Block 10.0
Runtime Versions: AIR (unsupported), Flash Player 10.2

This class is the runtime representation of the condition module present in the letter.



Public Properties
 PropertyDefined By
 InheritedassignedPosition : int
[read-only] The assigned position of the module within its container.
BaseModuleInstance
 Inheritedconstructor : 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
 InheritedcontentVariables : IList
[read-only] The set of active variables for the module.
BaseModuleInstance
  controlVariables : IList
[read-only] Bindable/Read-only.
ConditionModuleInstance
 Inheriteddescription : String
[read-only] Description associated with this ModuleInstance.
BaseModuleInstance
 Inheritededitable : Boolean
[read-only] True if this module is editable in its container (based on the assignment).
BaseModuleInstance
 Inheritedextra : Boolean
[read-only] The flag indicating if this module was not assigned while creating the letter.
BaseModuleInstance
 InheritedhasConflict : 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
 Inheritedid : String
[read-only] Unique identification associated with this ModuleInstance.
BaseModuleInstance
 InheritedindentationLevel : 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
 InheritedmoduleVo : DataModule
[read-only] The instance of DataModule associated with this module instance.
BaseModuleInstance
 Inheritedname : String
[read-only] Name associated with this ModuleInstance.
BaseModuleInstance
 InheritednewMandatory : 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
 InheritednonEditableOverride : 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
 Inheritedoccur : 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
 Inheritedoptional : 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
 InheritedparentContainer : IContainerInstance
[read-only] Parent container instance containing this ModuleInstance
BaseModuleInstance
 InheritedpreSelected : Boolean
[read-only] True if this module is pre-selected/removable in its container (based on the assignment, not the selected state).
BaseModuleInstance
 Inheritedselected : Boolean
Is the module is selected to be included in letter
BaseModuleInstance
 InheritedselectedPosition : int
Position of the content in it's container among all the selected contents of the container.
BaseModuleInstance
 InheritedskipStyle : Boolean
[read-only] Skip Style of the module.
BaseModuleInstance
 Inheritedtooltip : String
[read-only] Tooltip associated with this ModuleInstance.
BaseModuleInstance
 Inheritedvalid : Boolean
[read-only] Boolean indicating whether the content is valid
BaseModuleInstance
Public Methods
 MethodDefined By
  
ConditionModuleInstance(vCondData:ConditionModuleData, vParentContainer:IContainerInstance = null, remod:ReloadModule = null)
Constructor.
ConditionModuleInstance
 Inherited
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
 Inherited
Dispatches an event into the event flow.
EventDispatcher
 Inherited
Checks whether the EventDispatcher object has any listeners registered for a specific type of event.
EventDispatcher
 Inherited
Indicates whether an object has a specified property defined.
Object
 Inherited
Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.
Object
  
moveContent(sourceModule:IModuleInstance, moveUp:Boolean):void
Moves the specified item within the list's content one position in the specified direction.
ConditionModuleInstance
 Inherited
Indicates whether the specified property exists and is enumerable.
Object
 Inherited
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
 Inherited
removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void
Removes a listener from the EventDispatcher object.
EventDispatcher
 Inherited
Sets the availability of a dynamic property for loop operations.
Object
  
setSkipStyle(value:Boolean, skipChildren:Boolean = true):void
[override]
ConditionModuleInstance
 Inherited
Returns the string representation of this object, formatted according to locale-specific conventions.
Object
 Inherited
Returns the string representation of the specified object.
Object
 Inherited
Returns the primitive value of the specified object.
Object
 Inherited
Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type.
EventDispatcher
Protected Methods
 MethodDefined By
  
moduleDataChangeHandler(event:ModuleDataEvent):void
[override] Called when the module content's associated data object changes.
ConditionModuleInstance
Events
 Event Summary Defined By
 Inherited[broadcast event] Dispatched when the Flash Player or AIR application gains operating system focus and becomes active.EventDispatcher
 Inherited[broadcast event] Dispatched when the Flash Player or AIR application operating loses system focus and is becoming inactive.EventDispatcher
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():IList

controlVariables

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

hasContentRemoved

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

moduleType

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

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

ordered

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():Boolean
Constructor 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.

Parameters
vCondData:ConditionModuleData — ConditionModuleData object represented by this instance.
 
vParentContainer:IContainerInstance (default = null) — Container of the Condition Module that can be a list or a target area.
 
remod:ReloadModule (default = null) — Reload Module for the case of correspondence reload.
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 
override public function setSkipStyle(value:Boolean, skipChildren:Boolean = true):void

Language Version: ActionScript 3.0
Product Version: Asset Composer Building Block 10.0
Runtime Versions: AIR (unsupported), Flash Player 10.2

Parameters

value:Boolean
 
skipChildren:Boolean (default = true)