LDMAssignment

Package	com.adobe.icc.vo
Class	public class LDMAssignment
Inheritance	LDMAssignment Object
Implements	IEventDispatcher

Language Version:

ActionScript 3.0

Product Version:

Asset Composer Building Block 9.5

Runtime Versions:

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

Properties of a data module assigned to a data module as a list item.

Public Properties

	Property		Defined By
		compound : Boolean Only applicable if the 'target' is a List Module.	LDMAssignment
		constructor : Object A reference to the class object or constructor function for a given object instance.	Object
		editable : Boolean Specifies whether the item's value can be edited at runtime.	LDMAssignment
		ID : String Specifies the globally unique identifier, that is, the GUID.	LDMAssignment
		ignoreListStyle : Boolean Only applicable if the 'target' is a List Module.	LDMAssignment
		indentationLevel : Number Specifies The indentation level for the target data module.	LDMAssignment
		optional : Boolean Specifies whether the item is not mandatory for the list.	LDMAssignment
		position : int Specifies a zero-based position of the item within the list.	LDMAssignment
		preSelected : Boolean Specifies whether the item is pre-selected in the list at runtime.	LDMAssignment
		skipStyle : Boolean True if the item is to be skipped from being numbered/bulleted, false otherwise.	LDMAssignment
		target : DataModule Specifies the data module that is the item in the list.	LDMAssignment

Public Methods

	Method		Defined By
		LDMAssignment() Constructor.	LDMAssignment
		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.	LDMAssignment
		dispatchEvent(event:Event):Boolean Dispatches an event into the event flow.	LDMAssignment
		hasEventListener(type:String):Boolean Checks whether the EventDispatcher object has any listeners registered for a specific type of event.	LDMAssignment
		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.	LDMAssignment
		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 Specifies the string representation of this object.	LDMAssignment
		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.	LDMAssignment

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 propertyChange 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

Specifies whether the item's value can be edited at runtime. If the value is true, the item can be edited.

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

ID

property

ID: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 the globally unique identifier, that is, the GUID. Do not set on client.

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

Specifies whether the item is not mandatory for the list. If the value is true, the item is optional.

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

position

property

position: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 zero-based position of the item within 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 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

Specifies whether the item is pre-selected in the list at runtime. If the value is true, the item is pre-selected.

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

skipStyle

property

skipStyle: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 to be skipped from being numbered/bulleted, false otherwise. Indentation may still be applied.

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

target

property

target:DataModule

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 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 propertyChange event.

Implementation
public function get target():DataModule
public function set target(value:DataModule):void

Constructor Detail

LDMAssignment

()

Constructor

public function LDMAssignment()

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

addEventListener

()

method

 public function 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. You can register event listeners on all nodes in the display list for a specific type of event, phase, and priority.

After you successfully register an event listener, you cannot change its priority through additional calls to addEventListener(). To change a listener's priority, you must first call removeEventListener(). Then you can register the listener again with the new priority level.

After the listener is registered, subsequent calls to addEventListener() with a different value for either type or useCapture result in the creation of a separate listener registration. For example, if you first register a listener with useCapture set to true, it listens only during the capture phase. If you call addEventListener() again using the same listener object, but with useCapture set to false, you have two separate listeners: one that listens during the capture phase, and another that listens during the target and bubbling phases.

You cannot register an event listener for only the target phase or the bubbling phase. Those phases are coupled during registration because bubbling applies only to the ancestors of the target node.

When you no longer need an event listener, remove it by calling EventDispatcher.removeEventListener(); otherwise, memory problems might result. Objects with registered event listeners are not automatically removed from memory because the garbage collector does not remove objects that still have references.

Copying an EventDispatcher instance does not copy the event listeners attached to it. (If your newly created node needs an event listener, you must attach the listener after creating the node.) However, if you move an EventDispatcher instance, the event listeners attached to it move along with it.

If the event listener is being registered on a node while an event is also being processed on this node, the event listener is not triggered during the current phase but may be triggered during a later phase in the event flow, such as the bubbling phase.

If an event listener is removed from a node while an event is being processed on the node, it is still triggered by the current actions. After it is removed, the event listener is never invoked again (unless it is registered again for future processing).

Parameters

	`type:String` — The type of event.

	`listener:Function` — The listener function that processes the event. This function must accept an event object as its only parameter and must return nothing, as this example shows: `function(evt:Event):void` The function can have any name.

	`useCapture:Boolean` (default = `false`) — Determines whether the listener works in the capture phase or the target and bubbling phases. If `useCapture` is set to `true`, the listener processes the event only during the capture phase and not in the target or bubbling phase. If `useCapture` is `false`, the listener processes the event only during the target or bubbling phase. To listen for the event in all three phases, call `addEventListener()` twice, once with `useCapture` set to `true`, then again with `useCapture` set to `false`.

	`priority:int` (default = `0`) — The priority level of the event listener. Priorities are designated by a 32-bit integer. The higher the number, the higher the priority. All listeners with priority n are processed before listeners of priority n-1. If two or more listeners share the same priority, they are processed in the order in which they were added. The default priority is 0.

	`weakRef:Boolean` (default = `false`) — Determines whether the reference to the listener is strong or weak. A strong reference (the default) prevents your listener from being garbage-collected. A weak reference does not. Class-level member functions are not subject to garbage collection, so you can set `useWeakReference` to `true` for class-level member functions without subjecting them to garbage collection. If you set `useWeakReference` to `true` for a listener that is a nested inner function, the function will be garbge-collected and no longer persistent. If you create references to the inner function (save it in another variable) then it is not garbage-collected and stays persistent.

dispatchEvent

()

method

public function dispatchEvent(event:Event):Boolean

Dispatches an event into the event flow. The event target is the EventDispatcher object upon which dispatchEvent() is called.

Parameters

event:Event — The event object dispatched into the event flow.

Returns

Boolean — A value of true unless preventDefault() is called on the event, in which case it returns false.

hasEventListener

()

method

public function hasEventListener(type:String):Boolean

Checks whether the EventDispatcher object has any listeners registered for a specific type of event. This allows you to determine where an EventDispatcher object has altered handling of an event type in the event flow hierarchy. To determine whether a specific event type will actually trigger an event listener, use IEventDispatcher.willTrigger().

The difference between hasEventListener() and willTrigger() is that hasEventListener() examines only the object to which it belongs, whereas willTrigger() examines the entire event flow for the event specified by the type parameter.

Parameters

type:String — The type of event.

Returns

Boolean — A value of true if a listener of the specified type is registered; false otherwise.

removeEventListener

()

method

public function removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void

Removes a listener from the EventDispatcher object. If there is no matching listener registered with the EventDispatcher object, a call to this method has no effect.

Parameters

	`type:String` — The type of event.

	`listener:Function` — The listener object to remove.

	`useCapture:Boolean` (default = `false`) — Specifies whether the listener was registered for the capture phase or the target and bubbling phases. If the listener was registered for both the capture phase and the target and bubbling phases, two calls to `removeEventListener()` are required to remove both: one call with `useCapture` set to `true`, and another call with `useCapture` set to `false`.

toString

()

method

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 the string representation of this object.

Returns

String — The string representation of this object.

willTrigger

()

method

public function 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. This method returns true if an event listener is triggered during any phase of the event flow when an event of the specified type is dispatched to this EventDispatcher object or any of its descendants.

Parameters

type:String — The type of event.

Returns

Boolean — A value of true if a listener of the specified type will be triggered; false otherwise.

Legal Notices | Online Privacy Policy

LDMAssignment - AS3 Asset Composer

Classes x

compound

editable

ID

ignoreListStyle

indentationLevel

optional

position

preSelected

skipStyle

target

LDMAssignment

addEventListener

dispatchEvent

hasEventListener

removeEventListener

toString

willTrigger