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.factory 

DomainInstanceFactory  - AS3 Asset Composer

Packagecom.adobe.icc.dc.domain.factory
Classpublic class DomainInstanceFactory
InheritanceDomainInstanceFactory Inheritance Object
Implements IDomainInstanceFactory

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

The factory to create domain instances of the data modules.



Public Properties
 PropertyDefined By
 Inheritedconstructor : Object
A reference to the class object or constructor function for a given object instance.
Object
Public Methods
 MethodDefined By
  
Constructor.
DomainInstanceFactory
  
createConditionModuleInstance(vConditionData:ConditionModuleData, vParentContainer:IContainerInstance = null, remod:ReloadModule = null):ConditionModuleInstance
The function used to create a condition module instance for the specified letter.
DomainInstanceFactory
  
The function used to create a field instance for the specified letter.
DomainInstanceFactory
  
createImageModuleInstance(moduleData:ModuleData, vParentContainer:IContainerInstance = null, remod:ReloadModule = null):ImageModuleInstance
The function used to create a image module instance for the specified letter.
DomainInstanceFactory
  
The function used to create a letter instance.
DomainInstanceFactory
  
createListModuleInstance(vListData:ListData, vParentContainer:IContainerInstance = null, remod:ReloadModule = null):ListModuleInstance
The function used to create a list module instance for the specified letter.
DomainInstanceFactory
  
createModuleInstance(moduleData:ModuleData, vParentContainer:IContainerInstance = null, ... otherArgs):IModuleInstance
The function used to create a generic module instance for the specified letter.
DomainInstanceFactory
  
createTargetInstance(targetData:com.adobe.icc.dc.data:TargetData, reloadTarget:com.adobe.icc.dc.data.reload:ReloadTarget = null):com.adobe.icc.dc.domain:TargetInstance
The function used to create a target area instance for the specified letter.
DomainInstanceFactory
  
createTextModuleInstance(moduleData:ModuleData, vParentContainer:IContainerInstance = null, remod:ReloadModule = null):com.adobe.icc.dc.domain:TextModuleInstance
The function used to create a text module instance for the specified letter.
DomainInstanceFactory
  
The function used to create a variable instance for the specified letter.
DomainInstanceFactory
  
[static] Returns the singleton instance of this class.
DomainInstanceFactory
 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
 Inherited
Indicates whether the specified property exists and is enumerable.
Object
 Inherited
Sets the availability of a dynamic property for loop operations.
Object
 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
Public Constants
 ConstantDefined By
  MODULETYPE_CONDITION : String = "Condition"
[static] The constant defining the Condition type module.
DomainInstanceFactory
  MODULETYPE_IMAGE : String = "Image"
[static] The constant defining the Image type module.
DomainInstanceFactory
  MODULETYPE_LIST : String = "List"
[static] The constant defining the List type module.
DomainInstanceFactory
  MODULETYPE_TEXT : String = "Text"
[static] The constant defining the text type module.
DomainInstanceFactory
Constructor Detail

DomainInstanceFactory

()Constructor
public function DomainInstanceFactory()

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

Constructor.

Method Detail

createConditionModuleInstance

()method
public function createConditionModuleInstance(vConditionData:ConditionModuleData, vParentContainer:IContainerInstance = null, remod:ReloadModule = null):ConditionModuleInstance

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

The function used to create a condition module instance for the specified letter.

Parameters

vConditionData: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.

Returns
ConditionModuleInstance

createFieldInstance

()method 
public function createFieldInstance(value:FieldData):FieldInstance

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

The function used to create a field instance for the specified letter.

Parameters

value:FieldData — FieldData object used for the creation of the FieldInstance.

Returns
FieldInstance — The FieldInstance object.

createImageModuleInstance

()method 
public function createImageModuleInstance(moduleData:ModuleData, vParentContainer:IContainerInstance = null, remod:ReloadModule = null):ImageModuleInstance

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

The function used to create a image module instance for the specified letter.

Parameters

moduleData:ModuleData — ModuleData object represented by this instance.
 
vParentContainer:IContainerInstance (default = null) — Container of the Image Module that can be a list or a target area.
 
remod:ReloadModule (default = null) — Reload Module for the case of correspondence reload.

Returns
ImageModuleInstance

createLetterInstance

()method 
public function createLetterInstance(letter:Letter, ddi:DataDictionaryInstanceModel, initialXmlData:XML, params:Map):LetterInstance

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

The function used to create a letter instance.

Parameters

letter:Letter — The Letter object used to create the LetterInstance.
 
ddi:DataDictionaryInstanceModel — The DataDictionaryInstanceModel object used to create the LetterInstance.
 
initialXmlData:XML — The initial XML data associated with the Letter.
 
params:Map — Additional parameters required to create the LetterInstance.

Returns
LetterInstance

createListModuleInstance

()method 
public function createListModuleInstance(vListData:ListData, vParentContainer:IContainerInstance = null, remod:ReloadModule = null):ListModuleInstance

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

The function used to create a list module instance for the specified letter.

Parameters

vListData:ListData — ListData object represented by this instance.
 
vParentContainer:IContainerInstance (default = null) — Container of the List Module that can be a list or a target area.
 
remod:ReloadModule (default = null) — Reload Module for the case of correspondence reload.

Returns
ListModuleInstance

createModuleInstance

()method 
public function createModuleInstance(moduleData:ModuleData, vParentContainer:IContainerInstance = null, ... otherArgs):IModuleInstance

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

The function used to create a generic module instance for the specified letter. The type of the module created depends on the moduleData parameter.

Parameters

moduleData:ModuleData — The ModuleData object used to create ModuleInstance
 
vParentContainer:IContainerInstance (default = null) — Container of the Module that can be a list or a target area.
 
... otherArgs — Other Arguments associated with creation of Module instance.

Returns
IModuleInstance

createTargetInstance

()method 
public function createTargetInstance(targetData:com.adobe.icc.dc.data:TargetData, reloadTarget:com.adobe.icc.dc.data.reload:ReloadTarget = null):com.adobe.icc.dc.domain:TargetInstance

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

The function used to create a target area instance for the specified letter.

Parameters

targetData:com.adobe.icc.dc.data:TargetData — The TargetData object used for the creation of the TargetInstance.
 
reloadTarget:com.adobe.icc.dc.data.reload:ReloadTarget (default = null) — Reload Target for the case of correspondence reload.

Returns
com.adobe.icc.dc.domain:TargetInstance

createTextModuleInstance

()method 
public function createTextModuleInstance(moduleData:ModuleData, vParentContainer:IContainerInstance = null, remod:ReloadModule = null):com.adobe.icc.dc.domain:TextModuleInstance

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

The function used to create a text module instance for the specified letter.

Parameters

moduleData:ModuleData — ModuleData object represented by this instance.
 
vParentContainer:IContainerInstance (default = null) — Container of the Text Module that can be a list or a target area.
 
remod:ReloadModule (default = null) — Reload Module for the case of correspondence reload.

Returns
com.adobe.icc.dc.domain:TextModuleInstance

createVariableInstance

()method 
public function createVariableInstance(value:VariableData):VariableInstance

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

The function used to create a variable instance for the specified letter.

Parameters

value:VariableData — VariableData object used for the creation of the VariableInstance.

Returns
VariableInstance — The VariableInstance object.

getInstance

()method 
public static function getInstance():DomainInstanceFactory

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

Returns the singleton instance of this class.

Returns
DomainInstanceFactory — The instance of DomainInstanceFactory.
Constant Detail

MODULETYPE_CONDITION

Constant
public static const MODULETYPE_CONDITION:String = "Condition"

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

The constant defining the Condition type module.

MODULETYPE_IMAGE

Constant 
public static const MODULETYPE_IMAGE:String = "Image"

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

The constant defining the Image type module.

MODULETYPE_LIST

Constant 
public static const MODULETYPE_LIST:String = "List"

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

The constant defining the List type module.

MODULETYPE_TEXT

Constant 
public static const MODULETYPE_TEXT:String = "Text"

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

The constant defining the text type module.