com.adobe.icc.editors.model

# ListAssignmentModel - AS3 Asset Composer

Package | com.adobe.icc.editors.model
Class | public class ListAssignmentModel
Inheritance | ListAssignmentModel 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 `ListAssignmentModel` class represents the domain object for the assignments related to the list data module. 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
Hide Inherited Public Properties
Show Inherited Public Properties

| Property | Defined By
--- | --- | ---
|  | compound : Boolean Only applicable if the 'target' is a List Module. | ListAssignmentModel
|  | constructor : Object A reference to the class object or constructor function for a given object instance. | Object
|  | editable : Boolean True if the item's value can be edited at runtime. | ListAssignmentModel
|  | ignoreListStyle : Boolean Only applicable if the 'target' is a List Module. | ListAssignmentModel
|  | indentationLevel : Number Specifies The indentation level for the target data module. | ListAssignmentModel
|  | optional : Boolean True if the item is not a mandatory inclusion in the list. | ListAssignmentModel
|  | position : int The position of List item within the List. | ListAssignmentModel
|  | preSelected : Boolean True if the item is pre-selected in the list at runtime. | ListAssignmentModel
|  | skipListStyle : Boolean If true, the numbering style is not applied to the item. | ListAssignmentModel
|  | target : ModuleModel The data module that is the item in the list. | ListAssignmentModel
|  | vo : LDMAssignment The underlying assignment value object. | ListAssignmentModel

Public Methods
Hide Inherited Public Methods
Show Inherited Public Methods

| Method | Defined By
--- | --- | ---
|  | ListAssignmentModel(vo:LDMAssignment = null) Constructor for creating List Assignment Domain Model | ListAssignmentModel
|  | 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
|  | 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

Events
Click for more information on events
Hide Inherited Events
Show Inherited 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

### compound

property

`compound:Boolean`

Language Version: | ActionScript 3.0

Product Version: | Asset Composer Building Block 9.5

Runtime Versions: | AIR (unsupported), Flash Player 9, Flash Player 10

Only applicable if the 'target' is a List Module. If true, the numbering across the modules of the target List module would be compounded (i.e. of the format '1.1., 1.2.,...' or '1.a., 1.b.,...', etc.) When including a (nested) 'Plain/Bulleted' List as a target with the Compound Numbering option checked, the compound numbering style is applied as per the outer List's style. For instance, if the outer List has a style of '1, 2, 3..', the numbering on the nested List would be '1.1., 1.2...'; if the outer List has a style of 'A, B, C..', the numbering on the nested List would be 'A.A.., A.B....'; and so on.

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

Implementation
`public function get compound():Boolean`
`public function set compound(value:Boolean):void`

### editable

property

`editable:Boolean`

Language Version: | ActionScript 3.0

Product Version: | Asset Composer Building Block 9.5

Runtime Versions: | AIR (unsupported), Flash Player 9, Flash Player 10

True if the item's value can be edited at runtime.

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

Implementation
`public function get editable():Boolean`
`public function set editable(value:Boolean):void`

### ignoreListStyle

property

`ignoreListStyle:Boolean`

Language Version: | ActionScript 3.0

Product Version: | Asset Composer Building Block 9.5

Runtime Versions: | AIR (unsupported), Flash Player 9, Flash Player 10

Only applicable if the 'target' is a List Module. If true, the List's own style is ignored, and the numbering would continue from the outer List (as if the modules of the nested list were part of the outer list itself), disregarding any styles specified on the nested List.

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

Implementation
`public function get ignoreListStyle():Boolean`
`public function set ignoreListStyle(value:Boolean):void`

### indentationLevel

property

`indentationLevel:Number`

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 indentation level for the target data module.

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

Implementation
`public function get indentationLevel():Number`
`public function set indentationLevel(value:Number):void`

### optional

property

`optional:Boolean`

Language Version: | ActionScript 3.0

Product Version: | Asset Composer Building Block 9.5

Runtime Versions: | AIR (unsupported), Flash Player 9, Flash Player 10

True if the item is not a mandatory inclusion in the list.

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

Implementation
`public function get optional():Boolean`
`public function set optional(value:Boolean):void`

### position

property

`position:int`

Language Version: | ActionScript 3.0

Product Version: | Asset Composer Building Block 10

Runtime Versions: | AIR (unsupported), Flash Player 10.2

The position of List item within the List.

Implementation
`public function get position():int`
`public function set position(value:int):void`

### preSelected

property

`preSelected:Boolean`

Language Version: | ActionScript 3.0

Product Version: | Asset Composer Building Block 9.5

Runtime Versions: | AIR (unsupported), Flash Player 9, Flash Player 10

True if the item is pre-selected in the list at runtime.

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

Implementation
`public function get preSelected():Boolean`
`public function set preSelected(value:Boolean):void`

### skipListStyle

property

`skipListStyle:Boolean`

Language Version: | ActionScript 3.0

Product Version: | Asset Composer Building Block 9.5

Runtime Versions: | AIR (unsupported), Flash Player 9, Flash Player 10

If true, the numbering style is not applied to the item.

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

Implementation
`public function get skipListStyle():Boolean`
`public function set skipListStyle(value:Boolean):void`

### target

property

`target:ModuleModel`

Language Version: | ActionScript 3.0

Product Version: | Asset Composer Building Block 9.5

Runtime Versions: | AIR (unsupported), Flash Player 9, Flash Player 10

The data module that is the item in the list.

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

Implementation
`public function get target():ModuleModel`
`public function set target(value:ModuleModel):void`

### vo

property

`vo:LDMAssignment`

Language Version: | ActionScript 3.0

Product Version: | Asset Composer Building Block 9.5

Runtime Versions: | AIR (unsupported), Flash Player 9, Flash Player 10

The underlying assignment value object.

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

Implementation
`public function get vo():LDMAssignment`
`public function set vo(value:LDMAssignment):void`
Constructor Detail

### ListAssignmentModel

()
Constructor

`public function ListAssignmentModel(vo:LDMAssignment = null)`

Language Version: | ActionScript 3.0

Product Version: | Asset Composer Building Block 9.5

Runtime Versions: | AIR (unsupported), Flash Player 9, Flash Player 10

Constructor for creating List Assignment Domain Model

Parameters

| `vo:LDMAssignment` (default = `null`)`` — LDMAssignment object. If it's null, a new LDMAssignment object is created.

© 2015 Adobe Systems Incorporated. All rights reserved.
Mon Apr 10 2017, 12:28 PM -07:00