ImageModule

Package	com.adobe.icc.vo
Class	public class ImageModule
Inheritance	ImageModule DataModule Object

Language Version:

ActionScript 3.0

Product Version:

Asset Composer Building Block 9.5

Runtime Versions:

AIR (unsupported), Flash Player 9, Flash Player 10

A value object for an image module. Extends the basic attributes of DataModule.

Public Properties

	Property		Defined By
		activeEndDate : Date	DataModule
		activeStartDate : Date	DataModule
		caption : String used as the tooltip for the image when inserted into a letter (to create accessible letters)	ImageModule
		comment : String Specifies a comment associated with the last change or update to the data module.	DataModule
		constructor : Object A reference to the class object or constructor function for a given object instance.	Object
		crxVersion : String Version of the data module in repository	DataModule
		dataDictionaryRef : String Data Dictionary Reference	DataModule
		dataDictionaryRefs : ArrayCollection	DataModule
		desc : String Gets the description for this data module.	DataModule
		dmType : int [read-only] Fetch the type of data module 0 : Text 2 : Image 3 : Condition 4 : List	DataModule
		extendedProperties : Object extendedProperties Map for AssetManager Backend use case	DataModule
		fileName : String original image file name ("friendly name") from user's local system (no path included)	ImageModule
		hasVariables : Boolean [read-only] True if the module has variables in its content.	DataModule
		id : String Specifies the unique identifier for this data module.	DataModule
		imageBlob : ByteArray The byte stream of the image	ImageModule
		lastChangeBy : String Specifies the last user who completed a change.	DataModule
		lastPublishDate : Date Specifies the last publish date of the data module	DataModule
		lastUpdateDate : Date	DataModule
		lcat : Category Specifies the subcategory for the data module.	DataModule
		lcatName : String [read-only] Speifies the sub category associated with this data Module.	DataModule
		mimeType : String MIME type for the image.	ImageModule
		name : String Specifies the name of the data module.	DataModule
		serverFilePath : String Temporary image file path returned from HTTP upload servlet after uploading file (used only on create/update).	ImageModule
		state : int Specifies the state of the data module	DataModule
		ucat : Category Specifies the main category for the data module.	DataModule
		ucatName : String [read-only] Speifies the main category associated with this data Module.	DataModule
		updatedBy : String Specifies the constant string indicating the data module was updated by UPDATED_BY_NONE The asset has not been updated after publishing. UPDATED_BY_USER The asset has been updated by only user. UPDATED_BY_SYSTEM The asset has been updated by only system. UPDATED_BY_USER_AND_SYSTEM The asset has been updated by both user and system.	DataModule
		variableList : ArrayCollection List of Variable objects for each variable used by this module.	DataModule
		version : int	DataModule

Public Methods

	Method		Defined By
		ImageModule() Constructor	ImageModule
		addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, weakRef:Boolean = false):void Registers an event listener object with an EventDispatcher object so that the listener receives notification of an event.	DataModule
		dispatchEvent(event:Event):Boolean Dispatches an event into the event flow.	DataModule
		hasEventListener(type:String):Boolean Checks whether the EventDispatcher object has any listeners registered for a specific type of event.	DataModule
		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
		removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void Removes a listener from the EventDispatcher object.	DataModule
		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 [override] Returns the string representation of the specified object.	ImageModule
		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.	DataModule

Public Constants

	Constant		Defined By

Property Detail

caption

property

caption:String

Language Version:

ActionScript 3.0

Product Version:

Asset Composer Building Block 9.5

Runtime Versions:

AIR (unsupported), Flash Player 9, Flash Player 10

used as the tooltip for the image when inserted into a letter (to create accessible letters)

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 caption():String
public function set caption(value:String):void

fileName

property

fileName:String

Language Version:

ActionScript 3.0

Product Version:

Asset Composer Building Block 9.5

Runtime Versions:

AIR (unsupported), Flash Player 9, Flash Player 10

original image file name ("friendly name") from user's local system (no path included)

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 fileName():String
public function set fileName(value:String):void

imageBlob

property

imageBlob:ByteArray

Language Version:

ActionScript 3.0

Product Version:

Asset Composer Building Block 9.5

Runtime Versions:

AIR (unsupported), Flash Player 9, Flash Player 10

The byte stream of the image

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 imageBlob():ByteArray
public function set imageBlob(value:ByteArray):void

mimeType

property

mimeType:String

Language Version:

ActionScript 3.0

Product Version:

Asset Composer Building Block 9.5

Runtime Versions:

AIR (unsupported), Flash Player 9, Flash Player 10

MIME type for the image.

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 mimeType():String
public function set mimeType(value:String):void

Related API Elements

Possible values.

serverFilePath

property

serverFilePath:String

Language Version:

ActionScript 3.0

Product Version:

Asset Composer Building Block 9.5

Runtime Versions:

AIR (unsupported), Flash Player 9, Flash Player 10

Temporary image file path returned from HTTP upload servlet after uploading file (used only on create/update). Set this to a file path received from the server in order to associate a newly-selected/uploaded image file with this image module. Otherwise, leave it null.

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 serverFilePath():String
public function set serverFilePath(value:String):void

Constructor Detail

ImageModule

()

Constructor

public function ImageModule()

Language Version:

ActionScript 3.0

Product Version:

Asset Composer Building Block 9.5

Runtime Versions:

AIR (unsupported), Flash Player 9, Flash Player 10

Constructor

Method Detail

toString

()

method

override public function toString():String

Language Version:

ActionScript 3.0

Product Version:

Asset Composer Building Block 9.5

Runtime Versions:

AIR (unsupported), Flash Player 9, Flash Player 10

Returns the string representation of the specified object.

Note: Methods of the Object class are dynamically created on Object's prototype. To redefine this method in a subclass of Object, do not use the override keyword. For example, a subclass of Object implements function toString():String instead of using an override of the base class.

Returns

String — A string representation of the object.

Legal Notices | Online Privacy Policy

ImageModule - AS3 Asset Composer

Classes x

caption

fileName

imageBlob

mimeType

serverFilePath

ImageModule

toString