ListModel

Package	com.adobe.icc.editors.model
Class	public class ListModel
Inheritance	ListModel ModuleModel AssetModel EventDispatcher Object

Language Version:

ActionScript 3.0

Product Version:

Asset Composer Building Block 9.5

Runtime Versions:

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

The ListModel class represents the domain object for the assets of type List. Domain objects can be leveraged to build presentation on top of them. They ease the process of coding views by abstracting all the service calls and maintaining meaningful states.

Public Properties

	Property		Defined By
		activeEndDate : Date The activeEndDate of the underlying value object.	AssetModel
		activeStartDate : Date The activeStartDate date of the underlying value object.	AssetModel
		allowFreeText : Boolean Flag to indicate if this assignment allows adding free text.	ListModel
		assignments : IList The list of ListAssignmentModel objects.	ListModel
		category : Category The Category of the underlying value object.	AssetModel
		comment : String The comment of the underlying value object.	AssetModel
		constructor : Object A reference to the class object or constructor function for a given object instance.	Object
		crxVersion : String The crx version of the underlying value object.	AssetModel
		custom : String The custom property of the underlying value object.	ListModel
		dataDictionary : DataDictionary The typed DataDictionary object being used by this module.	ModuleModel
		dataDictionaryName : String The name of the data dictionary being used by this module.	ModuleModel
		description : String The description of the underlying value object.	AssetModel
		extendedProperties : Object The extended properties of the underlying value object.	AssetModel
		id : String The GUID of the underlying value object.	AssetModel
		isCustom : Boolean The flag indicating whether Custom style is used for the List items or not	ListModel
		isDDReferenced : Boolean [read-only] Indicates whether the data dictionary defined for this list has been referred in any of the assignments.	ListModel
		isNew : Boolean Indicates if this Asset is new.	AssetModel
		lastChangeBy : String The lastChangeBy property of the underlying value object.	AssetModel
		lastSelectedCustom : String Fetches the last selected Custom style name of the List.	ListModel
		max : int The max property of the underlying value object.	ListModel
		min : int The min property of the underlying value object.	ListModel
		name : String The name of the underlying value object.	AssetModel
		open : Boolean The open property of the underlying value object.	ListModel
		ordered : Boolean The ordered property of the underlying value object.	ListModel
		prefix : String The prefix property of the underlying value object.	ListModel
		service : IModuleService [static] The module service instance that is used for saving/retrieving the module on the server.	ListModel
		shallow : Boolean Flag to indicate if the underlying value object is shallow.	ModuleModel
		state : int The state of the underlying value object.	AssetModel
		style : String The style property of the underlying value object.	ListModel
		subCategory : Category The Sub-Category of the underlying value object.	AssetModel
		suffix : String The suffix property of the underlying value object.	ListModel
		type : String The type property of the underlying value object.	ListModel
		variables : IList [read-only] The variables defined within this module.	ModuleModel
		version : int The version of the underlying value object.	AssetModel
		vo : * The value object which this asset domain object is built atop.	AssetModel

Protected Properties

	Property		Defined By
		isCopy : Boolean Indicates that the object is a copy of an existing Asset.	AssetModel
		oldId : String Id of the Asset which was cloned to create this copy.	AssetModel
		preferencesManager : PreferencesManager To manage user preferences for category, subcategory and data dictionary.	AssetModel

Public Methods

	Method		Defined By
		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
		copy():ListModel Creates a copy of the domain object.	ListModel
		createFromId(moduleId:String):ModuleModel [static] Fetches a module by the given id and constructs the domain module object on top of it.	ModuleModel
		createFromVO(listVO:ListDataModule, fetchFromServer:Boolean = true):ListModel [static] Creates the domain object from the corresponding value object.	ListModel
		dispatchEvent(event:Event):Boolean Dispatches an event into the event flow.	EventDispatcher
		fetchComplete():void [override] Fetches the complete value object via remoting call.	ListModel
		filterContentLibrary(module:ModuleModel):Boolean Filter function for filtering content.	ListModel
		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
		isShallow():Boolean Indicates if the underlying value object is shallow.	ModuleModel
		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.	EventDispatcher
		save():void [override] Saves the underlying value object on the server.	ListModel
		setDataDictionaryName(ddName:String, fetchDataDictionary:Boolean = true):void Sets the data dictionary name to the one specified and also fetches the corresponding DataDictionary object from the server.	ModuleModel
		setDataDictRegistryService(value:DataDictionaryRegistryService):void [static] This method lets you inject a custom implementation of the infrastructure data dictionary service.	ModuleModel
		setModuleService(value:IModuleService):void [static] This method lets you inject a custom implementation of the infrastructure module service.	ListModel
		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
		validate():void Runs the client validations and raises events of the type AssetValidationEvent for notifying validation result.	ModuleModel
		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
		fetchDataDictionary():void Fetches the data dictionary corresponding to the name specified.	ModuleModel

Events

Click for more information on events

	Summary	Defined By
activate	[broadcast event] Dispatched when the Flash Player or AIR application gains operating system focus and becomes active.	EventDispatcher
assignmentAdd	Dispatched when an assignment is added to the assignments list.	ListModel
assignmentRemove	Dispatched when an assignment is removed from the assignments list.	ListModel
deactivate	[broadcast event] Dispatched when the Flash Player or AIR application operating loses system focus and is becoming inactive.	EventDispatcher
fetchComplete	Dispatched when this Asset is completely fetched from the server.	ListModel
saveComplete	Dispatched when the list is successfully saved.	ListModel
saveFault	Dispatched when a fault occurs while saving the list.	ListModel
saving	Dispatched when the current list is requested for save.	ListModel

Public Constants

	Constant		Defined By
		STYLE_BULLETED : String = "STYLE_BULLETED" [static]	ListModel
		STYLE_NUMBERED : String = "STYLE_NUMBERED" [static]	ListModel
		STYLE_PLAIN : String = "STYLE_PLAIN" [static]	ListModel
		TYPE_BULLET_DOT : String = "TYPE_BULLET_DOT" [static]	ListModel
		TYPE_CUSTOM : String = "TYPE_CUSTOM" [static]	ListModel
		TYPE_LETTER_LOWER : String = "TYPE_LETTER_LOWER" [static]	ListModel
		TYPE_LETTER_UPPER : String = "TYPE_LETTER_UPPER" [static]	ListModel
		TYPE_NUMBER_ARABIC : String = "TYPE_NUMBER_ARABIC" [static]	ListModel
		TYPE_NUMBER_ROMANLOWER : String = "TYPE_NUMBER_ROMANLOWER" [static]	ListModel
		TYPE_NUMBER_ROMANUPPER : String = "TYPE_NUMBER_ROMANUPPER" [static]	ListModel

Property Detail

allowFreeText

property

allowFreeText:Boolean

Language Version:

ActionScript 3.0

Product Version:

Asset Composer Building Block 10

Runtime Versions:

AIR (unsupported), Flash Player 10.2

Flag to indicate if this assignment allows adding free text.

This property can be used as the source for data binding. When this property is modified, it dispatches the allowFreeTextChange event.

Implementation
public function get allowFreeText():Boolean
public function set allowFreeText(value:Boolean):void

assignments

property

assignments:IList

Language Version:

ActionScript 3.0

Product Version:

Asset Composer Building Block 9.5

Runtime Versions:

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

The list of ListAssignmentModel objects.

This property can be used as the source for data binding. When this property is modified, it dispatches the fetchComplete event.

Implementation
public function get assignments():IList
public function set assignments(value:IList):void

Related API Elements

com.adobe.icc.vo.ListDataModule.assignmentList

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

The custom property of the underlying value object.

This property can be used as the source for data binding. When this property is modified, it dispatches the fetchComplete event.

Implementation
public function get custom():String
public function set custom(value:String):void

isCustom

property

isCustom:Boolean

Language Version:

ActionScript 3.0

Product Version:

Asset Composer Building Block 10

Runtime Versions:

AIR (unsupported), Flash Player 10.2

The flag indicating whether Custom style is used for the List items or not

This property can be used as the source for data binding. When this property is modified, it dispatches the isCustomChange event.

Implementation
public function get isCustom():Boolean
public function set isCustom(value:Boolean):void

isDDReferenced

property

isDDReferenced:Boolean [read-only]

Language Version:

ActionScript 3.0

Product Version:

Asset Composer Building Block 9.5

Runtime Versions:

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

Indicates whether the data dictionary defined for this list has been referred in any of the assignments.

This property can be used as the source for data binding. When this property is modified, it dispatches the assignmentRemove event.

Implementation
public function get isDDReferenced():Boolean

lastSelectedCustom

property

lastSelectedCustom:String

Language Version:

ActionScript 3.0

Product Version:

Asset Composer Building Block 10

Runtime Versions:

AIR (unsupported), Flash Player 10.2

Fetches the last selected Custom style name of the List.

This property can be used as the source for data binding. When this property is modified, it dispatches the lastSelectedCustomChange event.

Implementation
public function get lastSelectedCustom():String
public function set lastSelectedCustom(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

The max property of the underlying value object.

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

The min property of the underlying value object.

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

The open property of the underlying value object.

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

The ordered property of the underlying value object.

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

The prefix property of the underlying value object.

This property can be used as the source for data binding. When this property is modified, it dispatches the fetchComplete event.

Implementation
public function get prefix():String
public function set prefix(value:String):void

service

property

public static var service:IModuleService

Language Version:

ActionScript 3.0

Product Version:

Asset Composer Building Block 9.5

Runtime Versions:

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

The module service instance that is used for saving/retrieving the module on the server. This service is internally invoked by this class for performing CRUD operations.

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

The style property of the underlying value object.

This property can be used as the source for data binding. When this property is modified, it dispatches the fetchComplete 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

The suffix property of the underlying value object.

This property can be used as the source for data binding. When this property is modified, it dispatches the fetchComplete 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

The type property of the underlying value object.

This property can be used as the source for data binding. When this property is modified, it dispatches the fetchComplete event.

Implementation
public function get type():String
public function set type(value:String):void

Method Detail

copy

()

method

public function copy():ListModel

Language Version:

ActionScript 3.0

Product Version:

Asset Composer Building Block 9.5

Runtime Versions:

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

Creates a copy of the domain object.

Note that this is different than cloning via ObjectUtil.copy() since a "copied" object needs to be saved via a specific server api.

Returns

ListModel — A copy of current domain object.

createFromVO

()

method

public static function createFromVO(listVO:ListDataModule, fetchFromServer:Boolean = true):ListModel

Language Version:

ActionScript 3.0

Product Version:

Asset Composer Building Block 9.5

Runtime Versions:

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

Creates the domain object from the corresponding value object.

Value Objects are pure data entities mostly acting as parameters to the server apis. Domain objects are build atop to provide more meaningful business data and behavior thereby enabling faster and convenient UI view development.

In some cases, the value objects could be shallow; for instance when obtained via Data Services. The complete value object could be requested by passing the fetchFromServer flag as true. In that case, the value object is obtained from the server via remoting call and the domain object shapes accordingly as the server response arrives.

Parameters

	`listVO:ListDataModule` — The value object of the type List

	`fetchFromServer:Boolean` (default = `true`) — Flag to indicate if the complete value object should be obtained from the server

Returns

ListModel — The List domain object corresponding the passed List value object.

fetchComplete

()

method

override public function fetchComplete():void

Language Version:

ActionScript 3.0

Product Version:

Asset Composer Building Block 9.5

Runtime Versions:

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

Fetches the complete value object via remoting call. This should be called when the underlying value object is shallow.

filterContentLibrary

()

method

public function filterContentLibrary(module:ModuleModel):Boolean

Language Version:

ActionScript 3.0

Product Version:

Asset Composer Building Block 9.5

Runtime Versions:

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

Filter function for filtering content.

Parameters

module:ModuleModel — The module to inspect for filtering from the content library.

Returns

Boolean —

save

()

method

override public function save():void

Language Version:

ActionScript 3.0

Product Version:

Asset Composer Building Block 9.5

Runtime Versions:

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

Saves the underlying value object on the server.

Under the hood, separate calls are required for creating a new asset and copying or copying an existing one.

The save() method internally invokes the relevant server calls on the basis of its current state. The domain object constructed from the createFromVO() method would invoke the "update" api, the domain object starightaway instantiated on the client would inoke the "create" module api and the domain object obtained by the copy() method would internally call "copy api".

Invoking the save() implicitly invokes the validate() method to perform the necessary client side validations. Only when the client side validations are successful, is the actual save() call made. A save() method wouldn't proceed past the validation stage unless the object's state is made valid via user input or otherwise.

setModuleService

()

method

public static function setModuleService(value:IModuleService):void

Language Version:

ActionScript 3.0

Product Version:

Asset Composer Building Block 9.5

Runtime Versions:

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

This method lets you inject a custom implementation of the infrastructure module service. By default, the class ModuleServiceDelegate is used as the infrastructure service.

Parameters

value:IModuleService — An implementation for IModuleService.

Event Detail

assignmentAdd

Event

Event Object Type: flash.events.Event
property Event.type = flash.events.Event

Language Version:

ActionScript 3.0

Product Version:

Asset Composer Building Block 9.5

Runtime Versions:

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

Dispatched when an assignment is added to the assignments list.

assignmentRemove

Event

Event Object Type: flash.events.Event
property Event.type = flash.events.Event

Language Version:

ActionScript 3.0

Product Version:

Asset Composer Building Block 9.5

Runtime Versions:

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

Dispatched when an assignment is removed from the assignments list.

fetchComplete

Event

Event Object Type: flash.events.Event
property Event.type = flash.events.Event

Language Version:

ActionScript 3.0

Product Version:

Asset Composer Building Block 9.5

Runtime Versions:

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

Dispatched when this Asset is completely fetched from the server. Assets are often kept shallow in the Asset Manager and fetched completely only when necessary. The fetchComplete event is dispatched when the Asset has been retrieved completely from the server.

saveComplete

Event

Event Object Type: com.adobe.icc.editors.events.AssetEvent
property AssetEvent.type = com.adobe.icc.editors.events.AssetEvent.SAVE_COMPLETE

Language Version:

ActionScript 3.0

Product Version:

Asset Composer Building Block 9.5

Runtime Versions:

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

Dispatched when the list is successfully saved.

The AssetEvent.SAVE_COMPLETE constant defines the value of the type property of the event object for a saveComplete event.

The saveComplete event is dispatched when the domain object has been successfully saved on the server. Unlike the saving event, this is dispatched in an aysnchronous manner only after the server has responded with a result for the save api call.

This event can be used to stop UI animations indicating "save in progress" or to popup an info box indicating save success.

saveFault

Event

Event Object Type: com.adobe.icc.editors.events.AssetEvent
property AssetEvent.type = com.adobe.icc.editors.events.AssetEvent.SAVE_FAULT

Language Version:

ActionScript 3.0

Product Version:

Asset Composer Building Block 9.5

Runtime Versions:

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

Dispatched when a fault occurs while saving the list.

The AssetEvent.SAVE_FAULT constant defines the value of the type property of the event object for a saveFault event.

The saveFault event is dispatched when the server reports an error while saving the asset on the server. Unlike the saving event, this is dispatched in an aysnchronous manner only after the server has responded with a result for the save api call.

When this event is dispatched, the fault property contains the fault object encapsulating the error sent by the server. The fault property can be used to determine the faultCode and show an error message accordingly.

This event can be used to stop UI animations indicating "save in progress" or to popup an info box indicating save success.

saving

Event

Event Object Type: com.adobe.icc.editors.events.AssetEvent
property AssetEvent.type = com.adobe.icc.editors.events.AssetEvent.SAVING

Language Version:

ActionScript 3.0

Product Version:

Asset Composer Building Block 9.5

Runtime Versions:

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

Dispatched when the current list is requested for save. This event, being bubbling in nature, can be leveraged by the UI to display a progress bar or animation to indicate the save progress.

The AssetEvent.SAVING constant defines the value of the type property of the event object for a saving event.

The saving event is dispatched when the save() method has been called on the domain object. This event is dispatched before any server api is invoked but after the domain client validations are complete. This is because the actual save starts once the client validations are complete.

This event can be used to start a UI animation indicating "save in progress".

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

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

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

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

TYPE_CUSTOM

Constant

public static const TYPE_CUSTOM:String = "TYPE_CUSTOM"

Language Version:

ActionScript 3.0

Product Version:

Asset Composer Building Block 10

Runtime Versions:

AIR (unsupported), Flash Player 10.2

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

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

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

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

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

Legal Notices | Online Privacy Policy

ListModel - AS3 Asset Composer

Classes x

allowFreeText

assignments

custom

isCustom

isDDReferenced

lastSelectedCustom

max

min

open

ordered

prefix

service

style

suffix

type

copy

createFromVO

fetchComplete

filterContentLibrary

save

setModuleService

assignmentAdd

assignmentRemove

fetchComplete

saveComplete

saveFault

saving

STYLE_BULLETED

STYLE_NUMBERED

STYLE_PLAIN

TYPE_BULLET_DOT

TYPE_CUSTOM

TYPE_LETTER_LOWER

TYPE_LETTER_UPPER

TYPE_NUMBER_ARABIC

TYPE_NUMBER_ROMANLOWER

TYPE_NUMBER_ROMANUPPER