ListDataModule

Package	com.adobe.icc.vo
Class	public class ListDataModule
Inheritance	ListDataModule 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 a list module. Contains a list of LDMAssignment objects. Each LDMAssignment represents the target DataModule assigned to this list. Extends the basic attributes of a DataModule.

Public Properties

	Property		Defined By
		activeEndDate : Date	DataModule
		activeStartDate : Date	DataModule
		allowFreeText : Boolean Specifies whether free text can be added to the list	ListDataModule
		assignmentList : ArrayCollection Specifies the array of LDMAssignment objects.	ListDataModule
		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
		custom : String Specifies a custom bullet when the list style is STYLE_BULLETED and its type is TYPE_BULLET_CUSTOM.	ListDataModule
		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
		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
		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
		max : int Specifies a maximum selection.	ListDataModule
		min : int Specifies the minimum selection.	ListDataModule
		name : String Specifies the name of the data module.	DataModule
		open : Boolean Specifies whether the list allows extra content to be inserted from the library when a letter is being filled.	ListDataModule
		ordered : Boolean Specifies whether the items in the list cannot be reordered when a letter is being filled.	ListDataModule
		prefix : String Get the prefix before the number or letter.	ListDataModule
		state : int Specifies the state of the data module	DataModule
		style : String Specifies a list style constant.	ListDataModule
		suffix : String Get the suffix after the number or letter.	ListDataModule
		type : String Specifies a list type constant.This value is ignored if style is STYLE_PLAIN.	ListDataModule
		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
		ListDataModule() Constructor.	ListDataModule
		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] Specifies a string representation of this object.	ListDataModule
		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
		STYLE_BULLETED : String = "STYLE_BULLETED" [static] Specifies the constant for the list style that uses bullets.	ListDataModule
		STYLE_NUMBERED : String = "STYLE_NUMBERED" [static] Specifies the constant for the list style that uses numbers.	ListDataModule
		STYLE_PLAIN : String = "STYLE_PLAIN" [static] Specifies the constant for the plain list style.	ListDataModule
		TYPE_BULLET_DASH : String = "TYPE_BULLET_DASH" Deprecated: [static] Specifies the constant for the list style that uses dashed bullet.	ListDataModule
		TYPE_BULLET_DOT : String = "TYPE_BULLET_DOT" [static] Specifies the constant for the list style that uses dotted bullet.	ListDataModule
		TYPE_CUSTOM : String = "TYPE_CUSTOM" [static] Specifies the constant for the list style that uses custom style.	ListDataModule
		TYPE_LETTER_LOWER : String = "TYPE_LETTER_LOWER" [static] Specifies the constant for the list style that uses lowercase letters.	ListDataModule
		TYPE_LETTER_UPPER : String = "TYPE_LETTER_UPPER" [static] Specifies the constant for the list style that uses uppercase letters.	ListDataModule
		TYPE_NUMBER_ARABIC : String = "TYPE_NUMBER_ARABIC" [static] Specifies the constant for the list style that uses Arabic numerals.	ListDataModule
		TYPE_NUMBER_ROMANLOWER : String = "TYPE_NUMBER_ROMANLOWER" [static] Specifies the constant for the list style that uses lowercase Roman numerals.	ListDataModule
		TYPE_NUMBER_ROMANUPPER : String = "TYPE_NUMBER_ROMANUPPER" [static] Specifies the constant for the list style that uses uppercase Roman numerals.	ListDataModule

Property Detail

allowFreeText

property

allowFreeText:Boolean

Language Version:

ActionScript 3.0

Product Version:

Asset Composer Building Block 9.5

Runtime Versions:

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

Specifies whether free text can be added to the list

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

assignmentList

property

assignmentList:ArrayCollection

Language Version:

ActionScript 3.0

Product Version:

Asset Composer Building Block 9.5

Runtime Versions:

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

Specifies the array of LDMAssignment objects.

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

custom

property

custom:String

Language Version:

ActionScript 3.0

Product Version:

Asset Composer Building Block 9.5

Runtime Versions:

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

Specifies a custom bullet when the list style is STYLE_BULLETED and its type is TYPE_BULLET_CUSTOM. It is expected to be a single character. This character can be an HTML character code in the "yz" format where "xyz" is a number. For example, → for an arrow or ♦ for a diamond.

This value is ignored unless the style is STYLE_BULLETED and type is TYPE_BULLET_CUSTOM. If this property has the style and type for a custom bulleted list, it cannot be an empty string.

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

max

property

max:int

Language Version:

ActionScript 3.0

Product Version:

Asset Composer Building Block 9.5

Runtime Versions:

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

Specifies a maximum selection. If the value is negative, the value is infinite. If the value is not negative, the value is the maximum.

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

min

property

min:int

Language Version:

ActionScript 3.0

Product Version:

Asset Composer Building Block 9.5

Runtime Versions:

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

Specifies the minimum selection. A negative value defaults to zero.

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

open

property

open:Boolean

Language Version:

ActionScript 3.0

Product Version:

Asset Composer Building Block 9.5

Runtime Versions:

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

Specifies whether the list allows extra content to be inserted from the library when a letter is being filled. If the value is true, extra content can be inserted.

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

ordered

property

ordered:Boolean

Language Version:

ActionScript 3.0

Product Version:

Asset Composer Building Block 9.5

Runtime Versions:

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

Specifies whether the items in the list cannot be reordered when a letter is being filled. If the value is true, the list cannot be reordered.

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

prefix

property

prefix:String

Language Version:

ActionScript 3.0

Product Version:

Asset Composer Building Block 9.5

Runtime Versions:

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

Get the prefix before the number or letter. Can be an empty string.

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

style

property

style:String

Language Version:

ActionScript 3.0

Product Version:

Asset Composer Building Block 9.5

Runtime Versions:

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

Specifies a list style constant.

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

suffix

property

suffix:String

Language Version:

ActionScript 3.0

Product Version:

Asset Composer Building Block 9.5

Runtime Versions:

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

Get the suffix after the number or letter. Can be an empty string. This value is ignored if the style is STYLE_BULLETED or STYLE_PLAIN.

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

type

property

type:String

Language Version:

ActionScript 3.0

Product Version:

Asset Composer Building Block 9.5

Runtime Versions:

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

Specifies a list type constant.This value is ignored if style is STYLE_PLAIN.

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

Constructor Detail

ListDataModule

()

Constructor

public function ListDataModule()

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

Specifies a string representation of this object.

Returns

String — The string representation of this object.

Constant Detail

STYLE_BULLETED

Constant

public static const STYLE_BULLETED:String = "STYLE_BULLETED"

Language Version:

ActionScript 3.0

Product Version:

Asset Composer Building Block 9.5

Runtime Versions:

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

Specifies the constant for the list style that uses bullets.

STYLE_NUMBERED

Constant

public static const STYLE_NUMBERED:String = "STYLE_NUMBERED"

Language Version:

ActionScript 3.0

Product Version:

Asset Composer Building Block 9.5

Runtime Versions:

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

Specifies the constant for the list style that uses numbers.

STYLE_PLAIN

Constant

public static const STYLE_PLAIN:String = "STYLE_PLAIN"

Language Version:

ActionScript 3.0

Product Version:

Asset Composer Building Block 9.5

Runtime Versions:

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

Specifies the constant for the plain list style.

TYPE_BULLET_DASH

Constant

public static const TYPE_BULLET_DASH:String = "TYPE_BULLET_DASH"

Deprecated:

Language Version:

ActionScript 3.0

Product Version:

Asset Composer Building Block 9.5

Runtime Versions:

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

Specifies the constant for the list style that uses dashed bullet.

TYPE_BULLET_DOT

Constant

public static const TYPE_BULLET_DOT:String = "TYPE_BULLET_DOT"

Language Version:

ActionScript 3.0

Product Version:

Asset Composer Building Block 9.5

Runtime Versions:

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

Specifies the constant for the list style that uses dotted bullet.

TYPE_CUSTOM

Constant

public static const TYPE_CUSTOM:String = "TYPE_CUSTOM"

Language Version:

ActionScript 3.0

Product Version:

Asset Composer Building Block 9.5

Runtime Versions:

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

Specifies the constant for the list style that uses custom style.

TYPE_LETTER_LOWER

Constant

public static const TYPE_LETTER_LOWER:String = "TYPE_LETTER_LOWER"

Language Version:

ActionScript 3.0

Product Version:

Asset Composer Building Block 9.5

Runtime Versions:

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

Specifies the constant for the list style that uses lowercase letters.

TYPE_LETTER_UPPER

Constant

public static const TYPE_LETTER_UPPER:String = "TYPE_LETTER_UPPER"

Language Version:

ActionScript 3.0

Product Version:

Asset Composer Building Block 9.5

Runtime Versions:

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

Specifies the constant for the list style that uses uppercase letters.

TYPE_NUMBER_ARABIC

Constant

public static const TYPE_NUMBER_ARABIC:String = "TYPE_NUMBER_ARABIC"

Language Version:

ActionScript 3.0

Product Version:

Asset Composer Building Block 9.5

Runtime Versions:

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

Specifies the constant for the list style that uses Arabic numerals.

TYPE_NUMBER_ROMANLOWER

Constant

public static const TYPE_NUMBER_ROMANLOWER:String = "TYPE_NUMBER_ROMANLOWER"

Language Version:

ActionScript 3.0

Product Version:

Asset Composer Building Block 9.5

Runtime Versions:

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

Specifies the constant for the list style that uses lowercase Roman numerals.

TYPE_NUMBER_ROMANUPPER

Constant

public static const TYPE_NUMBER_ROMANUPPER:String = "TYPE_NUMBER_ROMANUPPER"

Language Version:

ActionScript 3.0

Product Version:

Asset Composer Building Block 9.5

Runtime Versions:

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

Specifies the constant for the list style that uses uppercase Roman numerals.

Legal Notices | Online Privacy Policy

ListDataModule - AS3 Asset Composer

Classes x

allowFreeText

assignmentList

custom

max

min

open

ordered

prefix

style

suffix

type

ListDataModule

toString

STYLE_BULLETED

STYLE_NUMBERED

STYLE_PLAIN

TYPE_BULLET_DASH

TYPE_BULLET_DOT

TYPE_CUSTOM

TYPE_LETTER_LOWER

TYPE_LETTER_UPPER

TYPE_NUMBER_ARABIC

TYPE_NUMBER_ROMANLOWER

TYPE_NUMBER_ROMANUPPER