ImageModuleInstance

Package	com.adobe.icc.dc.domain
Class	public class ImageModuleInstance
Inheritance	ImageModuleInstance BaseModuleInstance EventDispatcher Object

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 image module present in the letter.

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
		contentBytes : ByteArray The byte array representation of the underlying Image module instance associated with the letter.	ImageModuleInstance
		contentVariables : IList [override] [read-only] Bindable/Read-only.	ImageModuleInstance
		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 [override] [read-only] Module type represented by this ModuleInstance: Text,Image,List,Condition	ImageModuleInstance
		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

Public Methods

	Method		Defined By
		ImageModuleInstance(moduleData:ModuleData, vParentContainer:IContainerInstance = null, remod:ReloadModule = null) Constructor.	ImageModuleInstance
		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
		dispatchEvent(event:Event):Boolean Dispatches an event into the event flow.	EventDispatcher
		hasEventListener(type:String):Boolean Checks whether the EventDispatcher object has any listeners registered for a specific type of event.	EventDispatcher
		hasOwnProperty(name:String):Boolean Indicates whether an object has a specified property defined.	Object
		isPrototypeOf(theClass:Object):Boolean Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.	Object
		propertyIsEnumerable(name:String):Boolean Indicates whether the specified property exists and is enumerable.	Object
		refresh():void Refresh should be called when item is selected.	BaseModuleInstance
		removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void Removes a listener from the EventDispatcher object.	EventDispatcher
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Sets the availability of a dynamic property for loop operations.	Object
		toLocaleString():String Returns the string representation of this object, formatted according to locale-specific conventions.	Object
		toString():String Returns the string representation of the specified object.	Object
		valueOf():Object Returns the primitive value of the specified object.	Object
		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.	EventDispatcher

Protected Methods

	Method		Defined By
		moduleDataChangeHandler(event:ModuleDataEvent):void Called when the module content's associated data object changes.	BaseModuleInstance

Events

Click for more information on events

	Event		Summary	Defined By
		activate	[broadcast event] Dispatched when the Flash Player or AIR application gains operating system focus and becomes active.	EventDispatcher
		deactivate	[broadcast event] Dispatched when the Flash Player or AIR application operating loses system focus and is becoming inactive.	EventDispatcher

Property Detail

contentBytes

property

contentBytes:ByteArray

Language Version:

ActionScript 3.0

Product Version:

Asset Composer Building Block 10.0

Runtime Versions:

AIR (unsupported), Flash Player 10.2

The byte array representation of the underlying Image module instance associated with the 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 contentBytes():ByteArray
public function set contentBytes(value:ByteArray):void

contentVariables

property

contentVariables:IList [read-only] [override]

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 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
override public function get contentVariables():IList

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_IMAGE

Constructor Detail