ListModuleInstance

Package	com.adobe.icc.dc.domain
Class	public class ListModuleInstance
Inheritance	ListModuleInstance BaseModuleInstance EventDispatcher Object
Implements	IContainerInstance

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

Public Properties

Hide Inherited Public Properties

Show Inherited 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
		contents : IList [read-only] List of the contents associated with this Container instance.	ListModuleInstance
		contentVariables : IList [read-only] The set of active variables for the module.	BaseModuleInstance
		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
		hasContentRemoved : Boolean [read-only] True if the List has one or more content removed from it, than what was originall assigned.	ListModuleInstance
		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	ListModuleInstance
		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
		open : Boolean [read-only] True if the container is open to extra content; false if it only allows content that was explicitly assigned to it in the letter.	ListModuleInstance
		optional : Boolean [read-only] True if this module is optional in its container (based on the assignment, not the selected state).	BaseModuleInstance
		ordered : Boolean [read-only] True if the container's contents order is fixed; false if its contents can be re-ordered.	ListModuleInstance
		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

Hide Inherited Public Methods

Show Inherited Public Methods

	Method		Defined By
		ListModuleInstance(vListData:ListData, vParentContainer:IContainerInstance = null, remod:ReloadModule = null) Constructor.	ListModuleInstance
		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
		addRawModule(dataModule:DataModule, position:int = -1):IModuleInstance Inserts the specified raw DataModule into the list's contents as extra selected content if list is open.	ListModuleInstance
		dispatchEvent(event:Event):Boolean Dispatches an event into the event flow.	EventDispatcher
		getCompoundNumbering():Boolean If true, the numbering across the modules of the target List module would be compounded (i.e.	ListModuleInstance
		getIgnoreListStyle():Boolean 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.	ListModuleInstance
		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
		moveContent(sourceModule:IModuleInstance, moveUp:Boolean):void Moves the specified item within the list's content one position in the specified direction.	ListModuleInstance
		propertyIsEnumerable(name:String):Boolean Indicates whether the specified property exists and is enumerable.	Object
		refresh():void [override] Refresh should be called when item is selected.	ListModuleInstance
		removeContent(sourceModule:IModuleInstance):void Removes the specified item from the list's collection if the item is found in the collection and is non mandatory	ListModuleInstance
		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
		setSkipStyle(value:Boolean, skipChildren:Boolean = true):void [override]	ListModuleInstance
		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

Hide Inherited Protected Methods

Show Inherited 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

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

property

contents:IList [read-only]

Language Version:

ActionScript 3.0

Product Version:

Asset Composer Building Block 10.0

Runtime Versions:

AIR (unsupported), Flash Player 10.2

List of the contents associated with this Container instance.

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 contents():IList

hasContentRemoved

property

hasContentRemoved:Boolean [read-only]

Language Version:

ActionScript 3.0

Product Version:

Asset Composer Building Block 10.0

Runtime Versions:

AIR (unsupported), Flash Player 10.2

True if the List has one or more content removed from it, than what was originall assigned. [Relevant when reloading]

Implementation
public function get hasContentRemoved():Boolean

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_LIST

open

property

open:Boolean [read-only]

Language Version:

ActionScript 3.0

Product Version:

Asset Composer Building Block 10.0

Runtime Versions:

AIR (unsupported), Flash Player 10.2

True if the container is open to extra content; false if it only allows content that was explicitly assigned to it in the letter.

Implementation
public function get open():Boolean

ordered

property

ordered:Boolean [read-only]

Language Version:

ActionScript 3.0

Product Version:

Asset Composer Building Block 10.0

Runtime Versions:

AIR (unsupported), Flash Player 10.2

True if the container's contents order is fixed; false if its contents can be re-ordered.

Implementation
public function get ordered():Boolean

Constructor Detail

()

Constructor

public function ListModuleInstance(vListData:ListData, vParentContainer:IContainerInstance = null, remod:ReloadModule = null)

Language Version:

ActionScript 3.0

Product Version:

Asset Composer Building Block 10.0

Runtime Versions:

AIR (unsupported), Flash Player 10.2

Constructor.

Parameters

	`vListData:ListData` — ListData object represented by this instance.

	`vParentContainer:IContainerInstance` (default = `null`) — Container of the List Module that can be a list or a target area.

	`remod:ReloadModule` (default = `null`) — Reload Module for the case of correspondence reload.

Method Detail

addRawModule

()

method

public function addRawModule(dataModule:DataModule, position:int = -1):IModuleInstance

Language Version:

ActionScript 3.0

Product Version:

Asset Composer Building Block 10.0

Runtime Versions:

AIR (unsupported), Flash Player 10.2

Inserts the specified raw DataModule into the list's contents as extra selected content if list is open.

Parameters

	`dataModule:DataModule` — dataModule The module to select/insert.

	`position:int` (default = `-1`) — The absolute position at which to insert the module into the contents list. The dataModule becomes the new element at that position in the list. If `position` is less than zero or beyond the end of the list, the content is appended. If the list is fixed-order, then module is appended at end.

Returns

IModuleInstance —

getCompoundNumbering

()

method

public function getCompoundNumbering():Boolean

Language Version:

ActionScript 3.0

Product Version:

Asset Composer Building Block 10.0

Runtime Versions:

AIR (unsupported), Flash Player 10.2

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.

Returns

Boolean —

getIgnoreListStyle

()

method

public function getIgnoreListStyle():Boolean

Language Version:

ActionScript 3.0

Product Version:

Asset Composer Building Block 10.0

Runtime Versions:

AIR (unsupported), Flash Player 10.2

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.

Returns

Boolean —

moveContent

()

method

public function moveContent(sourceModule:IModuleInstance, moveUp:Boolean):void

Language Version:

ActionScript 3.0

Product Version:

Asset Composer Building Block 10.0

Runtime Versions:

AIR (unsupported), Flash Player 10.2

Moves the specified item within the list's content one position in the specified direction.

Parameters

	`sourceModule:IModuleInstance` — The item to move.

	`moveUp:Boolean` — True to move up, false to move down.

refresh

()

method

override public function refresh():void

Language Version:

ActionScript 3.0

Product Version:

Asset Composer Building Block 10.0

Runtime Versions:

AIR (unsupported), Flash Player 10.2

Refresh should be called when item is selected. This is useful in case when the the item is deselcted. In that case, if there is any change in variable value/ field value etc., those changes may not be propagated to module.

removeContent

()

method

public function removeContent(sourceModule:IModuleInstance):void

Language Version:

ActionScript 3.0

Product Version:

Asset Composer Building Block 10.0

Runtime Versions:

AIR (unsupported), Flash Player 10.2

Removes the specified item from the list's collection if the item is found in the collection and is non mandatory

Parameters

sourceModule:IModuleInstance — The item to be removed.

setSkipStyle

()

method

override public function setSkipStyle(value:Boolean, skipChildren:Boolean = true):void

Language Version:

ActionScript 3.0

Product Version:

Asset Composer Building Block 10.0

Runtime Versions:

AIR (unsupported), Flash Player 10.2

Parameters

	`value:Boolean`

	`skipChildren:Boolean` (default = `true`)

ListModuleInstance - AS3 Asset Composer

Classes x

contents

hasContentRemoved

moduleType

open

ordered